@dfinity/ckbtc 6.0.1 → 7.0.0-beta-2025-12-11

package/dist/candid/minter.idl.js

@@ -1,474 +0,0 @@
-/* eslint-disable */
-
-// @ts-nocheck
-
-// This file was automatically generated by @icp-sdk/bindgen@0.2.0.
-// You should NOT make any changes in this file as it will be overwritten.
-// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified.
-
-export const idlFactory = ({ IDL }) => {
-  const Mode = IDL.Variant({
-    RestrictedTo: IDL.Vec(IDL.Principal),
-    DepositsRestrictedTo: IDL.Vec(IDL.Principal),
-    ReadOnly: IDL.Null,
-    GeneralAvailability: IDL.Null,
-  });
-  const UpgradeArgs = IDL.Record({
-    get_utxos_cache_expiration_seconds: IDL.Opt(IDL.Nat64),
-    kyt_principal: IDL.Opt(IDL.Principal),
-    mode: IDL.Opt(Mode),
-    retrieve_btc_min_amount: IDL.Opt(IDL.Nat64),
-    max_time_in_queue_nanos: IDL.Opt(IDL.Nat64),
-    check_fee: IDL.Opt(IDL.Nat64),
-    btc_checker_principal: IDL.Opt(IDL.Principal),
-    min_confirmations: IDL.Opt(IDL.Nat32),
-    kyt_fee: IDL.Opt(IDL.Nat64),
-  });
-  const BtcNetwork = IDL.Variant({
-    Mainnet: IDL.Null,
-    Regtest: IDL.Null,
-    Testnet: IDL.Null,
-  });
-  const InitArgs = IDL.Record({
-    get_utxos_cache_expiration_seconds: IDL.Opt(IDL.Nat64),
-    kyt_principal: IDL.Opt(IDL.Principal),
-    ecdsa_key_name: IDL.Text,
-    mode: Mode,
-    retrieve_btc_min_amount: IDL.Nat64,
-    ledger_id: IDL.Principal,
-    max_time_in_queue_nanos: IDL.Nat64,
-    btc_network: BtcNetwork,
-    check_fee: IDL.Opt(IDL.Nat64),
-    btc_checker_principal: IDL.Opt(IDL.Principal),
-    min_confirmations: IDL.Opt(IDL.Nat32),
-    kyt_fee: IDL.Opt(IDL.Nat64),
-  });
-  const MinterArg = IDL.Variant({
-    Upgrade: IDL.Opt(UpgradeArgs),
-    Init: InitArgs,
-  });
-  const MemoryMetrics = IDL.Record({
-    wasm_binary_size: IDL.Nat,
-    wasm_chunk_store_size: IDL.Nat,
-    canister_history_size: IDL.Nat,
-    stable_memory_size: IDL.Nat,
-    snapshots_size: IDL.Nat,
-    wasm_memory_size: IDL.Nat,
-    global_memory_size: IDL.Nat,
-    custom_sections_size: IDL.Nat,
-  });
-  const CanisterStatusType = IDL.Variant({
-    stopped: IDL.Null,
-    stopping: IDL.Null,
-    running: IDL.Null,
-  });
-  const LogVisibility = IDL.Variant({
-    controllers: IDL.Null,
-    public: IDL.Null,
-    allowed_viewers: IDL.Vec(IDL.Principal),
-  });
-  const DefiniteCanisterSettings = IDL.Record({
-    freezing_threshold: IDL.Nat,
-    wasm_memory_threshold: IDL.Nat,
-    controllers: IDL.Vec(IDL.Principal),
-    reserved_cycles_limit: IDL.Nat,
-    log_visibility: LogVisibility,
-    wasm_memory_limit: IDL.Nat,
-    memory_allocation: IDL.Nat,
-    compute_allocation: IDL.Nat,
-  });
-  const QueryStats = IDL.Record({
-    response_payload_bytes_total: IDL.Nat,
-    num_instructions_total: IDL.Nat,
-    num_calls_total: IDL.Nat,
-    request_payload_bytes_total: IDL.Nat,
-  });
-  const CanisterStatusResponse = IDL.Record({
-    memory_metrics: MemoryMetrics,
-    status: CanisterStatusType,
-    memory_size: IDL.Nat,
-    cycles: IDL.Nat,
-    settings: DefiniteCanisterSettings,
-    query_stats: QueryStats,
-    idle_cycles_burned_per_day: IDL.Nat,
-    module_hash: IDL.Opt(IDL.Vec(IDL.Nat8)),
-    reserved_cycles: IDL.Nat,
-  });
-  const Account = IDL.Record({
-    owner: IDL.Principal,
-    subaccount: IDL.Opt(IDL.Vec(IDL.Nat8)),
-  });
-  const Utxo = IDL.Record({
-    height: IDL.Nat32,
-    value: IDL.Nat64,
-    outpoint: IDL.Record({ txid: IDL.Vec(IDL.Nat8), vout: IDL.Nat32 }),
-  });
-  const ReimbursementReason = IDL.Variant({
-    CallFailed: IDL.Null,
-    TaintedDestination: IDL.Record({
-      kyt_fee: IDL.Nat64,
-      kyt_provider: IDL.Principal,
-    }),
-  });
-  const WithdrawalFee = IDL.Record({
-    minter_fee: IDL.Nat64,
-    bitcoin_fee: IDL.Nat64,
-  });
-  const SuspendedReason = IDL.Variant({
-    ValueTooSmall: IDL.Null,
-    Quarantined: IDL.Null,
-  });
-  const BitcoinAddress = IDL.Variant({
-    p2wsh_v0: IDL.Vec(IDL.Nat8),
-    p2tr_v1: IDL.Vec(IDL.Nat8),
-    p2sh: IDL.Vec(IDL.Nat8),
-    p2wpkh_v0: IDL.Vec(IDL.Nat8),
-    p2pkh: IDL.Vec(IDL.Nat8),
-  });
-  const InvalidTransactionError = IDL.Variant({
-    too_many_inputs: IDL.Record({
-      max_num_inputs: IDL.Nat64,
-      num_inputs: IDL.Nat64,
-    }),
-  });
-  const WithdrawalReimbursementReason = IDL.Variant({
-    invalid_transaction: InvalidTransactionError,
-  });
-  const ReplacedReason = IDL.Variant({
-    to_cancel: IDL.Record({ reason: WithdrawalReimbursementReason }),
-    to_retry: IDL.Null,
-  });
-  const EventType = IDL.Variant({
-    received_utxos: IDL.Record({
-      to_account: Account,
-      mint_txid: IDL.Opt(IDL.Nat64),
-      utxos: IDL.Vec(Utxo),
-    }),
-    schedule_deposit_reimbursement: IDL.Record({
-      burn_block_index: IDL.Nat64,
-      account: Account,
-      amount: IDL.Nat64,
-      reason: ReimbursementReason,
-    }),
-    sent_transaction: IDL.Record({
-      fee: IDL.Opt(IDL.Nat64),
-      change_output: IDL.Opt(IDL.Record({ value: IDL.Nat64, vout: IDL.Nat32 })),
-      txid: IDL.Vec(IDL.Nat8),
-      withdrawal_fee: IDL.Opt(WithdrawalFee),
-      utxos: IDL.Vec(Utxo),
-      requests: IDL.Vec(IDL.Nat64),
-      submitted_at: IDL.Nat64,
-    }),
-    distributed_kyt_fee: IDL.Record({
-      block_index: IDL.Nat64,
-      amount: IDL.Nat64,
-      kyt_provider: IDL.Principal,
-    }),
-    init: InitArgs,
-    upgrade: UpgradeArgs,
-    retrieve_btc_kyt_failed: IDL.Record({
-      block_index: IDL.Nat64,
-      owner: IDL.Principal,
-      uuid: IDL.Text,
-      address: IDL.Text,
-      amount: IDL.Nat64,
-      kyt_provider: IDL.Principal,
-    }),
-    suspended_utxo: IDL.Record({
-      utxo: Utxo,
-      account: Account,
-      reason: SuspendedReason,
-    }),
-    accepted_retrieve_btc_request: IDL.Record({
-      received_at: IDL.Nat64,
-      block_index: IDL.Nat64,
-      address: BitcoinAddress,
-      reimbursement_account: IDL.Opt(Account),
-      amount: IDL.Nat64,
-      kyt_provider: IDL.Opt(IDL.Principal),
-    }),
-    checked_utxo: IDL.Record({
-      clean: IDL.Bool,
-      utxo: Utxo,
-      uuid: IDL.Text,
-      kyt_provider: IDL.Opt(IDL.Principal),
-    }),
-    schedule_withdrawal_reimbursement: IDL.Record({
-      burn_block_index: IDL.Nat64,
-      account: Account,
-      amount: IDL.Nat64,
-      reason: WithdrawalReimbursementReason,
-    }),
-    quarantined_withdrawal_reimbursement: IDL.Record({
-      burn_block_index: IDL.Nat64,
-    }),
-    removed_retrieve_btc_request: IDL.Record({ block_index: IDL.Nat64 }),
-    confirmed_transaction: IDL.Record({ txid: IDL.Vec(IDL.Nat8) }),
-    replaced_transaction: IDL.Record({
-      fee: IDL.Nat64,
-      change_output: IDL.Record({ value: IDL.Nat64, vout: IDL.Nat32 }),
-      new_utxos: IDL.Opt(IDL.Vec(Utxo)),
-      old_txid: IDL.Vec(IDL.Nat8),
-      withdrawal_fee: IDL.Opt(WithdrawalFee),
-      new_txid: IDL.Vec(IDL.Nat8),
-      submitted_at: IDL.Nat64,
-      reason: IDL.Opt(ReplacedReason),
-    }),
-    checked_utxo_v2: IDL.Record({ utxo: Utxo, account: Account }),
-    ignored_utxo: IDL.Record({ utxo: Utxo }),
-    checked_utxo_mint_unknown: IDL.Record({
-      utxo: Utxo,
-      account: Account,
-    }),
-    reimbursed_failed_deposit: IDL.Record({
-      burn_block_index: IDL.Nat64,
-      mint_block_index: IDL.Nat64,
-    }),
-    reimbursed_withdrawal: IDL.Record({
-      burn_block_index: IDL.Nat64,
-      mint_block_index: IDL.Nat64,
-    }),
-  });
-  const Event = IDL.Record({
-    timestamp: IDL.Opt(IDL.Nat64),
-    payload: EventType,
-  });
-  const MinterInfo = IDL.Record({
-    retrieve_btc_min_amount: IDL.Nat64,
-    min_confirmations: IDL.Nat32,
-    kyt_fee: IDL.Nat64,
-  });
-  const RetrieveBtcArgs = IDL.Record({
-    address: IDL.Text,
-    amount: IDL.Nat64,
-  });
-  const RetrieveBtcOk = IDL.Record({ block_index: IDL.Nat64 });
-  const RetrieveBtcError = IDL.Variant({
-    MalformedAddress: IDL.Text,
-    GenericError: IDL.Record({
-      error_message: IDL.Text,
-      error_code: IDL.Nat64,
-    }),
-    TemporarilyUnavailable: IDL.Text,
-    AlreadyProcessing: IDL.Null,
-    AmountTooLow: IDL.Nat64,
-    InsufficientFunds: IDL.Record({ balance: IDL.Nat64 }),
-  });
-  const RetrieveBtcStatus = IDL.Variant({
-    Signing: IDL.Null,
-    Confirmed: IDL.Record({ txid: IDL.Vec(IDL.Nat8) }),
-    Sending: IDL.Record({ txid: IDL.Vec(IDL.Nat8) }),
-    AmountTooLow: IDL.Null,
-    Unknown: IDL.Null,
-    Submitted: IDL.Record({ txid: IDL.Vec(IDL.Nat8) }),
-    Pending: IDL.Null,
-  });
-  const ReimbursementRequest = IDL.Record({
-    account: Account,
-    amount: IDL.Nat64,
-    reason: ReimbursementReason,
-  });
-  const ReimbursedDeposit = IDL.Record({
-    account: Account,
-    mint_block_index: IDL.Nat64,
-    amount: IDL.Nat64,
-    reason: ReimbursementReason,
-  });
-  const RetrieveBtcStatusV2 = IDL.Variant({
-    Signing: IDL.Null,
-    Confirmed: IDL.Record({ txid: IDL.Vec(IDL.Nat8) }),
-    Sending: IDL.Record({ txid: IDL.Vec(IDL.Nat8) }),
-    AmountTooLow: IDL.Null,
-    WillReimburse: ReimbursementRequest,
-    Unknown: IDL.Null,
-    Submitted: IDL.Record({ txid: IDL.Vec(IDL.Nat8) }),
-    Reimbursed: ReimbursedDeposit,
-    Pending: IDL.Null,
-  });
-  const RetrieveBtcWithApprovalArgs = IDL.Record({
-    from_subaccount: IDL.Opt(IDL.Vec(IDL.Nat8)),
-    address: IDL.Text,
-    amount: IDL.Nat64,
-  });
-  const RetrieveBtcWithApprovalError = IDL.Variant({
-    MalformedAddress: IDL.Text,
-    GenericError: IDL.Record({
-      error_message: IDL.Text,
-      error_code: IDL.Nat64,
-    }),
-    TemporarilyUnavailable: IDL.Text,
-    InsufficientAllowance: IDL.Record({ allowance: IDL.Nat64 }),
-    AlreadyProcessing: IDL.Null,
-    AmountTooLow: IDL.Nat64,
-    InsufficientFunds: IDL.Record({ balance: IDL.Nat64 }),
-  });
-  const UtxoStatus = IDL.Variant({
-    ValueTooSmall: Utxo,
-    Tainted: Utxo,
-    Minted: IDL.Record({
-      minted_amount: IDL.Nat64,
-      block_index: IDL.Nat64,
-      utxo: Utxo,
-    }),
-    Checked: Utxo,
-  });
-  const Timestamp = IDL.Nat64;
-  const SuspendedUtxo = IDL.Record({
-    utxo: Utxo,
-    earliest_retry: Timestamp,
-    reason: SuspendedReason,
-  });
-  const PendingUtxo = IDL.Record({
-    confirmations: IDL.Nat32,
-    value: IDL.Nat64,
-    outpoint: IDL.Record({ txid: IDL.Vec(IDL.Nat8), vout: IDL.Nat32 }),
-  });
-  const UpdateBalanceError = IDL.Variant({
-    GenericError: IDL.Record({
-      error_message: IDL.Text,
-      error_code: IDL.Nat64,
-    }),
-    TemporarilyUnavailable: IDL.Text,
-    AlreadyProcessing: IDL.Null,
-    NoNewUtxos: IDL.Record({
-      suspended_utxos: IDL.Opt(IDL.Vec(SuspendedUtxo)),
-      required_confirmations: IDL.Nat32,
-      pending_utxos: IDL.Opt(IDL.Vec(PendingUtxo)),
-      current_confirmations: IDL.Opt(IDL.Nat32),
-    }),
-  });
-
-  return IDL.Service({
-    estimate_withdrawal_fee: IDL.Func(
-      [IDL.Record({ amount: IDL.Opt(IDL.Nat64) })],
-      [IDL.Record({ minter_fee: IDL.Nat64, bitcoin_fee: IDL.Nat64 })],
-      ["query"],
-    ),
-    get_btc_address: IDL.Func(
-      [
-        IDL.Record({
-          owner: IDL.Opt(IDL.Principal),
-          subaccount: IDL.Opt(IDL.Vec(IDL.Nat8)),
-        }),
-      ],
-      [IDL.Text],
-      [],
-    ),
-    get_canister_status: IDL.Func([], [CanisterStatusResponse], []),
-    get_deposit_fee: IDL.Func([], [IDL.Nat64], ["query"]),
-    get_events: IDL.Func(
-      [IDL.Record({ start: IDL.Nat64, length: IDL.Nat64 })],
-      [IDL.Vec(Event)],
-      ["query"],
-    ),
-    get_known_utxos: IDL.Func(
-      [
-        IDL.Record({
-          owner: IDL.Opt(IDL.Principal),
-          subaccount: IDL.Opt(IDL.Vec(IDL.Nat8)),
-        }),
-      ],
-      [IDL.Vec(Utxo)],
-      ["query"],
-    ),
-    get_minter_info: IDL.Func([], [MinterInfo], ["query"]),
-    get_withdrawal_account: IDL.Func([], [Account], []),
-    retrieve_btc: IDL.Func(
-      [RetrieveBtcArgs],
-      [IDL.Variant({ Ok: RetrieveBtcOk, Err: RetrieveBtcError })],
-      [],
-    ),
-    retrieve_btc_status: IDL.Func(
-      [IDL.Record({ block_index: IDL.Nat64 })],
-      [RetrieveBtcStatus],
-      ["query"],
-    ),
-    retrieve_btc_status_v2: IDL.Func(
-      [IDL.Record({ block_index: IDL.Nat64 })],
-      [RetrieveBtcStatusV2],
-      ["query"],
-    ),
-    retrieve_btc_status_v2_by_account: IDL.Func(
-      [IDL.Opt(Account)],
-      [
-        IDL.Vec(
-          IDL.Record({
-            block_index: IDL.Nat64,
-            status_v2: IDL.Opt(RetrieveBtcStatusV2),
-          }),
-        ),
-      ],
-      ["query"],
-    ),
-    retrieve_btc_with_approval: IDL.Func(
-      [RetrieveBtcWithApprovalArgs],
-      [
-        IDL.Variant({
-          Ok: RetrieveBtcOk,
-          Err: RetrieveBtcWithApprovalError,
-        }),
-      ],
-      [],
-    ),
-    update_balance: IDL.Func(
-      [
-        IDL.Record({
-          owner: IDL.Opt(IDL.Principal),
-          subaccount: IDL.Opt(IDL.Vec(IDL.Nat8)),
-        }),
-      ],
-      [
-        IDL.Variant({
-          Ok: IDL.Vec(UtxoStatus),
-          Err: UpdateBalanceError,
-        }),
-      ],
-      [],
-    ),
-  });
-};
-
-export const init = ({ IDL }) => {
-  const Mode = IDL.Variant({
-    RestrictedTo: IDL.Vec(IDL.Principal),
-    DepositsRestrictedTo: IDL.Vec(IDL.Principal),
-    ReadOnly: IDL.Null,
-    GeneralAvailability: IDL.Null,
-  });
-  const UpgradeArgs = IDL.Record({
-    get_utxos_cache_expiration_seconds: IDL.Opt(IDL.Nat64),
-    kyt_principal: IDL.Opt(IDL.Principal),
-    mode: IDL.Opt(Mode),
-    retrieve_btc_min_amount: IDL.Opt(IDL.Nat64),
-    max_time_in_queue_nanos: IDL.Opt(IDL.Nat64),
-    check_fee: IDL.Opt(IDL.Nat64),
-    btc_checker_principal: IDL.Opt(IDL.Principal),
-    min_confirmations: IDL.Opt(IDL.Nat32),
-    kyt_fee: IDL.Opt(IDL.Nat64),
-  });
-  const BtcNetwork = IDL.Variant({
-    Mainnet: IDL.Null,
-    Regtest: IDL.Null,
-    Testnet: IDL.Null,
-  });
-  const InitArgs = IDL.Record({
-    get_utxos_cache_expiration_seconds: IDL.Opt(IDL.Nat64),
-    kyt_principal: IDL.Opt(IDL.Principal),
-    ecdsa_key_name: IDL.Text,
-    mode: Mode,
-    retrieve_btc_min_amount: IDL.Nat64,
-    ledger_id: IDL.Principal,
-    max_time_in_queue_nanos: IDL.Nat64,
-    btc_network: BtcNetwork,
-    check_fee: IDL.Opt(IDL.Nat64),
-    btc_checker_principal: IDL.Opt(IDL.Principal),
-    min_confirmations: IDL.Opt(IDL.Nat32),
-    kyt_fee: IDL.Opt(IDL.Nat64),
-  });
-  const MinterArg = IDL.Variant({
-    Upgrade: IDL.Opt(UpgradeArgs),
-    Init: InitArgs,
-  });
-
-  return [MinterArg];
-};

