Overview

https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-bitcoin_get_balance

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

getBalanceQuery()

getBalanceQuery(params): Promise<bigint>

Defined in: packages/canisters/src/ckbtc/bitcoin.canister.ts:63

Given a get_balance_request, which must specify a Bitcoin address and a Bitcoin network (mainnet, testnet or regtest), the function returns the current balance of this address in Satoshi (10^8 Satoshi = 1 Bitcoin) in the specified Bitcoin network.

⚠️ Note that this method does not support certified calls because only canisters are allowed to get Bitcoin balance via update calls.

Parameters

params

GetBalanceParams

Returns

Promise<bigint>

The balance is returned in Satoshi (10^8 Satoshi = 1 Bitcoin).

Link

getUtxosQuery()

getUtxosQuery(params): Promise<get_utxos_response>

Defined in: packages/canisters/src/ckbtc/bitcoin.canister.ts:41

Given a get_utxos_request, which must specify a Bitcoin address and a Bitcoin network (mainnet, testnet or regtest), the function returns all unspent transaction outputs (UTXOs) associated with the provided address in the specified Bitcoin network based on the current view of the Bitcoin blockchain available to the Bitcoin component.

⚠️ Note that this method does not support certified calls because only canisters are allowed to get UTXOs via update calls.

Parameters

params

GetUtxosParams

Returns

Promise<get_utxos_response>

The UTXOs are returned sorted by block height in descending order.

Link

https://internetcomputer.org/docs/current/references/ic-interface-spec#ic-bitcoin_get_utxos

create()

static create(options): BitcoinCanister

Defined in: packages/canisters/src/ckbtc/bitcoin.canister.ts:17

Parameters

options

CkBtcCanisterOptions<_SERVICE>

Returns

BitcoinCanister

CkBtcMinterCanister

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:38

Extends

Canister<_SERVICE>

Constructors

Constructor

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

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

Parameters

id

Principal

service

certifiedService

Returns

CkBtcMinterCanister

Inherited from

Canister<CkBtcMinterService>.constructor

Properties

caller()

protected caller: (__namedParameters) => _SERVICE

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

Parameters

__namedParameters

QueryParams

Returns

EstimateWithdrawalFeeParams

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

estimateWithdrawalFee()

estimateWithdrawalFee(params): Promise<EstimateWithdrawalFee>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:237

Returns an estimation of the user’s fee (in Satoshi) for a retrieve_btc request based on the current status of the Bitcoin network and the fee related to the minter.

Parameters

params

The parameters to estimate the fee.

Returns

Promise<EstimateWithdrawalFee>

getBtcAddress()

getBtcAddress(params): Promise<string>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:60

Returns a BTC address for a given account.

Note: an update call is required by the Minter canister.

Parameters

params

MinterParams

The parameters for which a BTC address should be resolved.

Returns

Promise<string>

The BTC address of the given account.

getKnownUtxos()

getKnownUtxos(params): Promise<Utxo[]>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:266

Returns UTXOs of the given account known by the minter.

Parameters

params

GetKnownUtxosParams

The parameters for which the known utxos should be resolved.

Returns

Promise<Utxo[]>

The known utxos (with no guarantee in the ordering).

getMinterInfo()

getMinterInfo(params): Promise<MinterInfo>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:251

Returns internal minter parameters such as the minimal amount to retrieve BTC, minimal number of confirmations or KYT fee.

Parameters

params

QueryParams

The parameters to get the minter info.

Returns

Promise<MinterInfo>

getWithdrawalAccount()

getWithdrawalAccount(): Promise<Account>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:102

Returns the account to which the caller should deposit ckBTC before withdrawing BTC using the [retrieveBtc] endpoint.

Returns

Promise<Account>

The account to which ckBTC needs to be transferred. Provide corresponding information to map an Icrc1 account.

retrieveBtc()

retrieveBtc(params): Promise<RetrieveBtcOk>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:121

