README_cn.md

ontology dApi

English / 中文

ontology-dapi

DAPI是基于Ontology blockchain开发dApp的轻量级去中心化API。本工程是根据OEP-6实现了dAPI ，请参考OEP-6 协议。

使用前请先安装 dAPI provider . 比如 Cyano Wallet.

dAPI使用TypeScript实现, 同时也支持在JavaScript工程中使用.

如何使用

ontology-dapi 可以作为 CommonJS/ES6 模块或在网页中直接使用.

安装 CommonJS/ES 模块

npm install @ont-dev/ontology-dapi

或者

yarn add @ont-dev/ontology-dapi

导入 CommonJS

var client = require('@ont-dev/ontology-dapi').client;

导入 ES6 模块

import { client } from '@ont-dev/ontology-dapi';

Web require

导入 '/lib' 文件夹下的 browser.js 文件:

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

使用方法.

var client = dApi.client;

初始化

dApp 先注册 dAPI provider的客户端.

import { client } from '@ont-dev/ontology-dapi';

client.registerClient({});

使用例子

请参考例子， EXAMPLES.md 或 demo app

文档

所有dAPI方法分成这几个模块: asset, identity, message, network, provider, smartContract and utils. 方法定义请参考 OEP-6.

Build

安装工具与依赖

• Node
• Yarn

开发

执行如下命令:

下载

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

安装

yarn

开发Build

yarn build:dev

产品Build

yarn build:prod

创建工具

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

作者

• Matus Zamborsky - Initial work - Backslash47

License

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