package/dist/enums/btc.enums.d.ts

@@ -1,12 +0,0 @@
-export declare enum BtcNetwork {
-    Mainnet = 0,
-    Regtest = 1,
-    Testnet = 2
-}
-export declare enum BtcAddressType {
-    P2wpkhV0 = 0,
-    P2pkh = 1,
-    P2sh = 2,
-    P2wsh = 3,
-    P2tr = 4
-}

package/dist/errors/btc.errors.d.ts

@@ -1,18 +0,0 @@
-export declare class ParseBtcAddressError extends Error {
-}
-export declare class ParseBtcAddressInvalidError extends ParseBtcAddressError {
-}
-export declare class ParseBtcAddressNoDataError extends ParseBtcAddressError {
-}
-export declare class ParseBtcAddressUnsupportedAddressTypeError extends ParseBtcAddressError {
-}
-export declare class ParseBtcAddressBadWitnessLengthError extends ParseBtcAddressError {
-}
-export declare class ParseBtcAddressUnsupportedWitnessVersionError extends ParseBtcAddressError {
-}
-export declare class ParseBtcAddressUnexpectedHumanReadablePartError extends ParseBtcAddressError {
-}
-export declare class ParseBtcAddressMalformedAddressError extends ParseBtcAddressError {
-}
-export declare class ParseBtcAddressWrongNetworkError extends ParseBtcAddressError {
-}

