CkETHMinterCanister
Defined in: packages/cketh/src/minter.canister.ts:29
Extends
Section titled “Extends”Canister<CkETHMinterService>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew CkETHMinterCanister(id,service,certifiedService):CkETHMinterCanister
Defined in: packages/utils/dist/services/canister.d.ts:7
Parameters
Section titled “Parameters”Principal
service
Section titled “service”_SERVICE
certifiedService
Section titled “certifiedService”_SERVICE
Returns
Section titled “Returns”CkETHMinterCanister
Inherited from
Section titled “Inherited from”Canister<CkETHMinterService>.constructor
Properties
Section titled “Properties”caller()
Section titled “caller()”
protectedcaller: (__namedParameters) =>_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:9
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”QueryParams
Returns
Section titled “Returns”_SERVICE
Inherited from
Section titled “Inherited from”Canister.caller
certifiedService
Section titled “certifiedService”
protectedreadonlycertifiedService:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:6
Inherited from
Section titled “Inherited from”Canister.certifiedService
service
Section titled “service”
protectedreadonlyservice:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:5
Inherited from
Section titled “Inherited from”Canister.service
Accessors
Section titled “Accessors”canisterId
Section titled “canisterId”Get Signature
Section titled “Get Signature”get canisterId():
Principal
Defined in: packages/utils/dist/services/canister.d.ts:8
Returns
Section titled “Returns”Principal
Inherited from
Section titled “Inherited from”Canister.canisterId
Methods
Section titled “Methods”eip1559TransactionPrice()
Section titled “eip1559TransactionPrice()”eip1559TransactionPrice(
params):Promise<Eip1559TransactionPrice>
Defined in: packages/cketh/src/minter.canister.ts:151
Estimate the price of a transaction issued by the minter when converting ckETH to ETH and ckER20 to ERC20.
Parameters
Section titled “Parameters”params
Section titled “params”The parameters to get the minter info.
Returns
Section titled “Returns”Promise<Eip1559TransactionPrice>
- The estimated gas fee and limit.
getMinterInfo()
Section titled “getMinterInfo()”getMinterInfo(
params):Promise<MinterInfo>
Defined in: packages/cketh/src/minter.canister.ts:179
Returns internal minter parameters such as the minimal withdrawal amount, the last observed block number, etc.
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
The parameters to get the minter info.
Returns
Section titled “Returns”Promise<MinterInfo>
getSmartContractAddress()
Section titled “getSmartContractAddress()”getSmartContractAddress(
params):Promise<string>
Defined in: packages/cketh/src/minter.canister.ts:48
The address of the helper smart contract may change in the future when the minter is upgraded. Please verify the address of the helper contract before any important transfer by querying the minter as follows.
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams = {}
The parameters to resolve the ckETH smart contract address.
Returns
Section titled “Returns”Promise<string>
Address of the helper smart contract.
retrieveEthStatus()
Section titled “retrieveEthStatus()”retrieveEthStatus(
blockIndex):Promise<RetrieveEthStatus>
Defined in: packages/cketh/src/minter.canister.ts:166
Retrieve the status of a withdrawal request.
Parameters
Section titled “Parameters”blockIndex
Section titled “blockIndex”bigint
Returns
Section titled “Returns”Promise<RetrieveEthStatus>
The current status of an Ethereum transaction for a block index resulting from a withdrawal.
withdrawErc20()
Section titled “withdrawErc20()”withdrawErc20(
params):Promise<RetrieveErc20Request>
Defined in: packages/cketh/src/minter.canister.ts:110
Submits a request to convert ckErc20 to Erc20 - e.g. ckUSDC to USDC - after making ICRC-2 approvals for the ckETH and related ckErc20 ledgers.
Preconditions:
The caller allowed the minter’s principal to spend its funds using [icrc2_approve] on the ckErc20 ledger and to burn some of the user’s ckETH tokens to pay for the transaction fees on the CkETH ledger.
Parameters
Section titled “Parameters”params
Section titled “params”The parameters to withdrawal ckErc20 to Erc20.
address
Section titled “address”string
The destination ETH address.
amount
Section titled “amount”bigint
The ETH amount in wei.
fromCkErc20Subaccount?
Section titled “fromCkErc20Subaccount?”fromCkEthSubaccount?
Section titled “fromCkEthSubaccount?”The optional subaccount to burn ckETH from to pay for the transaction fee.
ledgerCanisterId
Section titled “ledgerCanisterId”Principal
Returns
Section titled “Returns”Promise<RetrieveErc20Request>
The successful result or the operation.
withdrawEth()
Section titled “withdrawEth()”withdrawEth(
params):Promise<RetrieveEthRequest>
Defined in: packages/cketh/src/minter.canister.ts:69
Submits a request to convert ckETH to ETH after making an ICRC-2 approval.
Preconditions:
The caller allowed the minter’s principal to spend its funds using [icrc2_approve] on the ckETH ledger.
Parameters
Section titled “Parameters”params
Section titled “params”The parameters to withdrawal ckETH to ETH.
address
Section titled “address”string
The destination ETH address.
amount
Section titled “amount”bigint
The ETH amount in wei.
fromSubaccount?
Section titled “fromSubaccount?”The optional subaccount to burn ckETH from.
Returns
Section titled “Returns”Promise<RetrieveEthRequest>
The successful result or the operation.
create()
Section titled “create()”
staticcreate(options):CkETHMinterCanister
Defined in: packages/cketh/src/minter.canister.ts:30
Parameters
Section titled “Parameters”options
Section titled “options”CkETHMinterCanisterOptions<_SERVICE>
Returns
Section titled “Returns”CkETHMinterCanister