client

crypto

amino-decode

amino-encode

ledger

utils

Transaction

Creates a new transaction object.

• client
  • static
    • .BncClient
      • new exports.BncClient(server, useAsyncBroadcast)
      • .initChain() ⇒ Promise
      • .chooseNetwork(network)
      • .setPrivateKey() ⇒ Promise
      • .useAsyncBroadcast(useAsyncBroadcast) ⇒ BncClient
      • .setSigningDelegate(delegate) ⇒ BncClient
      • .setBroadcastDelegate(delegate) ⇒ BncClient
      • .useDefaultSigningDelegate() ⇒ BncClient
      • .useDefaultBroadcastDelegate() ⇒ BncClient
      • .useLedgerSigningDelegate(ledgerApp, preSignCb, postSignCb, errCb) ⇒ BncClient
      • .transfer(fromAddress, toAddress, amount, asset, memo, sequence) ⇒ Promise
      • .multiSend(fromAddress, outputs, memo, sequence) ⇒ Promise
      • .cancelOrder(fromAddress, symbol, refid, sequence) ⇒ Promise
      • .placeOrder(address, symbol, side, price, quantity, sequence, timeinforce) ⇒ Promise
      • ._prepareTransaction(msg, stdSignMsg, address, sequence, memo) ⇒ Transaction
      • .sendTransaction(tx, sync) ⇒ Promise
      • .sendRawTransaction(signedBz, sync) ⇒ Promise
      • ._sendTransaction(msg, stdSignMsg, address, sequence, memo, sync) ⇒ Promise
      • .getAccount(address) ⇒ Promise
      • .getBalance(address) ⇒ Promise
      • .getMarkets(offset, limit,) ⇒ Promise
      • .createAccount() ⇒ object
      • .createAccountWithKeystore(password)
      • .createAccountWithMneomnic() ⇒ object
      • .recoverAccountFromKeystore(keystore, keystore)
      • .recoverAccountFromMnemonic(mneomnic)
      • .recoverAccountFromPrivateKey(privateKey)
      • .checkAddress(address) ⇒ Boolean
      • .getClientKeyAddress() ⇒ String
    • .DefaultSigningDelegate ⇒ Transaction
    • .DefaultBroadcastDelegate
    • .LedgerSigningDelegate ⇒ function
    • .checkNumber
  • inner
    • ~checkOutputs(outputs)
    • ~calInputCoins(inputs, coins)

The Binance Chain client.

Kind: static class of client

• .BncClient
  • new exports.BncClient(server, useAsyncBroadcast)
  • .initChain() ⇒ Promise
  • .chooseNetwork(network)
  • .setPrivateKey() ⇒ Promise
  • .useAsyncBroadcast(useAsyncBroadcast) ⇒ BncClient
  • .setSigningDelegate(delegate) ⇒ BncClient
  • .setBroadcastDelegate(delegate) ⇒ BncClient
  • .useDefaultSigningDelegate() ⇒ BncClient
  • .useDefaultBroadcastDelegate() ⇒ BncClient
  • .useLedgerSigningDelegate(ledgerApp, preSignCb, postSignCb, errCb) ⇒ BncClient
  • .transfer(fromAddress, toAddress, amount, asset, memo, sequence) ⇒ Promise
  • .multiSend(fromAddress, outputs, memo, sequence) ⇒ Promise
  • .cancelOrder(fromAddress, symbol, refid, sequence) ⇒ Promise
  • .placeOrder(address, symbol, side, price, quantity, sequence, timeinforce) ⇒ Promise
  • ._prepareTransaction(msg, stdSignMsg, address, sequence, memo) ⇒ Transaction
  • .sendTransaction(tx, sync) ⇒ Promise
  • .sendRawTransaction(signedBz, sync) ⇒ Promise
  • ._sendTransaction(msg, stdSignMsg, address, sequence, memo, sync) ⇒ Promise
  • .getAccount(address) ⇒ Promise
  • .getBalance(address) ⇒ Promise
  • .getMarkets(offset, limit,) ⇒ Promise
  • .createAccount() ⇒ object
  • .createAccountWithKeystore(password)
  • .createAccountWithMneomnic() ⇒ object
  • .recoverAccountFromKeystore(keystore, keystore)
  • .recoverAccountFromMnemonic(mneomnic)
  • .recoverAccountFromPrivateKey(privateKey)
  • .checkAddress(address) ⇒ Boolean
  • .getClientKeyAddress() ⇒ String

