Class: BitcoinTransaction ​
Defined in: packages/bitcoin/src/client/rest/transaction.ts:6
Constructors ​
Constructor ​
new BitcoinTransaction(
protocol,exec):BitcoinTransaction
Defined in: packages/bitcoin/src/client/rest/transaction.ts:10
Parameters ​
protocol ​
exec ​
(req) => Promise<any>
Returns ​
BitcoinTransaction
Methods ​
get() ​
get(
txid):Promise<RawTransactionRest>
Defined in: packages/bitcoin/src/client/rest/transaction.ts:21
Returns the transaction in JSON format. See Esplora GET /tx/:txid for details.
Parameters ​
txid ​
string
The transaction id (required).
Returns ​
Promise<RawTransactionRest>
A promise resolving to data about a transaction.
getHex() ​
getHex(
txid):Promise<string>
Defined in: packages/bitcoin/src/client/rest/transaction.ts:41
Returns the raw transaction as a hex string. See Esplora GET /tx/:txid/hex for details.
Parameters ​
txid ​
string
The transaction id (required).
Returns ​
Promise<string>
A promise resolving to the raw transaction hex.
getRaw() ​
getRaw(
txid):Promise<Bytes>
Defined in: packages/bitcoin/src/client/rest/transaction.ts:51
Returns the raw transaction as binary data. See Esplora GET /tx/:txid/raw for details.
Parameters ​
txid ​
string
The transaction id (required).
Returns ​
Promise<Bytes>
A promise resolving to the raw transaction bytes.
isConfirmed() ​
isConfirmed(
txid):Promise<boolean>
Defined in: packages/bitcoin/src/client/rest/transaction.ts:30
Checks if a transaction is confirmed.
Parameters ​
txid ​
string
The transaction id (required).
Returns ​
Promise<boolean>
True if the transaction is confirmed.
send() ​
send(
tx):Promise<string>
Defined in: packages/bitcoin/src/client/rest/transaction.ts:61
Broadcast a raw transaction to the network. See Esplora POST /tx for details.
Parameters ​
tx ​
string
The raw transaction in hex format (required).
Returns ​
Promise<string>
The transaction id of the broadcasted transaction.