Submits a request to convert ckBTC to BTC.

Note:

The BTC retrieval process is slow. Instead of synchronously waiting for a BTC transaction to settle, this method returns a request ([block_index]) that the caller can use to query the request status.

Preconditions:

The caller deposited the requested amount in ckBTC to the account that the [getWithdrawalAccount] endpoint returns.

Parameters

params

RetrieveBtcParams

The parameters are the bitcoin address and amount to convert.

Returns

Promise<RetrieveBtcOk>

The result or the operation.

retrieveBtcStatus()

retrieveBtcStatus(transactionId): Promise<RetrieveBtcStatus>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:185

Returns the status of a specific BTC withdrawal based on the transaction ID of the corresponding burn transaction.

Parameters

transactionId

The ID of the corresponding burn transaction.

certified

boolean

transactionId

bigint

Returns

Promise<RetrieveBtcStatus>

The status of the BTC retrieval request.

retrieveBtcStatusV2ByAccount()

retrieveBtcStatusV2ByAccount(certified): Promise<RetrieveBtcStatusV2WithId[]>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:203

Returns the status of all BTC withdrawals for an account.

Parameters

certified

RetrieveBtcStatusV2ByAccountParams

query or update call

Returns

Promise<RetrieveBtcStatusV2WithId[]>

The statuses of the BTC retrieval requests.

retrieveBtcWithApproval()

retrieveBtcWithApproval(__namedParameters): Promise<RetrieveBtcOk>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:153

Submits a request to convert ckBTC to BTC after making an ICRC-2 approval.

The BTC retrieval process is slow. Instead of synchronously waiting for a BTC transaction to settle, this method returns a request ([block_index]) that the caller can use to query the request status.

Preconditions

The caller allowed the minter’s principal to spend its funds using [icrc2_approve] on the ckBTC ledger.

Parameters

__namedParameters

address

string

amount

bigint

fromSubaccount?

Uint8Array<ArrayBufferLike>

Returns

Promise<RetrieveBtcOk>

The result or the operation.

updateBalance()

updateBalance(params): Promise<UpdateBalanceOk>

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:79

Notify the minter about the bitcoin transfer.

Upon successful notification, new ckBTC should be available on the targeted address.

Parameters

params

MinterParams

The parameters are the address to which bitcoin where transferred.

Returns

Promise<UpdateBalanceOk>

The result of the balance update.

create()

static create(options): CkBtcMinterCanister

Defined in: packages/canisters/src/ckbtc/minter.canister.ts:39

Parameters

options

CkBtcCanisterOptions<_SERVICE>

Returns

CkBtcMinterCanister

MinterAlreadyProcessingError

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

Extends

MinterGenericError

Constructors

Constructor

new MinterAlreadyProcessingError(message?): MinterAlreadyProcessingError

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

Parameters

message?

string

Returns

MinterAlreadyProcessingError

Inherited from

MinterAlreadyProcessingError

Constructor

new MinterAlreadyProcessingError(message?, options?): MinterAlreadyProcessingError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

MinterAmountTooLowError

MinterAmountTooLowError

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

Extends

MinterRetrieveBtcError

Constructors

Constructor

new MinterAmountTooLowError(message?): MinterAmountTooLowError

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

Parameters

message?

string

Returns

Inherited from

MinterAmountTooLowError

Constructor

new MinterAmountTooLowError(message?, options?): MinterAmountTooLowError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

MinterGenericError

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

Extends

Error

Constructors

Constructor

new MinterGenericError(message?): MinterGenericError

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

Parameters

message?

string

Returns

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

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

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

Inherited from

Error.prepareStackTrace

MinterInsufficientAllowanceError

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

Extends

MinterRetrieveBtcError

Constructors

Constructor

new MinterInsufficientAllowanceError(message?): MinterInsufficientAllowanceError

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

Parameters

message?

string

Returns

MinterInsufficientAllowanceError

Inherited from

