Class: BitcoinApi ​
Defined in: packages/api/src/api.ts:134
Constructors ​
Constructor ​
new BitcoinApi(
cfg?):BitcoinApi
Defined in: packages/api/src/api.ts:139
Parameters ​
cfg? ​
Returns ​
BitcoinApi
Properties ​
defaultConfirmations ​
readonlydefaultConfirmations:number
Defined in: packages/api/src/api.ts:137
rest ​
readonlyrest:BitcoinRestClient
Defined in: packages/api/src/api.ts:135
rpc ​
readonlyrpc:BitcoinCoreRpcClient
Defined in: packages/api/src/api.ts:136
Methods ​
getBlock() ​
getBlock(
params):Promise<BlockResponse|undefined>
Defined in: packages/api/src/api.ts:171
Get a block by hash or height via REST.
Parameters ​
params ​
hash? ​
string
height? ​
number
Returns ​
Promise<BlockResponse | undefined>
getTransaction() ​
getTransaction(
txid):Promise<RawTransactionRest>
Defined in: packages/api/src/api.ts:156
Fetch a transaction by txid via REST.
Parameters ​
txid ​
string
Returns ​
Promise<RawTransactionRest>
getUtxos() ​
getUtxos(
address):Promise<AddressUtxo[]>
Defined in: packages/api/src/api.ts:166
Get UTXOs for an address via REST.
Parameters ​
address ​
string
Returns ​
Promise<AddressUtxo[]>
send() ​
send(
rawTxHex):Promise<string>
Defined in: packages/api/src/api.ts:161
Broadcast a raw tx (hex) via REST.
Parameters ​
rawTxHex ​
string
Returns ​
Promise<string>