@junobuild/functions 0.4.1 → 0.5.0

package/canisters/_canister.d.ts

@@ -0,0 +1,17 @@
+import type { Principal } from '@icp-sdk/core/principal';
+import * as z from 'zod';
+/**
+ * @see CanisterParameters
+ */
+export declare const CanisterParametersSchema: z.ZodObject<{
+    canisterId: z.ZodCustom<Principal, Principal>;
+}, z.core.$strict>;
+/**
+ * The parameters that define a canister.
+ */
+export type CanisterParameters = z.infer<typeof CanisterParametersSchema>;
+export declare abstract class Canister {
+    #private;
+    protected constructor({ canisterId }: CanisterParameters);
+    get canisterId(): Principal;
+}

package/canisters/_constants.d.ts

@@ -0,0 +1,3 @@
+import { Principal } from '@icp-sdk/core/principal';
+export declare const CMC_ID: Principal;
+export declare const ICP_LEDGER_ID: Principal;

package/canisters/ckbtc/index.d.ts

@@ -0,0 +1 @@
+export { CkBTCBitcoinIdl, CkBTCMinterIdl, type CkBTCBitcoinDid, type CkBTCMinterDid } from '../declarations';

package/canisters/ckbtc/index.js

@@ -0,0 +1,2 @@
+import{a as i,b as C}from"../../chunk-HANEPD6T.js";import"../../chunk-4C666HHU.js";export{i as CkBTCBitcoinIdl,C as CkBTCMinterIdl};
+//# sourceMappingURL=index.js.map

package/canisters/cketh/index.d.ts

@@ -0,0 +1 @@
+export { CkETHMinterIdl, CkETHOrchestratorIdl, type CkETHMinterDid, type CkETHOrchestratorDid } from '../declarations';

package/canisters/cketh/index.js

@@ -0,0 +1,2 @@
+import{c as r,d as t}from"../../chunk-HANEPD6T.js";import"../../chunk-4C666HHU.js";export{r as CkETHMinterIdl,t as CkETHOrchestratorIdl};
+//# sourceMappingURL=index.js.map

package/canisters/cketh/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/canisters/cmc/cmc.canister.d.ts

@@ -0,0 +1,28 @@
+import { Canister } from '../_canister';
+import { type CmcDid } from '../declarations';
+import { type CanisterOptions } from '../schemas';
+/**
+ * Provides a simple interface to interact with the Cycle Minting Canister,
+ * when developing Juno Serverless Functions in TypeScript.
+ *
+ * @param {CanisterOptions} [options] - Optional custom canister ID.
+ */
+export declare class CMCCanister extends Canister {
+    constructor(options?: CanisterOptions);
+    /**
+     * Notifies the Cycle Minting Canister (CMC) that a top-up transfer has been completed.
+     *
+     * After sending ICP to the CMC top-up account for a canister, the transfer is recorded
+     * on the ledger. The CMC does not automatically convert that ICP into cycles — you
+     * must call this function to let the CMC know which transaction to process.
+     *
+     * The CMC will then convert the ICP from the given ledger block into cycles and add
+     * them to the specified canister.
+     *
+     * @param {CmcDid.NotifyTopUpArg} args - Arguments containing the ledger block index and the canister ID that should receive the cycles.
+     * @returns {Promise<CmcDid.NotifyTopUpResult>} The result of the CMC conversion and deposit.
+     */
+    notifyTopUp: ({ args }: {
+        args: CmcDid.NotifyTopUpArg;
+    }) => Promise<CmcDid.NotifyTopUpResult>;
+}

package/canisters/cmc/index.d.ts

@@ -0,0 +1,2 @@
+export { CmcIdl, type CmcDid } from '../declarations';
+export { CMCCanister } from './cmc.canister';

package/canisters/cmc/index.js

@@ -0,0 +1,2 @@
+import{a as s}from"../../chunk-BXZ5PSUW.js";import{a as e}from"../../chunk-5NZMOUKF.js";import{g as i}from"../../chunk-EMQQE34V.js";import{a as p}from"../../chunk-TZVF5LQY.js";import"../../chunk-7B6WU32N.js";import{e as o}from"../../chunk-HANEPD6T.js";import"../../chunk-4C666HHU.js";var r=class extends e{constructor(t={}){p.parse(t),super({canisterId:t?.canisterId??s})}notifyTopUp=async({args:t})=>await i({canisterId:this.canisterId,method:"notify_top_up",args:[[o.NotifyTopUpArg,t]],result:o.NotifyTopUpResult})};export{r as CMCCanister,o as CmcIdl};
+//# sourceMappingURL=index.js.map

