General purpose library for the BON blockchain

肖之胤 ec8ccc3b93 update README 1 year ago
bin 07d9e7f4a8 first commit 1 year ago
dist 07d9e7f4a8 first commit 1 year ago
docker 07d9e7f4a8 first commit 1 year ago
docs 07d9e7f4a8 first commit 1 year ago
src 07d9e7f4a8 first commit 1 year ago
.gitignore 07d9e7f4a8 first commit 1 year ago
.travis.yml 07d9e7f4a8 first commit 1 year ago
README.md ec8ccc3b93 update README 1 year ago
package.json 07d9e7f4a8 first commit 1 year ago

README.md

Usage

  • Install with: npm install bonjs
Bon = require('bonjs')

// Private key or keys (array) provided statically or by way of a function.
// For multiple keys, the get_required_keys API is used (more on that below).
keyProvider: '5K4C3X6feSoZVnvLjtWiCp1afyCJpkTGse8YzEnY6cBmzpUaDFh'

// Localhost Testnet (run ./docker/up.sh)
bon = Bon({keyProvider})

// Connect to a testnet or mainnet
bon = Bon({httpEndpoint, chainId, keyProvider})

// Cold-storage
bon = Bon({httpEndpoint: null, chainId, keyProvider})

// Add support for non-BON public key prefixes, such as PUB, etc
bon = Bon({keyPrefix: 'PUB'})

// Read-only instance when 'bonjs' is already a dependency
bon = Bon.modules.api({/*config*/})

// Read-only instance when an application never needs to write (smaller library)
BonApi = require('bonjs-api')
bon = BonApi({/*config*/})

No-arguments prints usage.

bon.getBlock()
USAGE
getBlock - Fetch a block from the blockchain.

PARAMETERS
{
  "block_num_or_id": "string"
}

Start a nodbond process. The docker in this repository provides a setup that supports the examples in this README.

cd ./docker && ./up.sh

All blockchain functions (read and write) follow this pattern:

// If the last argument is a function it is treated as a callback
bon.getBlock(1, (error, result) => {})

// If a callback is not provided, a Promise is returned
bon.getBlock(1) // @returns {Promise}

// Parameters can be positional or an object
bon.getBlock({block_num_or_id: 1})

// An API with no parameters is invoked with an empty object or callback (avoids logging usage)
bon.getInfo({}) // @returns {Promise}
bon.getInfo((error, result) => { console.log(error, result) })

API Documentation

Chain and history API functions are available after creating the bon object.

Configuration

Bon = require('bonjs')

// Default configuration
config = {
  chainId: null, // 32 byte (64 char) hex string
  keyProvider: ['PrivateKeys...'], // WIF string or array of keys..
  httpEndpoint: 'http://127.0.0.1:8888',
  expireInSeconds: 60,
  broadcast: true,
  verbose: false, // API activity
  sign: true
}

bon = Bon(config)
  • chainId hex - Unique ID for the blockchain you're connecting to. This is required for valid transaction signing. The chainId is provided via the get_info API call.

Identifies a chain by its initial genesis block. All transactions signed will only be valid the blockchain with this chainId. Verify the chainId for security reasons.

  • keyProvider [array<string>|string|function] - Provides private keys used to sign transactions. If multiple private keys are found, the API get_required_keys is called to discover which signing keys to use. If a function is provided, this function is called for each transaction.

If a keyProvider is not provided here, one may be provided on a per-action or per-transaction basis in Options.

  • keyPrefix [string='BON'] - Change the public key prefix.

  • httpEndpoint string - http or https location of a nodbond server providing a chain API. When using bonjs from a browser remember to configure the same origin policy in nodbond or proxy server. For testing, nodbond configuration access-control-allow-origin = * could be used.

