CoolWallet Binance Coin (BNB) SDK

Typescript library with support for the integration of BNB for third party application, include the functionalities of generation of addresses and signed transactions.

Install

npm install @coolwallet/bnb

Usage

import BNB from '@coolwallet/bnb';
import { crypto } from '@coolwallet/core';
import { createTransport } from '@coolwallet/transport-web-ble';

const bnb = new BNB();

const transport = await createTransport();

const { privateKey: appPrivateKey } = crypto.key.generateKeyPair();

const appId = 'appId that had been registered by wallet';

const addressIndex = 0;

const address = await bnb.getAddress(transport, appPrivateKey, appId, addressIndex);

const chainId = 'Binance-Chain-Tigris';

// Use your way to get account data in this format.
const accountData = {
  account_number: '39',
  public_key: 'account_public_key',
  sequence: '',
}

const transaction = {
  account_number: accountData.account_number,
  chain_id: chainId,
  data: null,
  memo: '',
  msgs: [
    {
      inputs: [
        {
          address: 'bnb16xjz4q2lc63nnmxchlxsj0w34q6lgrsnhff60l',
          coins: [{ amount: 1000, denom: 'BNB' }],
        },
      ],
      outputs: [
        {
          address: 'bnb1uzsh50kfmh73m8ytfcta7p3zceull2ycnttw5s',
          coins: [{ amount: 1000, denom: 'BNB' }],
        },
      ],
    },
  ],
  sequence: '503',
  source: '711',
}

const signObj = {
    account_number: accountData.account_number,
    chain_id: chainId,
    data: null,
    memo: "",
    msgs: ['some messages'],
    sequence: accountData.sequence,
    source: "711"
};

const signTxData = {
    transport,
    appPrivateKey,
    appId,
    transaction,
    addressIndex,
    signObj,
    signPublicKey: Buffer.from(accountData.public_key),
    addressIndex,
}

const normalTx = await bnb.signTransaction(signTxData);

Methods

getAddress

Description

The address generated is compatible to BIP44 with account and change set to 0, which means calling getAddress with addressIndex = i will get the address of folllowing BIP44 path:

m/44'/714'/0'/0/{i}

In the design of current hardware, we only support path m/44'/714'/0'/0/{i} for speed optimization. This might change in the future and we will then open a more general interface to deal with custom path.

async getAddress(
    transport: Types.Transport, 
    appPrivateKey: string, 
    appId: string, 
    addressIndex: number
): Promise<string> 

Arguments

| Arg | Description | Type | Required | |:-------------:|:--------------------------------------------:|:---------:|:---------:| | transport | Object to communicate with CoolWallet device | Transport | True | | appPrivateKey | Private key for the connected application | string | True | | appId | ID for the connected application | string | True | | addressIndex | The from address index in BIP44 derivation | number | True |

Sign Transactions

CoolWallet currently support 3 types of Binance DEX transaction: Transfer, PlaceOrder and CancelOrder.

signTransfer

Description

Sign BNB Transaction

async signTransaction(signData: signType): Promise<string>

signType Arguments

| Arg | Description | Type | Required | |:-------------:|:--------------------------------------------------------------------:|:---------:|:---------:| | transport | Object to communicate with CoolWallet device | Transport | True | | appPrivateKey | Private key for the connected application | string | True | | appId | ID for the connected application | string | True | | signObj | Signing object for BNB Transfer transaction | Transfer | True | | signPublicKey | Public key for signing transaction | Buffer | True | | addressIndex | The from address index in BIP44 derivation | number | True | | confirmCB | Callback of confirmation data to the connected application | Function | False | | authorizedCB | Callback of authorized transaction data to the connected application | Function | False |

placeOrder

Description

Sign BNB Place Order Transaction

async signPlaceOrder(signData: signPlaceOrderType): Promise<string>

signPlaceOrderType Arguments

| Arg | Description | Type | Required | |:-------------:|:--------------------------------------------------------------------:|:----------:|:---------:| | transport | Object to communicate with CoolWallet device | Transport | True | | appPrivateKey | Private key for the connected application | string | True | | appId | ID for the connected application | string | True | | signObj | Signing object for BNB PlaceOrder transaction | PlaceOrder | True | | signPublicKey | Public key for signing transaction | Buffer | True | | addressIndex | The from address index in BIP44 derivation | number | True | | confirmCB | Callback of confirmation data to the connected application | Function | False | | authorizedCB | Callback of authorized transaction data to the connected application | Function | False |

cancelOrder

Description

Sign BNB Cancel Order Transaction

async signCancelOrder(signData: signCancelOrderType): Promise<string> 

signCancelOrderType Arguments

| Arg | Description | Type | Required | |:-------------:|:--------------------------------------------------------------------:|:-----------:|:---------:| | transport | Object to communicate with CoolWallet device | Transport | True | | appPrivateKey | Private key for the connected application | string | True | | appId | ID for the connected application | string | True | | signObj | Signing object for BNB CancelOrder transaction | CancelOrder | True | | signPublicKey | Public key for signing transaction | Buffer | True | | addressIndex | The from address index in BIP44 derivation | number | True | | confirmCB | Callback of confirmation data to the connected application | Function | False | | authorizedCB | Callback of authorized transaction data to the connected application | Function | False |