MinterInsufficientAllowanceError

Constructor

new MinterInsufficientAllowanceError(message?, options?): MinterInsufficientAllowanceError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

MinterInsufficientFundsError

MinterInsufficientFundsError

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

Extends

MinterRetrieveBtcError

Constructors

Constructor

new MinterInsufficientFundsError(message?): MinterInsufficientFundsError

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

Parameters

message?

string

Returns

Inherited from

MinterInsufficientFundsError

Constructor

new MinterInsufficientFundsError(message?, options?): MinterInsufficientFundsError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

MinterMalformedAddressError

MinterMalformedAddressError

Defined in: packages/canisters/src/ckbtc/errors/minter.errors.ts:26

Extends

MinterRetrieveBtcError

Constructors

Constructor

new MinterMalformedAddressError(message?): MinterMalformedAddressError

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

Parameters

message?

string

Returns

Inherited from

MinterMalformedAddressError

Constructor

new MinterMalformedAddressError(message?, options?): MinterMalformedAddressError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

MinterUpdateBalanceError.constructor

MinterNoNewUtxosError

Defined in: packages/canisters/src/ckbtc/errors/minter.errors.ts:9

Extends

MinterUpdateBalanceError

Constructors

Constructor

new MinterNoNewUtxosError(__namedParameters): MinterNoNewUtxosError

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

Parameters

__namedParameters

pending_utxos

[] | [PendingUtxo[]]

required_confirmations

number

Returns

MinterNoNewUtxosError

Overrides

Properties

cause?

optional cause: unknown

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

Inherited from

MinterUpdateBalanceError.cause

message

message: string

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

Inherited from

MinterUpdateBalanceError.message

name

name: string

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

Inherited from

MinterUpdateBalanceError.name

pendingUtxos

readonly pendingUtxos: PendingUtxo[]

Defined in: packages/canisters/src/ckbtc/errors/minter.errors.ts:10

requiredConfirmations

readonly requiredConfirmations: number

Defined in: packages/canisters/src/ckbtc/errors/minter.errors.ts:11

stack?

optional stack: string

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

Inherited from

MinterUpdateBalanceError.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

MinterUpdateBalanceError.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

MinterUpdateBalanceError.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

MinterUpdateBalanceError.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

MinterUpdateBalanceError.prepareStackTrace

MinterRetrieveBtcError

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

Extends

MinterGenericError

Extended by

MinterMalformedAddressError
MinterAmountTooLowError
MinterInsufficientFundsError
MinterInsufficientAllowanceError

Constructors

Constructor

new MinterRetrieveBtcError(message?): MinterRetrieveBtcError

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

Parameters

message?

string

Returns

MinterRetrieveBtcError

Inherited from

Constructor

new MinterRetrieveBtcError(message?, options?): MinterRetrieveBtcError

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

Parameters

message?

string

options?

ErrorOptions

Returns

MinterRetrieveBtcError

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

MinterTemporaryUnavailableError

MinterTemporaryUnavailableError

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

Extends

MinterGenericError

Constructors

Constructor

new MinterTemporaryUnavailableError(message?): MinterTemporaryUnavailableError

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

Parameters

message?

string

Returns

Inherited from

MinterTemporaryUnavailableError

Constructor

new MinterTemporaryUnavailableError(message?, options?): MinterTemporaryUnavailableError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

MinterUpdateBalanceError

MinterUpdateBalanceError

Defined in: packages/canisters/src/ckbtc/errors/minter.errors.ts:8

Extends

MinterGenericError

Extended by

MinterNoNewUtxosError

Constructors

Constructor

new MinterUpdateBalanceError(message?): MinterUpdateBalanceError

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

Parameters

message?

string

Returns

Inherited from

MinterUpdateBalanceError

Constructor

new MinterUpdateBalanceError(message?, options?): MinterUpdateBalanceError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

ParseBtcAddressBadWitnessLengthError

