BitcoinDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:120
Properties
Section titled “Properties”bitcoin_get_balance
Section titled “bitcoin_get_balance”bitcoin_get_balance:
ActorMethod<[get_balance_request],bigint>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:121
bitcoin_get_balance_query
Section titled “bitcoin_get_balance_query”bitcoin_get_balance_query:
ActorMethod<[get_balance_request],bigint>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:122
bitcoin_get_block_headers
Section titled “bitcoin_get_block_headers”bitcoin_get_block_headers:
ActorMethod<[get_block_headers_request],get_block_headers_response>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:123
bitcoin_get_current_fee_percentiles
Section titled “bitcoin_get_current_fee_percentiles”bitcoin_get_current_fee_percentiles:
ActorMethod<[get_current_fee_percentiles_request],BigUint64Array<ArrayBufferLike>>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:127
bitcoin_get_utxos
Section titled “bitcoin_get_utxos”bitcoin_get_utxos:
ActorMethod<[get_utxos_request],get_utxos_response>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:131
bitcoin_get_utxos_query
Section titled “bitcoin_get_utxos_query”bitcoin_get_utxos_query:
ActorMethod<[get_utxos_request],get_utxos_response>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:132
bitcoin_send_transaction
Section titled “bitcoin_send_transaction”bitcoin_send_transaction:
ActorMethod<[send_transaction_request],undefined>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:133
get_blockchain_info
Section titled “get_blockchain_info”get_blockchain_info:
ActorMethod<[],blockchain_info>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:134
get_config
Section titled “get_config”get_config:
ActorMethod<[],config>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:135
set_config
Section titled “set_config”set_config:
ActorMethod<[set_config_request],undefined>
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:136
blockchain_info
Section titled “blockchain_info”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:17
Properties
Section titled “Properties”block_hash
Section titled “block_hash”block_hash:
block_hash
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:19
difficulty
Section titled “difficulty”difficulty:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:20
height
Section titled “height”height:
number
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:18
timestamp
Section titled “timestamp”timestamp:
number
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:21
utxos_length
Section titled “utxos_length”utxos_length:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:22
config
Section titled “config”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:27
Properties
Section titled “Properties”api_access
Section titled “api_access”api_access:
flag
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:28
blocks_source
Section titled “blocks_source”blocks_source:
Principal
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:30
burn_cycles
Section titled “burn_cycles”burn_cycles:
flag
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:36
disable_api_if_not_fully_synced
Section titled “disable_api_if_not_fully_synced”disable_api_if_not_fully_synced:
flag
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:37
fees:
fees
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:31
lazily_evaluate_fee_percentiles
Section titled “lazily_evaluate_fee_percentiles”lazily_evaluate_fee_percentiles:
flag
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:29
network
Section titled “network”network:
network
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:33
stability_threshold
Section titled “stability_threshold”stability_threshold:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:34
syncing
Section titled “syncing”syncing:
flag
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:35
watchdog_canister
Section titled “watchdog_canister”watchdog_canister: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:32
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:39
Properties
Section titled “Properties”get_balance
Section titled “get_balance”get_balance:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:45
get_balance_maximum
Section titled “get_balance_maximum”get_balance_maximum:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:49
get_block_headers_base
Section titled “get_block_headers_base”get_block_headers_base:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:47
get_block_headers_cycles_per_ten_instructions
Section titled “get_block_headers_cycles_per_ten_instructions”get_block_headers_cycles_per_ten_instructions:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:42
get_block_headers_maximum
Section titled “get_block_headers_maximum”get_block_headers_maximum:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:51
get_current_fee_percentiles
Section titled “get_current_fee_percentiles”get_current_fee_percentiles:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:40
get_current_fee_percentiles_maximum
Section titled “get_current_fee_percentiles_maximum”get_current_fee_percentiles_maximum:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:43
get_utxos_base
Section titled “get_utxos_base”get_utxos_base:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:48
get_utxos_cycles_per_ten_instructions
Section titled “get_utxos_cycles_per_ten_instructions”get_utxos_cycles_per_ten_instructions:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:46
get_utxos_maximum
Section titled “get_utxos_maximum”get_utxos_maximum:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:41
send_transaction_base
Section titled “send_transaction_base”send_transaction_base:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:50
send_transaction_per_byte
Section titled “send_transaction_per_byte”send_transaction_per_byte:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:44
get_balance_request
Section titled “get_balance_request”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:54
Properties
Section titled “Properties”address
Section titled “address”address:
string
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:56
min_confirmations
Section titled “min_confirmations”min_confirmations: [
number] | []
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:57
network
Section titled “network”network:
network
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:55
get_block_headers_request
Section titled “get_block_headers_request”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:59
Properties
Section titled “Properties”end_height
Section titled “end_height”end_height: [
number] | []
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:61
network
Section titled “network”network:
network
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:62
start_height
Section titled “start_height”start_height:
number
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:60
get_block_headers_response
Section titled “get_block_headers_response”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:64
Properties
Section titled “Properties”block_headers
Section titled “block_headers”block_headers:
block_header[]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:66
tip_height
Section titled “tip_height”tip_height:
number
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:65
get_current_fee_percentiles_request
Section titled “get_current_fee_percentiles_request”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:68
Properties
Section titled “Properties”network
Section titled “network”network:
network
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:69
get_utxos_request
Section titled “get_utxos_request”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:71
Properties
Section titled “Properties”address
Section titled “address”address:
string
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:74
filter
Section titled “filter”filter: [] | [{
page:Uint8Array; } | {min_confirmations:number; }]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:73
network
Section titled “network”network:
network
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:72
get_utxos_response
Section titled “get_utxos_response”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:76
Properties
Section titled “Properties”next_page
Section titled “next_page”next_page: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:77
tip_block_hash
Section titled “tip_block_hash”tip_block_hash:
block_hash
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:79
tip_height
Section titled “tip_height”tip_height:
number
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:78
utxos:
utxo[]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:80
init_config
Section titled “init_config”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:82
Properties
Section titled “Properties”api_access
Section titled “api_access”api_access: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:83
blocks_source
Section titled “blocks_source”blocks_source: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:85
burn_cycles
Section titled “burn_cycles”burn_cycles: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:91
disable_api_if_not_fully_synced
Section titled “disable_api_if_not_fully_synced”disable_api_if_not_fully_synced: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:92
fees: [] | [
fees]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:86
lazily_evaluate_fee_percentiles
Section titled “lazily_evaluate_fee_percentiles”lazily_evaluate_fee_percentiles: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:84
network
Section titled “network”network: [] | [
network]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:88
stability_threshold
Section titled “stability_threshold”stability_threshold: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:89
syncing
Section titled “syncing”syncing: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:90
watchdog_canister
Section titled “watchdog_canister”watchdog_canister: [] | [[] | [
Principal]]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:87
outpoint
Section titled “outpoint”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:96
Properties
Section titled “Properties”txid:
Uint8Array
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:97
vout:
number
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:98
send_transaction_request
Section titled “send_transaction_request”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:101
Properties
Section titled “Properties”network
Section titled “network”network:
network
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:103
transaction
Section titled “transaction”transaction:
Uint8Array
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:102
set_config_request
Section titled “set_config_request”Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:105
Properties
Section titled “Properties”api_access
Section titled “api_access”api_access: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:106
burn_cycles
Section titled “burn_cycles”burn_cycles: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:112
disable_api_if_not_fully_synced
Section titled “disable_api_if_not_fully_synced”disable_api_if_not_fully_synced: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:113
fees: [] | [
fees]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:108
lazily_evaluate_fee_percentiles
Section titled “lazily_evaluate_fee_percentiles”lazily_evaluate_fee_percentiles: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:107
stability_threshold
Section titled “stability_threshold”stability_threshold: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:110
syncing
Section titled “syncing”syncing: [] | [
flag]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:111
watchdog_canister
Section titled “watchdog_canister”watchdog_canister: [] | [[] | [
Principal]]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:109
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:115
Properties
Section titled “Properties”height
Section titled “height”height:
number
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:116
outpoint
Section titled “outpoint”outpoint:
outpoint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:118
value:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:117
Type Aliases
Section titled “Type Aliases”address
Section titled “address”address =
string
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:13
block_hash
Section titled “block_hash”block_hash =
Uint8Array
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:14
block_header
Section titled “block_header”block_header =
Uint8Array
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:15
block_height
Section titled “block_height”block_height =
number
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:16
canister_arg
Section titled “canister_arg”canister_arg = {
init:init_config; } | {upgrade: [] | [set_config_request]; }
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:24
flag = {
disabled:null; } | {enabled:null; }
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:53
millisatoshi_per_byte
Section titled “millisatoshi_per_byte”millisatoshi_per_byte =
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:94
network
Section titled “network”network = {
mainnet:null; } | {regtest:null; } | {testnet:null; }
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:95
satoshi
Section titled “satoshi”satoshi =
bigint
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:100
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:138
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/ckbtc/bitcoin.d.ts:139
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]