transferBTC

transferBTC(config, params): Promise<TransferBTCResponse>

Transfers BTC with the given parameters. Optionally, it can broadcast the transaction.

Import

import { transferBTC } from "@midl-xyz/midl-js-core";

Example

const tx = await transferBTC(config, {
  transfers: [
    { receiver: "tb1q...", amount: 10000 },
    { receiver: "tb1q...", amount: 20000 },
  ],
  feeRate: 1,
  publish: true,
});

console.log(tx);

Parameters

Name	Type	Description
config	Config	The configuration object
params	TransferBTCParams	The parameters for the transfer

TransferBTCParams

Name	Type	Description
transfers	object[]	An array of transfers
transfers.receiver	string	The receiver address
transfers.amount	number	The amount in satoshis to transfer
feeRate?	number	The fee rate in satoshis per byte
publish?	boolean	If true, the transaction will be broadcasted
from?	string	The address to transfer the BTC from

Returns

Promise<TransferBTCResponse>

The PSBT and transaction data

TransferBTCResponse

Name	Type	Description
psbt	string	Signed Base64 encoded PSBT
tx	object	The transaction
tx.id	string	The transaction ID
tx.hex	string	The transaction hex