@coolwallet/bch v1.1.4

CoolWallet Bitcoin Cash (BCH) SDK

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

Install

npm i @coolwallet/bch

Usage

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

const bch = new BCH();

const transport = await createTransport();

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

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

const address = await bch.getAddress(transport, appPrivateKey, appId, 0);

const signTxData = {
    tranpsort,
    appPrivateKey,
    appId,
    scriptType: 0,
    inputs: [{
        preTxHash: "9d717e7f9fb55c0591eb0f59999866091c592c55234a7024230123e1731524b5",
        preIndex: 0,
        preValue: "500000",
        sequence: 0xFFFFFFFF,
        addressIndex: 2,
        pubkeyBuf: Uint8Array(33)
    }],
    output: {
        value: "10000",
        address: "qzr809ywhqvhrlhq5nd9m78kmn3p20qm5y07gj0p8v",
    },
    change: {
        value: "489835",
        addressIndex: 1,
        pubkeyBuf: Uint8Array(33)
    }
}

const tx = await bch.signTransaction(signTxData);

Methods

getAddress

Description

The BCH 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'/145'/0'/0/{i}

In the design of current hardware, we only support path m/44'/145'/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

signTransaction

Description

Sign BCH Transaction.

async signTransaction(signTxData: types.signTxType): Promise<string>

signTxType Arguments