eosjs 文檔（介紹）

時間 2019-11-09

標籤 eosjs 文檔介紹简体版

原文原文鏈接

介紹

用於使用EOSIO RPC API與基於EOSIO的區塊鏈集成的Javascript API。html

安裝

NodeJS依賴

npm install eosjs@beta or yarn add eosjs@beta

瀏覽器發行包

在本地克隆此存儲庫而後運行npm run build-web或yarn build-web，瀏覽器發行包將位於dist-web中，能夠直接複製到項目存儲庫中。dist-web文件夾包含準備生產的縮小捆綁包以及用於調試的庫的源映射版本，有關完整的瀏覽器用法示例，請參閱文檔。node

導入

ES模塊

若是你有一個轉換器，則支持在瀏覽器中使用ES6模塊語法導入，就像Babel：web

import { Api, JsonRpc, RpcError } from 'eosjs';

import JsSignatureProvider from 'eosjs/dist/eosjs-jssig'; // development only

CommonJS

NodeJS支持使用commonJS語法導入。npm

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

基礎用法

簽名提供程序

簽名提供程序持有私鑰並負責簽名交易。json

在瀏覽器中使用JsSignatureProvider並不安全，只能用於開發目的，在網頁上下文以外使用安全保管庫，以確保在生產中籤名交易時的安全性。segmentfault

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

JSON-RPC

打開與JSON-RPC的鏈接，包括在NodeJS上的fetch。api

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錯誤。async

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