CkBtcMinterDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:957
Properties
Section titled “Properties”decode_ledger_memo
Section titled “decode_ledger_memo”decode_ledger_memo:
ActorMethod<[DecodeLedgerMemoArgs],DecodeLedgerMemoResult>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:962
Section “Transaction Information” {{{ Returns information related to minter transactions.
estimate_withdrawal_fee
Section titled “estimate_withdrawal_fee”estimate_withdrawal_fee:
ActorMethod<[{amount: [] | [bigint]; }], {bitcoin_fee:bigint;minter_fee:bigint; }>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:970
/ Returns an estimate of the user’s fee (in Satoshi) for a / retrieve_btc request based on the current status of the Bitcoin network.
get_btc_address
Section titled “get_btc_address”get_btc_address:
ActorMethod<[{owner: [] | [Principal];subaccount: [] | [Uint8Array<ArrayBufferLike>]; }],string>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:982
Returns the Bitcoin address to which the owner should send BTC before converting the amount to ckBTC using the [update_balance] endpoint.
If the owner is not set, it defaults to the caller’s principal. The resolved owner must be a non-anonymous principal.
get_canister_status
Section titled “get_canister_status”get_canister_status:
ActorMethod<[],CanisterStatusResponse>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:986
get_deposit_fee
Section titled “get_deposit_fee”get_deposit_fee:
ActorMethod<[],bigint>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:990
/ Returns the fee that the minter will charge for a bitcoin deposit.
get_events
Section titled “get_events”get_events:
ActorMethod<[{length:bigint;start:bigint; }],Event[]>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1002
The minter keeps track of all state modifications in an internal event log.
This method returns a list of events in the specified range. The minter can return fewer events than requested. The result is an empty vector if the start position is greater than the total number of events.
NOTE: this method exists for debugging purposes. The ckBTC minter authors do not guarantee backward compatibility for this method.
get_known_utxos
Section titled “get_known_utxos”get_known_utxos:
ActorMethod<[{owner: [] | [Principal];subaccount: [] | [Uint8Array<ArrayBufferLike>]; }],Utxo[]>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1009
Returns UTXOs of the given account known by the minter (with no guarantee in the ordering of the returned values).
If the owner is not set, it defaults to the caller’s principal.
get_minter_info
Section titled “get_minter_info”get_minter_info:
ActorMethod<[],MinterInfo>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1017
Section “Minter Information” {{{ Returns internal minter parameters.
get_withdrawal_account
Section titled “get_withdrawal_account”get_withdrawal_account:
ActorMethod<[],Account>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1022
Returns the account to which the caller should deposit ckBTC before withdrawing BTC using the [retrieve_btc] endpoint.
icrc10_supported_standards
Section titled “icrc10_supported_standards”icrc10_supported_standards:
ActorMethod<[],Icrc10StandardRecord[]>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1026
Returns the list of supported ICRC standards.
icrc21_canister_call_consent_message
Section titled “icrc21_canister_call_consent_message”icrc21_canister_call_consent_message:
ActorMethod<[Icrc21ConsentMessageRequest], {Ok:Icrc21ConsentInfo; } | {Err:Icrc21Error; }>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1032
Returns a human-readable consent message describing the requested canister call. See the ICRC-21 standard for details: https://github.com/dfinity/ICRC/blob/main/ICRCs/ICRC-21/ICRC-21.md
retrieve_btc
Section titled “retrieve_btc”retrieve_btc:
ActorMethod<[RetrieveBtcArgs], {Ok:RetrieveBtcOk; } | {Err:RetrieveBtcError; }>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1051
Submits a request to convert ckBTC to BTC.
The BTC retrieval process is slow. Instead of synchronously waiting for a BTC transaction to settle, this method returns a request ([block_index]) that the caller can use to query the request status.
Preconditions
Section titled “Preconditions”- The caller deposited the requested amount in ckBTC to the account that the [get_withdrawal_account] endpoint returns.
retrieve_btc_status
Section titled “retrieve_btc_status”retrieve_btc_status:
ActorMethod<[{block_index:bigint; }],RetrieveBtcStatus>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1059
/ [deprecated] Returns the status of a withdrawal request. / You should use retrieve_btc_status_v2 to retrieve the status of your withdrawal request.
retrieve_btc_status_v2
Section titled “retrieve_btc_status_v2”retrieve_btc_status_v2:
ActorMethod<[{block_index:bigint; }],RetrieveBtcStatusV2>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1066
/ Returns the status of a withdrawal request request using the RetrieveBtcStatusV2 type.
retrieve_btc_status_v2_by_account
Section titled “retrieve_btc_status_v2_by_account”retrieve_btc_status_v2_by_account:
ActorMethod<[[] | [Account]],object[]>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1078
Returns the withdrawal statues by account.
The v2 part indicates that you get a response in line with the retrieve_btc_status_v2 endpoint, i.e., you get a vector of RetrieveBtcStatusV2 and not RetrieveBtcStatus.
retrieve_btc_with_approval
Section titled “retrieve_btc_with_approval”retrieve_btc_with_approval:
ActorMethod<[RetrieveBtcWithApprovalArgs], {Ok:RetrieveBtcOk; } | {Err:RetrieveBtcWithApprovalError; }>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1097
Submits a request to convert ckBTC to BTC.
The BTC retrieval process is slow. Instead of synchronously waiting for a BTC transaction to settle, this method returns a request ([block_index]) that the caller can use to query the request status.
Preconditions
Section titled “Preconditions”- The caller allowed the minter’s principal to spend its funds using [icrc2_approve] on the ckBTC ledger.
update_balance
Section titled “update_balance”update_balance:
ActorMethod<[{owner: [] | [Principal];subaccount: [] | [Uint8Array<ArrayBufferLike>]; }], {Ok:UtxoStatus[]; } | {Err:UpdateBalanceError; }>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1111
Mints ckBTC for newly deposited UTXOs.
If the owner is not set, it defaults to the caller’s principal.
Preconditions
Section titled “Preconditions”- The owner deposited some BTC to the address that the [get_btc_address] endpoint returns.
Account
Section titled “Account”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:16
Represents an account on the ckBTC ledger.
Properties
Section titled “Properties”owner:
Principal
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:17
subaccount
Section titled “subaccount”subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:18
CanisterStatusResponse
Section titled “CanisterStatusResponse”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:80
Properties
Section titled “Properties”cycles
Section titled “cycles”cycles:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:86
idle_cycles_burned_per_day
Section titled “idle_cycles_burned_per_day”idle_cycles_burned_per_day:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:89
memory_metrics
Section titled “memory_metrics”memory_metrics:
MemoryMetrics
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:81
memory_size
Section titled “memory_size”memory_size:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:83
module_hash
Section titled “module_hash”module_hash: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:90
query_stats
Section titled “query_stats”query_stats:
QueryStats
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:88
ready_for_migration
Section titled “ready_for_migration”ready_for_migration:
boolean
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:84
reserved_cycles
Section titled “reserved_cycles”reserved_cycles:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:91
settings
Section titled “settings”settings:
DefiniteCanisterSettings
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:87
status
Section titled “status”status:
CanisterStatusType
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:82
version
Section titled “version”version:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:85
DecodeLedgerMemoArgs
Section titled “DecodeLedgerMemoArgs”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:97
Properties
Section titled “Properties”encoded_memo
Section titled “encoded_memo”encoded_memo:
Uint8Array
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:105
The encoded memo from a minter transaction on the ledger
memo_type
Section titled “memo_type”memo_type:
MemoType
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:101
The encoded memo type
DefiniteCanisterSettings
Section titled “DefiniteCanisterSettings”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:141
Properties
Section titled “Properties”compute_allocation
Section titled “compute_allocation”compute_allocation:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:150
controllers
Section titled “controllers”controllers:
Principal[]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:145
environment_variables
Section titled “environment_variables”environment_variables:
environment_variable[]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:144
freezing_threshold
Section titled “freezing_threshold”freezing_threshold:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:142
log_visibility
Section titled “log_visibility”log_visibility:
LogVisibility
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:147
memory_allocation
Section titled “memory_allocation”memory_allocation:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:149
reserved_cycles_limit
Section titled “reserved_cycles_limit”reserved_cycles_limit:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:146
wasm_memory_limit
Section titled “wasm_memory_limit”wasm_memory_limit:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:148
wasm_memory_threshold
Section titled “wasm_memory_threshold”wasm_memory_threshold:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:143
environment_variable
Section titled “environment_variable”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:953
Properties
Section titled “Properties”name:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:955
value:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:954
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:152
Properties
Section titled “Properties”payload
Section titled “payload”payload:
EventType
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:154
timestamp
Section titled “timestamp”timestamp: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:153
Icrc10StandardRecord
Section titled “Icrc10StandardRecord”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:277
ICRC-10 supported standards record.
Properties
Section titled “Properties”name:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:279
url:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:278
Icrc21ConsentInfo
Section titled “Icrc21ConsentInfo”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:281
Properties
Section titled “Properties”consent_message
Section titled “consent_message”consent_message:
Icrc21ConsentMessage
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:283
metadata
Section titled “metadata”metadata:
Icrc21ConsentMessageMetadata
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:282
Icrc21ConsentMessageMetadata
Section titled “Icrc21ConsentMessageMetadata”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:293
ICRC-21 Canister Call Consent Message types.
Properties
Section titled “Properties”language
Section titled “language”language:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:295
utc_offset_minutes
Section titled “utc_offset_minutes”utc_offset_minutes: [
number] | []
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:294
Icrc21ConsentMessageRequest
Section titled “Icrc21ConsentMessageRequest”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:297
Properties
Section titled “Properties”arg:
Uint8Array
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:298
method
Section titled “method”method:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:299
user_preferences
Section titled “user_preferences”user_preferences:
Icrc21ConsentMessageSpec
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:300
Icrc21ConsentMessageSpec
Section titled “Icrc21ConsentMessageSpec”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:302
Properties
Section titled “Properties”device_spec
Section titled “device_spec”device_spec: [] | [
Icrc21DeviceSpec]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:304
metadata
Section titled “metadata”metadata:
Icrc21ConsentMessageMetadata
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:303
Icrc21ErrorInfo
Section titled “Icrc21ErrorInfo”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:316
Properties
Section titled “Properties”description
Section titled “description”description:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:317
Icrc21FieldsDisplay
Section titled “Icrc21FieldsDisplay”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:319
Properties
Section titled “Properties”fields
Section titled “fields”fields: [
string,Icrc21Value][]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:320
intent
Section titled “intent”intent:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:321
InitArgs
Section titled “InitArgs”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:337
The initialization parameters of the minter canister.
Properties
Section titled “Properties”btc_checker_principal
Section titled “btc_checker_principal”btc_checker_principal: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:394
/ The canister id of the Bitcoin checker canister.
btc_network
Section titled “btc_network”btc_network:
BtcNetwork
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:378
The minter will interact with this Bitcoin network.
check_fee
Section titled “check_fee”check_fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:382
/ The fee paid per Bitcoin check.
deposit_btc_min_amount
Section titled “deposit_btc_min_amount”deposit_btc_min_amount: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:363
The minimal amount of BTC that can be converted to ckBTC. UTXOs with lower values will be ignored.
ecdsa_key_name
Section titled “ecdsa_key_name”ecdsa_key_name:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:350
The name of the ECDSA key to use. E.g., “dfx_test_key” on the local replica.
get_utxos_cache_expiration_seconds
Section titled “get_utxos_cache_expiration_seconds”get_utxos_cache_expiration_seconds: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:341
/ The expiration duration (in seconds) for cached entries in the get_utxos cache.
kyt_fee
Section titled “kyt_fee”kyt_fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:403
/ The fee paid per check by the KYT canister (deprecated, use check_fee instead).
kyt_principal
Section titled “kyt_principal”kyt_principal: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:345
/ The canister id of the KYT canister (deprecated, use btc_checker_principal instead).
ledger_id
Section titled “ledger_id”ledger_id:
Principal
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:369
The principal of the ledger that handles ckBTC transfers. The default account of the ckBTC minter must be configured as the minting account of the ledger.
max_num_inputs_in_transaction
Section titled “max_num_inputs_in_transaction”max_num_inputs_in_transaction: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:386
/ The maximum number of input UTXOs allowed in a transaction.
max_time_in_queue_nanos
Section titled “max_time_in_queue_nanos”max_time_in_queue_nanos:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:374
/ Maximum time in nanoseconds that a transaction should spend in the queue / before being sent.
min_confirmations
Section titled “min_confirmations”min_confirmations: [
number] | []
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:399
/ The minimum number of confirmations required for the minter to / accept a Bitcoin transaction.
mode:
Mode
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:354
/ The minter’s operation mode.
retrieve_btc_min_amount
Section titled “retrieve_btc_min_amount”retrieve_btc_min_amount:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:358
The minimal amount of ckBTC that can be converted to BTC.
utxo_consolidation_threshold
Section titled “utxo_consolidation_threshold”utxo_consolidation_threshold: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:390
/ The minimum number of available UTXOs to trigger a consolidation.
MemoryMetrics
Section titled “MemoryMetrics”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:413
Properties
Section titled “Properties”canister_history_size
Section titled “canister_history_size”canister_history_size:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:416
custom_sections_size
Section titled “custom_sections_size”custom_sections_size:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:421
global_memory_size
Section titled “global_memory_size”global_memory_size:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:420
snapshots_size
Section titled “snapshots_size”snapshots_size:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:418
stable_memory_size
Section titled “stable_memory_size”stable_memory_size:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:417
wasm_binary_size
Section titled “wasm_binary_size”wasm_binary_size:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:414
wasm_chunk_store_size
Section titled “wasm_chunk_store_size”wasm_chunk_store_size:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:415
wasm_memory_size
Section titled “wasm_memory_size”wasm_memory_size:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:419
MinterInfo
Section titled “MinterInfo”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:476
Properties
Section titled “Properties”deposit_btc_min_amount
Section titled “deposit_btc_min_amount”deposit_btc_min_amount: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:486
Minimal amount of BTC that can be deposited to be converted into ckBTC. UTXOs with lower values will be ignored.
kyt_fee
Section titled “kyt_fee”kyt_fee:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:491
The same as check_fee, but the old name is kept here to be backward compatible.
min_confirmations
Section titled “min_confirmations”min_confirmations:
number
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:487
retrieve_btc_min_amount
Section titled “retrieve_btc_min_amount”retrieve_btc_min_amount:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:481
This amount is based on the retrieve_btc_min_amount setting during canister
initialization or upgrades, but may vary according to current network fees.
PendingUtxo
Section titled “PendingUtxo”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:521
Utxos that don’t have enough confirmations to be processed.
Properties
Section titled “Properties”confirmations
Section titled “confirmations”confirmations:
number
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:522
outpoint
Section titled “outpoint”outpoint:
object
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:524
txid:
Uint8Array
vout:
number
value:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:523
QueryStats
Section titled “QueryStats”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:526
Properties
Section titled “Properties”num_calls_total
Section titled “num_calls_total”num_calls_total:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:529
num_instructions_total
Section titled “num_instructions_total”num_instructions_total:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:528
request_payload_bytes_total
Section titled “request_payload_bytes_total”request_payload_bytes_total:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:530
response_payload_bytes_total
Section titled “response_payload_bytes_total”response_payload_bytes_total:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:527
ReimbursedDeposit
Section titled “ReimbursedDeposit”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:532
Properties
Section titled “Properties”account
Section titled “account”account:
Account
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:533
amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:535
mint_block_index
Section titled “mint_block_index”mint_block_index:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:534
reason
Section titled “reason”reason:
ReimbursementReason
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:536
ReimbursementRequest
Section titled “ReimbursementRequest”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:541
Properties
Section titled “Properties”account
Section titled “account”account:
Account
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:542
amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:543
reason
Section titled “reason”reason:
ReimbursementReason
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:544
RetrieveBtcArgs
Section titled “RetrieveBtcArgs”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:551
Properties
Section titled “Properties”address
Section titled “address”address:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:555
The address to which the ckBTC minter should deposit BTC.
amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:559
The amount of ckBTC in Satoshis that the client wants to withdraw.
RetrieveBtcOk
Section titled “RetrieveBtcOk”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:601
Properties
Section titled “Properties”block_index
Section titled “block_index”block_index:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:606
Returns the burn transaction index corresponding to the withdrawal. You can use this index to query the withdrawal status.
RetrieveBtcWithApprovalArgs
Section titled “RetrieveBtcWithApprovalArgs”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:722
Properties
Section titled “Properties”address
Section titled “address”address:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:730
The address to which the ckBTC minter should deposit BTC.
amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:734
The amount of ckBTC in Satoshis that the client wants to withdraw.
from_subaccount
Section titled “from_subaccount”from_subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:726
The subaccount to burn ckBTC from.
SuspendedUtxo
Section titled “SuspendedUtxo”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:810
Properties
Section titled “Properties”earliest_retry
Section titled “earliest_retry”earliest_retry:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:812
reason
Section titled “reason”reason:
SuspendedReason
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:813
utxo:
Utxo
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:811
UpgradeArgs
Section titled “UpgradeArgs”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:853
The upgrade parameters of the minter canister.
Properties
Section titled “Properties”btc_checker_principal
Section titled “btc_checker_principal”btc_checker_principal: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:895
/ The principal of the Bitcoin checker canister.
check_fee
Section titled “check_fee”check_fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:883
/ The fee per Bitcoin check.
deposit_btc_min_amount
Section titled “deposit_btc_min_amount”deposit_btc_min_amount: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:874
The minimal amount of BTC that can be converted to ckBTC. UTXOs with lower values will be ignored.
get_utxos_cache_expiration_seconds
Section titled “get_utxos_cache_expiration_seconds”get_utxos_cache_expiration_seconds: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:857
/ The expiration duration (in seconds) for cached entries in the get_utxos cache.
kyt_fee
Section titled “kyt_fee”kyt_fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:904
/ The fee paid per check by the KYT canister (deprecated, use check_fee instead).
kyt_principal
Section titled “kyt_principal”kyt_principal: [] | [
Principal]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:861
/ The canister id of the KYT canister (deprecated, use btc_checker_principal instead).
max_num_inputs_in_transaction
Section titled “max_num_inputs_in_transaction”max_num_inputs_in_transaction: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:887
/ The maximum number of input UTXOs allowed in a transaction.
max_time_in_queue_nanos
Section titled “max_time_in_queue_nanos”max_time_in_queue_nanos: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:879
/ Maximum time in nanoseconds that a transaction should spend in the queue / before being sent.
min_confirmations
Section titled “min_confirmations”min_confirmations: [
number] | []
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:900
/ The minimum number of confirmations required for the minter to / accept a Bitcoin transaction.
mode: [] | [
Mode]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:865
/ If set, overrides the current minter’s operation mode.
retrieve_btc_min_amount
Section titled “retrieve_btc_min_amount”retrieve_btc_min_amount: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:869
The minimal amount of ckBTC that the minter converts to BTC.
utxo_consolidation_threshold
Section titled “utxo_consolidation_threshold”utxo_consolidation_threshold: [] | [
bigint]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:891
/ The minimum number of available UTXOs to trigger a consolidation.
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:906
Properties
Section titled “Properties”height
Section titled “height”height:
number
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:907
outpoint
Section titled “outpoint”outpoint:
object
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:909
txid:
Uint8Array
vout:
number
value:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:908
WithdrawalFee
Section titled “WithdrawalFee”Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:946
Properties
Section titled “Properties”bitcoin_fee
Section titled “bitcoin_fee”bitcoin_fee:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:948
minter_fee
Section titled “minter_fee”minter_fee:
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:947
Type Aliases
Section titled “Type Aliases”BitcoinAddress
Section titled “BitcoinAddress”BitcoinAddress = {
p2wsh_v0:Uint8Array; } | {p2tr_v1:Uint8Array; } | {p2sh:Uint8Array; } | {p2wpkh_v0:Uint8Array; } | {p2pkh:Uint8Array; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:20
BtcNetwork
Section titled “BtcNetwork”BtcNetwork = {
Mainnet:null; } | {Regtest:null; } | {Testnet:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:26
Type Declaration
Section titled “Type Declaration”{ Mainnet: null; }
Mainnet
Section titled “Mainnet”Mainnet:
null
The public Bitcoin mainnet.
{ Regtest: null; }
Regtest
Section titled “Regtest”Regtest:
null
A local Bitcoin regtest installation.
{ Testnet: null; }
Testnet
Section titled “Testnet”Testnet:
null
The public Bitcoin testnet.
BurnMemo
Section titled “BurnMemo”BurnMemo = {
Consolidate: {inputs:bigint;value:bigint; }; } | {Convert: {address: [] | [string];kyt_fee: [] | [bigint];status: [] | [Status]; }; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:45
Type Declaration
Section titled “Type Declaration”{ Consolidate: { inputs: bigint; value: bigint; }; }
Consolidate
Section titled “Consolidate”Consolidate:
object
The minter consolidated UTXOs.
Consolidate.inputs
Section titled “Consolidate.inputs”inputs:
bigint
The number of input UTXOs that were consolidated.
Consolidate.value
Section titled “Consolidate.value”value:
bigint
The total value of the consolidated UTXOs.
{ Convert: { address: [] | [string]; kyt_fee: [] | [bigint]; status: [] | [Status]; }; }
Convert
Section titled “Convert”Convert:
object
The minter processed a retrieve_btc request.
Convert.address
Section titled “Convert.address”address: [] | [
string]
The destination of the retrieve BTC request.
Convert.kyt_fee
Section titled “Convert.kyt_fee”kyt_fee: [] | [
bigint]
The check fee for the burn.
Convert.status
Section titled “Convert.status”status: [] | [
Status]
The status of the Bitcoin check.
CanisterStatusType
Section titled “CanisterStatusType”CanisterStatusType = {
stopped:null; } | {stopping:null; } | {running:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:93
DecodedMemo
Section titled “DecodedMemo”DecodedMemo = {
Burn: [] | [BurnMemo]; } | {Mint: [] | [MintMemo]; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:128
Type Declaration
Section titled “Type Declaration”{ Burn: [] | [BurnMemo]; }
Burn: [] | [
BurnMemo]
The decoded BurnMemo - opt since other variants of BurnMemo could be added in the future.
{ Mint: [] | [MintMemo]; }
Mint: [] | [
MintMemo]
The decoded MintMemo - opt since other variants of MintMemo could be added in the future.
DecodeLedgerMemoError
Section titled “DecodeLedgerMemoError”DecodeLedgerMemoError =
object
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:107
Properties
Section titled “Properties”InvalidMemo
Section titled “InvalidMemo”InvalidMemo:
string
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:111
The provided memo could not be decoded.
DecodeLedgerMemoResult
Section titled “DecodeLedgerMemoResult”DecodeLedgerMemoResult = {
Ok: [] | [DecodedMemo]; } | {Err: [] | [DecodeLedgerMemoError]; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:113
Type Declaration
Section titled “Type Declaration”{ Ok: [] | [DecodedMemo]; }
Ok: [] | [
DecodedMemo]
The decoded memo, if the minter was able to decode it. This field is opt, so that other memo types can be
added in the future.
{ Err: [] | [DecodeLedgerMemoError]; }
Err: [] | [
DecodeLedgerMemoError]
An error in case the minter was not able to decode the provided memo. This field is opt, so that other error
types can be added in the future.
EventType
Section titled “EventType”EventType = {
received_utxos: {mint_txid: [] | [bigint];to_account:Account;utxos:Utxo[]; }; } | {schedule_deposit_reimbursement: {account:Account;amount:bigint;burn_block_index:bigint;reason:ReimbursementReason; }; } | {sent_transaction: {change_output: [] | [{value:bigint;vout:number; }];fee: [] | [bigint];requests:BigUint64Array;signed_tx: [] | [Uint8Array];submitted_at:bigint;txid:Uint8Array;utxos:Utxo[];withdrawal_fee: [] | [WithdrawalFee]; }; } | {distributed_kyt_fee: {amount:bigint;block_index:bigint;kyt_provider:Principal; }; } | {init:InitArgs; } | {upgrade:UpgradeArgs; } | {retrieve_btc_kyt_failed: {address:string;amount:bigint;block_index:bigint;kyt_provider:Principal;owner:Principal;uuid:string; }; } | {suspended_utxo: {account:Account;reason:SuspendedReason;utxo:Utxo; }; } | {accepted_retrieve_btc_request: {address:BitcoinAddress;amount:bigint;block_index:bigint;kyt_provider: [] | [Principal];received_at:bigint;reimbursement_account: [] | [Account]; }; } | {checked_utxo: {clean:boolean;kyt_provider: [] | [Principal];utxo:Utxo;uuid:string; }; } | {schedule_withdrawal_reimbursement: {account:Account;amount:bigint;burn_block_index:bigint;reason:WithdrawalReimbursementReason; }; } | {quarantined_withdrawal_reimbursement: {burn_block_index:bigint; }; } | {removed_retrieve_btc_request: {block_index:bigint; }; } | {confirmed_transaction: {txid:Uint8Array; }; } | {replaced_transaction: {change_output: {value:bigint;vout:number; };fee:bigint;new_txid:Uint8Array;new_utxos: [] | [Utxo[]];old_txid:Uint8Array;reason: [] | [ReplacedReason];submitted_at:bigint;withdrawal_fee: [] | [WithdrawalFee]; }; } | {checked_utxo_v2: {account:Account;utxo:Utxo; }; } | {ignored_utxo: {utxo:Utxo; }; } | {checked_utxo_mint_unknown: {account:Account;utxo:Utxo; }; } | {created_consolidate_utxos_request: {address:BitcoinAddress;amount:bigint;block_index:bigint;received_at:bigint; }; } | {reimbursed_failed_deposit: {burn_block_index:bigint;mint_block_index:bigint; }; } | {reimbursed_withdrawal: {burn_block_index:bigint;mint_block_index:bigint; }; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:156
Icrc21ConsentMessage
Section titled “Icrc21ConsentMessage”Icrc21ConsentMessage = {
FieldsDisplayMessage:Icrc21FieldsDisplay; } | {GenericDisplayMessage:string; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:285
Icrc21DeviceSpec
Section titled “Icrc21DeviceSpec”Icrc21DeviceSpec = {
GenericDisplay:null; } | {FieldsDisplay:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:306
Icrc21Error
Section titled “Icrc21Error”Icrc21Error = {
GenericError: {description:string;error_code:bigint; }; } | {InsufficientPayment:Icrc21ErrorInfo; } | {UnsupportedCanisterCall:Icrc21ErrorInfo; } | {ConsentMessageUnavailable:Icrc21ErrorInfo; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:309
Icrc21Value
Section titled “Icrc21Value”Icrc21Value = {
Text: {content:string; }; } | {TokenAmount: {amount:bigint;decimals:number;symbol:string; }; } | {TimestampSeconds: {amount:bigint; }; } | {DurationSeconds: {amount:bigint; }; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:323
InvalidTransactionError
Section titled “InvalidTransactionError”InvalidTransactionError =
object
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:405
Properties
Section titled “Properties”too_many_inputs
Section titled “too_many_inputs”too_many_inputs:
object
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:406
max_num_inputs
Section titled “max_num_inputs”max_num_inputs:
bigint
num_inputs
Section titled “num_inputs”num_inputs:
bigint
LogVisibility
Section titled “LogVisibility”LogVisibility = {
controllers:null; } | {public:null; } | {allowed_viewers:Principal[]; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:408
MemoType
Section titled “MemoType”MemoType = {
Burn:null; } | {Mint:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:412
MinterArg
Section titled “MinterArg”MinterArg = {
Upgrade: [] | [UpgradeArgs]; } | {Init:InitArgs; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:475
MintMemo
Section titled “MintMemo”MintMemo = {
Kyt:null; } | {ReimburseWithdrawal: {withdrawal_id:bigint; }; } | {KytFail: {associated_burn_index: [] | [bigint];kyt_fee: [] | [bigint];status: [] | [Status]; }; } | {Convert: {kyt_fee: [] | [bigint];txid: [] | [Uint8Array];vout: [] | [number]; }; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:423
Type Declaration
Section titled “Type Declaration”{ Kyt: null; }
Kyt:
null
[deprecated] The minter minted accumulated check fees to the KYT provider.
{ ReimburseWithdrawal: { withdrawal_id: bigint; }; }
ReimburseWithdrawal
Section titled “ReimburseWithdrawal”ReimburseWithdrawal:
object
ReimburseWithdrawal.withdrawal_id
Section titled “ReimburseWithdrawal.withdrawal_id”withdrawal_id:
bigint
The id corresponding to the withdrawal request, which corresponds to the ledger burn index.
{ KytFail: { associated_burn_index: [] | [bigint]; kyt_fee: [] | [bigint]; status: [] | [Status]; }; }
KytFail
Section titled “KytFail”KytFail:
object
[deprecated] The minter failed to check retrieve btc destination address or the destination address is tainted.
KytFail.associated_burn_index
Section titled “KytFail.associated_burn_index”associated_burn_index: [] | [
bigint]
KytFail.kyt_fee
Section titled “KytFail.kyt_fee”kyt_fee: [] | [
bigint]
The Bitcoin check fee.
KytFail.status
Section titled “KytFail.status”status: [] | [
Status]
The status of the Bitcoin check.
{ Convert: { kyt_fee: [] | [bigint]; txid: [] | [Uint8Array]; vout: [] | [number]; }; }
Convert
Section titled “Convert”Convert:
object
The minter converted a single UTXO to ckBTC.
Convert.kyt_fee
Section titled “Convert.kyt_fee”kyt_fee: [] | [
bigint]
The Bitcoin check fee.
Convert.txid
Section titled “Convert.txid”txid: [] | [
Uint8Array]
The transaction ID of the accepted UTXO.
Convert.vout
Section titled “Convert.vout”vout: [] | [
number]
UTXO’s output index within the BTC transaction.
Mode = {
RestrictedTo:Principal[]; } | {DepositsRestrictedTo:Principal[]; } | {ReadOnly:null; } | {GeneralAvailability:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:493
Type Declaration
Section titled “Type Declaration”{ RestrictedTo: Principal[]; }
RestrictedTo
Section titled “RestrictedTo”RestrictedTo:
Principal[]
Only specified principals can modify minter’s state.
{ DepositsRestrictedTo: Principal[]; }
DepositsRestrictedTo
Section titled “DepositsRestrictedTo”DepositsRestrictedTo:
Principal[]
Only specified principals can convert BTC to ckBTC.
{ ReadOnly: null; }
ReadOnly
Section titled “ReadOnly”ReadOnly:
null
The minter does not allow any state modifications.
{ GeneralAvailability: null; }
GeneralAvailability
Section titled “GeneralAvailability”GeneralAvailability:
null
Anyone can interact with the minter.
ReimbursementReason
Section titled “ReimbursementReason”ReimbursementReason = {
CallFailed:null; } | {TaintedDestination: {kyt_fee:bigint;kyt_provider:Principal; }; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:538
ReplacedReason
Section titled “ReplacedReason”ReplacedReason = {
to_cancel: {reason:WithdrawalReimbursementReason; }; } | {to_retry:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:546
RetrieveBtcError
Section titled “RetrieveBtcError”RetrieveBtcError = {
MalformedAddress:string; } | {GenericError: {error_code:bigint;error_message:string; }; } | {TemporarilyUnavailable:string; } | {AlreadyProcessing:null; } | {AmountTooLow:bigint; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:561
Type Declaration
Section titled “Type Declaration”{ MalformedAddress: string; }
MalformedAddress
Section titled “MalformedAddress”MalformedAddress:
string
The minter failed to parse the destination address.
{ GenericError: { error_code: bigint; error_message: string; }; }
GenericError
Section titled “GenericError”GenericError:
object
A generic error reserved for future extensions.
GenericError.error_code
Section titled “GenericError.error_code”error_code:
bigint
GenericError.error_message
Section titled “GenericError.error_message”error_message:
string
{ TemporarilyUnavailable: string; }
TemporarilyUnavailable
Section titled “TemporarilyUnavailable”TemporarilyUnavailable:
string
The minter is overloaded, retry the request. The payload contains a human-readable message explaining what caused the unavailability.
{ AlreadyProcessing: null; }
AlreadyProcessing
Section titled “AlreadyProcessing”AlreadyProcessing:
null
The minter is already processing another retrieval request for the same principal.
{ AmountTooLow: bigint; }
AmountTooLow
Section titled “AmountTooLow”AmountTooLow:
bigint
The withdrawal amount is too low. The payload contains the minimal withdrawal amount.
{ InsufficientFunds: { balance: bigint; }; }
InsufficientFunds
Section titled “InsufficientFunds”InsufficientFunds:
object
The ckBTC balance of the withdrawal account is too low.
InsufficientFunds.balance
Section titled “InsufficientFunds.balance”balance:
bigint
RetrieveBtcStatus
Section titled “RetrieveBtcStatus”RetrieveBtcStatus = {
Signing:null; } | {Confirmed: {txid:Uint8Array; }; } | {Sending: {txid:Uint8Array; }; } | {AmountTooLow:null; } | {Unknown:null; } | {Submitted: {txid:Uint8Array; }; } | {Pending:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:608
Type Declaration
Section titled “Type Declaration”{ Signing: null; }
Signing
Section titled “Signing”Signing:
null
The minter is obtaining all required ECDSA signatures on the Bitcoin transaction for this request.
{ Confirmed: { txid: Uint8Array; }; }
Confirmed
Section titled “Confirmed”Confirmed:
object
The minter received enough confirmations for the Bitcoin transaction for this request. The payload contains the identifier of the transaction on the Bitcoin network.
Confirmed.txid
Section titled “Confirmed.txid”txid:
Uint8Array
{ Sending: { txid: Uint8Array; }; }
Sending
Section titled “Sending”Sending:
object
The minter signed the transaction and is waiting for a reply from the Bitcoin canister.
Sending.txid
Section titled “Sending.txid”txid:
Uint8Array
{ AmountTooLow: null; }
AmountTooLow
Section titled “AmountTooLow”AmountTooLow:
null
The amount was too low to cover the transaction fees.
{ Unknown: null; }
Unknown
Section titled “Unknown”Unknown:
null
The minter does not have any information on the specified retrieval request. It can be that nobody submitted the request or the minter pruned the relevant information from the history to save space.
{ Submitted: { txid: Uint8Array; }; }
Submitted
Section titled “Submitted”Submitted:
object
The minter sent a transaction for the retrieve request. The payload contains the identifier of the transaction on the Bitcoin network.
Submitted.txid
Section titled “Submitted.txid”txid:
Uint8Array
{ Pending: null; }
Pending
Section titled “Pending”Pending:
null
The minter did not send a Bitcoin transaction for this request yet.
RetrieveBtcStatusV2
Section titled “RetrieveBtcStatusV2”RetrieveBtcStatusV2 = {
Signing:null; } | {Confirmed: {txid:Uint8Array; }; } | {Sending: {txid:Uint8Array; }; } | {AmountTooLow:null; } | {WillReimburse:ReimbursementRequest; } | {Unknown:null; } | {Submitted: {txid:Uint8Array; }; } | {Reimbursed:ReimbursedDeposit; } | {Pending:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:659
Type Declaration
Section titled “Type Declaration”{ Signing: null; }
Signing
Section titled “Signing”Signing:
null
The minter is obtaining all required ECDSA signatures on the Bitcoin transaction for this request.
{ Confirmed: { txid: Uint8Array; }; }
Confirmed
Section titled “Confirmed”Confirmed:
object
The minter received enough confirmations for the Bitcoin transaction for this request. The payload contains the identifier of the transaction on the Bitcoin network.
Confirmed.txid
Section titled “Confirmed.txid”txid:
Uint8Array
{ Sending: { txid: Uint8Array; }; }
Sending
Section titled “Sending”Sending:
object
The minter signed the transaction and is waiting for a reply from the Bitcoin canister.
Sending.txid
Section titled “Sending.txid”txid:
Uint8Array
{ AmountTooLow: null; }
AmountTooLow
Section titled “AmountTooLow”AmountTooLow:
null
The amount was too low to cover the transaction fees.
{ WillReimburse: ReimbursementRequest; }
WillReimburse
Section titled “WillReimburse”WillReimburse:
ReimbursementRequest
/ The minter will try to reimburse this transaction.
{ Unknown: null; }
Unknown
Section titled “Unknown”Unknown:
null
The minter does not have any information on the specified retrieval request. It can be that nobody submitted the request or the minter pruned the relevant information from the history to save space.
{ Submitted: { txid: Uint8Array; }; }
Submitted
Section titled “Submitted”Submitted:
object
The minter sent a transaction for the retrieve request. The payload contains the identifier of the transaction on the Bitcoin network.
Submitted.txid
Section titled “Submitted.txid”txid:
Uint8Array
{ Reimbursed: ReimbursedDeposit; }
Reimbursed
Section titled “Reimbursed”Reimbursed:
ReimbursedDeposit
/ The retrieve Bitcoin request has been reimbursed.
{ Pending: null; }
Pending
Section titled “Pending”Pending:
null
The minter did not send a Bitcoin transaction for this request yet.
RetrieveBtcWithApprovalError
Section titled “RetrieveBtcWithApprovalError”RetrieveBtcWithApprovalError = {
MalformedAddress:string; } | {GenericError: {error_code:bigint;error_message:string; }; } | {TemporarilyUnavailable:string; } | {InsufficientAllowance: {allowance:bigint; }; } | {AlreadyProcessing:null; } | {AmountTooLow:bigint; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:736
Type Declaration
Section titled “Type Declaration”{ MalformedAddress: string; }
MalformedAddress
Section titled “MalformedAddress”MalformedAddress:
string
The minter failed to parse the destination address.
{ GenericError: { error_code: bigint; error_message: string; }; }
GenericError
Section titled “GenericError”GenericError:
object
A generic error reserved for future extensions.
GenericError.error_code
Section titled “GenericError.error_code”error_code:
bigint
GenericError.error_message
Section titled “GenericError.error_message”error_message:
string
{ TemporarilyUnavailable: string; }
TemporarilyUnavailable
Section titled “TemporarilyUnavailable”TemporarilyUnavailable:
string
The minter is overloaded, retry the request. The payload contains a human-readable message explaining what caused the unavailability.
{ InsufficientAllowance: { allowance: bigint; }; }
InsufficientAllowance
Section titled “InsufficientAllowance”InsufficientAllowance:
object
The allowance given to the minter is too low.
InsufficientAllowance.allowance
Section titled “InsufficientAllowance.allowance”allowance:
bigint
{ AlreadyProcessing: null; }
AlreadyProcessing
Section titled “AlreadyProcessing”AlreadyProcessing:
null
The minter is already processing another retrieval request for the same principal.
{ AmountTooLow: bigint; }
AmountTooLow
Section titled “AmountTooLow”AmountTooLow:
bigint
The withdrawal amount is too low. The payload contains the minimal withdrawal amount.
{ InsufficientFunds: { balance: bigint; }; }
InsufficientFunds
Section titled “InsufficientFunds”InsufficientFunds:
object
The ckBTC balance of the withdrawal account is too low.
InsufficientFunds.balance
Section titled “InsufficientFunds.balance”balance:
bigint
Status
Section titled “Status”Status = {
CallFailed:null; } | {Rejected:null; } | {Accepted:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:782
Type Declaration
Section titled “Type Declaration”{ CallFailed: null; }
CallFailed
Section titled “CallFailed”CallFailed:
null
{ Rejected: null; }
Rejected
Section titled “Rejected”Rejected:
null
The minter rejected a retrieve_btc due to a failed Bitcoin check.
{ Accepted: null; }
Accepted
Section titled “Accepted”Accepted:
null
The minter accepted a retrieve_btc request.
SuspendedReason
Section titled “SuspendedReason”SuspendedReason = {
ValueTooSmall:null; } | {Quarantined:null; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:796
Type Declaration
Section titled “Type Declaration”{ ValueTooSmall: null; }
ValueTooSmall
Section titled “ValueTooSmall”ValueTooSmall:
null
The minter ignored this UTXO because UTXO’s value is too small to pay the check fees.
{ Quarantined: null; }
Quarantined
Section titled “Quarantined”Quarantined:
null
The Bitcoin checker considered this UTXO to be tainted.
Timestamp
Section titled “Timestamp”Timestamp =
bigint
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:818
Number of nanoseconds since the Unix Epoch
UpdateBalanceError
Section titled “UpdateBalanceError”UpdateBalanceError = {
GenericError: {error_code:bigint;error_message:string; }; } | {TemporarilyUnavailable:string; } | {AlreadyProcessing:null; } | {NoNewUtxos: {current_confirmations: [] | [number];pending_utxos: [] | [PendingUtxo[]];required_confirmations:number;suspended_utxos: [] | [SuspendedUtxo[]]; }; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:819
Type Declaration
Section titled “Type Declaration”{ GenericError: { error_code: bigint; error_message: string; }; }
GenericError
Section titled “GenericError”GenericError:
object
A generic error reserved for future extensions.
GenericError.error_code
Section titled “GenericError.error_code”error_code:
bigint
GenericError.error_message
Section titled “GenericError.error_message”error_message:
string
{ TemporarilyUnavailable: string; }
TemporarilyUnavailable
Section titled “TemporarilyUnavailable”TemporarilyUnavailable:
string
The minter is overloaded, retry the request. The payload contains a human-readable message explaining what caused the unavailability.
{ AlreadyProcessing: null; }
AlreadyProcessing
Section titled “AlreadyProcessing”AlreadyProcessing:
null
The minter is already processing another update balance request for the caller.
{ NoNewUtxos: { current_confirmations: [] | [number]; pending_utxos: [] | [PendingUtxo[]]; required_confirmations: number; suspended_utxos: [] | [SuspendedUtxo[]]; }; }
NoNewUtxos
Section titled “NoNewUtxos”NoNewUtxos:
object
There are no new UTXOs to process.
NoNewUtxos.current_confirmations
Section titled “NoNewUtxos.current_confirmations”current_confirmations: [] | [
number]
NoNewUtxos.pending_utxos
Section titled “NoNewUtxos.pending_utxos”pending_utxos: [] | [
PendingUtxo[]]
NoNewUtxos.required_confirmations
Section titled “NoNewUtxos.required_confirmations”required_confirmations:
number
NoNewUtxos.suspended_utxos
Section titled “NoNewUtxos.suspended_utxos”suspended_utxos: [] | [
SuspendedUtxo[]]
UtxoStatus
Section titled “UtxoStatus”UtxoStatus = {
ValueTooSmall:Utxo; } | {Tainted:Utxo; } | {Minted: {block_index:bigint;minted_amount:bigint;utxo:Utxo; }; } | {Checked:Utxo; }
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:914
The result of an [update_balance] call.
Type Declaration
Section titled “Type Declaration”{ ValueTooSmall: Utxo; }
ValueTooSmall
Section titled “ValueTooSmall”ValueTooSmall:
Utxo
The minter ignored this UTXO because UTXO’s value is too small to pay the check fees.
{ Tainted: Utxo; }
Tainted
Section titled “Tainted”Tainted:
Utxo
The Bitcoin checker considered this UTXO to be tainted.
{ Minted: { block_index: bigint; minted_amount: bigint; utxo: Utxo; }; }
Minted
Section titled “Minted”Minted:
object
The UTXO passed the Bitcoin check, and ckBTC has been minted.
Minted.block_index
Section titled “Minted.block_index”block_index:
bigint
Minted.minted_amount
Section titled “Minted.minted_amount”minted_amount:
bigint
Minted.utxo
Section titled “Minted.utxo”utxo:
Utxo
{ Checked: Utxo; }
Checked
Section titled “Checked”Checked:
Utxo
The UTXO passed the Bitcoin check, but the minter failed to mint ckBTC because the Ledger was unavailable. Retrying the [update_balance] call should eventually advance the UTXO to the [Minted] state.
WithdrawalReimbursementReason
Section titled “WithdrawalReimbursementReason”WithdrawalReimbursementReason =
object
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:950
Properties
Section titled “Properties”invalid_transaction
Section titled “invalid_transaction”invalid_transaction:
InvalidTransactionError
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:951
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1116
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:1117
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]