package/dist/errors/minter.errors.d.ts

@@ -1,30 +0,0 @@
-import type { PendingUtxo, RetrieveBtcError, RetrieveBtcWithApprovalError, UpdateBalanceError } from "../candid/minter";
-export declare class MinterGenericError extends Error {
-}
-export declare class MinterTemporaryUnavailableError extends MinterGenericError {
-}
-export declare class MinterAlreadyProcessingError extends MinterGenericError {
-}
-export declare class MinterUpdateBalanceError extends MinterGenericError {
-}
-export declare class MinterNoNewUtxosError extends MinterUpdateBalanceError {
-    readonly pendingUtxos: PendingUtxo[];
-    readonly requiredConfirmations: number;
-    constructor({ pending_utxos, required_confirmations, }: {
-        pending_utxos: [] | [PendingUtxo[]];
-        required_confirmations: number;
-    });
-}
-export declare class MinterRetrieveBtcError extends MinterGenericError {
-}
-export declare class MinterMalformedAddressError extends MinterRetrieveBtcError {
-}
-export declare class MinterAmountTooLowError extends MinterRetrieveBtcError {
-}
-export declare class MinterInsufficientFundsError extends MinterRetrieveBtcError {
-}
-export declare class MinterInsufficientAllowanceError extends MinterRetrieveBtcError {
-}
-export declare const createUpdateBalanceError: (Err: UpdateBalanceError) => MinterGenericError;
-export declare const createRetrieveBtcError: (Err: RetrieveBtcError) => MinterGenericError;
-export declare const createRetrieveBtcWithApprovalError: (Err: RetrieveBtcWithApprovalError) => MinterGenericError;