Set this value to null for a cold-storage (no network) configuration.

  • expireInSeconds number - number of seconds before the transaction will expire. The time is based on the nodbond's clock. An unexpired transaction that may have had an error is a liability until the expiration is reached, this time should be brief.

  • broadcast [boolean=true] - post the transaction to the blockchain. Use false to obtain a fully signed transaction.

  • verbose [boolean=false] - verbose logging such as API activity.

  • debug [boolean=false] - low level debug logging (serialization).

  • sign [boolean=true] - sign the transaction with a private key. Leaving a transaction unsigned avoids the need to provide a private key.

  • mockTransactions (advanced)

    • mockTransactions: () => null // 'pass', or 'fail'
    • pass - do not broadcast, always pretend that the transaction worked
    • fail - do not broadcast, pretend the transaction failed
    • null|undefined - broadcast as usual
  • transactionHeaders (advanced) - manually calculate transaction header. This may be provided so bonjs does not need to make header related API calls to nodbon. Used in environments like cold-storage. This callback is called for every transaction.

    • transactionHeaders: (expireInSeconds, callback) => {callback(null/*error*/, headers)}
  • logger - default logging configuration.

    logger: {
    log: config.verbose ? console.log : null,  // null to disable
    error: config.verbose ? console.error : null,
    }
    

For example, redirect error logs: config.logger = {error: (...args) => ..}

  • authorization - replace the default bonjs authorization on actions. An authorization provided here may still be over-written by specifying an authorization for each individual action.

For example, if most actions in an dapp are based on the posting key, this would replace the default active authorization with a posting authorization:

  {authorization: '@posting'}

Options

Options may be provided after parameters.

NOTE: authorization is for individual actions, it does not belong in Bon(config).

options = {
  authorization: 'alice@active',
  broadcast: true,
  sign: true
}
bon.transfer('alice', 'bob', '1.0000 BON', '', options)
  • authorization [array<auth>|auth] - identifies the signing account and permission typically in a multisig configuration. Authorization may be a string formatted as account@permission or an object<{actor: account, permission}>.
    • If missing default authorizations will be calculated.
    • If provided additional authorizations will not be added.
    • Performs deterministic sorting by account name

If a default authorization is calculated the action's 1st field must be an account_name. The account_name in the 1st field gets added as the active key authorization for the action.

  • broadcast [boolean=true] - post the transaction to the blockchain. Use false to obtain a fully signed transaction.

  • sign [boolean=true] - sign the transaction with a private key. Leaving a transaction unsigned avoids the need to provide a private key.

  • keyProvider [array<string>|string|function] - just like the global keyProvider except this provides a temporary key for a single action or transaction.

  await bon.anyAction('args', {keyProvider})
  await bon.transaction(tr => { tr.anyAction() }, {keyProvider})

Transaction

The transaction function accepts the standard blockchain transaction.

Required transaction header fields will be added unless you are signing without a network connection (httpEndpoint == null). In that case provide you own headers:

// only needed in cold-storage or for offline transactions
const headers = {
  expiration: '2018-06-14T18:16:10',
  ref_block_num: 1,
  ref_block_prefix: 452435776
}

Create and send (broadcast) a transaction:

/** @return {Promise} */
bon.transaction(
  {
    // ...headers,
    // context_free_actions: [],
    actions: [
      {
        account: 'bon.token',
        name: 'transfer',
        authorization: [{
          actor: 'inita',
          permission: 'active'
        }],
        data: {
          from: 'inita',
          to: 'initb',
          quantity: '7.0000 BON',
          memo: ''
        }
      }
    ]
  }
  // config -- example: {broadcast: false, sign: true}
)

Named action functions

More concise functions are provided for applications that may use actions more frequently. This avoids having lots of JSON in the code.

// Run with no arguments to print usage.
bon.transfer()

// Callback is last, when omitted a promise is returned
bon.transfer('inita', 'initb', '1.0000 BON', '', (error, result) => {})
bon.transfer('inita', 'initb', '1.1000 BON', '') // @returns {Promise}

// positional parameters
bon.transfer('inita', 'initb', '1.2000 BON', '')

// named parameters
bon.transfer({from: 'inita', to: 'initb', quantity: '1.3000 BON', memo: ''})

// options appear after parameters
options = {broadcast: true, sign: true}