ParseBtcAddressBadWitnessLengthError

Defined in: packages/canisters/src/ckbtc/errors/btc.errors.ts:5

Extends

ParseBtcAddressError

Constructors

Constructor

new ParseBtcAddressBadWitnessLengthError(message?): ParseBtcAddressBadWitnessLengthError

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

Parameters

message?

string

Returns

Inherited from

ParseBtcAddressBadWitnessLengthError

Constructor

new ParseBtcAddressBadWitnessLengthError(message?, options?): ParseBtcAddressBadWitnessLengthError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

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

ParseBtcAddressError

Defined in: packages/canisters/src/ckbtc/errors/btc.errors.ts:1

Extends

Error

Extended by

ParseBtcAddressInvalidError
ParseBtcAddressNoDataError
ParseBtcAddressUnsupportedAddressTypeError
ParseBtcAddressBadWitnessLengthError
ParseBtcAddressUnsupportedWitnessVersionError
ParseBtcAddressUnexpectedHumanReadablePartError
ParseBtcAddressMalformedAddressError
ParseBtcAddressWrongNetworkError

Constructors

Constructor

new ParseBtcAddressError(message?): ParseBtcAddressError

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

Parameters

message?

string

Returns

ParseBtcAddressError

Inherited from

Error.constructor

Constructor

new ParseBtcAddressError(message?, options?): ParseBtcAddressError

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

Parameters

message?

string

options?

ErrorOptions

Returns

ParseBtcAddressError

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

Inherited from

Error.prepareStackTrace

ParseBtcAddressInvalidError

Defined in: packages/canisters/src/ckbtc/errors/btc.errors.ts:2

Extends

ParseBtcAddressError

Constructors

Constructor

new ParseBtcAddressInvalidError(message?): ParseBtcAddressInvalidError

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

Parameters

message?

string

Returns

ParseBtcAddressInvalidError

Inherited from

ParseBtcAddressInvalidError

Constructor

new ParseBtcAddressInvalidError(message?, options?): ParseBtcAddressInvalidError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

ParseBtcAddressMalformedAddressError

ParseBtcAddressMalformedAddressError

Defined in: packages/canisters/src/ckbtc/errors/btc.errors.ts:8

Extends

ParseBtcAddressError

Constructors

Constructor

new ParseBtcAddressMalformedAddressError(message?): ParseBtcAddressMalformedAddressError

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

Parameters

message?

string

Returns

Inherited from

ParseBtcAddressMalformedAddressError

Constructor

new ParseBtcAddressMalformedAddressError(message?, options?): ParseBtcAddressMalformedAddressError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

ParseBtcAddressNoDataError

ParseBtcAddressNoDataError

Defined in: packages/canisters/src/ckbtc/errors/btc.errors.ts:3

Extends

ParseBtcAddressError

Constructors

Constructor

new ParseBtcAddressNoDataError(message?): ParseBtcAddressNoDataError

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

Parameters

message?

string

Returns

Inherited from

ParseBtcAddressNoDataError

Constructor

new ParseBtcAddressNoDataError(message?, options?): ParseBtcAddressNoDataError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

ParseBtcAddressUnexpectedHumanReadablePartError

ParseBtcAddressUnexpectedHumanReadablePartError

Defined in: packages/canisters/src/ckbtc/errors/btc.errors.ts:7

Extends

ParseBtcAddressError

Constructors

Constructor

new ParseBtcAddressUnexpectedHumanReadablePartError(message?): ParseBtcAddressUnexpectedHumanReadablePartError

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

Parameters

message?

string

Returns

Inherited from

ParseBtcAddressUnexpectedHumanReadablePartError

Constructor

new ParseBtcAddressUnexpectedHumanReadablePartError(message?, options?): ParseBtcAddressUnexpectedHumanReadablePartError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

ParseBtcAddressUnsupportedAddressTypeError

ParseBtcAddressUnsupportedAddressTypeError