package/dist/minter.canister.d.ts

@@ -1,120 +0,0 @@
-import { Canister, type QueryParams } from "@dfinity/utils";
-import type { _SERVICE as CkBTCMinterService, MinterInfo, RetrieveBtcOk, RetrieveBtcStatus, Utxo, Account as WithdrawalAccount } from "./candid/minter";
-import type { CkBTCCanisterOptions } from "./types/canister.options";
-import type { EstimateWithdrawalFeeParams, GetBTCAddressParams, GetKnownUtxosParams, RetrieveBtcParams, RetrieveBtcStatusV2ByAccountParams, UpdateBalanceParams } from "./types/minter.params";
-import type { EstimateWithdrawalFee, RetrieveBtcStatusV2WithId, UpdateBalanceOk } from "./types/minter.responses";
-export declare class CkBTCMinterCanister extends Canister<CkBTCMinterService> {
-    static create(options: CkBTCCanisterOptions<CkBTCMinterService>): CkBTCMinterCanister;
-    /**
-     * Returns a BTC address for a given account.
-     *
-     * Note: an update call is required by the Minter canister.
-     *
-     * @param {GetBTCAddressParams} params The parameters for which a BTC address should be resolved.
-     * @param {Principal} params.owner The owner for which the BTC address should be generated. If not provided, the `caller` will be use instead.
-     * @param {Uint8Array} params.subaccount An optional subaccount to compute the address.
-     * @returns {Promise<string>} The BTC address of the given account.
-     */
-    getBtcAddress: ({ owner, subaccount, }: GetBTCAddressParams) => Promise<string>;
-    /**
-     * Notify the minter about the bitcoin transfer.
-     *
-     * Upon successful notification, new ckBTC should be available on the targeted address.
-     *
-     * @param {UpdateBalanceParams} params The parameters are the address to which bitcoin where transferred.
-     * @param {Principal} params.owner The owner of the address. If not provided, the `caller` will be use instead.
-     * @param {Principal} params.subaccount An optional subaccount of the address.
-     * @returns {Promise<UpdateBalanceOk>} The result of the balance update.
-     */
-    updateBalance: ({ owner, subaccount, }: UpdateBalanceParams) => Promise<UpdateBalanceOk>;
-    /**
-     * 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.
-     */
-    getWithdrawalAccount: () => Promise<WithdrawalAccount>;
-    /**
-     * 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.
-     *
-     * @param {RetrieveBtcParams} params The parameters are the bitcoin address and amount to convert.
-     * @param {string} params.address The bitcoin address.
-     * @param {bigint} params.amount The ckBTC amount.
-     * @returns {Promise<RetrieveBtcOk>} The result or the operation.
-     */
-    retrieveBtc: (params: RetrieveBtcParams) => Promise<RetrieveBtcOk>;
-    /**
-     * Submits a request to convert ckBTC to BTC after making an ICRC-2 approval.
-     *
-     * # 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 allowed the minter's principal to spend its funds using
-     * [icrc2_approve] on the ckBTC ledger.
-     *
-     * @param {string} params.address The bitcoin address.
-     * @param {bigint} params.amount The ckBTC amount.
-     * @param {Uint8Array} params.fromSubaccount An optional subaccount from which
-     *     the ckBTC should be transferred.
-     * @returns {Promise<RetrieveBtcOk>} The result or the operation.
-     */
-    retrieveBtcWithApproval: ({ address, amount, fromSubaccount, }: {
-        address: string;
-        amount: bigint;
-        fromSubaccount?: Uint8Array;
-    }) => Promise<RetrieveBtcOk>;
-    /**
-     * Returns the status of a specific BTC withdrawal based on the transaction ID
-     * of the corresponding burn transaction.
-     *
-     * @param {bigint} transactionId The ID of the corresponding burn transaction.
-     * @param {boolean} certified query or update call
-     * @returns {Promise<RetrieveBtcStatus>} The status of the BTC retrieval request.
-     */
-    retrieveBtcStatus: ({ transactionId, certified, }: {
-        transactionId: bigint;
-        certified: boolean;
-    }) => Promise<RetrieveBtcStatus>;
-    /**
-     * Returns the status of all BTC withdrawals for an account.
-     *
-     * @param {boolean} certified query or update call
-     * @param {MinterAccount} account an optional account to retrieve the statuses. If not provided, statuses for the caller are retrieved.
-     * @returns {Promise<RetrieveBtcStatusV2WithId[]>} The statuses of the BTC retrieval requests.
-     */
-    retrieveBtcStatusV2ByAccount: ({ account, certified, }: RetrieveBtcStatusV2ByAccountParams) => Promise<RetrieveBtcStatusV2WithId[]>;
-    /**
-     * 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.
-     *
-     * @param {RetrieveBtcParams} params The parameters to estimate the fee.
-     * @param {boolean} params.certified query or update call
-     * @param {bigint | undefined} params.amount The optional amount for which the fee should be estimated.
-     */
-    estimateWithdrawalFee: ({ certified, amount, }: EstimateWithdrawalFeeParams) => Promise<EstimateWithdrawalFee>;
-    /**
-     * Returns internal minter parameters such as the minimal amount to retrieve BTC, minimal number of confirmations or KYT fee.
-     *
-     * @param {QueryParams} params The parameters to get the minter info.
-     * @param {boolean} params.certified query or update call
-     */
-    getMinterInfo: ({ certified }: QueryParams) => Promise<MinterInfo>;
-    /**
-     * Returns UTXOs of the given account known by the minter.
-     *
-     * @param {GetKnownUtxosParams} params The parameters for which the known utxos should be resolved.
-     * @param {Principal} params.owner The owner of the account. Note that if not provided, the `caller` would be used by the minter instead.
-     * @param {Uint8Array} params.subaccount An optional subaccount.
-     * @returns {Promise<Utxo[]>} The known utxos (with no guarantee in the ordering).
-     */
-    getKnownUtxos: ({ owner, subaccount, certified, }: GetKnownUtxosParams) => Promise<Utxo[]>;
-}

