Interface: BitcoinRpcClient ​
Defined in: packages/bitcoin/src/client/rpc/interface.ts:16
General interface for a Bitcoin Core RPC client.\
Name ​
BitcoinRpcClient
Methods ​
createRawTransaction() ​
createRawTransaction(
inputs,outputs,locktime?,replacable?):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:18
Creates a raw transaction spending specified inputs to specified outputs.
Parameters ​
inputs ​
outputs ​
locktime? ​
number
replacable? ​
boolean
Returns ​
Promise<string>
getBlock() ​
getBlock(
__namedParameters):Promise<BlockResponse|undefined>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:27
Gets detailed information about a specific block.
Parameters ​
__namedParameters ​
Returns ​
Promise<BlockResponse | undefined>
getBlockchainInfo() ​
getBlockchainInfo():
Promise<ChainInfo>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:30
Retrieves general blockchain state info.
Returns ​
Promise<ChainInfo>
getBlockCount() ​
getBlockCount():
Promise<number>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:21
Returns the number of blocks in the longest blockchain.
Returns ​
Promise<number>
getBlockHash() ​
getBlockHash(
height):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:24
Gets the hash of a block at a given height.
Parameters ​
height ​
number
Returns ​
Promise<string>
getNewAddress() ​
getNewAddress(
account?):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:33
Gets a new Bitcoin address for receiving payments.
Parameters ​
account? ​
string
Returns ​
Promise<string>
sendRawTransaction() ​
sendRawTransaction(
hexstring,maxfeerate?,maxBurnAmount?):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:36
Sends raw transaction hex to the Bitcoin network.
Parameters ​
hexstring ​
string
maxfeerate? ​
string | number
maxBurnAmount? ​
string | number
Returns ​
Promise<string>
sendToAddress() ​
sendToAddress(
address,amount,comment?,comment_to?,subtreactfeefromamount?,replaceable?,conf_target?,estimate_mode?):Promise<RawTransactionResponse>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:43
Sends bitcoins to a specified address.
Parameters ​
address ​
string
amount ​
number
comment? ​
string
comment_to? ​
string
subtreactfeefromamount? ​
boolean
replaceable? ​
boolean
conf_target? ​
number
estimate_mode? ​
Returns ​
Promise<RawTransactionResponse>
signMessage() ​
signMessage(
address,message):Promise<string>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:57
Parameters ​
address ​
string
message ​
string
Returns ​
Promise<string>
verifyMessage() ​
verifyMessage(
address,signature,message):Promise<boolean>
Defined in: packages/bitcoin/src/client/rpc/interface.ts:55
Verifies a signed message.
Parameters ​
address ​
string
signature ​
string
message ​
string
Returns ​
Promise<boolean>