morgandream/ontology-dapi

A lightweight Javascript library for interacting with Ontology node and Ontology wallets

ontology dApi

English / 中文

ontology-dapi

API for dApps on Ontology blockchain. This is an implementation of dAPI from OEP-6 communication protocol.

It is necessary to have installed suitable dAPI provider . Reference implementation is Cyano Wallet.

The library is written in TypeScript, so all the methods and objects are typed. It is therefore usable in TypeScript projects as well as vanilla JavaScript projects.

How to use

ontology-dapi can be used as CommonJS/ES6 module or directly referencing in web page html.

Install CommonJS/ES module

npm install ontology-dapi

Import CommonJS

var client = require('ontology-dapi').client;

Import ES6 module

import { client } from 'ontology-dapi';

Web require

The browser.js file under the '/lib' folder needs to be referenced from the page:

<script src="./lib/browser.js"></script>

The use of the code is required under the global namespace of Ont.

var client = dApi.client;

Initialisation

dApp needs to register itself as a client with the ontology-dapi library to enable the communication.

import { client } from 'ontology-dapi';

client.registerClient({});

Usage

Examples of usage can be found in EXAMPLES.md or in a demo app

Documentation

All the methods of dAPI from OEP-6 are organised into smaller units: asset, identity, message, network, provider, smartContract and utils. The definitions of the methods can be found directly in the OEP-6.

Build

Required Tools and Dependencies

• Node
• Npm

Developing

Execute these commands in the project's root directory:

Download

git clone 'https://github.com/OntologyCommunityDevelopers/ontology-dapi.git'
cd ontology-dapi

Install

npm install

Development build

This will build the project with minimum polyfilling for better debug experience.

npm run build:dev

You will get the packaged code under '/lib'.

Production build

npm run build:prod

You will get the packaged code under '/lib'

Built With

• TypeScript - Used language
• Node.js - JavaScript runtime for building

Authors

• Matus Zamborsky - Initial work - Backslash47

License

This project is licensed under the ISC License - see the LICENSE.md file for details