package/canisters/cmc/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/canisters/cmc/cmc.canister.ts"],
+  "sourcesContent": ["import {call} from '../../ic-cdk/call.ic-cdk';\nimport {Canister} from '../_canister';\nimport {CMC_ID} from '../_constants';\nimport {type CmcDid, CmcIdl} from '../declarations';\nimport {type CanisterOptions, CanisterOptionsSchema} from '../schemas';\n\n/**\n * Provides a simple interface to interact with the Cycle Minting Canister,\n * when developing Juno Serverless Functions in TypeScript.\n *\n * @param {CanisterOptions} [options] - Optional custom canister ID.\n */\nexport class CMCCanister extends Canister {\n  constructor(options: CanisterOptions = {}) {\n    CanisterOptionsSchema.parse(options);\n\n    super({canisterId: options?.canisterId ?? CMC_ID});\n  }\n\n  /**\n   * Notifies the Cycle Minting Canister (CMC) that a top-up transfer has been completed.\n   *\n   * After sending ICP to the CMC top-up account for a canister, the transfer is recorded\n   * on the ledger. The CMC does not automatically convert that ICP into cycles \u2014 you\n   * must call this function to let the CMC know which transaction to process.\n   *\n   * The CMC will then convert the ICP from the given ledger block into cycles and add\n   * them to the specified canister.\n   *\n   * @param {CmcDid.NotifyTopUpArg} args - Arguments containing the ledger block index and the canister ID that should receive the cycles.\n   * @returns {Promise<CmcDid.NotifyTopUpResult>} The result of the CMC conversion and deposit.\n   */\n  notifyTopUp = async ({args}: {args: CmcDid.NotifyTopUpArg}): Promise<CmcDid.NotifyTopUpResult> =>\n    await call<CmcDid.NotifyTopUpResult>({\n      canisterId: this.canisterId,\n      method: 'notify_top_up',\n      args: [[CmcIdl.NotifyTopUpArg, args]],\n      result: CmcIdl.NotifyTopUpResult\n    });\n}\n"],
+  "mappings": "4RAYO,IAAMA,EAAN,cAA0BC,CAAS,CACxC,YAAYC,EAA2B,CAAC,EAAG,CACzCC,EAAsB,MAAMD,CAAO,EAEnC,MAAM,CAAC,WAAYA,GAAS,YAAcE,CAAM,CAAC,CACnD,CAeA,YAAc,MAAO,CAAC,KAAAC,CAAI,IACxB,MAAMC,EAA+B,CACnC,WAAY,KAAK,WACjB,OAAQ,gBACR,KAAM,CAAC,CAACC,EAAO,eAAgBF,CAAI,CAAC,EACpC,OAAQE,EAAO,iBACjB,CAAC,CACL",
+  "names": ["CMCCanister", "Canister", "options", "CanisterOptionsSchema", "CMC_ID", "args", "call", "cmc_did_idl_exports"]
+}

package/canisters/declarations/_idl.d.ts

@@ -0,0 +1,16 @@
+import * as CkBTCBitcoinIdl from './ckbtc/bitcoin.did.idl';
+import * as CkBTCMinterIdl from './ckbtc/minter.did.idl';
+import * as CkETHMinterIdl from './cketh/minter.did.idl';
+import * as CkETHOrchestratorIdl from './cketh/orchestrator.did.idl';
+import * as CmcIdl from './cmc/cmc.did.idl';
+import * as IcManagementIdl from './ic-management/ic-management.did.idl';
+import * as IcpIndexIdl from './ledger-icp/index.did.idl';
+import * as IcpLedgerIdl from './ledger-icp/ledger.did.idl';
+import * as IcrcIndexNgIdl from './ledger-icrc/icrc_index-ng.did.idl';
+import * as IcrcLedgerIdl from './ledger-icrc/icrc_ledger.did.idl';
+import * as NnsGovernanceIdl from './nns/governance.did.idl';
+import * as NnsSnsWasmIdl from './nns/sns_wasm.did.idl';
+import * as SnsGovernanceIdl from './sns/sns_governance.did.idl';
+import * as SnsRootIdl from './sns/sns_root.did.idl';
+import * as SnsSwapIdl from './sns/sns_swap.did.idl';
+export { CkBTCBitcoinIdl, CkBTCMinterIdl, CkETHMinterIdl, CkETHOrchestratorIdl, CmcIdl, IcManagementIdl, IcpIndexIdl, IcpLedgerIdl, IcrcIndexNgIdl, IcrcLedgerIdl, NnsGovernanceIdl, NnsSnsWasmIdl, SnsGovernanceIdl, SnsRootIdl, SnsSwapIdl };