Initialize the client with the chain's ID. Asynchronous.

Kind: instance method of BncClient

Sets the client network (testnet or mainnet).

Kind: instance method of BncClient

Sets the client's private key for calls made by this client. Asynchronous.

Kind: instance method of BncClient

Use async broadcast mode. Broadcasts faster with less guarantees (default off)

Kind: instance method of BncClient
Returns: BncClient - this instance (for chaining)

Sets the signing delegate (for wallet integrations).

Kind: instance method of BncClient
Returns: BncClient - this instance (for chaining)

Sets the broadcast delegate (for wallet integrations).

Kind: instance method of BncClient
Returns: BncClient - this instance (for chaining)

Applies the default signing delegate.

Kind: instance method of BncClient
Returns: BncClient - this instance (for chaining)

Applies the default broadcast delegate.

Kind: instance method of BncClient
Returns: BncClient - this instance (for chaining)

Applies the Ledger signing delegate.

Kind: instance method of BncClient
Returns: BncClient - this instance (for chaining)

Transfer tokens from one address to another.

Kind: instance method of BncClient
Returns: Promise - resolves with response (success or fail)

Create and sign a multi send tx

Kind: instance method of BncClient
Returns: Promise - resolves with response (success or fail)

Example

const outputs = [
{
  "to": "tbnb1p4kpnj5qz5spsaf0d2555h6ctngse0me5q57qe",
  "coins": [{
    "denom": "BNB",
    "amount": 10
  },{
    "denom": "BTC",
    "amount": 10
  }]
},
{
  "to": "tbnb1scjj8chhhp7lngdeflltzex22yaf9ep59ls4gk",
  "coins": [{
    "denom": "BTC",
    "amount": 10
  },{
    "denom": "BNB",
    "amount": 10
  }]
}]

Cancel an order.

Kind: instance method of BncClient
Returns: Promise - resolves with response (success or fail)

Place an order.

Kind: instance method of BncClient
Returns: Promise - resolves with response (success or fail)

Prepare a serialized raw transaction for sending to the blockchain.

Kind: instance method of BncClient
Returns: Transaction - signed transaction

Broadcast a transaction to the blockchain.

Kind: instance method of BncClient
Returns: Promise - resolves with response (success or fail)

Broadcast a raw transaction to the blockchain.

Kind: instance method of BncClient
Returns: Promise - resolves with response (success or fail)

Broadcast a raw transaction to the blockchain.

Kind: instance method of BncClient
Returns: Promise - resolves with response (success or fail)

get account

Kind: instance method of BncClient
Returns: Promise - resolves with http response

get balances

Kind: instance method of BncClient
Returns: Promise - resolves with http response

get markets

Kind: instance method of BncClient
Returns: Promise - resolves with http response

Creates a private key and returns it and its address.

Kind: instance method of BncClient
Returns: object - the private key and address in an object. { address, privateKey }

Creates an account keystore object, and returns the private key and address.

Kind: instance method of BncClient

Creates an account from mnemonic seed phrase.

Kind: instance method of BncClient
Returns: object - { privateKey, address, mnemonic }

Recovers an account from a keystore object.

Kind: instance method of BncClient

Recovers an account from a mnemonic seed phrase.

Kind: instance method of BncClient

Recovers an account using private key.

Kind: instance method of BncClient

Validates an address.

Kind: instance method of BncClient

Returns the address for the current account if setPrivateKey has been called on this client.

Kind: instance method of BncClient

The default signing delegate which uses the local private key.

Kind: static constant of client

The default broadcast delegate which immediately broadcasts a transaction.

Kind: static constant of client

The Ledger signing delegate.

Kind: static constant of client

validate the input number.

Kind: static constant of client

validate the input number.

Kind: inner method of client

sum corresponding input coin

Kind: inner method of client

