介绍
用于使用 EOSIO RPC API 与基于 EOSIO 的区块链集成的 Javascript API。
安装
NodeJS 依赖
npm install eosjs@beta or yarn add eosjs@beta
浏览器发行包
在本地克隆此存储库然后运行 npm run build-web 或 yarn build-web，浏览器发行包将位于 dist-web 中，可以直接复制到项目存储库中。dist-web 文件夹包含准备生产的缩小捆绑包以及用于调试的库的源映射版本，有关完整的浏览器用法示例，请参阅文档。
导入
ES 模块
如果你有一个转换器，则支持在浏览器中使用 ES6 模块语法导入，就像 Babel：
import {Api, JsonRpc, RpcError} from ‘eosjs’;
import JsSignatureProvider from ‘eosjs/dist/eosjs-jssig’; // development only
CommonJS
NodeJS 支持使用 commonJS 语法导入。
const {Api, JsonRpc, RpcError} = require(‘eosjs’);
const JsSignatureProvider = require(‘eosjs/dist/eosjs-jssig’); // development only
const fetch = require(‘node-fetch’); // node only; not needed in browsers
const {TextEncoder, TextDecoder} = require(‘util’); // node only; native TextEncoder/Decoder
const {TextEncoder, TextDecoder} = require(‘text-encoding’); // React Native, IE11, and Edge Browsers only
基础用法
签名提供者
签名提供者持有私钥并负责签名交易。
在浏览器中使用 JsSignatureProvider 并不安全，只能用于开发目的，在网页上下文之外使用安全保管库，以确保在生产中签名交易时的安全性。
const defaultPrivateKey = “5JtUScZK2XEp3g9gh7F8bwtPTRAkASmNrrftmx4AxDKD5K4zDnr”; // useraaaaaaaa
const signatureProvider = new JsSignatureProvider([defaultPrivateKey]);
JSON-RPC
打开与 JSON-RPC 的连接，包括在 NodeJS 上的 fetch。
const rpc = new JsonRpc(‘http://127.0.0.1:8888’, { fetch});
API
在浏览器中使用时包含 textDecoder 和 textEncoder。
const api = new Api({rpc, signatureProvider, textDecoder: new TextDecoder(), textEncoder: new TextEncoder()});
发送交易
transact() 用于使用可选的配置对象参数将交易签名并推送到区块链，此参数可以重写 broadcast: true 的默认值，并可用于填充给定 blocksBehind 和 expireSeconds 的 TAPOS 字段。如果没有配置选项，则预计将使用 TAPOS 字段（expiration、ref_block_num、ref_block_prefix）解压缩交易，并自动将其广播到链上。
(async () => {
const result = await api.transact({
actions: [{
account: ‘eosio.token’,
name: ‘transfer’,
authorization: [{
actor: ‘useraaaaaaaa’,
permission: ‘active’,
}],
data: {
from: ‘useraaaaaaaa’,
to: ‘useraaaaaaab’,
quantity: ‘0.0001 SYS’,
memo: ”,
},
}]
}, {
blocksBehind: 3,
expireSeconds: 30,
});
console.dir(result);
})();
错误处理
使用 RpcError 处理 RPC 错误。
…
try {
const result = await api.transact({
…
} catch (e) {
console.log(‘\nCaught exception: ‘ + e);
if (e instanceof RpcError)
console.log(JSON.stringify(e.json, null, 2));
}
…
运行测试
自动单元测试套件
npm run test or yarn test
Web 集成测试套件
运行 npm run build-web 构建浏览器发行包，然后在你选择的浏览器中打开 src/tests/web.html，该文件应该运行 6 次测试，在每次测试后将结果传递到网页上，延迟时间为 2 秒，最后两个测试应该为无效的交易和无效的 rpc 调用将异常传递到网页上。
上一篇：eosjs 文档（目录）
下一篇：浏览器