package/canisters/declarations/_types.d.ts

@@ -0,0 +1,16 @@
+import type * as CkBTCBitcoinDid from './ckbtc/bitcoin.did';
+import type * as CkBTCMinterDid from './ckbtc/minter.did';
+import type * as CkETHMinterDid from './cketh/minter.did';
+import type * as CkETHOrchestratorDid from './cketh/orchestrator.did';
+import type * as CmcDid from './cmc/cmc.did';
+import type * as IcManagementDid from './ic-management/ic-management.did';
+import type * as IcpIndexDid from './ledger-icp/index.did';
+import type * as IcpLedgerDid from './ledger-icp/ledger.did';
+import type * as IcrcIndexNgDid from './ledger-icrc/icrc_index-ng.did';
+import type * as IcrcLedgerDid from './ledger-icrc/icrc_ledger.did';
+import type * as NnsGovernanceDid from './nns/governance.did';
+import type * as NnsSnsWasmDid from './nns/sns_wasm.did';
+import type * as SnsGovernanceDid from './sns/sns_governance.did';
+import type * as SnsRootDid from './sns/sns_root.did';
+import type * as SnsSwapDid from './sns/sns_swap.did';
+export type { CkBTCBitcoinDid, CkBTCMinterDid, CkETHMinterDid, CkETHOrchestratorDid, CmcDid, IcManagementDid, IcpIndexDid, IcpLedgerDid, IcrcIndexNgDid, IcrcLedgerDid, NnsGovernanceDid, NnsSnsWasmDid, SnsGovernanceDid, SnsRootDid, SnsSwapDid };

package/canisters/declarations/ckbtc/bitcoin.did.d.ts

