Interface: BitcoinRpcClient ​
Defined in: packages/bitcoin/src/client/rpc/interface.ts:18
General interface for a Bitcoin Core RPC client.
Methods ​
createRawTransaction() ​
Call Signature ​
createRawTransaction(
inputs,outputs,locktime?,replacable?):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:47
Creates a raw transaction spending specified inputs to specified outputs.
Parameters ​
inputs ​
outputs ​
locktime? ​
number
replacable? ​
boolean
Returns ​
Promise<string>
Call Signature ​
createRawTransaction(
inputs,outputs,locktime?,replacable?):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:65
Creates a raw transaction spending specified inputs to specified outputs.
Parameters ​
inputs ​
outputs ​
locktime? ​
number
replacable? ​
boolean
Returns ​
Promise<string>
createSignSendRawTransaction() ​
createSignSendRawTransaction(
inputs,outputs):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:41
Creates, signs, and sends a raw transaction in one step.
Parameters ​
inputs ​
outputs ​
Returns ​
Promise<string>
deriveAddresses() ​
deriveAddresses(
descriptor,range?):Promise<DerivedAddresses[]>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:50
Derives addresses from a descriptor.
Parameters ​
descriptor ​
string
range? ​
number[]
Returns ​
Promise<DerivedAddresses[]>
generateToAddress() ​
Call Signature ​
generateToAddress(
nblocks,address):Promise<string[]>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:53
Mines a specified number of blocks to a given address.
Parameters ​
nblocks ​
number
address ​
string
Returns ​
Promise<string[]>
Call Signature ​
generateToAddress(
nblocks,address):Promise<string[]>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:99
Mines a specified number of blocks to a given address.
Parameters ​
nblocks ​
number
address ​
string
Returns ​
Promise<string[]>
getBalance() ​
getBalance():
Promise<number>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:56
Gets the wallet's balance.
Returns ​
Promise<number>
getBlock() ​
Call Signature ​
getBlock(
__namedParameters):Promise<BlockResponse|undefined>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:20
Gets detailed information about a specific block.
Parameters ​
__namedParameters ​
Returns ​
Promise<BlockResponse | undefined>
Call Signature ​
getBlock(
__namedParameters):Promise<BlockResponse|undefined>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:74
Gets detailed information about a specific block.
Parameters ​
__namedParameters ​
Returns ​
Promise<BlockResponse | undefined>
getBlockchainInfo() ​
Call Signature ​
getBlockchainInfo():
Promise<ChainInfo>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:29
Retrieves general blockchain state info.
Returns ​
Promise<ChainInfo>
Call Signature ​
getBlockchainInfo():
Promise<ChainInfo>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:77
Retrieves general blockchain state info.
Returns ​
Promise<ChainInfo>
getBlockCount() ​
Call Signature ​
getBlockCount():
Promise<number>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:23
Returns the number of blocks in the longest blockchain.
Returns ​
Promise<number>
Call Signature ​
getBlockCount():
Promise<number>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:68
Returns the number of blocks in the longest blockchain.
Returns ​
Promise<number>
getBlockHash() ​
Call Signature ​
getBlockHash(
height):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:26
Gets the hash of a block at a given height.
Parameters ​
height ​
number
Returns ​
Promise<string>
Call Signature ​
getBlockHash(
height):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:71
Gets the hash of a block at a given height.
Parameters ​
height ​
number
Returns ​
Promise<string>
getNewAddress() ​
Call Signature ​
getNewAddress(
addressType,label?):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:59
Gets a new Bitcoin address for receiving payments.
Parameters ​
addressType ​
string
label? ​
string
Returns ​
Promise<string>
Call Signature ​
getNewAddress(
account?):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:80
Gets a new Bitcoin address for receiving payments.
Parameters ​
account? ​
string
Returns ​
Promise<string>
listTransactions() ​
listTransactions(
params):Promise<ListTransactionsResult>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:44
Lists transactions in the wallet.
Parameters ​
params ​
Returns ​
Promise<ListTransactionsResult>
listUnspent() ​
listUnspent(
params):Promise<UnspentTxInfo[]>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:62
Lists unspent transaction outputs in the wallet.
Parameters ​
params ​
address? ​
string[]
include_unsafe? ​
boolean
maxconf? ​
number
minconf? ​
number
Returns ​
Promise<UnspentTxInfo[]>
sendRawTransaction() ​
Call Signature ​
sendRawTransaction(
hexstring,maxfeerate?,maxBurnAmount?):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:35
Sends a raw transaction hex to the Bitcoin network.
Parameters ​
hexstring ​
string
maxfeerate? ​
string | number
maxBurnAmount? ​
string | number
Returns ​
Promise<string>
Call Signature ​
sendRawTransaction(
hexstring,maxfeerate?,maxBurnAmount?):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:83
Sends raw transaction hex to the Bitcoin network.
Parameters ​
hexstring ​
string
maxfeerate? ​
string | number
maxBurnAmount? ​
string | number
Returns ​
Promise<string>
sendToAddress() ​
sendToAddress(
address,amount):Promise<RawTransactionV2>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:90
Sends bitcoins to a specified address.
Parameters ​
address ​
string
amount ​
number
Returns ​
Promise<RawTransactionV2>
signAndSendRawTransaction() ​
signAndSendRawTransaction(
hexstring):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:38
Signs and sends a raw transaction in one step.
Parameters ​
hexstring ​
string
Returns ​
Promise<string>
signMessage() ​
signMessage(
address,message):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:96
Sign a message with the private key of an address.
Parameters ​
address ​
string
message ​
string
Returns ​
Promise<string>
signRawTransaction() ​
signRawTransaction(
hexstring):Promise<SignedRawTx>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:32
Signs a raw transaction with the wallet's private keys.
Parameters ​
hexstring ​
string
Returns ​
Promise<SignedRawTx>
verifyMessage() ​
verifyMessage(
address,signature,message):Promise<boolean>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:93
Verifies a signed message.
Parameters ​
address ​
string
signature ​
string
message ​
string
Returns ​
Promise<boolean>