Overview

Namespaces

• CkEthMinterDid
• CkEthOrchestratorDid

Classes

CkEthMinterCanister

Defined in: packages/canisters/src/cketh/minter.canister.ts:24

Extends

• Canister<_SERVICE>

Constructors

Constructor

protected new CkEthMinterCanister(id, service, certifiedService): CkEthMinterCanister

Defined in: packages/utils/dist/services/canister.d.ts:7

Parameters

id

Principal

service

_SERVICE

certifiedService

_SERVICE

Returns

CkEthMinterCanister

Inherited from

Canister<CkEthMinterService>.constructor

Properties

caller()

protected caller: (__namedParameters) => _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:9

Parameters

__namedParameters

QueryParams

Returns

_SERVICE

Inherited from

Canister.caller

certifiedService

protected readonly certifiedService: _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:6

Inherited from

Canister.certifiedService

service

protected readonly service: _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:5

Inherited from

Canister.service

Accessors

canisterId

Get Signature

get canisterId(): Principal

Defined in: packages/utils/dist/services/canister.d.ts:8

Returns

Principal

Inherited from

Canister.canisterId

Methods

eip1559TransactionPrice()

eip1559TransactionPrice(params): Promise<Eip1559TransactionPrice>

Defined in: packages/canisters/src/cketh/minter.canister.ts:146

Estimate the price of a transaction issued by the minter when converting ckETH to ETH and ckER20 to ERC20.

Parameters

params

Eip1559TransactionPriceParams

The parameters to get the minter info.

Returns

Promise<Eip1559TransactionPrice>

• The estimated gas fee and limit.

getMinterInfo()

getMinterInfo(params): Promise<MinterInfo>

Defined in: packages/canisters/src/cketh/minter.canister.ts:176

Returns internal minter parameters such as the minimal withdrawal amount, the last observed block number, etc.

Parameters

params

QueryParams

The parameters to get the minter info.

Returns

Promise<MinterInfo>

getSmartContractAddress()

getSmartContractAddress(params): Promise<string>

Defined in: packages/canisters/src/cketh/minter.canister.ts:43

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

params

QueryParams = {}

The parameters to resolve the ckETH smart contract address.

Returns

Promise<string>

Address of the helper smart contract.

retrieveEthStatus()

retrieveEthStatus(blockIndex): Promise<RetrieveEthStatus>

Defined in: packages/canisters/src/cketh/minter.canister.ts:161

Retrieve the status of a withdrawal request.

Parameters

blockIndex

bigint

Returns

Promise<RetrieveEthStatus>

The current status of an Ethereum transaction for a block index resulting from a withdrawal.

withdrawErc20()

withdrawErc20(params): Promise<RetrieveErc20Request>

Defined in: packages/canisters/src/cketh/minter.canister.ts:105

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

params

The parameters to withdrawal ckErc20 to Erc20.

address

string

The destination ETH address.

amount

bigint

The ETH amount in wei.

fromCkErc20Subaccount?

Subaccount

fromCkEthSubaccount?

Subaccount

The optional subaccount to burn ckETH from to pay for the transaction fee.

ledgerCanisterId

Principal

Returns

Promise<RetrieveErc20Request>

The successful result or the operation.

withdrawEth()

withdrawEth(params): Promise<RetrieveEthRequest>

Defined in: packages/canisters/src/cketh/minter.canister.ts:64

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

params

The parameters to withdrawal ckETH to ETH.

address

string

The destination ETH address.

amount

bigint

The ETH amount in wei.

fromSubaccount?

Subaccount

The optional subaccount to burn ckETH from.

Returns

Promise<RetrieveEthRequest>

The successful result or the operation.

create()

static create(options): CkEthMinterCanister

Defined in: packages/canisters/src/cketh/minter.canister.ts:25

Parameters

options

CkEthMinterCanisterOptions<_SERVICE>

Returns

CkEthMinterCanister

---

CkEthOrchestratorCanister

Defined in: packages/canisters/src/cketh/orchestrator.canister.ts:15