@@ -0,0 +1,134 @@
+/* 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.
+
+import type { ActorMethod } from '@icp-sdk/core/agent';
+import type { IDL } from '@icp-sdk/core/candid';
+import type { Principal } from '@icp-sdk/core/principal';
+
+export type address = string;
+export type block_hash = Uint8Array;
+export type block_header = Uint8Array;
+export type block_height = number;
+export interface config {
+  'api_access' : flag,
+  'lazily_evaluate_fee_percentiles' : flag,
+  'blocks_source' : Principal,
+  'fees' : fees,
+  'watchdog_canister' : [] | [Principal],
+  'network' : network,
+  'stability_threshold' : bigint,
+  'syncing' : flag,
+  'burn_cycles' : flag,
+  'disable_api_if_not_fully_synced' : flag,
+}
+export interface fees {
+  'get_current_fee_percentiles' : bigint,
+  'get_utxos_maximum' : bigint,
+  'get_block_headers_cycles_per_ten_instructions' : bigint,
+  'get_current_fee_percentiles_maximum' : bigint,
+  'send_transaction_per_byte' : bigint,
+  'get_balance' : bigint,
+  'get_utxos_cycles_per_ten_instructions' : bigint,
+  'get_block_headers_base' : bigint,
+  'get_utxos_base' : bigint,
+  'get_balance_maximum' : bigint,
+  'send_transaction_base' : bigint,
+  'get_block_headers_maximum' : bigint,
+}
+export type flag = { 'disabled' : null } |
+  { 'enabled' : null };
+export interface get_balance_request {
+  'network' : network,
+  'address' : address,
+  'min_confirmations' : [] | [number],
+}
+export interface get_block_headers_request {
+  'start_height' : block_height,
+  'end_height' : [] | [block_height],
+  'network' : network,
+}
+export interface get_block_headers_response {
+  'tip_height' : block_height,
+  'block_headers' : Array<block_header>,
+}
+export interface get_current_fee_percentiles_request { 'network' : network }
+export interface get_utxos_request {
+  'network' : network,
+  'filter' : [] | [{ 'page' : Uint8Array } | { 'min_confirmations' : number }],
+  'address' : address,
+}
+export interface get_utxos_response {
+  'next_page' : [] | [Uint8Array],
+  'tip_height' : block_height,
+  'tip_block_hash' : block_hash,
+  'utxos' : Array<utxo>,
+}
+export interface init_config {
+  'api_access' : [] | [flag],
+  'lazily_evaluate_fee_percentiles' : [] | [flag],
+  'blocks_source' : [] | [Principal],
+  'fees' : [] | [fees],
+  'watchdog_canister' : [] | [[] | [Principal]],
+  'network' : [] | [network],
+  'stability_threshold' : [] | [bigint],
+  'syncing' : [] | [flag],
+  'burn_cycles' : [] | [flag],
+  'disable_api_if_not_fully_synced' : [] | [flag],
+}
+export type millisatoshi_per_byte = bigint;
+export type network = { 'mainnet' : null } |
+  { 'regtest' : null } |
+  { 'testnet' : null };
+export interface outpoint { 'txid' : Uint8Array, 'vout' : number }
+export type satoshi = bigint;
+export interface send_transaction_request {
+  'transaction' : Uint8Array,
+  'network' : network,
+}
+export interface set_config_request {
+  'api_access' : [] | [flag],
+  'lazily_evaluate_fee_percentiles' : [] | [flag],
+  'fees' : [] | [fees],
+  'watchdog_canister' : [] | [[] | [Principal]],
+  'stability_threshold' : [] | [bigint],
+  'syncing' : [] | [flag],
+  'burn_cycles' : [] | [flag],
+  'disable_api_if_not_fully_synced' : [] | [flag],
+}
+export interface utxo {
+  'height' : block_height,
+  'value' : satoshi,
+  'outpoint' : outpoint,
+}
+export interface _SERVICE {
+  'bitcoin_get_balance' : ActorMethod<[get_balance_request], satoshi>,
+  'bitcoin_get_balance_query' : ActorMethod<[get_balance_request], satoshi>,
+  'bitcoin_get_block_headers' : ActorMethod<
+    [get_block_headers_request],
+    get_block_headers_response
+  >,
+  'bitcoin_get_current_fee_percentiles' : ActorMethod<
+    [get_current_fee_percentiles_request],
+    BigUint64Array
+  >,
+  'bitcoin_get_utxos' : ActorMethod<[get_utxos_request], get_utxos_response>,
+  'bitcoin_get_utxos_query' : ActorMethod<
+    [get_utxos_request],
+    get_utxos_response
+  >,
+  'bitcoin_send_transaction' : ActorMethod<
+    [send_transaction_request],
+    undefined
+  >,
+  'get_config' : ActorMethod<[], config>,
+  'set_config' : ActorMethod<[set_config_request], undefined>,
+}
+export declare const idlService: IDL.ServiceClass;
+export declare const idlInitArgs: IDL.Type[];
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];

package/canisters/declarations/ckbtc/bitcoin.did.idl.d.ts

@@ -0,0 +1,40 @@
+export const flag: IDL.VariantClass;
+export const fees: IDL.RecordClass;
+export const network: IDL.VariantClass;
+export const init_config: IDL.RecordClass;
+export const address: IDL.TextClass;
+export const get_balance_request: IDL.RecordClass;
+export const satoshi: IDL.FixedNatClass;
+export const block_height: IDL.FixedNatClass;
+export const get_block_headers_request: IDL.RecordClass;
+export const block_header: IDL.VecClass<number | bigint>;
+export const get_block_headers_response: IDL.RecordClass;
+export const get_current_fee_percentiles_request: IDL.RecordClass;
+export const millisatoshi_per_byte: IDL.FixedNatClass;
+export const get_utxos_request: IDL.RecordClass;
+export const block_hash: IDL.VecClass<number | bigint>;
+export const outpoint: IDL.RecordClass;
+export const utxo: IDL.RecordClass;
+export const get_utxos_response: IDL.RecordClass;
+export const send_transaction_request: IDL.RecordClass;
+export const config: IDL.RecordClass;
+export const set_config_request: IDL.RecordClass;
+export const idlService: IDL.ServiceClass<string, {
+    bitcoin_get_balance: IDL.FuncClass<[IDL.RecordClass], [IDL.FixedNatClass]>;
+    bitcoin_get_balance_query: IDL.FuncClass<[IDL.RecordClass], [IDL.FixedNatClass]>;
+    bitcoin_get_block_headers: IDL.FuncClass<[IDL.RecordClass], [IDL.RecordClass]>;
+    bitcoin_get_current_fee_percentiles: IDL.FuncClass<[IDL.RecordClass], [IDL.VecClass<number | bigint>]>;
+    bitcoin_get_utxos: IDL.FuncClass<[IDL.RecordClass], [IDL.RecordClass]>;
+    bitcoin_get_utxos_query: IDL.FuncClass<[IDL.RecordClass], [IDL.RecordClass]>;
+    bitcoin_send_transaction: IDL.FuncClass<[IDL.RecordClass], []>;
+    get_config: IDL.FuncClass<[], [IDL.RecordClass]>;
+    set_config: IDL.FuncClass<[IDL.RecordClass], []>;
+}>;
+export const idlInitArgs: IDL.RecordClass[];
+export function idlFactory({ IDL }: {
+    IDL: any;
+}): any;
+export function init({ IDL }: {
+    IDL: any;
+}): any[];
+import { IDL } from '@icp-sdk/core/candid';