// `false` is a shortcut for {broadcast: false}
bon.transfer('inita', 'initb', '1.4000 BON', '', false)

Assets amounts require zero padding. For a better user-experience, if you know the correct precision you may use DecimalPad to add the padding.

DecimalPad = Bon.modules.format.DecimalPad
userInput = '10.2'
precision = 4
assert.equal('10.2000', DecimalPad(userInput, precision))

Shorthand

Shorthand is available for some types such as Asset and Authority. This syntax is only for concise functions and does not work when providing entire transaction objects to bon.transaction..

For example:

  • permission inita defaults inita@active
  • authority 'BON6MRy..' expands {threshold: 1, keys: [{key: 'BON6MRy..', weight: 1}]}
  • authority inita expands {threshold: 1, accounts: [{permission: {actor: 'inita', permission: 'active'}, weight: 1}]}

New Account

New accounts will likely require some staked tokens for RAM and bandwidth.

wif = '5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3'
pubkey = 'BON6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV'

bon.transaction(tr => {
  tr.newaccount({
    creator: 'bon',
    name: 'myaccount',
    owner: pubkey,
    active: pubkey
  })

  tr.buyrambytes({
    payer: 'bon',
    receiver: 'myaccount',
    bytes: 8192
  })

  tr.delegatebw({
    from: 'bon',
    receiver: 'myaccount',
    stake_net_quantity: '10.0000 BON',
    stake_cpu_quantity: '10.0000 BON',
    transfer: 0
  })
})

Contract

Deploy and call smart contracts.

Compile

If you're loading a wasm file, you do not need binaryen. If you're loading a wast file you can include and configure the binaryen compiler, this is used to compile to wasm automatically when calling setcode.

$ npm install binaryen@37.0.0
binaryen = require('binaryen')
bon = Bon({keyProvider, binaryen})

Deploy

wasm = fs.readFileSync(`docker/contracts/bon.token/bon.token.wasm`)
abi = fs.readFileSync(`docker/contracts/bon.token/bon.token.abi`)

// Publish contract to the blockchain
bon.setcode('myaccount', 0, 0, wasm) // @returns {Promise}
bon.setabi('myaccount', JSON.parse(abi)) // @returns {Promise}

Fetch a smart contract

// @returns {Promise}
bon.contract('myaccount', [options], [callback])

// Run immediately, `myaction` returns a Promise
bon.contract('myaccount').then(myaccount => myaccount.myaction(..))

// Group actions. `transaction` returns a Promise but `myaction` does not
bon.transaction('myaccount', myaccount => { myaccount.myaction(..) })

// Transaction with multiple contracts
bon.transaction(['myaccount', 'myaccount2'], ({myaccount, myaccount2}) => {
   myaccount.myaction(..)
   myaccount2.myaction(..)
})

Offline or cold-storage contract

bon = Bon({httpEndpoint: null})

abi = fs.readFileSync(`docker/contracts/bon.token/bon.token.abi`)
bon.fc.abiCache.abi('myaccount', JSON.parse(abi))

// Check that the ABI is available (print usage)
bon.contract('myaccount').then(myaccount => myaccount.create())

Offline or cold-storage transaction

// ONLINE

// Prepare headers
expireInSeconds = 60 * 60 // 1 hour

bon = Bon(/* {httpEndpoint: 'https://..'} */)

info = await bon.getInfo({})
chainDate = new Date(info.head_block_time + 'Z')
expiration = new Date(chainDate.getTime() + expireInSeconds * 1000)
expiration = expiration.toISOString().split('.')[0]

block = await bon.getBlock(info.last_irreversible_block_num)

transactionHeaders = {
  expiration,
  ref_block_num: info.last_irreversible_block_num & 0xFFFF,
  ref_block_prefix: block.ref_block_prefix
}

// OFFLINE (bring `transactionHeaders`)

// All keys in keyProvider will sign.
bon = Bon({httpEndpoint: null, chainId, keyProvider, transactionHeaders})

