CkEthMinterDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:978
Properties
Section titled “Properties”add_ckerc20_token
Section titled “add_ckerc20_token”add_ckerc20_token:
ActorMethod<[AddCkErc20Token],undefined>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:983
Add a ckERC-20 token to be supported by the minter. This call is restricted to the orchestrator ID.
decode_ledger_memo
Section titled “decode_ledger_memo”decode_ledger_memo:
ActorMethod<[DecodeLedgerMemoArgs],DecodeLedgerMemoResult>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:987
Decode ledger memos produced by the minter when minting (deposits) or burning (withdrawals).
eip_1559_transaction_price
Section titled “eip_1559_transaction_price”eip_1559_transaction_price:
ActorMethod<[[] | [Eip1559TransactionPriceArg]],Eip1559TransactionPrice>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:994
Estimate the price of a transaction issued by the minter when converting ckETH to ETH.
get_canister_status
Section titled “get_canister_status”get_canister_status:
ActorMethod<[],CanisterStatusResponse>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1003
Retrieve the status of the minter canister.
This is a debug endpoint where backwards-compatibility is not guaranteed.
get_events
Section titled “get_events”get_events:
ActorMethod<[{length:bigint;start:bigint; }], {events:Event[];total_event_count:bigint; }>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1009
Retrieve events from the minter’s audit log. The endpoint can return fewer events than requested to bound the response size. IMPORTANT: this endpoint is meant as a debugging tool and is not guaranteed to be backwards-compatible.
get_minter_info
Section titled “get_minter_info”get_minter_info:
ActorMethod<[],MinterInfo>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1016
Returns internal minter parameters
is_address_blocked
Section titled “is_address_blocked”is_address_blocked:
ActorMethod<[string],boolean>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1020
Check if an address is blocked by the minter.
minter_address
Section titled “minter_address”minter_address:
ActorMethod<[],string>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1028
Retrieve the Ethereum address controlled by the minter:
- Deposits will be transferred from the helper smart contract to this address
- Withdrawals will originate from this address IMPORTANT: Do NOT send ETH to this address directly. Use the helper smart contract instead so that the minter knows to which IC principal the funds should be deposited.
retrieve_eth_status
Section titled “retrieve_eth_status”retrieve_eth_status:
ActorMethod<[bigint],RetrieveEthStatus>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1032
Retrieve the status of a Eth withdrawal request.
smart_contract_address
Section titled “smart_contract_address”smart_contract_address:
ActorMethod<[],string>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1041
Address of the helper smart contract. Returns “N/A” if the helper smart contract is not set. IMPORTANT:
- Use this address to send ETH to the minter to convert it to ckETH.
- In case the smart contract needs to be updated the returned address will change! Always check the address before making a transfer.
withdraw_erc20
Section titled “withdraw_erc20”withdraw_erc20:
ActorMethod<[WithdrawErc20Arg], {Ok:RetrieveErc20Request; } | {Err:WithdrawErc20Error; }>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1045
Withdraw the specified amount of ERC-20 tokens to the given Ethereum address.
withdraw_eth
Section titled “withdraw_eth”withdraw_eth:
ActorMethod<[WithdrawalArg], {Ok:RetrieveEthRequest; } | {Err:WithdrawalError; }>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1053
Withdraw the specified amount in Wei to the given Ethereum address. IMPORTANT: The current gas limit is set to 21,000 for a transaction so withdrawals to smart contract addresses will likely fail.
withdrawal_status
Section titled “withdrawal_status”withdrawal_status:
ActorMethod<[WithdrawalSearchParameter],WithdrawalDetail[]>
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1060
Return details of all withdrawals matching the given search parameter.
Account
Section titled “Account”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:16
ICRC-1 account type.
Properties
Section titled “Properties”owner:
Principal
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:17
subaccount
Section titled “subaccount”subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:18
AddCkErc20Token
Section titled “AddCkErc20Token”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:20
Properties
Section titled “Properties”address
Section titled “address”address:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:32
The Ethereum address of the ERC-20 smart contract.
chain_id
Section titled “chain_id”chain_id:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:28
Ethereum chain ID.
ckerc20_ledger_id
Section titled “ckerc20_ledger_id”ckerc20_ledger_id:
Principal
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:24
The ledger ID for that ckERC20 token.
ckerc20_token_symbol
Section titled “ckerc20_token_symbol”ckerc20_token_symbol:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:36
The ckERC20 token symbol on the ledger.
CanisterStatusResponse
Section titled “CanisterStatusResponse”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:104
Properties
Section titled “Properties”cycles
Section titled “cycles”cycles:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:110
idle_cycles_burned_per_day
Section titled “idle_cycles_burned_per_day”idle_cycles_burned_per_day:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:113
memory_metrics
Section titled “memory_metrics”memory_metrics:
MemoryMetrics
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:105
memory_size
Section titled “memory_size”memory_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:107
module_hash
Section titled “module_hash”module_hash: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:114
query_stats
Section titled “query_stats”query_stats:
QueryStats
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:112
ready_for_migration
Section titled “ready_for_migration”ready_for_migration:
boolean
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:108
reserved_cycles
Section titled “reserved_cycles”reserved_cycles:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:115
settings
Section titled “settings”settings:
DefiniteCanisterSettings
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:111
status
Section titled “status”status:
CanisterStatusType
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:106
version
Section titled “version”version:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:109
CkErc20Token
Section titled “CkErc20Token”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:121
Properties
Section titled “Properties”ckerc20_token_symbol
Section titled “ckerc20_token_symbol”ckerc20_token_symbol:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:124
erc20_contract_address
Section titled “erc20_contract_address”erc20_contract_address:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:122
ledger_canister_id
Section titled “ledger_canister_id”ledger_canister_id:
Principal
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:123
DecodeLedgerMemoArgs
Section titled “DecodeLedgerMemoArgs”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:126
Properties
Section titled “Properties”encoded_memo
Section titled “encoded_memo”encoded_memo:
Uint8Array
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:134
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/cketh/minter.d.ts:130
The encoded memo type
DefiniteCanisterSettings
Section titled “DefiniteCanisterSettings”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:170
Properties
Section titled “Properties”compute_allocation
Section titled “compute_allocation”compute_allocation:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:179
controllers
Section titled “controllers”controllers:
Principal[]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:174
environment_variables
Section titled “environment_variables”environment_variables:
environment_variable[]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:173
freezing_threshold
Section titled “freezing_threshold”freezing_threshold:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:171
log_visibility
Section titled “log_visibility”log_visibility:
LogVisibility
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:176
memory_allocation
Section titled “memory_allocation”memory_allocation:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:178
reserved_cycles_limit
Section titled “reserved_cycles_limit”reserved_cycles_limit:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:175
wasm_memory_limit
Section titled “wasm_memory_limit”wasm_memory_limit:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:177
wasm_memory_threshold
Section titled “wasm_memory_threshold”wasm_memory_threshold:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:172
Eip1559TransactionPrice
Section titled “Eip1559TransactionPrice”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:186
Estimate price of an EIP-1559 transaction when converting ckETH to ETH or ckERC20 to ERC20, see https://eips.ethereum.org/EIPS/eip-1559
Properties
Section titled “Properties”gas_limit
Section titled “gas_limit”gas_limit:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:210
Maximum amount of gas transaction is authorized to consume.
max_fee_per_gas
Section titled “max_fee_per_gas”max_fee_per_gas:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:196
Maximum amount of Wei per gas unit that the transaction is willing to pay in total.
This covers the base fee determined by the network and the max_priority_fee_per_gas.
max_priority_fee_per_gas
Section titled “max_priority_fee_per_gas”max_priority_fee_per_gas:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:191
Maximum amount of Wei per gas unit that the transaction gives to miners to incentivize them to include their transaction (priority fee).
max_transaction_fee
Section titled “max_transaction_fee”max_transaction_fee:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:201
Maximum amount of Wei that can be charged for the transaction,
computed as max_fee_per_gas * gas_limit
timestamp
Section titled “timestamp”timestamp: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:206
Timestamp of when the price was estimated. Nanoseconds since the UNIX epoch.
Eip1559TransactionPriceArg
Section titled “Eip1559TransactionPriceArg”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:217
Argument to Eip1559TransactionPrice. When specified, it is to lookup transaction price for a ckERC20 token withdrawal. When not specified (null), it is for ETH withdrawal.
Properties
Section titled “Properties”ckerc20_ledger_id
Section titled “ckerc20_ledger_id”ckerc20_ledger_id:
Principal
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:221
The ledger ID for that ckERC20 token.
environment_variable
Section titled “environment_variable”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:974
Properties
Section titled “Properties”name:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:976
value:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:975
EthTransaction
Section titled “EthTransaction”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:223
Properties
Section titled “Properties”transaction_hash
Section titled “transaction_hash”transaction_hash:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:224
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:239
Properties
Section titled “Properties”payload
Section titled “payload”payload: {
SkippedBlock: {block_number:bigint;contract_address: [] | [string]; }; } | {AcceptedErc20Deposit: {block_number:bigint;erc20_contract_address:string;from_address:string;log_index:bigint;principal:Principal;subaccount: [] | [Subaccount];transaction_hash:string;value:bigint; }; } | {SignedTransaction: {raw_transaction:string;withdrawal_id:bigint; }; } | {Upgrade:UpgradeArg; } | {Init:InitArg; } | {AddedCkErc20Token: {address:string;chain_id:bigint;ckerc20_ledger_id:Principal;ckerc20_token_symbol:string; }; } | {SyncedDepositWithSubaccountToBlock: {block_number:bigint; }; } | {QuarantinedDeposit: {event_source:EventSource; }; } | {SyncedToBlock: {block_number:bigint; }; } | {AcceptedDeposit: {block_number:bigint;from_address:string;log_index:bigint;principal:Principal;subaccount: [] | [Subaccount];transaction_hash:string;value:bigint; }; } | {ReplacedTransaction: {transaction:UnsignedTransaction;withdrawal_id:bigint; }; } | {QuarantinedReimbursement: {index:ReimbursementIndex; }; } | {MintedCkEth: {event_source:EventSource;mint_block_index:bigint; }; } | {ReimbursedEthWithdrawal: {reimbursed_amount:bigint;reimbursed_in_block:bigint;transaction_hash: [] | [string];withdrawal_id:bigint; }; } | {FailedErc20WithdrawalRequest: {reimbursed_amount:bigint;to:Principal;to_subaccount: [] | [Uint8Array<ArrayBufferLike>];withdrawal_id:bigint; }; } | {ReimbursedErc20Withdrawal: {burn_in_block:bigint;ledger_id:Principal;reimbursed_amount:bigint;reimbursed_in_block:bigint;transaction_hash: [] | [string];withdrawal_id:bigint; }; } | {MintedCkErc20: {ckerc20_token_symbol:string;erc20_contract_address:string;event_source:EventSource;mint_block_index:bigint; }; } | {CreatedTransaction: {transaction:UnsignedTransaction;withdrawal_id:bigint; }; } | {InvalidDeposit: {event_source:EventSource;reason:string; }; } | {SyncedErc20ToBlock: {block_number:bigint; }; } | {AcceptedErc20WithdrawalRequest: {ckerc20_ledger_burn_index:bigint;ckerc20_ledger_id:Principal;cketh_ledger_burn_index:bigint;created_at:bigint;destination:string;erc20_contract_address:string;from:Principal;from_subaccount: [] | [Uint8Array<ArrayBufferLike>];max_transaction_fee:bigint;withdrawal_amount:bigint; }; } | {AcceptedEthWithdrawalRequest: {created_at: [] | [bigint];destination:string;from:Principal;from_subaccount: [] | [Uint8Array<ArrayBufferLike>];ledger_burn_index:bigint;withdrawal_amount:bigint; }; } | {FinalizedTransaction: {transaction_receipt:TransactionReceipt;withdrawal_id:bigint; }; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:241
timestamp
Section titled “timestamp”timestamp:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:240
EventSource
Section titled “EventSource”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:376
Properties
Section titled “Properties”log_index
Section titled “log_index”log_index:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:378
transaction_hash
Section titled “transaction_hash”transaction_hash:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:377
GasFeeEstimate
Section titled “GasFeeEstimate”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:380
Properties
Section titled “Properties”max_fee_per_gas
Section titled “max_fee_per_gas”max_fee_per_gas:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:390
Maximum amount of Wei per gas unit that the transaction is willing to pay in total.
This covers the base fee determined by the network and the max_priority_fee_per_gas.
max_priority_fee_per_gas
Section titled “max_priority_fee_per_gas”max_priority_fee_per_gas:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:385
Maximum amount of Wei per gas unit that the transaction gives to miners to incentivize them to include their transaction (priority fee).
timestamp
Section titled “timestamp”timestamp:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:395
Timestamp of when the price was estimated. Nanoseconds since the UNIX epoch.
InitArg
Section titled “InitArg”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:400
The initialization parameters of the minter canister.
Properties
Section titled “Properties”ecdsa_key_name
Section titled “ecdsa_key_name”ecdsa_key_name:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:414
The name of the ECDSA key to use. E.g., “dfx_test_key” on the local replica.
ethereum_block_height
Section titled “ethereum_block_height”ethereum_block_height:
BlockTag
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:442
Determine ethereum block height observed by minter.
ethereum_contract_address
Section titled “ethereum_contract_address”ethereum_contract_address: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:434
Address of the helper smart contract.
ethereum_network
Section titled “ethereum_network”ethereum_network:
EthereumNetwork
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:404
The minter will interact with this Ethereum network.
evm_rpc_id
Section titled “evm_rpc_id”evm_rpc_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:424
The principal of the EVM RPC canister that handles the communication with the Ethereum blockchain. If not specified, uses the production or staging EVM RPC canister based on the ethereum_network field.
last_scraped_block_number
Section titled “last_scraped_block_number”last_scraped_block_number:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:409
Block number to start scrapping from on the Ethereum network.
Scrapping the logs will resume at last_scraped_block_number + 1 (inclusive).
ledger_id
Section titled “ledger_id”ledger_id:
Principal
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:430
The principal of the ledger that handles ckETH transfers. The default account of the ckETH minter must be configured as the minting account of the ledger.
minimum_withdrawal_amount
Section titled “minimum_withdrawal_amount”minimum_withdrawal_amount:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:438
Minimum amount in Wei that can be withdrawn.
next_transaction_nonce
Section titled “next_transaction_nonce”next_transaction_nonce:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:418
Nonce of the next transaction to be sent to the Ethereum network.
MemoryMetrics
Section titled “MemoryMetrics”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:490
Properties
Section titled “Properties”canister_history_size
Section titled “canister_history_size”canister_history_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:493
custom_sections_size
Section titled “custom_sections_size”custom_sections_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:498
global_memory_size
Section titled “global_memory_size”global_memory_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:497
snapshots_size
Section titled “snapshots_size”snapshots_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:495
stable_memory_size
Section titled “stable_memory_size”stable_memory_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:494
wasm_binary_size
Section titled “wasm_binary_size”wasm_binary_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:491
wasm_chunk_store_size
Section titled “wasm_chunk_store_size”wasm_chunk_store_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:492
wasm_memory_size
Section titled “wasm_memory_size”wasm_memory_size:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:496
MinterInfo
Section titled “MinterInfo”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:545
Properties
Section titled “Properties”cketh_ledger_id
Section titled “cketh_ledger_id”cketh_ledger_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:587
Canister ID of the ckETH ledger.
deposit_with_subaccount_helper_contract_address
Section titled “deposit_with_subaccount_helper_contract_address”deposit_with_subaccount_helper_contract_address: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:549
Address of the ETH or ERC20 deposit with subaccount helper smart contract.
erc20_balances
Section titled “erc20_balances”erc20_balances: [] | [
object[]]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:605
Amount of ETH in Wei controlled by the minter.
This might be less that the actual amount available on the minter_address().
erc20_helper_contract_address
Section titled “erc20_helper_contract_address”erc20_helper_contract_address: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:571
Address of the ERC20 helper smart contract
eth_balance
Section titled “eth_balance”eth_balance: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:554
Amount of ETH in Wei controlled by the minter.
This might be less that the actual amount available on the minter_address().
eth_helper_contract_address
Section titled “eth_helper_contract_address”eth_helper_contract_address: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:558
Address of the ETH helper smart contract.
ethereum_block_height
Section titled “ethereum_block_height”ethereum_block_height: [] | [
BlockTag]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:619
Determine ethereum block height observed by minter.
evm_rpc_id
Section titled “evm_rpc_id”evm_rpc_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:567
Canister ID of the EVM RPC canister that handles the communication with the Ethereum blockchain.
last_deposit_with_subaccount_scraped_block_number
Section titled “last_deposit_with_subaccount_scraped_block_number”last_deposit_with_subaccount_scraped_block_number: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:615
Last scraped block number for logs of the deposit with subaccount helper contract.
last_erc20_scraped_block_number
Section titled “last_erc20_scraped_block_number”last_erc20_scraped_block_number: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:575
Last scraped block number for logs of the ERC20 helper contract.
last_eth_scraped_block_number
Section titled “last_eth_scraped_block_number”last_eth_scraped_block_number: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:596
Last scraped block number for logs of the ETH helper contract.
last_gas_fee_estimate
Section titled “last_gas_fee_estimate”last_gas_fee_estimate: [] | [
GasFeeEstimate]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:583
Last gas fee estimate.
last_observed_block_number
Section titled “last_observed_block_number”last_observed_block_number: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:562
Last Ethereum block number observed by the minter.
minimum_withdrawal_amount
Section titled “minimum_withdrawal_amount”minimum_withdrawal_amount: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:600
Minimum amount in Wei that can be withdrawn when converting ckETH -> ETH.
minter_address
Section titled “minter_address”minter_address: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:611
Ethereum address controlled by the minter via threshold ECDSA.
smart_contract_address
Section titled “smart_contract_address”smart_contract_address: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:592
(Deprecated) Address of the ETH helper smart contract.
Use eth_helper_contract_address.
supported_ckerc20_tokens
Section titled “supported_ckerc20_tokens”supported_ckerc20_tokens: [] | [
CkErc20Token[]]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:579
Information of supported ERC20 tokens.
QueryStats
Section titled “QueryStats”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:621
Properties
Section titled “Properties”num_calls_total
Section titled “num_calls_total”num_calls_total:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:624
num_instructions_total
Section titled “num_instructions_total”num_instructions_total:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:623
request_payload_bytes_total
Section titled “request_payload_bytes_total”request_payload_bytes_total:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:625
response_payload_bytes_total
Section titled “response_payload_bytes_total”response_payload_bytes_total:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:622
RetrieveErc20Request
Section titled “RetrieveErc20Request”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:636
Properties
Section titled “Properties”ckerc20_block_index
Section titled “ckerc20_block_index”ckerc20_block_index:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:640
Burn index on the ledger handling the withdrawn ckERC20 token.
cketh_block_index
Section titled “cketh_block_index”cketh_block_index:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:645
Burn index on the ckETH ledger. ckETH is needed to pay for the transaction fees.
RetrieveEthRequest
Section titled “RetrieveEthRequest”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:647
Properties
Section titled “Properties”block_index
Section titled “block_index”block_index:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:648
TransactionReceipt
Section titled “TransactionReceipt”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:686
Properties
Section titled “Properties”block_hash
Section titled “block_hash”block_hash:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:690
block_number
Section titled “block_number”block_number:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:691
effective_gas_price
Section titled “effective_gas_price”effective_gas_price:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:687
gas_used
Section titled “gas_used”gas_used:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:692
status
Section titled “status”status: {
Success:null; } | {Failure:null; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:688
transaction_hash
Section titled “transaction_hash”transaction_hash:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:689
UnsignedTransaction
Section titled “UnsignedTransaction”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:723
Properties
Section titled “Properties”access_list
Section titled “access_list”access_list:
object[]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:732
address
Section titled “address”address:
string
storage_keys
Section titled “storage_keys”storage_keys:
Uint8Array<ArrayBufferLike>[]
chain_id
Section titled “chain_id”chain_id:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:729
data:
Uint8Array
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:727
destination
Section titled “destination”destination:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:724
gas_limit
Section titled “gas_limit”gas_limit:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:731
max_fee_per_gas
Section titled “max_fee_per_gas”max_fee_per_gas:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:728
max_priority_fee_per_gas
Section titled “max_priority_fee_per_gas”max_priority_fee_per_gas:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:726
nonce:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:730
value:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:725
UpgradeArg
Section titled “UpgradeArg”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:734
Properties
Section titled “Properties”deposit_with_subaccount_helper_contract_address
Section titled “deposit_with_subaccount_helper_contract_address”deposit_with_subaccount_helper_contract_address: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:738
Change the deposit with subaccount helper smart contract address.
erc20_helper_contract_address
Section titled “erc20_helper_contract_address”erc20_helper_contract_address: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:756
Change the ERC-20 helper smart contract address.
ethereum_block_height
Section titled “ethereum_block_height”ethereum_block_height: [] | [
BlockTag]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:776
Change the ethereum block height observed by the minter.
ethereum_contract_address
Section titled “ethereum_contract_address”ethereum_contract_address: [] | [
string]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:764
Change the ETH helper smart contract address.
evm_rpc_id
Section titled “evm_rpc_id”evm_rpc_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:747
The principal of the EVM RPC canister that handles the communication with the Ethereum blockchain.
last_deposit_with_subaccount_scraped_block_number
Section titled “last_deposit_with_subaccount_scraped_block_number”last_deposit_with_subaccount_scraped_block_number: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:772
Change the last scraped block number of the deposit with subaccount helper smart contract.
last_erc20_scraped_block_number
Section titled “last_erc20_scraped_block_number”last_erc20_scraped_block_number: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:760
Change the last scraped block number of the ERC-20 helper smart contract.
ledger_suite_orchestrator_id
Section titled “ledger_suite_orchestrator_id”ledger_suite_orchestrator_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:752
The principal of the ledger suite orchestrator that handles the ICRC1 ledger suites for all ckERC20 tokens.
minimum_withdrawal_amount
Section titled “minimum_withdrawal_amount”minimum_withdrawal_amount: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:768
Change the minimum amount in Wei that can be withdrawn.
next_transaction_nonce
Section titled “next_transaction_nonce”next_transaction_nonce: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:742
Change the nonce of the next transaction to be sent to the Ethereum network.
WithdrawalArg
Section titled “WithdrawalArg”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:839
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:851
The amount of ckETH in Wei that the client wants to withdraw.
from_subaccount
Section titled “from_subaccount”from_subaccount: [] | [
Subaccount]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:847
The subaccount to burn ckETH from.
recipient
Section titled “recipient”recipient:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:843
The address to which the minter should deposit ETH.
WithdrawalDetail
Section titled “WithdrawalDetail”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:856
Details of a withdrawal request and its status.
Properties
Section titled “Properties”from:
Principal
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:876
Sender’s principal.
from_subaccount
Section titled “from_subaccount”from_subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:880
Sender’s subaccount (if given).
max_transaction_fee
Section titled “max_transaction_fee”max_transaction_fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:884
Max transaction fee in Wei (transaction fee paid by the sender).
recipient_address
Section titled “recipient_address”recipient_address:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:888
Address to send tokens to.
status
Section titled “status”status:
WithdrawalStatus
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:860
Withdrawal status
token_symbol
Section titled “token_symbol”token_symbol:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:864
Symbol of the withdrawal token (either ckETH or ckERC20 token symbol).
withdrawal_amount
Section titled “withdrawal_amount”withdrawal_amount:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:868
Amount of tokens in base unit that was withdrawn.
withdrawal_id
Section titled “withdrawal_id”withdrawal_id:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:872
Withdrawal id (i.e. burn index on the ckETH ledger).
WithdrawErc20Arg
Section titled “WithdrawErc20Arg”Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:778
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:800
Amount of tokens to withdraw. The amount is in the smallest unit of the token, e.g., ckUSDC uses 6 decimals and so to withdraw 1 ckUSDC, the amount should be 1_000_000.
ckerc20_ledger_id
Section titled “ckerc20_ledger_id”ckerc20_ledger_id:
Principal
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:782
The ledger ID for that ckERC20 token.
from_ckerc20_subaccount
Section titled “from_ckerc20_subaccount”from_ckerc20_subaccount: [] | [
Subaccount]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:794
The subaccount to burn ckERC20 from.
from_cketh_subaccount
Section titled “from_cketh_subaccount”from_cketh_subaccount: [] | [
Subaccount]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:790
The subaccount to burn ckETH from to pay for the transaction fee.
recipient
Section titled “recipient”recipient:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:786
Ethereum address to withdraw to.
Type Aliases
Section titled “Type Aliases”BlockTag
Section titled “BlockTag”BlockTag = {
Safe:null; } | {Finalized:null; } | {Latest:null; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:38
Type Declaration
Section titled “Type Declaration”{ Safe: null; }
Safe:
null
/ The latest safe head block.
{ Finalized: null; }
Finalized
Section titled “Finalized”Finalized:
null
/ The latest finalized block.
{ Latest: null; }
Latest
Section titled “Latest”Latest:
null
/ The latest mined block.
BurnMemo
Section titled “BurnMemo”BurnMemo = {
Erc20Convert: {ckerc20_withdrawal_id:bigint;to_address:string; }; } | {Erc20GasFee: {ckerc20_token_symbol:string;ckerc20_withdrawal_amount:bigint;to_address:string; }; } | {Convert: {to_address:string; }; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:57
Type Declaration
Section titled “Type Declaration”{ Erc20Convert: { ckerc20_withdrawal_id: bigint; to_address: string; }; }
Erc20Convert
Section titled “Erc20Convert”Erc20Convert:
object
The minter processed a ckERC20 withdrawal request.
Erc20Convert.ckerc20_withdrawal_id
Section titled “Erc20Convert.ckerc20_withdrawal_id”ckerc20_withdrawal_id:
bigint
ckETH ledger burn index identifying the burn to pay for the transaction fee.
Erc20Convert.to_address
Section titled “Erc20Convert.to_address”to_address:
string
The destination of the withdrawal request.
{ Erc20GasFee: { ckerc20_token_symbol: string; ckerc20_withdrawal_amount: bigint; to_address: string; }; }
Erc20GasFee
Section titled “Erc20GasFee”Erc20GasFee:
object
The minter processed a ckERC20 withdrawal request and that burn pays the transaction fee.
Erc20GasFee.ckerc20_token_symbol
Section titled “Erc20GasFee.ckerc20_token_symbol”ckerc20_token_symbol:
string
ckERC20 token symbol of the withdrawal request.
Erc20GasFee.ckerc20_withdrawal_amount
Section titled “Erc20GasFee.ckerc20_withdrawal_amount”ckerc20_withdrawal_amount:
bigint
The amount of the ckERC20 withdrawal request.
Erc20GasFee.to_address
Section titled “Erc20GasFee.to_address”to_address:
string
The destination of the withdrawal request.
{ Convert: { to_address: string; }; }
Convert
Section titled “Convert”Convert:
object
The minter processed a withdrawal request.
Convert.to_address
Section titled “Convert.to_address”to_address:
string
The destination of the withdrawal request.
CanisterStatusType
Section titled “CanisterStatusType”CanisterStatusType = {
stopped:null; } | {stopping:null; } | {running:null; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:117
DecodedMemo
Section titled “DecodedMemo”DecodedMemo = {
Burn: [] | [BurnMemo]; } | {Mint: [] | [MintMemo]; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:157
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/cketh/minter.d.ts:136
Properties
Section titled “Properties”InvalidMemo
Section titled “InvalidMemo”InvalidMemo:
string
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:140
The provided memo could not be decoded.
DecodeLedgerMemoResult
Section titled “DecodeLedgerMemoResult”DecodeLedgerMemoResult = {
Ok: [] | [DecodedMemo]; } | {Err: [] | [DecodeLedgerMemoError]; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:142
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.
EthereumNetwork
Section titled “EthereumNetwork”EthereumNetwork = {
Mainnet:null; } | {Sepolia:null; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:226
Type Declaration
Section titled “Type Declaration”{ Mainnet: null; }
Mainnet
Section titled “Mainnet”Mainnet:
null
The public Ethereum mainnet.
{ Sepolia: null; }
Sepolia
Section titled “Sepolia”Sepolia:
null
The public Ethereum Sepolia testnet.
LedgerError
Section titled “LedgerError”LedgerError = {
TemporarilyUnavailable:string; } | {InsufficientAllowance: {allowance:bigint;failed_burn_amount:bigint;ledger_id:Principal;token_symbol:string; }; } | {AmountTooLow: {failed_burn_amount:bigint;ledger_id:Principal;minimum_burn_amount:bigint;token_symbol:string; }; } | {InsufficientFunds: {balance:bigint;failed_burn_amount:bigint;ledger_id:Principal;token_symbol:string; }; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:444
Type Declaration
Section titled “Type Declaration”{ TemporarilyUnavailable: string; }
TemporarilyUnavailable
Section titled “TemporarilyUnavailable”TemporarilyUnavailable:
string
The ledger is overloaded, retry the request. The payload contains a human-readable message explaining what caused the unavailability.
{ InsufficientAllowance: { allowance: bigint; failed_burn_amount: bigint; ledger_id: Principal; token_symbol: string; }; }
InsufficientAllowance
Section titled “InsufficientAllowance”InsufficientAllowance:
object
The allowance given to the minter is too low.
InsufficientAllowance.allowance
Section titled “InsufficientAllowance.allowance”allowance:
bigint
InsufficientAllowance.failed_burn_amount
Section titled “InsufficientAllowance.failed_burn_amount”failed_burn_amount:
bigint
InsufficientAllowance.ledger_id
Section titled “InsufficientAllowance.ledger_id”ledger_id:
Principal
InsufficientAllowance.token_symbol
Section titled “InsufficientAllowance.token_symbol”token_symbol:
string
{ AmountTooLow: { failed_burn_amount: bigint; ledger_id: Principal; minimum_burn_amount: bigint; token_symbol: string; }; }
AmountTooLow
Section titled “AmountTooLow”AmountTooLow:
object
The withdrawal amount is too low and doesn’t cover the ledger transaction fee.
AmountTooLow.failed_burn_amount
Section titled “AmountTooLow.failed_burn_amount”failed_burn_amount:
bigint
AmountTooLow.ledger_id
Section titled “AmountTooLow.ledger_id”ledger_id:
Principal
AmountTooLow.minimum_burn_amount
Section titled “AmountTooLow.minimum_burn_amount”minimum_burn_amount:
bigint
AmountTooLow.token_symbol
Section titled “AmountTooLow.token_symbol”token_symbol:
string
{ InsufficientFunds: { balance: bigint; failed_burn_amount: bigint; ledger_id: Principal; token_symbol: string; }; }
InsufficientFunds
Section titled “InsufficientFunds”InsufficientFunds:
object
The balance of the withdrawal account is too low.
InsufficientFunds.balance
Section titled “InsufficientFunds.balance”balance:
bigint
InsufficientFunds.failed_burn_amount
Section titled “InsufficientFunds.failed_burn_amount”failed_burn_amount:
bigint
InsufficientFunds.ledger_id
Section titled “InsufficientFunds.ledger_id”ledger_id:
Principal
InsufficientFunds.token_symbol
Section titled “InsufficientFunds.token_symbol”token_symbol:
string
LogVisibility
Section titled “LogVisibility”LogVisibility = {
controllers:null; } | {public:null; } | {allowed_viewers:Principal[]; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:485
MemoType
Section titled “MemoType”MemoType = {
Burn:null; } | {Mint:null; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:489
MinterArg
Section titled “MinterArg”MinterArg = {
UpgradeArg:UpgradeArg; } | {InitArg:InitArg; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:544
MintMemo
Section titled “MintMemo”MintMemo = {
ReimburseWithdrawal: {withdrawal_id:bigint; }; } | {ReimburseTransaction: {tx_hash:string;withdrawal_id:bigint; }; } | {Convert: {from_address:string;log_index:bigint;tx_hash:string; }; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:500
Type Declaration
Section titled “Type Declaration”{ ReimburseWithdrawal: { withdrawal_id: bigint; }; }
ReimburseWithdrawal
Section titled “ReimburseWithdrawal”ReimburseWithdrawal:
object
The minter failed to process a withdrawal request, so no transaction was issued, but some reimbursement was made.
ReimburseWithdrawal.withdrawal_id
Section titled “ReimburseWithdrawal.withdrawal_id”withdrawal_id:
bigint
The id corresponding to the withdrawal request.
{ ReimburseTransaction: { tx_hash: string; withdrawal_id: bigint; }; }
ReimburseTransaction
Section titled “ReimburseTransaction”ReimburseTransaction:
object
ReimburseTransaction.tx_hash
Section titled “ReimburseTransaction.tx_hash”tx_hash:
string
Hash of the failed transaction.
ReimburseTransaction.withdrawal_id
Section titled “ReimburseTransaction.withdrawal_id”withdrawal_id:
bigint
The id corresponding to the withdrawal request.
{ Convert: { from_address: string; log_index: bigint; tx_hash: string; }; }
Convert
Section titled “Convert”Convert:
object
The minter received some ETH or ERC20 token.
Convert.from_address
Section titled “Convert.from_address”from_address:
string
The sender of the ETH or ERC20 token.
Convert.log_index
Section titled “Convert.log_index”log_index:
bigint
Integer of the log index position in the block.
Convert.tx_hash
Section titled “Convert.tx_hash”tx_hash:
string
Hash of the transaction.
ReimbursementIndex
Section titled “ReimbursementIndex”ReimbursementIndex = {
CkErc20: {ckerc20_ledger_burn_index:bigint;cketh_ledger_burn_index:bigint;ledger_id:Principal; }; } | {CkEth: {ledger_burn_index:bigint; }; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:627
RetrieveEthStatus
Section titled “RetrieveEthStatus”RetrieveEthStatus = {
NotFound:null; } | {TxFinalized:TxFinalizedStatus; } | {TxSent:EthTransaction; } | {TxCreated:null; } | {Pending:null; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:653
Retrieve the status of a withdrawal request.
Type Declaration
Section titled “Type Declaration”{ NotFound: null; }
NotFound
Section titled “NotFound”NotFound:
null
Withdrawal request is not found.
{ TxFinalized: TxFinalizedStatus; }
TxFinalized
Section titled “TxFinalized”TxFinalized:
TxFinalizedStatus
Ethereum transaction is finalized.
{ TxSent: EthTransaction; }
TxSent
Section titled “TxSent”TxSent:
EthTransaction
Ethereum transaction was signed and is sent to the network.
{ TxCreated: null; }
TxCreated
Section titled “TxCreated”TxCreated:
null
Transaction fees were estimated and an Ethereum transaction was created. Transaction is not signed yet.
{ Pending: null; }
Pending
Section titled “Pending”Pending:
null
Withdrawal request is waiting to be processed.
Subaccount
Section titled “Subaccount”Subaccount =
Uint8Array
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:685
TxFinalizedStatus
Section titled “TxFinalizedStatus”TxFinalizedStatus = {
Success: {effective_transaction_fee: [] | [bigint];transaction_hash:string; }; } | {Reimbursed: {reimbursed_amount:bigint;reimbursed_in_block:bigint;transaction_hash:string; }; } | {PendingReimbursement:EthTransaction; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:697
Status of a finalized transaction.
Type Declaration
Section titled “Type Declaration”{ Success: { effective_transaction_fee: [] | [bigint]; transaction_hash: string; }; }
Success
Section titled “Success”Success:
object
Transaction was successful.
Success.effective_transaction_fee
Section titled “Success.effective_transaction_fee”effective_transaction_fee: [] | [
bigint]
Success.transaction_hash
Section titled “Success.transaction_hash”transaction_hash:
string
{ Reimbursed: { reimbursed_amount: bigint; reimbursed_in_block: bigint; transaction_hash: string; }; }
Reimbursed
Section titled “Reimbursed”Reimbursed:
object
Transaction failed, user got reimbursed.
Reimbursed.reimbursed_amount
Section titled “Reimbursed.reimbursed_amount”reimbursed_amount:
bigint
Reimbursed.reimbursed_in_block
Section titled “Reimbursed.reimbursed_in_block”reimbursed_in_block:
bigint
Reimbursed.transaction_hash
Section titled “Reimbursed.transaction_hash”transaction_hash:
string
{ PendingReimbursement: EthTransaction; }
PendingReimbursement
Section titled “PendingReimbursement”PendingReimbursement:
EthTransaction
Transaction failed and will be reimbursed,
WithdrawalError
Section titled “WithdrawalError”WithdrawalError = {
TemporarilyUnavailable:string; } | {InsufficientAllowance: {allowance:bigint; }; } | {AmountTooLow: {min_withdrawal_amount:bigint; }; } | {RecipientAddressBlocked: {address:string; }; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:890
Type Declaration
Section titled “Type Declaration”{ TemporarilyUnavailable: string; }
TemporarilyUnavailable
Section titled “TemporarilyUnavailable”TemporarilyUnavailable:
string
The minter or the ckETH ledger is temporarily unavailable, 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
{ AmountTooLow: { min_withdrawal_amount: bigint; }; }
AmountTooLow
Section titled “AmountTooLow”AmountTooLow:
object
The withdrawal amount is too low. The payload contains the minimal withdrawal amount.
AmountTooLow.min_withdrawal_amount
Section titled “AmountTooLow.min_withdrawal_amount”min_withdrawal_amount:
bigint
{ RecipientAddressBlocked: { address: string; }; }
RecipientAddressBlocked
Section titled “RecipientAddressBlocked”RecipientAddressBlocked:
object
Recipient’s address is blocked. No withdrawal can be made to that address.
RecipientAddressBlocked.address
Section titled “RecipientAddressBlocked.address”address:
string
{ InsufficientFunds: { balance: bigint; }; }
InsufficientFunds
Section titled “InsufficientFunds”InsufficientFunds:
object
The ckETH balance of the withdrawal account is too low.
InsufficientFunds.balance
Section titled “InsufficientFunds.balance”balance:
bigint
WithdrawalSearchParameter
Section titled “WithdrawalSearchParameter”WithdrawalSearchParameter = {
ByRecipient:string; } | {BySenderAccount:Account; } | {ByWithdrawalId:bigint; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:927
Search parameter for withdrawals.
Type Declaration
Section titled “Type Declaration”{ ByRecipient: string; }
ByRecipient
Section titled “ByRecipient”ByRecipient:
string
Search by recipient’s ETH address.
{ BySenderAccount: Account; }
BySenderAccount
Section titled “BySenderAccount”BySenderAccount:
Account
Search by sender’s token account.
{ ByWithdrawalId: bigint; }
ByWithdrawalId
Section titled “ByWithdrawalId”ByWithdrawalId:
bigint
Search by ckETH burn index (which is also used to index ckERC20 withdrawals).
WithdrawalStatus
Section titled “WithdrawalStatus”WithdrawalStatus = {
TxFinalized:TxFinalizedStatus; } | {TxSent:EthTransaction; } | {TxCreated:null; } | {Pending:null; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:949
Status of a withdrawal request.
Type Declaration
Section titled “Type Declaration”{ TxFinalized: TxFinalizedStatus; }
TxFinalized
Section titled “TxFinalized”TxFinalized:
TxFinalizedStatus
Transaction already finalized.
{ TxSent: EthTransaction; }
TxSent
Section titled “TxSent”TxSent:
EthTransaction
Transaction sent but not yet finalized.
{ TxCreated: null; }
TxCreated
Section titled “TxCreated”TxCreated:
null
Transaction created byt not yet sent.
{ Pending: null; }
Pending
Section titled “Pending”Pending:
null
Request is pending, i.e. transaction is not yet created.
WithdrawErc20Error
Section titled “WithdrawErc20Error”WithdrawErc20Error = {
TokenNotSupported: {supported_tokens:CkErc20Token[]; }; } | {TemporarilyUnavailable:string; } | {CkErc20LedgerError: {cketh_block_index:bigint;error:LedgerError; }; } | {CkEthLedgerError: {error:LedgerError; }; } | {RecipientAddressBlocked: {address:string; }; }
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:802
Type Declaration
Section titled “Type Declaration”{ TokenNotSupported: { supported_tokens: CkErc20Token[]; }; }
TokenNotSupported
Section titled “TokenNotSupported”TokenNotSupported:
object
The user provided ckERC20 token is not supported by the minter.
TokenNotSupported.supported_tokens
Section titled “TokenNotSupported.supported_tokens”supported_tokens:
CkErc20Token[]
{ TemporarilyUnavailable: string; }
TemporarilyUnavailable
Section titled “TemporarilyUnavailable”TemporarilyUnavailable:
string
The minter is temporarily unavailable, retry the request. The payload contains a human-readable message explaining what caused the unavailability.
{ CkErc20LedgerError: { cketh_block_index: bigint; error: LedgerError; }; }
CkErc20LedgerError
Section titled “CkErc20LedgerError”CkErc20LedgerError:
object
The minter could not burn the requested amount of ckERC20 tokens.
The cketh_block_index identifies the burn that occurred on the ckETH ledger and that will be reimbursed.
CkErc20LedgerError.cketh_block_index
Section titled “CkErc20LedgerError.cketh_block_index”cketh_block_index:
bigint
CkErc20LedgerError.error
Section titled “CkErc20LedgerError.error”error:
LedgerError
{ CkEthLedgerError: { error: LedgerError; }; }
CkEthLedgerError
Section titled “CkEthLedgerError”CkEthLedgerError:
object
The minter could not burn the required amount of ckETH to pay for the transaction fees.
CkEthLedgerError.error
Section titled “CkEthLedgerError.error”error:
LedgerError
{ RecipientAddressBlocked: { address: string; }; }
RecipientAddressBlocked
Section titled “RecipientAddressBlocked”RecipientAddressBlocked:
object
Recipient’s address is blocked. No withdrawal can be made to that address.
RecipientAddressBlocked.address
Section titled “RecipientAddressBlocked.address”address:
string
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1065
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:1066
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]