EosJS 是访问 EOS 区块链的 JavaScript 开发包

Question

EosJS 是访问 EOS 区块链的 JavaScript 开发包，它通过 RPC API 访问 EOS 节点，同时包含了密钥签名、交易序列化等本地操作。

引入 EosJS 包

在 ES 模块中使用 import 引入 EosJS 包，例如：

import { Api, JsonRpc, RpcError } from 'eosjs';
import JsSignatureProvider from 'eosjs/dist/eosjs-jssig'; // development only

在 nodejs 的 commonjs 模块中，使用 require 引入 EosJS 包，例如：

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

签名提供器

EosJS 中的签名提供器负责对交易进行签名。例如：

const defaultPrivateKey = "5JtUScZK2XEp3g9gh7F8bwtPTRAkASmNrrftmx4AxDKD5K4zDnr"; // useraaaaaaaa
const signatureProvider = new JsSignatureProvider([defaultPrivateKey]);

目前 EosJS 中包含的 JsSignatureProvider 在内存中管理私钥，在浏览器里使用这个签名提供器是不安全的，仅限开发环境使用。

JSON-RPC 调用

JsonRpc 类封装了 EOS JSON-RPC 调用，在 Nodejs 中使用时，记得设置 fetch API：

const rpc = new JsonRpc('http://127.0.0.1:8888', { fetch });

API

在浏览器中使用 Api 类时，需要声明 textDecoder 和 textEncoder：

const api = new Api({ rpc, signatureProvider, textDecoder: new TextDecoder(), textEncoder: new TextEncoder() });

交易提交

使用 Api 实例的 transact() 方法提交一个交易到区块链上，例如：

(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);
})();

transact() 的第二个参数是一个选项对象，可以包含以下字段：

• broadcast：是否广播交易，默认值：true
• blocksBehind：TAPOS字段，节点用来判断交易是否超时
• expiresSeconds：TAPOS字段，节点用来判断交易是否超时

错误处理

使用 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));
}