transfer = await bon.transfer('inita', 'initb', '1.0000 BON', '')
transferTransaction = transfer.transaction

// ONLINE (bring `transferTransaction`)

bon = Bon(/* {httpEndpoint: 'https://..'} */)

processedTransaction = await bon.pushTransaction(transferTransaction)

// clbon version:
const clbonTransaction = transferTransaction.transaction
clbonTransaction.signatures = transferTransaction.signatures
// `cloes push transaction ${JSON.stringify(clbonTransaction)}`

Custom Token

// more on the contract / transaction syntax

await bon.transaction('myaccount', myaccount => {

  // Create the initial token with its max supply
  // const options = {authorization: 'myaccount'} // default
  myaccount.create('myaccount', '10000000.000 TON')//, options)

  // Issue some of the max supply for circulation into an arbitrary account
  myaccount.issue('myaccount', '10000.000 TON', 'issue')
})

const balance = await bon.getCurrencyBalance('myaccount', 'myaccount', 'TON')
console.log('Currency Balance', balance)

Calling Actions

Other ways to use contracts and transactions.

// if either transfer fails, both will fail (1 transaction, 2 messages)
await bon.transaction(bon =>
  {
    bon.transfer('inita', 'initb', '1.0000 BON', ''/*memo*/)
    bon.transfer('inita', 'initc', '1.0000 BON', ''/*memo*/)
    // Returning a promise is optional (but handled as expected)
  }
  // [options],
  // [callback]
)

// transaction on a single contract
await bon.transaction('myaccount', myaccount => {
  myaccount.transfer('myaccount', 'inita', '10.000 TON', '')
})

// mix contracts in the same transaction
await bon.transaction(['myaccount', 'bon.token'], ({myaccount, bon_token}) => {
  myaccount.transfer('inita', 'initb', '1.000 TON', '')
  bon_token.transfer('inita', 'initb', '1.0000 BON', '')
})

// The contract method does not take an array so must be called once for
// each contract that is needed.
const myaccount = await bon.contract('myaccount')
await myaccount.transfer('myaccount', 'inita', '1.000 TON', '')

// a transaction to a contract instance can specify multiple actions
await myaccount.transaction(myaccountTr => {
  myaccountTr.transfer('inita', 'initb', '1.000 TON', '')
  myaccountTr.transfer('initb', 'inita', '1.000 TON', '')
})

Development

From time-to-time the bonjs and nodbon binary format will change between releases so you may need to start nodbon with the --skip-transaction-signatures parameter to get your transactions to pass.

Note, package.json has a "main" pointing to ./lib. The ./lib folder is for es2015 code built in a separate step. If you're changing and testing code, import from ./src instead.

Bon = require('./src')

// forceActionDataHex = false helps transaction readability but may trigger back-end bugs
config = {verbose: true, debug: false, broadcast: true, forceActionDataHex: true, keyProvider}

bon = Bon(config)

Fcbuffer

The bon instance can provide serialization:

// 'asset' is a type but could be any struct or type like: transaction or uint8
type = {type: 1, data: '00ff'}
buffer = bon.fc.toBuffer('extensions_type', type)
assert.deepEqual(type, bon.fc.fromBuffer('extensions_type', buffer))

// ABI Serialization
bon.contract('bon.token', (error, bon_token) => {
  create = {issuer: 'inita', maximum_supply: '1.0000 BON'}
  buffer = bon_token.fc.toBuffer('create', create)
  assert.deepEqual(create, bon_token.fc.fromBuffer('create', buffer))
})

Use Node v10+ for package-lock.json.

Related Libraries

These libraries are integrated into bonjs seamlessly so you probably do not need to use them directly. They are exported here giving more API access or in some cases may be used standalone.

var {format, api, ecc, json, Fcbuffer} = Bon.modules
  • bonjs-ecc [Github, NPM]
    • Private Key, Public Key, Signature, AES, Encryption / Decryption
    • Validate public or private keys
    • Encrypt or decrypt with BON compatible checksums
    • Calculate a shared secret

Environment

Node and browser (es2015)