Defined in: packages/canisters/src/ckbtc/errors/btc.errors.ts:4

Extends

ParseBtcAddressError

Constructors

Constructor

new ParseBtcAddressUnsupportedAddressTypeError(message?): ParseBtcAddressUnsupportedAddressTypeError

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

Parameters

message?

string

Returns

Inherited from

ParseBtcAddressUnsupportedAddressTypeError

Constructor

new ParseBtcAddressUnsupportedAddressTypeError(message?, options?): ParseBtcAddressUnsupportedAddressTypeError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

ParseBtcAddressUnsupportedWitnessVersionError

ParseBtcAddressUnsupportedWitnessVersionError

Defined in: packages/canisters/src/ckbtc/errors/btc.errors.ts:6

Extends

ParseBtcAddressError

Constructors

Constructor

new ParseBtcAddressUnsupportedWitnessVersionError(message?): ParseBtcAddressUnsupportedWitnessVersionError

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

Parameters

message?

string

Returns

Inherited from

ParseBtcAddressUnsupportedWitnessVersionError

Constructor

new ParseBtcAddressUnsupportedWitnessVersionError(message?, options?): ParseBtcAddressUnsupportedWitnessVersionError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

ParseBtcAddressWrongNetworkError

ParseBtcAddressWrongNetworkError

Defined in: packages/canisters/src/ckbtc/errors/btc.errors.ts:9

Extends

ParseBtcAddressError

Constructors

Constructor

new ParseBtcAddressWrongNetworkError(message?): ParseBtcAddressWrongNetworkError

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

Parameters

message?

string

Returns

Inherited from

ParseBtcAddressWrongNetworkError

Constructor

new ParseBtcAddressWrongNetworkError(message?, options?): ParseBtcAddressWrongNetworkError

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

Parameters

message?

string

options?

ErrorOptions

Returns

Inherited from

Properties

cause?

optional cause: unknown

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

Inherited from

message

message: string

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

Inherited from

name

name: string

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

Inherited from

stack?

optional stack: string

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

Inherited from

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

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

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

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

Inherited from

NnsGovernanceCanisterOptions.agent

Interfaces

BtcAddress

Defined in: packages/canisters/src/ckbtc/types/btc.ts:3

Properties

address

address: string

Defined in: packages/canisters/src/ckbtc/types/btc.ts:4

network?

optional network: BtcNetwork

Defined in: packages/canisters/src/ckbtc/types/btc.ts:5

BtcAddressInfo

Defined in: packages/canisters/src/ckbtc/types/btc.ts:8

Extends

Required<BtcAddress>

Properties

address

address: string

Defined in: packages/canisters/src/ckbtc/types/btc.ts:4

Inherited from

BtcAddress.address

network

network: BtcNetwork

Defined in: packages/canisters/src/ckbtc/types/btc.ts:5

Inherited from

BtcAddress.network

parser

parser: "bip-173" | "base58"

Defined in: packages/canisters/src/ckbtc/types/btc.ts:9

type

type: BtcAddressType

Defined in: packages/canisters/src/ckbtc/types/btc.ts:10

CkBtcCanisterOptions

Defined in: packages/canisters/src/ckbtc/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

canisterId

canisterId: Principal

Defined in: packages/canisters/src/ckbtc/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

EstimateWithdrawalFee

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:17

Properties

bitcoin_fee

bitcoin_fee: bigint

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:19

minter_fee

minter_fee: bigint

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:18

MinterAccount

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

Properties

owner

owner: Principal

Defined in: packages/canisters/src/ckbtc/types/minter.params.ts:6

subaccount?

optional subaccount: Uint8Array<ArrayBufferLike>

Defined in: packages/canisters/src/ckbtc/types/minter.params.ts:7

RetrieveBtcStatusV2WithId

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:22

Properties

id

id: bigint

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:23

status

status: RetrieveBtcStatusV2 | undefined

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:24

Type Aliases

BitcoinNetwork

