Class BTC

constructor

• new BTC(rpc_url, network?): xmcore.BTC

• Parameters

  • rpc_url: string
  • network: Network = BITCOIN_CONSTANTS.DEFAULT_NETWORK

  Returns xmcore.BTC

Optionaladdress

network

provider

wallet

Staticnetworks

connect

• connect(): Promise<boolean>

• Connects to the RPC provider

  Returns Promise<boolean>

  A boolean indicating if the connection was successful

connectWallet

• connectWallet(privateKeyWIF): Promise<ECPairInterface>

• Connects to a wallet using a private key

  Parameters

  • privateKeyWIF: string

  Returns Promise<ECPairInterface>

  The wallet object

fetchAllUTXOs

• fetchAllUTXOs(): Promise<any[]>

• Returns Promise<any[]>

fetchUTXOs

• fetchUTXOs(address): Promise<any[]>

• Parameters

  • address: string

  Returns Promise<any[]>

generatePrivateKey

• generatePrivateKey(seed?): string

• Generate a private key for the BTC chain

  Parameters

  • Optionalseed: Buffer<ArrayBufferLike>

    The seed to generate the private key from (optional)

  Returns string

  The private key as a WIF string

getAddress

• getAddress(): string

• Returns the address of the connected wallet

  Returns string

getBalance

• getBalance(): Promise<string>

• Gets the balance of a wallet

  Returns Promise<string>

  The balance of the wallet as a string

getEmptyTransaction

• getEmptyTransaction(): Promise<any>

• Creates a skeleton transaction

  Returns Promise<any>

getFeeRate

• getFeeRate(overrideRate?): Promise<number>

• Parameters

  • OptionaloverrideRate: number

  Returns Promise<number>

getTxHex

• getTxHex(txid): Promise<string>

• Parameters

  • txid: string

  Returns Promise<string>

preparePay

• preparePay(address, amount, overrideFeeRate?, addNoise?): Promise<string>
• Alias

  Creates a signed transaction to transfer default chain currency

  Parameters

  • address: string
  • amount: string

    The amount to transfer
  • OptionaloverrideFeeRate: number
  • addNoise: boolean = false

  Returns Promise<string>

  The signed transaction

  prepareTransfer

preparePays

• preparePays(payments, overrideFeeRate?, addNoise?): Promise<string[]>

• Creates a list of signed transactions to transfer default chain currency

  Parameters

  • payments: IPayOptions[]

    A list of transfers to prepare
  • OptionaloverrideFeeRate: number
  • addNoise: boolean = false

  Returns Promise<string[]>

  An ordered list of signed transactions

signMessage

• signMessage(message, options?): Promise<string>

• Signs a message using the connected wallet

  Parameters

  • message: string

    The message to sign
  • Optionaloptions: {
        privateKey?: string;
    }

    Options

    • OptionalprivateKey?: string

  Returns Promise<string>

  The signed message

signTransaction

• signTransaction(psbt): Promise<string>

• Signs a transaction using the connected wallet

  Parameters

  • psbt: Psbt

  Returns Promise<string>

  The signed transaction

signTransactions

• signTransactions(psbts): Promise<string[]>

• Signs a list of transactions using the connected wallet. The transaction nonce is incremented for each transaction in order of appearance.

  Parameters

  • psbts: Psbt[]

  Returns Promise<string[]>

verifyMessage

• verifyMessage(message, signature, address): Promise<boolean>

• Verifies a message using the connected wallet

  Parameters

  • message: string

    The message to verify
  • signature: string

    The signature to verify
  • address: string

  Returns Promise<boolean>

  A boolean indicating if the message was verified

Staticcreate

• create<T>(this, rpc_url, network?): Promise<T>

• Creates a new instance of this sdk

  Type Parameters

  • T extends xmcore.BTC

  Parameters

  • this: (new (rpc_url: string, network: Network) => T)
    • • new (rpc_url, network): T

      • Parameters

        • rpc_url: string
        • network: Network

        Returns T

  • rpc_url: string

    The RPC URL
  • network: Network = BITCOIN_CONSTANTS.DEFAULT_NETWORK

  Returns Promise<T>

  The sdk instance connected to the RPC provider