@makkii/app-btc

Bitcoin-like(such as Bitcoin, Litecoin, etc) application client:

• Support Legacy address, prefix with 1
• Support both mainnet and testnet
• BIP39 Path m/49'/coinType'/0'/0/index For example, bitcoin's 1st account: m/49'/0'/0'/0/1
• Support get account from WIF private key

This library uses some services:

• bitpay insight-api - pass in BtcApiClient constructor, used to get balance, broadcast tranaction, etc.
• Transaction Explorer - bitpay insight-ui

Installation

$ npm install @makkii/app-btc

Usage

import {BtcApiClient, BtcKeystoreClient, BtcLocalSigner} from '@makkii/app-btc'

const api_client = new BtcApiClient({ network: 'BTC', insight_api: '***' });
api_client.getBalance('1ADeU4oeRSCTPn8GpZ2g6RXwDKsCuSjSbQ')
    .then(console.log)
    .catch(error=>console.log(error));

const keystore_client = new BtcKeystoreClient('BTC');
api_client.buildTransaction(
    '1ADeU4oeRSCTPn8GpZ2g6RXwDKsCuSjSbQ', // from address
    '147SwRQdpCfj5p8PnfsXV2SsVVpVcz3aPq', // to address
    0, // amount
    {
        byte_fee: 10,
    }
).then(function(unsignedTx) {
    keystore_client.signTransaction(unsignedTx, new BtcLocalSigner(), {
        private_key: '***'
    }).then(function(signedTx) {
        console.log(signedTx);
    });
});

API

Table of Contents

• BtcLocalSigner
  • Parameters
  • signTransaction
    • Parameters
• BtcKeystoreClient
  • Parameters
  • ledgerSupport
  • getCurrentNetwork
  • checkLedgerSupport
  • signTransaction
    • Parameters
  • generateMnemonic
  • recoverKeyPairByPrivateKey
    • Parameters
  • recoverKeyPairByWIF
    • Parameters
  • validatePrivateKey
    • Parameters
  • validateAddress
    • Parameters
  • getAccountFromMnemonic
    • Parameters
  • getAccountFromHardware
    • Parameters
• IBtcConfig
  • network
  • insight_api
  • broadcast
  • explorer
• BtcUnsignedTx
• BtcApiClient
  • Parameters
  • config
  • getNetwork
  • updateConfiguration
    • Parameters
  • getBlockByNumber
    • Parameters
  • getBlockNumber
  • getTransactionStatus
    • Parameters
  • getTransactionExplorerUrl
    • Parameters
  • getBalance
    • Parameters
  • getTransactionsByAddress
    • Parameters
  • sendTransaction
    • Parameters
  • sameAddress
    • Parameters
  • sendAll
    • Parameters
  • buildTransaction
    • Parameters
• BtcTxStatus
• BtcTransaction
• BtcPendingTransaction
• BtcKeypair

BtcLocalSigner

Parameters

• network

signTransaction

Sign transaction of btc local signer

Parameters

• transaction BtcUnsignedTx
• params {private_key: string, compressed: boolean} {private_key: string, compressed: boolean}

Returns string btc signed tx

BtcKeystoreClient

Parameters

• network ("BTC" | "BTCTEST" | "LTC" | "LTCTEST")

ledgerSupport

only btc btcTest support ledger

getCurrentNetwork

Get current network

Returns string network

checkLedgerSupport

Check ledger support

Returns boolean if support ledger

signTransaction

Sign transaction by signer

Parameters

• tx BtcUnsignedTx
• signer T localSigner or hardware
• signerParam any localSigner: {private_key, compressed} hardware:{derivationIndex}
• unsignedTx unsigned transaction build by buildTransaction

Returns Promise<string> encoded transaction

generateMnemonic

Generate mnemonic by bip39

Returns string 12 length of mnemonic

recoverKeyPairByPrivateKey

Recover key pair by private key

Parameters

• priKey string
• options any? compressed boolean whether to compress public key

Returns Promise<BtcKeypair>

recoverKeyPairByWIF

Recover key pair by wif

Parameters

• WIF string
• wif wif string

Returns Promise<BtcKeypair>

validatePrivateKey

Validate private key

not implemented

Parameters

• privateKey (string | Buffer)

validateAddress

Validate address

Parameters

• address string

Returns boolean

getAccountFromMnemonic

Get account from mnemonic

Parameters

• address_index number bip39 path index
• mnemonic string

Returns Promise<BtcKeypair>

getAccountFromHardware

Get account from hardware

Parameters

• index number derivation index
• hardware IHardware

IBtcConfig

network

Network name

Type: ("BTC" | "BTCTEST" | "LTC" | "LTCTEST")

insight_api

bitcoin reset api: https://github.com/bitpay/insight-api/tree/v0.4.3

Type: string

broadcast

bitcoin broadcasst tx api

Type: string

explorer

bitcoin explorer url to show tx detail

Type: string

BtcUnsignedTx

BTC unsigned transaction.

• to: Array<{ addr: string; value: number }>;
• from: Array<{ addr: string; value: number }>;
• value: BigNumber;
• utxos: Array<{ hash: string; index: number; script: string; raw: string; amount: number; }>;
• change_address: string;
• to_address: string;
• byte_fee: number;
• network: string;

BtcApiClient

BTC api client that implement IsingleApiClient

Parameters

• config IBtcConfig

config

Config of btc api client

Type: IBtcConfig

getNetwork

Get network of btc api client

Returns string network

updateConfiguration

Update configuration of btc api client

Parameters

• config IBtcConfig

getBlockByNumber

Get block by number

not implemented

Parameters

• blockNumber string

getBlockNumber

Get current Block height

not implemented

getTransactionStatus

Get transaction status by tx id

Parameters

• hash string transaction id

Returns Promise<BtcTxStatus> transaction status

getTransactionExplorerUrl

Get an explorer url showing transaction details

Parameters

• hash string

Returns string url

getBalance

Get an account's balance

Parameters

• address string

Returns Promise<BigNumber> balance

getTransactionsByAddress

Get transactions by address

Parameters

• address string
• page number
• size number

Returns Promise<Map<string, BtcTransaction>>

sendTransaction

Send transaction

Parameters

• unsignedTx BtcUnsignedTx unsigned transaction build by buildTransaction
• signer T localSigner or hardware
• signerParams any localSigner: {private_key, compressed} hardware:{derivationIndex}

Returns Promise<BtcPendingTransaction>

sameAddress

check if two address is same

Parameters

• address1 string
• address2 string

Returns boolean

sendAll

try to estimate send one address all balance

Parameters

• address string
• byte_fee number

Returns Promise<number> one address all balance after minus fee

buildTransaction

Build transaction

Parameters

• from string
• to string
• value BigNumber
• options {byte_fee: number}

Returns Promise<BtcUnsignedTx>

BtcTxStatus

BTC transaction status

• status: boolean;
• blockNumber?: number;
• timestamp?: number;

BtcTransaction

BTC transaction

• hash: string;
• timestamp: number;
• blockNUmber: number;
• status: "CONFIRMED";
• from: Array<{ addr: string; value: number; }>;
• to: Array<{ addr: string; value: number; }>;
• fee: number;

BtcPendingTransaction

BTC pending transaction.

• hash: string;
• status: "PENDING";
• from: Array<{ addr: string; value: number; }>;
• to: Array<{ addr: string; value: number; }>;
• fee: number;

BtcKeypair

BTC key pair.

• private_key: string;
• public_key: string;
• address: string;
• index?: number;
• compressed?: boolean;
• sign?: (hash: any) => Buffer;
• toWIF?: () => string;