Class representing the CkEth Orchestrator Canister, which manages the Ledger and Index canisters of ckERC20 tokens.

See

Code

Extends

• Canister<_SERVICE>

Constructors

Constructor

protected new CkEthOrchestratorCanister(id, service, certifiedService): CkEthOrchestratorCanister

Defined in: packages/utils/dist/services/canister.d.ts:7

Parameters

id

Principal

service

_SERVICE

certifiedService

_SERVICE

Returns

CkEthOrchestratorCanister

Inherited from

Canister<CkEthOrchestratorService>.constructor

Properties

caller()

protected caller: (__namedParameters) => _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:9

Parameters

__namedParameters

QueryParams

Returns

_SERVICE

Inherited from

Canister.caller

certifiedService

protected readonly certifiedService: _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:6

Inherited from

Canister.certifiedService

service

protected readonly service: _SERVICE

Defined in: packages/utils/dist/services/canister.d.ts:5

Inherited from

Canister.service

Accessors

canisterId

Get Signature

get canisterId(): Principal

Defined in: packages/utils/dist/services/canister.d.ts:8

Returns

Principal

Inherited from

Canister.canisterId

Methods

getOrchestratorInfo()

getOrchestratorInfo(params?): Promise<OrchestratorInfo>

Defined in: packages/canisters/src/cketh/orchestrator.canister.ts:40

Retrieves orchestrator information, which contains the list of existing ckERC20 Ledger and Index canisters.

Parameters

params?

QueryParams = {}

The query parameters.

Returns

Promise<OrchestratorInfo>

A promise that resolves to the orchestrator information.

create()

static create(options): CkEthOrchestratorCanister

Defined in: packages/canisters/src/cketh/orchestrator.canister.ts:21

Creates an instance of CkEthOrchestratorCanister.

Parameters

options

CkEthOrchestratorCanisterOptions<_SERVICE>

Options for creating the canister.

Returns

CkEthOrchestratorCanister

A new instance of CkEthOrchestratorCanister.

---

DetailedError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:4

Extends

• Error

Extended by

• MinterError
• LedgerError

Type Parameters

T

T

Constructors

Constructor

new DetailedError<T>(__namedParameters): DetailedError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

DetailedError<T>

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

---

LedgerAmountTooLowError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:30

Extends

• LedgerError<T>

Type Parameters

T

T

Constructors

Constructor

new LedgerAmountTooLowError<T>(__namedParameters): LedgerAmountTooLowError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

LedgerAmountTooLowError<T>

Inherited from

LedgerError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

LedgerError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

LedgerError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

LedgerError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

LedgerError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

LedgerError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

LedgerError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

LedgerError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

LedgerError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

LedgerError.prepareStackTrace

---

LedgerError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:25

Extends

• DetailedError<T>

Extended by

• LedgerWithdrawalError
• LedgerTemporaryUnavailableError
• LedgerInsufficientAllowanceError
• LedgerAmountTooLowError
• LedgerInsufficientFundsError

Type Parameters

T

T

Constructors

Constructor

new LedgerError<T>(__namedParameters): LedgerError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

LedgerError<T>

Inherited from

DetailedError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

DetailedError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

DetailedError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

DetailedError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

DetailedError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

DetailedError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

DetailedError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

DetailedError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

DetailedError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

DetailedError.prepareStackTrace

---

LedgerGenericError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:23

Extends

• Error

Constructors

Constructor

new LedgerGenericError(message?): LedgerGenericError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

LedgerGenericError

Inherited from

Error.constructor

Constructor

new LedgerGenericError(message?, options?): LedgerGenericError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

LedgerGenericError

Inherited from

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

---

LedgerInsufficientAllowanceError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:29

Extends

• LedgerError<T>

Type Parameters

T

T

Constructors

Constructor

new LedgerInsufficientAllowanceError<T>(__namedParameters): LedgerInsufficientAllowanceError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

LedgerInsufficientAllowanceError<T>

Inherited from

LedgerError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

LedgerError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

LedgerError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

LedgerError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

LedgerError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

LedgerError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

LedgerError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

