@dfinity/cmc 8.0.1 → 9.0.0

package/dist/candid/cmc.idl.js

@@ -1,203 +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 ExchangeRateCanister = IDL.Variant({
-    Set: IDL.Principal,
-    Unset: IDL.Null,
-  });
-  const AccountIdentifier = IDL.Text;
-  const CyclesCanisterInitPayload = IDL.Record({
-    exchange_rate_canister: IDL.Opt(ExchangeRateCanister),
-    cycles_ledger_canister_id: IDL.Opt(IDL.Principal),
-    last_purged_notification: IDL.Opt(IDL.Nat64),
-    governance_canister_id: IDL.Opt(IDL.Principal),
-    minting_account_id: IDL.Opt(AccountIdentifier),
-    ledger_canister_id: IDL.Opt(IDL.Principal),
-  });
-  const SubnetListWithType = IDL.Record({
-    subnets: IDL.Vec(IDL.Principal),
-    subnet_type: IDL.Text,
-  });
-  const ChangeSubnetTypeAssignmentArgs = IDL.Variant({
-    Add: SubnetListWithType,
-    Remove: SubnetListWithType,
-  });
-  const SubnetFilter = IDL.Record({ subnet_type: IDL.Opt(IDL.Text) });
-  const SubnetSelection = IDL.Variant({
-    Filter: SubnetFilter,
-    Subnet: IDL.Record({ subnet: IDL.Principal }),
-  });
-  const environment_variable = IDL.Record({
-    value: IDL.Text,
-    name: IDL.Text,
-  });
-  const log_visibility = IDL.Variant({
-    controllers: IDL.Null,
-    public: IDL.Null,
-    allowed_viewers: IDL.Vec(IDL.Principal),
-  });
-  const CanisterSettings = IDL.Record({
-    freezing_threshold: IDL.Opt(IDL.Nat),
-    wasm_memory_threshold: IDL.Opt(IDL.Nat),
-    environment_variables: IDL.Opt(IDL.Vec(environment_variable)),
-    controllers: IDL.Opt(IDL.Vec(IDL.Principal)),
-    reserved_cycles_limit: IDL.Opt(IDL.Nat),
-    log_visibility: IDL.Opt(log_visibility),
-    log_memory_limit: IDL.Opt(IDL.Nat),
-    wasm_memory_limit: IDL.Opt(IDL.Nat),
-    memory_allocation: IDL.Opt(IDL.Nat),
-    compute_allocation: IDL.Opt(IDL.Nat),
-  });
-  const CreateCanisterArg = IDL.Record({
-    subnet_selection: IDL.Opt(SubnetSelection),
-    settings: IDL.Opt(CanisterSettings),
-    subnet_type: IDL.Opt(IDL.Text),
-  });
-  const CreateCanisterError = IDL.Variant({
-    Refunded: IDL.Record({
-      create_error: IDL.Text,
-      refund_amount: IDL.Nat,
-    }),
-  });
-  const CreateCanisterResult = IDL.Variant({
-    Ok: IDL.Principal,
-    Err: CreateCanisterError,
-  });
-  const IcpXdrConversionRate = IDL.Record({
-    xdr_permyriad_per_icp: IDL.Nat64,
-    timestamp_seconds: IDL.Nat64,
-  });
-  const IcpXdrConversionRateResponse = IDL.Record({
-    certificate: IDL.Vec(IDL.Nat8),
-    data: IcpXdrConversionRate,
-    hash_tree: IDL.Vec(IDL.Nat8),
-  });
-  const PrincipalsAuthorizedToCreateCanistersToSubnetsResponse = IDL.Record({
-    data: IDL.Vec(IDL.Tuple(IDL.Principal, IDL.Vec(IDL.Principal))),
-  });
-  const SubnetTypesToSubnetsResponse = IDL.Record({
-    data: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Vec(IDL.Principal))),
-  });
-  const BlockIndex = IDL.Nat64;
-  const NotifyCreateCanisterArg = IDL.Record({
-    controller: IDL.Principal,
-    block_index: BlockIndex,
-    subnet_selection: IDL.Opt(SubnetSelection),
-    settings: IDL.Opt(CanisterSettings),
-    subnet_type: IDL.Opt(IDL.Text),
-  });
-  const NotifyError = IDL.Variant({
-    Refunded: IDL.Record({
-      block_index: IDL.Opt(BlockIndex),
-      reason: IDL.Text,
-    }),
-    InvalidTransaction: IDL.Text,
-    Other: IDL.Record({
-      error_message: IDL.Text,
-      error_code: IDL.Nat64,
-    }),
-    Processing: IDL.Null,
-    TransactionTooOld: BlockIndex,
-  });
-  const NotifyCreateCanisterResult = IDL.Variant({
-    Ok: IDL.Principal,
-    Err: NotifyError,
-  });
-  const Memo = IDL.Opt(IDL.Vec(IDL.Nat8));
-  const Subaccount = IDL.Opt(IDL.Vec(IDL.Nat8));
-  const NotifyMintCyclesArg = IDL.Record({
-    block_index: BlockIndex,
-    deposit_memo: Memo,
-    to_subaccount: Subaccount,
-  });
-  const NotifyMintCyclesSuccess = IDL.Record({
-    balance: IDL.Nat,
-    block_index: IDL.Nat,
-    minted: IDL.Nat,
-  });
-  const NotifyMintCyclesResult = IDL.Variant({
-    Ok: NotifyMintCyclesSuccess,
-    Err: NotifyError,
-  });
-  const NotifyTopUpArg = IDL.Record({
-    block_index: BlockIndex,
-    canister_id: IDL.Principal,
-  });
-  const Cycles = IDL.Nat;
-  const NotifyTopUpResult = IDL.Variant({ Ok: Cycles, Err: NotifyError });
-  const SetAuthorizedSubnetworkListArgs = IDL.Record({
-    who: IDL.Opt(IDL.Principal),
-    subnets: IDL.Vec(IDL.Principal),
-  });
-  const UpdateSubnetTypeArgs = IDL.Variant({
-    Add: IDL.Text,
-    Remove: IDL.Text,
-  });
-
-  return IDL.Service({
-    change_subnet_type_assignment: IDL.Func(
-      [ChangeSubnetTypeAssignmentArgs],
-      [],
-      [],
-    ),
-    create_canister: IDL.Func([CreateCanisterArg], [CreateCanisterResult], []),
-    get_build_metadata: IDL.Func([], [IDL.Text], ["query"]),
-    get_default_subnets: IDL.Func([], [IDL.Vec(IDL.Principal)], ["query"]),
-    get_icp_xdr_conversion_rate: IDL.Func(
-      [],
-      [IcpXdrConversionRateResponse],
-      ["query"],
-    ),
-    get_principals_authorized_to_create_canisters_to_subnets: IDL.Func(
-      [],
-      [PrincipalsAuthorizedToCreateCanistersToSubnetsResponse],
-      ["query"],
-    ),
-    get_subnet_types_to_subnets: IDL.Func(
-      [],
-      [SubnetTypesToSubnetsResponse],
-      ["query"],
-    ),
-    notify_create_canister: IDL.Func(
-      [NotifyCreateCanisterArg],
-      [NotifyCreateCanisterResult],
-      [],
-    ),
-    notify_mint_cycles: IDL.Func(
-      [NotifyMintCyclesArg],
-      [NotifyMintCyclesResult],
-      [],
-    ),
-    notify_top_up: IDL.Func([NotifyTopUpArg], [NotifyTopUpResult], []),
-    set_authorized_subnetwork_list: IDL.Func(
-      [SetAuthorizedSubnetworkListArgs],
-      [],
-      [],
-    ),
-    update_subnet_type: IDL.Func([UpdateSubnetTypeArgs], [], []),
-  });
-};
-
-export const init = ({ IDL }) => {
-  const ExchangeRateCanister = IDL.Variant({
-    Set: IDL.Principal,
-    Unset: IDL.Null,
-  });
-  const AccountIdentifier = IDL.Text;
-  const CyclesCanisterInitPayload = IDL.Record({
-    exchange_rate_canister: IDL.Opt(ExchangeRateCanister),
-    cycles_ledger_canister_id: IDL.Opt(IDL.Principal),
-    last_purged_notification: IDL.Opt(IDL.Nat64),
-    governance_canister_id: IDL.Opt(IDL.Principal),
-    minting_account_id: IDL.Opt(AccountIdentifier),
-    ledger_canister_id: IDL.Opt(IDL.Principal),
-  });
-
-  return [IDL.Opt(CyclesCanisterInitPayload)];
-};