package/dist/types/bitcoin.params.d.ts

@@ -1,17 +0,0 @@
-import { type QueryParams } from "@dfinity/utils";
-import type { get_balance_request, get_utxos_request } from "../candid/bitcoin";
-export type BitcoinNetwork = "testnet" | "mainnet" | "regtest";
-export type GetUtxosParams = Omit<get_utxos_request, "network" | "filter"> & {
-    network: BitcoinNetwork;
-    filter?: {
-        page: Uint8Array;
-    } | {
-        minConfirmations: number;
-    };
-} & Omit<QueryParams, "certified">;
-export declare const toGetUtxosParams: ({ network, filter, ...rest }: GetUtxosParams) => get_utxos_request;
-export type GetBalanceParams = Omit<get_balance_request, "network" | "min_confirmations"> & {
-    network: BitcoinNetwork;
-    minConfirmations?: number;
-} & Omit<QueryParams, "certified">;
-export declare const toGetBalanceParams: ({ network, minConfirmations, ...rest }: GetBalanceParams) => get_balance_request;

package/dist/types/btc.d.ts

@@ -1,9 +0,0 @@
-import type { BtcAddressType, BtcNetwork } from "../enums/btc.enums";
-export interface BtcAddress {
-    address: string;
-    network?: BtcNetwork;
-}
-export interface BtcAddressInfo extends Required<BtcAddress> {
-    parser: "bip-173" | "base58";
-    type: BtcAddressType;
-}

package/dist/types/canister.options.d.ts

@@ -1,5 +0,0 @@
-import type { CanisterOptions } from "@dfinity/utils";
-import type { Principal } from "@icp-sdk/core/principal";
-export interface CkBTCCanisterOptions<T> extends Omit<CanisterOptions<T>, "canisterId"> {
-    canisterId: Principal;
-}