English / 中文
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.
ontology-dapi can be used as CommonJS/ES6 module or directly referencing in web page html.
npm install @ont-dev/ontology-dapi
or
yarn add @ont-dev/ontology-dapi
var client = require('@ont-dev/ontology-dapi').client;
import { client } from '@ont-dev/ontology-dapi';
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;
dApp needs to register itself as a client with the ontology-dapi library to enable the communication.
import { client } from '@ont-dev/ontology-dapi';
client.registerClient({});
Examples of usage can be found in EXAMPLES.md or in a demo app
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.
- Node
- Yarn
Execute these commands in the project's root directory:
git clone 'https://github.com/ontio/ontology-dapi.git'
cd ontology-dapi
yarn
This will build the project with minimum polyfilling for better debug experience.
yarn build:dev
You will get the packaged code under '/lib'.
yarn build:prod
You will get the packaged code under '/lib'
- TypeScript - Used language
- Node.js - JavaScript runtime for building
- Matus Zamborsky - Initial work - Backslash47
This project is licensed under the ISC License - see the LICENSE.md file for details