⚠️ Important! We recently released a major breaking rewrite for @snaxfoundation/snaxjs. Be sure to lock your dependencies. ⚠️

If you are looking for the the previous version of snaxjs you can find it here.

Installation

NodeJS

npm install @snaxfoundation/snaxjs

Basic Usage

Browser

Importing using ES6 module syntax in the browser is supported if you have a transpiler, such as Babel.

import {
  Api,
  JsonRpc,
  RpcError,
  JsSignatureProvider
} from "@snaxfoundation/snaxjs";

NodeJS

Importing using commonJS syntax is supported by node out of the box.

const {
  Api,
  JsonRpc,
  RpcError,
  JsSignatureProvider
} = require("@snaxfoundation/snaxjs");
const fetch = require("node-fetch"); // node only; not needed in browsers
const { TextDecoder, TextEncoder } = require("text-encoding"); // node, IE11 and IE Edge Browsers

SignatureProvider

SignatureProvider holds private keys and is responsible for signing transactions.

Using the default JsSignatureProvider in the browser is not secure and should only be used for development purposes. Use a secure vault outside of the context of the webpage to ensure security when signing transactions in production

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

JSON-RPC

Open a connection to JSON-RPC, include fetch when on NodeJS.

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

API Constructor

Include textDecoder and textEncoder when using in browser.

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

Sending a transaction

(async () => {
  const result = await api.transact(
    {
      actions: [
        {
          account: "snax.token",
          name: "transfer",
          authorization: [
            {
              actor: "useraaaaaaaa",
              permission: "active"
            }
          ],
          data: {
            from: "useraaaaaaaa",
            to: "useraaaaaaab",
            quantity: "0.0001 SNAX",
            memo: ""
          }
        }
      ]
    },
    {
      blocksBehind: 3,
      expireSeconds: 30
    }
  );
  console.dir(result);
})();

Error handling

use RpcError for handling RPC Errors

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

Browsers

After running npm run build-web or yarn build-web, the browser distribution will be located in dist. For full browser usage examples, see the documentation.

How it works

transact() is used to sign and push transactions onto the blockchain with an optional configuration object parameter. This parameter can override the default value of broadcast: true, and can be used to fill TAPOS fields given blocksBehind and expireSeconds. Given no configuration options, transactions are expected to be unpacked with TAPOS fields (expiration, ref_block_num, ref_block_prefix) and will automatically be broadcast onto the chain.

Running Tests

Automated Test Suite

npm run test or yarn test