LedgerError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

LedgerError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

LedgerError.prepareStackTrace

---

LedgerInsufficientFundsError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:31

Extends

• LedgerError<T>

Type Parameters

T

T

Constructors

Constructor

new LedgerInsufficientFundsError<T>(__namedParameters): LedgerInsufficientFundsError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

LedgerInsufficientFundsError<T>

Inherited from

LedgerError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

LedgerError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

LedgerError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

LedgerError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

LedgerError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

LedgerError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

LedgerError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

LedgerError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

LedgerError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

LedgerError.prepareStackTrace

---

LedgerTemporaryUnavailableError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:28

Extends

• LedgerError<T>

Type Parameters

T

T

Constructors

Constructor

new LedgerTemporaryUnavailableError<T>(__namedParameters): LedgerTemporaryUnavailableError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

LedgerTemporaryUnavailableError<T>

Inherited from

LedgerError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

LedgerError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

LedgerError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

LedgerError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

LedgerError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

LedgerError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

LedgerError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

LedgerError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

LedgerError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

LedgerError.prepareStackTrace

---

LedgerWithdrawalError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:27

Extends

• LedgerError<T>

Type Parameters

T

T

Constructors

Constructor

new LedgerWithdrawalError<T>(__namedParameters): LedgerWithdrawalError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

LedgerWithdrawalError<T>

Inherited from

LedgerError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

LedgerError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

LedgerError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

LedgerError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

LedgerError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

LedgerError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

LedgerError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

LedgerError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

LedgerError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

LedgerError.prepareStackTrace

---

MinterAmountTooLowError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:19

Extends

• MinterError<T>

Type Parameters

T

T

Constructors

Constructor

new MinterAmountTooLowError<T>(__namedParameters): MinterAmountTooLowError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

MinterAmountTooLowError<T>

Inherited from

MinterError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

MinterError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

MinterError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

MinterError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

MinterError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

MinterError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

MinterError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

MinterError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

MinterError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

MinterError.prepareStackTrace

---

MinterError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:14

Extends

• DetailedError<T>

Extended by

• MinterInsufficientFundsError
• MinterInsufficientAllowanceError
• MinterAmountTooLowError
• MinterRecipientAddressBlockedError
• MinterTokenNotSupported

Type Parameters

T

T

Constructors

Constructor

new MinterError<T>(__namedParameters): MinterError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

MinterError<T>

Inherited from

DetailedError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

DetailedError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

DetailedError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

DetailedError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

DetailedError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

DetailedError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

DetailedError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

DetailedError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

DetailedError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

DetailedError.prepareStackTrace

---

MinterGenericError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:12

Extends

• Error

Extended by

• MinterTemporaryUnavailableError

Constructors

Constructor

new MinterGenericError(message?): MinterGenericError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

MinterGenericError

Inherited from

Error.constructor

Constructor

new MinterGenericError(message?, options?): MinterGenericError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

MinterGenericError

Inherited from

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

---

MinterInsufficientAllowanceError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:18

Extends

• MinterError<T>

Type Parameters

T

T

Constructors

Constructor

new MinterInsufficientAllowanceError<T>(__namedParameters): MinterInsufficientAllowanceError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

MinterInsufficientAllowanceError<T>

Inherited from

MinterError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

MinterError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

MinterError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

MinterError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

MinterError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

MinterError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

MinterError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

MinterError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

MinterError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

MinterError.prepareStackTrace

---

MinterInsufficientFundsError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:17

Extends

• MinterError<T>

Type Parameters

T

T

Constructors

Constructor

new MinterInsufficientFundsError<T>(__namedParameters): MinterInsufficientFundsError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

MinterInsufficientFundsError<T>

Inherited from

MinterError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

MinterError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

MinterError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

MinterError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

MinterError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

MinterError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

MinterError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

MinterError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

MinterError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

MinterError.prepareStackTrace

---

MinterRecipientAddressBlockedError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:20

Extends

• MinterError<T>

Type Parameters

T

T

Constructors

Constructor