package/dist/cmc.canister.d.ts

@@ -1,63 +0,0 @@
-import { Canister, type QueryParams } from "@dfinity/utils";
-import type { Principal } from "@icp-sdk/core/principal";
-import type { _SERVICE as CMCCanisterService, Cycles, NotifyCreateCanisterArg, NotifyTopUpArg, SubnetTypesToSubnetsResponse } from "./candid/cmc";
-import type { CMCCanisterOptions } from "./cmc.options";
-export declare class CMCCanister extends Canister<CMCCanisterService> {
-    static create(options: CMCCanisterOptions): CMCCanister;
-    /**
-     * Returns conversion rate of ICP to Cycles. It can be called as query or update.
-     *
-     * @param {Object} [params] - The parameters for the call.
-     * @param {boolean} [params.certified] - Determines whether the response should be certified (default: non-certified)
-     *
-     * @returns Promise<BigInt>
-     */
-    getIcpToCyclesConversionRate: ({ certified, }?: QueryParams) => Promise<bigint>;
-    /**
-     * Notifies Cycles Minting Canister of the creation of a new canister.
-     * It returns the new canister principal.
-     *
-     * @param {Object} request
-     * @param {Principal} request.controller
-     * @param {BlockIndex} request.block_index
-     * @returns Promise<Principal>
-     * @throws RefundedError, InvalidaTransactionError, ProcessingError, TransactionTooOldError, CMCError
-     */
-    notifyCreateCanister: (request: NotifyCreateCanisterArg) => Promise<Principal>;
-    /**
-     * Notifies Cycles Minting Canister of new cycles being added to canister.
-     * It returns the new Cycles of the canister.
-     *
-     * @param {Object} request
-     * @param {Principal} request.canister_id
-     * @param {BlockIndex} request.block_index
-     * @returns Promise<Cycles>
-     * @throws RefundedError, InvalidaTransactionError, ProcessingError, TransactionTooOldError, CMCError
-     */
-    notifyTopUp: (request: NotifyTopUpArg) => Promise<Cycles>;
-    /**
-     * This function calls the `get_default_subnets` method of the CMC canister, which returns a list of
-     * default subnets as `Principal` objects. It can be called as query or update.
-     *
-     * @param {Object} [params] - The query parameters for the call.
-     * @param {boolean} [params.certified] - Determines whether the response should be certified
-     * (default: non-certified if not specified).
-     *
-     * @returns {Promise<Principal[]>} - A promise that resolves to an array of `Principal` objects
-     * representing the default subnets.
-     */
-    getDefaultSubnets: ({ certified }?: QueryParams) => Promise<Principal[]>;
-    /**
-     * This function calls the `get_subnet_types_to_subnets` method of the CMC canister, which returns a list of subnets where canisters can be created.
-     * These subnets are excluded from the random subnet selection process used by the CMC when no explicit subnet ID is provided
-     * during canister creation and therefore, not provided in the results of the similar function `get_default_subnets`.
-     *
-     * @param {Object} [params] - The optional query parameters for the call.
-     * @param {boolean} [params.certified=false] - Specifies whether the response should be certified.
-     * If not provided, the response defaults to non-certified.
-     *
-     * @returns {Promise<SubnetTypesToSubnetsResponse>} - A promise that resolves to an object representing
-     * the mapping of subnet types to subnets.
-     */
-    getSubnetTypesToSubnets: ({ certified, }?: QueryParams) => Promise<SubnetTypesToSubnetsResponse>;
-}

package/dist/cmc.errors.d.ts

@@ -1,14 +0,0 @@
-import type { NotifyError } from "./candid/cmc";
-export declare class RefundedError extends Error {
-}
-export declare class InvalidaTransactionError extends Error {
-}
-export declare class CMCError extends Error {
-}
-export declare class ProcessingError extends Error {
-}
-export declare class TransactionTooOldError extends Error {
-}
-export declare const throwNotifyError: ({ Err: error, }: {
-    Err: NotifyError;
-}) => void;

package/dist/cmc.options.d.ts

@@ -1,6 +0,0 @@
-import type { CanisterOptions } from "@dfinity/utils";
-import type { Principal } from "@icp-sdk/core/principal";
-import type { _SERVICE as CanisterService } from "./candid/cmc";
-export interface CMCCanisterOptions extends Omit<CanisterOptions<CanisterService>, "canisterId"> {
-    canisterId: Principal;
-}