BitcoinNetwork = "testnet" | "mainnet" | "regtest"

Defined in: packages/canisters/src/ckbtc/types/bitcoin.params.ts:4

EstimateWithdrawalFeeParams

EstimateWithdrawalFeeParams = QueryParams & object

Defined in: packages/canisters/src/ckbtc/types/minter.params.ts:32

Params to estimate the fee of the Bitcoin network.

Type Declaration

amount

amount: bigint | undefined

GetBalanceParams

GetBalanceParams = Omit<get_balance_request, "network" | "min_confirmations"> & object & Omit<QueryParams, "certified">

Defined in: packages/canisters/src/ckbtc/types/bitcoin.params.ts:36

Type Declaration

minConfirmations?

optional minConfirmations: number

network

network: BitcoinNetwork

GetBTCAddressParams

GetBTCAddressParams = MinterParams

Defined in: packages/canisters/src/ckbtc/types/minter.params.ts:16

Params to get a BTC address.

GetKnownUtxosParams

GetKnownUtxosParams = QueryParams & MinterParams

Defined in: packages/canisters/src/ckbtc/types/minter.params.ts:46

Params to get the known utxos.

GetUtxosParams

GetUtxosParams = Omit<get_utxos_request, "network" | "filter"> & object & Omit<QueryParams, "certified">

Defined in: packages/canisters/src/ckbtc/types/bitcoin.params.ts:12

Type Declaration

filter?

optional filter: { page: Uint8Array; } | { minConfirmations: number; }

network

network: BitcoinNetwork

MinterParams

MinterParams = Omit<QueryParams, "certified"> & Partial<MinterAccount>

Defined in: packages/canisters/src/ckbtc/types/minter.params.ts:10

RetrieveBtcParams

RetrieveBtcParams = RetrieveBtcArgs & Omit<QueryParams, "certified">

Defined in: packages/canisters/src/ckbtc/types/minter.params.ts:26

Params to convert ckBTC to Bitcoin.

RetrieveBtcResponse

RetrieveBtcResponse = { Ok: RetrieveBtcOk; } | { Err: RetrieveBtcError; }

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:9

RetrieveBtcStatusV2ByAccountParams

RetrieveBtcStatusV2ByAccountParams = QueryParams & object

Defined in: packages/canisters/src/ckbtc/types/minter.params.ts:39

Params to retrieve the status of all BTC withdrawals for an account.

Type Declaration

account?

optional account: MinterAccount

RetrieveBtcWithApprovalResponse

RetrieveBtcWithApprovalResponse = { Ok: RetrieveBtcOk; } | { Err: RetrieveBtcWithApprovalError; }

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:13

UpdateBalanceOk

UpdateBalanceOk = UtxoStatus[]

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:3

UpdateBalanceParams

UpdateBalanceParams = MinterParams

Defined in: packages/canisters/src/ckbtc/types/minter.params.ts:21

Params to update ckBTC balance after a bitcoin transfer.

UpdateBalanceResponse

UpdateBalanceResponse = { Ok: UpdateBalanceOk; } | { Err: UpdateBalanceError; }

Defined in: packages/canisters/src/ckbtc/types/minter.responses.ts:5

Functions

createRetrieveBtcError()

createRetrieveBtcError(Err): MinterGenericError

Defined in: packages/canisters/src/ckbtc/errors/minter.errors.ts:74

Parameters

Err

RetrieveBtcError

Returns

RetrieveBtcWithApprovalError

createRetrieveBtcWithApprovalError()

createRetrieveBtcWithApprovalError(Err): MinterGenericError

Defined in: packages/canisters/src/ckbtc/errors/minter.errors.ts:101

Parameters

Err

Returns

createUpdateBalanceError()

createUpdateBalanceError(Err): MinterGenericError

Defined in: packages/canisters/src/ckbtc/errors/minter.errors.ts:55

Parameters

Err

UpdateBalanceError

Returns