_SERVICE
Defined in: packages/canisters/src/declarations/cketh/minter.d.ts:823
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:828
Add a ckERC-20 token to be supported by the minter. This call is restricted to the orchestrator ID.
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:832
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:839
Retrieve the status of the minter canister.
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:845
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:852
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:856
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:864
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:868
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:877
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:881
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:889
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:896
Return details of all withdrawals matching the given search parameter.