createCustomUtxoApi
createCustomUtxoApi(
methods):object
Defined in: toolboxes/src/utxo/helpers/api.ts:247
“Factory” to ensure typing for custom UTXO APIs
Parameters
Section titled “Parameters”methods
Section titled “methods”broadcastTx
Section titled “broadcastTx”(txHash) => Promise<string> = ...
getAddressData
Section titled “getAddressData”(address) => Promise<undefined | { address: BlockchairAddressCoreData; transactions: BlockchairTransaction[]; utxo: BlockchairUtxo[]; } | { address: { balance: number; transaction_count: number; }; utxo: never[]; }> = ...
getBalance
Section titled “getBalance”(address) => Promise<number> = ...
getRawTx
Section titled “getRawTx”(txHash) => Promise<string> = ...
getSuggestedTxFee
Section titled “getSuggestedTxFee”() => Promise<number> = ...
scanUTXOs
Section titled “scanUTXOs”(params) => Promise<object[]> = ...
Returns
Section titled “Returns”object
broadcastTx()
Section titled “broadcastTx()”broadcastTx: (
txHash) =>Promise<string>
Parameters
Section titled “Parameters”txHash
Section titled “txHash”string
Returns
Section titled “Returns”Promise<string>
getAddressData()
Section titled “getAddressData()”getAddressData: (
address) =>Promise<undefined| {address:BlockchairAddressCoreData;transactions:BlockchairTransaction[];utxo:BlockchairUtxo[]; } | {address: {balance:number;transaction_count:number; };utxo:never[]; }>
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”Promise<undefined | { address: BlockchairAddressCoreData; transactions: BlockchairTransaction[]; utxo: BlockchairUtxo[]; } | { address: { balance: number; transaction_count: number; }; utxo: never[]; }>
getBalance()
Section titled “getBalance()”getBalance: (
address) =>Promise<number>
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”Promise<number>
getRawTx()
Section titled “getRawTx()”getRawTx: (
txHash) =>Promise<string>
Parameters
Section titled “Parameters”txHash
Section titled “txHash”string
Returns
Section titled “Returns”Promise<string>
getSuggestedTxFee()
Section titled “getSuggestedTxFee()”getSuggestedTxFee: () =>
Promise<number>
Returns
Section titled “Returns”Promise<number>
scanUTXOs()
Section titled “scanUTXOs()”scanUTXOs: (
params) =>Promise<object[]>
Parameters
Section titled “Parameters”params
Section titled “params”address
Section titled “address”string
fetchTxHex?
Section titled “fetchTxHex?”boolean
Returns
Section titled “Returns”Promise<object[]>