new MinterRecipientAddressBlockedError<T>(__namedParameters): MinterRecipientAddressBlockedError<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

MinterRecipientAddressBlockedError<T>

Inherited from

MinterError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

MinterError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

MinterError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

MinterError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

MinterError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

MinterError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

MinterError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

MinterError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

MinterError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

MinterError.prepareStackTrace

---

MinterTemporaryUnavailableError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:16

Extends

• MinterGenericError

Constructors

Constructor

new MinterTemporaryUnavailableError(message?): MinterTemporaryUnavailableError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

MinterTemporaryUnavailableError

Inherited from

MinterGenericError.constructor

Constructor

new MinterTemporaryUnavailableError(message?, options?): MinterTemporaryUnavailableError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

MinterTemporaryUnavailableError

Inherited from

MinterGenericError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

MinterGenericError.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

MinterGenericError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

MinterGenericError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

MinterGenericError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

MinterGenericError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

MinterGenericError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

MinterGenericError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

MinterGenericError.prepareStackTrace

---

MinterTokenNotSupported

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:21

Extends

• MinterError<T>

Type Parameters

T

T

Constructors

Constructor

new MinterTokenNotSupported<T>(__namedParameters): MinterTokenNotSupported<T>

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:6

Parameters

__namedParameters

details?

T

msg?

string

Returns

MinterTokenNotSupported<T>

Inherited from

MinterError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

MinterError.cause

details

details: T | undefined

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:5

Inherited from

MinterError.details

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

MinterError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

MinterError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

MinterError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

MinterError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

MinterError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

MinterError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

MinterError.prepareStackTrace

Interfaces

CkEthMinterCanisterOptions

Defined in: packages/canisters/src/cketh/types/canister.options.ts:4

Extends

• Omit<CanisterOptions<T>, "canisterId">

Type Parameters

T

T

Properties

agent?

optional agent: Agent

Defined in: packages/utils/dist/types/canister.options.d.ts:4

Inherited from

NnsGovernanceCanisterOptions.agent

canisterId

canisterId: Principal

Defined in: packages/canisters/src/cketh/types/canister.options.ts:9

certifiedServiceOverride?

optional certifiedServiceOverride: ActorSubclass<T>

Defined in: packages/utils/dist/types/canister.options.d.ts:7

Inherited from

Omit.certifiedServiceOverride

serviceOverride?

optional serviceOverride: ActorSubclass<T>

Defined in: packages/utils/dist/types/canister.options.d.ts:6

Inherited from

Omit.serviceOverride

Type Aliases

CkEthOrchestratorCanisterOptions

CkEthOrchestratorCanisterOptions<T> = CkEthMinterCanisterOptions<T>

Defined in: packages/canisters/src/cketh/types/canister.options.ts:12

Type Parameters

T

T

---

Eip1559TransactionPriceParams

Eip1559TransactionPriceParams = object & QueryParams

Defined in: packages/canisters/src/cketh/types/minter.params.ts:5

Type Declaration

ckErc20LedgerId?

optional ckErc20LedgerId: Principal

Functions

createWithdrawErc20Error()

createWithdrawErc20Error(Err): MinterGenericError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:71

Parameters

Err

WithdrawErc20Error

Returns

MinterGenericError

---

createWithdrawEthError()

createWithdrawEthError(Err): MinterGenericError

Defined in: packages/canisters/src/cketh/errors/minter.errors.ts:33

Parameters

Err

WithdrawalError

Returns

MinterGenericError

---

encodePrincipalToEthAddress()

encodePrincipalToEthAddress(principal): string

Defined in: packages/canisters/src/cketh/utils/minter.utils.ts:12

Encode a principal to a byte array as Ethereum data hex (staring with 0x). Such a conversion is required to deposit ETH to the ckETH helper contract.

Code adapted from the ckETH minter dashboard JS function: https://github.com/dfinity/ic/blob/master/rs/ethereum/cketh/minter/templates/principal_to_bytes.js

Parameters

principal

Principal

The principal to encode into a fixed 32-byte representation suitable for calling Ethereum smart contracts.

Returns

string