• crypto
  • .decodeAddress
  • .checkAddress ⇒ boolean
  • .encodeAddress
  • .generatePrivateKey ⇒ string
  • .generateRandomArray ⇒ ArrayBuffer
  • .getPublicKey ⇒ Elliptic.PublicKey
  • .getPublicKeyFromPrivateKey ⇒ string
  • .generatePubKey ⇒ Elliptic.PublicKey
  • .getAddressFromPublicKey
  • .getAddressFromPrivateKey
  • .generateSignature ⇒ Buffer
  • .verifySignature ⇒ Buffer
  • .generateKeyStore ⇒ object
  • .getPrivateKeyFromKeyStore
  • .generateMnemonic
  • .validateMnemonic ⇒ bool
  • .getPrivateKeyFromMnemonic ⇒ string

Decodes an address in bech32 format.

Kind: static constant of crypto

Checks whether an address is valid.

Kind: static constant of crypto

Encodes an address from input data bytes.

Kind: static constant of crypto

Generates 32 bytes of random entropy

Kind: static constant of crypto
Returns: string - entropy bytes hexstring

Generates an arrayBuffer filled with random bits.

Kind: static constant of crypto

Kind: static constant of crypto
Returns: Elliptic.PublicKey - public key hexstring

Calculates the public key from a given private key.

Kind: static constant of crypto
Returns: string - public key hexstring

PubKey performs the point-scalar multiplication from the privKey on the generator point to get the pubkey.

Kind: static constant of crypto
Returns: Elliptic.PublicKey - PubKey

Gets an address from a public key hex.

Kind: static constant of crypto

Gets an address from a private key.

Kind: static constant of crypto

Generates a signature (64 byte <r,s>) for a transaction based on given private key.

Kind: static constant of crypto
Returns: Buffer - Signature. Does not include tx.

Verifies a signature (64 byte <r,s>) given the sign bytes and public key.

Kind: static constant of crypto
Returns: Buffer - Signature. Does not include tx.

Generates a keystore object (web3 secret storage format) given a private key to store and a password.

Kind: static constant of crypto
Returns: object - the keystore object.

Gets a private key from a keystore given its password.

Kind: static constant of crypto

Generates mnemonic phrase words using random entropy.

Kind: static constant of crypto

Validates mnemonic phrase words.

Kind: static constant of crypto
Returns: bool - validation result

Get a private key from mnemonic words.

Kind: static constant of crypto
Returns: string - hexstring

• amino-decode
  • .unMarshalBinaryLengthPrefixed
  • .unMarshalBinaryBare

js amino UnmarshalBinaryLengthPrefixed

Kind: static constant of amino-decode

js amino UnmarshalBinaryBare

Kind: static constant of amino-decode

• amino-encode
  • .encodeNumber
  • .encodeBool
  • .encodeString
  • .encodeTime
  • .convertObjectToSignBytes ⇒ Buffer
  • .marshalBinary
  • .marshalBinaryBare
  • .encodeBinary ⇒ Buffer
  • .encodeBinaryByteArray ⇒ Buffer
  • .encodeObjectBinary ⇒ Buffer
  • .encodeArrayBinary ⇒ Buffer

encode number

Kind: static constant of amino-encode

encode bool

Kind: static constant of amino-encode

encode string

Kind: static constant of amino-encode

encode time

Kind: static constant of amino-encode

Kind: static constant of amino-encode
Returns: Buffer - bytes

js amino MarshalBinary

Kind: static constant of amino-encode

js amino MarshalBinaryBare

Kind: static constant of amino-encode

This is the main entrypoint for encoding all types in binary form.

Kind: static constant of amino-encode
Returns: Buffer - binary of object.

prefixed with bytes length

Kind: static constant of amino-encode
Returns: Buffer - with bytes length prefixed

Kind: static constant of amino-encode
Returns: Buffer - with bytes length prefixed

Kind: static constant of amino-encode
Returns: Buffer - bytes of array

• ledger
  • ~LedgerApp
    • new LedgerApp(transport, interactiveTimeout, nonInteractiveTimeout)
    • .getVersion()
    • .publicKeySecp256k1(hdPath)
    • .signSecp256k1(signBytes, hdPath)
    • .showAddress(hrp, hdPath)
    • .getPublicKey(hdPath)
    • .sign(signBytes, hdPath)

Ledger app interface.

Kind: inner class of ledger

• ~LedgerApp
  • new LedgerApp(transport, interactiveTimeout, nonInteractiveTimeout)
  • .getVersion()
  • .publicKeySecp256k1(hdPath)
  • .signSecp256k1(signBytes, hdPath)
  • .showAddress(hrp, hdPath)
  • .getPublicKey(hdPath)
  • .sign(signBytes, hdPath)

