_SERVICE
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:897
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:902
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:910
/ 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:922
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:926
get_deposit_fee
Section titled “get_deposit_fee”get_deposit_fee:
ActorMethod<[],bigint>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:930
/ 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:942
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:949
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:957
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:962
Returns the account to which the caller should deposit ckBTC before withdrawing BTC using the [retrieve_btc] endpoint.
retrieve_btc
Section titled “retrieve_btc”retrieve_btc:
ActorMethod<[RetrieveBtcArgs], {Ok:RetrieveBtcOk; } | {Err:RetrieveBtcError; }>
Defined in: packages/canisters/src/declarations/ckbtc/minter.d.ts:978
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:986
/ [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:993
/ 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:1005
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:1024
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:1038
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.