Constructs a new LedgerApp.

Gets the version of the Ledger app that is currently open on the device.

Kind: instance method of LedgerApp
Throws:

• Will throw Error if a transport error occurs, or if the firmware app is not open.

Gets the public key from the Ledger app that is currently open on the device.

Kind: instance method of LedgerApp
Throws:

• Will throw Error if a transport error occurs, or if the firmware app is not open.

Sends a transaction sign doc to the Ledger app to be signed.

Kind: instance method of LedgerApp
Throws:

• Will throw Error if a transport error occurs, or if the firmware app is not open.

Shows the user's address for the given HD path on the device display.

Kind: instance method of LedgerApp
Throws:

• Will throw Error if a transport error occurs, or if the firmware app is not open.

Gets the public key from the Ledger app that is currently open on the device.

Kind: instance method of LedgerApp
Throws:

• Will throw Error if a transport error occurs, or if the firmware app is not open.

Sends a transaction sign doc to the Ledger app to be signed.

Kind: instance method of LedgerApp
Throws:

• Will throw Error if a transport error occurs, or if the firmware app is not open.

• utils
  • .ab2str ⇒ string
  • .str2ab ⇒ arrayBuffer
  • .hexstring2ab ⇒ Array.<number>
  • .ab2hexstring ⇒ string
  • .str2hexstring ⇒ string
  • .hexstring2str ⇒ string
  • .int2hex ⇒ string
  • .num2hexstring ⇒ string
  • .num2VarInt ⇒ string
  • .hexXor ⇒ string
  • .reverseArray ⇒ Uint8Array
  • .reverseHex ⇒ string
  • .isHex ⇒ boolean
  • .ensureHex
  • .sha256ripemd160 ⇒ string
  • .sha256 ⇒ string
  • .sha3 ⇒ string

Kind: static constant of utils
Returns: string - ASCII string

Kind: static constant of utils

Kind: static constant of utils

Kind: static constant of utils
Returns: string - HEX string

Kind: static constant of utils
Returns: string - HEX string

Kind: static constant of utils
Returns: string - ASCII string

convert an integer to big endian hex and add leading zeros

Kind: static constant of utils

Converts a number to a big endian hexstring of a suitable size, optionally little endian

Kind: static constant of utils

Converts a number to a variable length Int. Used for array length header

Kind: static constant of utils
Returns: string - hexstring of the variable Int.

XORs two hexstrings

Kind: static constant of utils
Returns: string - XOR output as a HEX string

Reverses an array. Accepts arrayBuffer.

Kind: static constant of utils

Reverses a HEX string, treating 2 chars as a byte.

Kind: static constant of utils
Returns: string - HEX string reversed in 2s.

Example

reverseHex('abcdef') = 'efcdab'

Checks if input is a hexstring. Empty string is considered a hexstring.

Kind: static constant of utils

Example

isHex('0101') = true
isHex('') = true
isHex('0x01') = false

Throws an error if input is not hexstring.

Kind: static constant of utils

Computes a SHA256 followed by a RIPEMD160.

Kind: static constant of utils
Returns: string - hash output

Computes a single SHA256 digest.

Kind: static constant of utils
Returns: string - hash output

Computes a single SHA3 (Keccak) digest.

Kind: static constant of utils
Returns: string - hash output

Creates a new transaction object.

Kind: global class
Properties

• Transaction
  • new Transaction(type)
  • .getSignBytes(concrete) ⇒ Buffer
  • .addSignature(pubKey, signature) ⇒ Transaction
  • .sign(privateKey, concrete) ⇒ Transaction
  • .serialize(opts)
  • ._serializePubKey(unencodedPubKey) ⇒ Buffer

Example

var rawTx = {
  account_number: 1,
  chain_id: 'bnbchain-1000',
  memo: '',
  msg: {},
  type: 'NewOrderMsg',
  sequence: 29,
};
var tx = new Transaction(rawTx);

generate the sign bytes for a transaction, given a msg

Kind: instance method of Transaction

attaches a signature to the transaction

Kind: instance method of Transaction

sign transaction with a given private key and msg

Kind: instance method of Transaction

encode signed transaction to hex which is compatible with amino

Kind: instance method of Transaction

serializes a public key in a 33-byte compressed format.

Kind: instance method of Transaction