@junobuild/admin 0.0.11 → 0.0.13

package/README.md

@@ -4,7 +4,7 @@
 [npm-badge]: https://img.shields.io/npm/v/@junobuild/admin
 [npm-badge-url]: https://www.npmjs.com/package/@junobuild/admin
 [npm-license]: https://img.shields.io/npm/l/@junobuild/admin
-[npm-license-url]: https://github.com/deckgo/junobuild/blob/main/webcomponents/admin/LICENSE
+[npm-license-url]: https://github.com/buildwithjuno/juno-js/blob/main/LICENSE
 
 # Juno JavaScript admin SDK
 

package/declarations/cmc/cmc.did

@@ -0,0 +1,122 @@
+type Cycles = nat;
+type BlockIndex = nat64;
+
+// The argument of the [notify_top_up] method.
+type NotifyTopUpArg = record {
+  // Index of the block on the ICP ledger that contains the payment.
+  block_index : BlockIndex;
+
+  // The canister to top up.
+  canister_id : principal;
+};
+
+// The argument of the [notify_create_canister] method.
+type NotifyCreateCanisterArg = record {
+  // Index of the block on the ICP ledger that contains the payment.
+  block_index : BlockIndex;
+
+  // The controller of canister to create.
+  controller : principal;
+
+  // An optional subnet type that, if set, determines what type of subnet
+  // the new canister will be created on.
+  subnet_type: opt text;
+};
+
+type NotifyError = variant {
+  // The payment processing failed and the payment was returned the caller.
+  // This is a non-retriable error.
+  Refunded : record {
+    // The reason for the refund.
+    reason : text;
+    // The index of the block containing the refund.
+    block_index : opt BlockIndex;
+  };
+
+  // The same payment is already being processed by a concurrent request.
+  // This is a retriable error.
+  Processing;
+
+  // The payment was too old to be processed.
+  // The value of the variant is the oldest block index that can still be processed.
+  // This a non-retriable error.
+  TransactionTooOld : BlockIndex;
+
+  // The transaction does not satisfy the cycle minting canister payment protocol.
+  // The text contains the description of the problem.
+  // This is a non-retriable error.
+  InvalidTransaction : text;
+
+  // Other error.
+  Other : record { error_code : nat64; error_message : text };
+};
+
+type NotifyTopUpResult = variant {
+  // The amount of cycles sent to the specified canister.
+  Ok : Cycles;
+  Err : NotifyError;
+};
+
+type NotifyCreateCanisterResult = variant {
+  // The principal of the newly created canister.
+  Ok : principal;
+  Err : NotifyError;
+};
+
+type IcpXdrConversionRate = record {
+  // The time for which the market data was queried, expressed in UNIX epoch
+  // time in seconds.
+  timestamp_seconds : nat64;
+
+  // The number of 10,000ths of IMF SDR (currency code XDR) that corresponds
+  // to 1 ICP. This value reflects the current market price of one ICP token.
+  xdr_permyriad_per_icp : nat64;
+};
+
+
+type IcpXdrConversionRateResponse = record {
+  // The latest ICP/XDR conversion rate.
+  data : IcpXdrConversionRate;
+
+  // CBOR-serialized hash tree as specified in
+  // https://smartcontracts.org/docs/interface-spec/index.html#certification-encoding.
+  // The hash tree is used for certification and hash the following structure:
+  // ```
+  // *
+  // |
+  // +-- ICP_XDR_CONVERSION_RATE -- [ Candid encoded IcpXdrConversionRate ]
+  // |
+  // `-- AVERAGE_ICP_XDR_CONVERSION_RATE -- [ Candid encoded IcpXdrConversionRate ]
+  // ```
+  hash_tree : blob;
+
+  // System certificate as specified in
+  // https://smartcontracts.org/docs/interface-spec/index.html#certification-encoding
+  certificate : blob;
+};
+
+type SubnetTypesToSubnetsResponse = record {
+  data: vec record { text; vec principal };
+};
+
+type CyclesCanisterInitPayload = record {
+  governance_canister_id : principal;
+  minting_account_id : opt text;
+  ledger_canister_id : principal;
+  last_purged_notification: opt BlockIndex;
+};
+
+service: (CyclesCanisterInitPayload) -> {
+  // Propmts the cycles minting canister to process a payment by converting ICP
+  // into cycles and sending the cycles the specified canister.
+  notify_top_up : (NotifyTopUpArg) -> (NotifyTopUpResult);
+
+  // Prompts the cycles minting canister to process a payment for canister creation.
+  notify_create_canister : (NotifyCreateCanisterArg) -> (NotifyCreateCanisterResult);
+
+  // Returns the ICP/XDR conversion rate.
+  get_icp_xdr_conversion_rate : () -> (IcpXdrConversionRateResponse) query;
+
+  // Returns the current mapping of subnet types to subnets.
+  get_subnet_types_to_subnets : () -> (SubnetTypesToSubnetsResponse) query;
+}

package/declarations/cmc/cmc.did.d.ts

@@ -0,0 +1,48 @@
+import type {ActorMethod} from '@dfinity/agent';
+import type {Principal} from '@dfinity/principal';
+
+export type BlockIndex = bigint;
+export type Cycles = bigint;
+export interface CyclesCanisterInitPayload {
+  last_purged_notification: [] | [BlockIndex];
+  governance_canister_id: Principal;
+  minting_account_id: [] | [string];
+  ledger_canister_id: Principal;
+}
+export interface IcpXdrConversionRate {
+  xdr_permyriad_per_icp: bigint;
+  timestamp_seconds: bigint;
+}
+export interface IcpXdrConversionRateResponse {
+  certificate: Uint8Array | number[];
+  data: IcpXdrConversionRate;
+  hash_tree: Uint8Array | number[];
+}
+export interface NotifyCreateCanisterArg {
+  controller: Principal;
+  block_index: BlockIndex;
+  subnet_type: [] | [string];
+}
+export type NotifyCreateCanisterResult = {Ok: Principal} | {Err: NotifyError};
+export type NotifyError =
+  | {
+      Refunded: {block_index: [] | [BlockIndex]; reason: string};
+    }
+  | {InvalidTransaction: string}
+  | {Other: {error_message: string; error_code: bigint}}
+  | {Processing: null}
+  | {TransactionTooOld: BlockIndex};
+export interface NotifyTopUpArg {
+  block_index: BlockIndex;
+  canister_id: Principal;
+}
+export type NotifyTopUpResult = {Ok: Cycles} | {Err: NotifyError};
+export interface SubnetTypesToSubnetsResponse {
+  data: Array<[string, Array<Principal>]>;
+}
+export interface _SERVICE {
+  get_icp_xdr_conversion_rate: ActorMethod<[], IcpXdrConversionRateResponse>;
+  get_subnet_types_to_subnets: ActorMethod<[], SubnetTypesToSubnetsResponse>;
+  notify_create_canister: ActorMethod<[NotifyCreateCanisterArg], NotifyCreateCanisterResult>;
+  notify_top_up: ActorMethod<[NotifyTopUpArg], NotifyTopUpResult>;
+}

package/declarations/cmc/cmc.factory.did.js

@@ -0,0 +1,65 @@
+export const idlFactory = ({IDL}) => {
+  const BlockIndex = IDL.Nat64;
+  const CyclesCanisterInitPayload = IDL.Record({
+    last_purged_notification: IDL.Opt(BlockIndex),
+    governance_canister_id: IDL.Principal,
+    minting_account_id: IDL.Opt(IDL.Text),
+    ledger_canister_id: IDL.Principal
+  });
+  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 SubnetTypesToSubnetsResponse = IDL.Record({
+    data: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Vec(IDL.Principal)))
+  });
+  const NotifyCreateCanisterArg = IDL.Record({
+    controller: IDL.Principal,
+    block_index: BlockIndex,
+    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 NotifyTopUpArg = IDL.Record({
+    block_index: BlockIndex,
+    canister_id: IDL.Principal
+  });
+  const Cycles = IDL.Nat;
+  const NotifyTopUpResult = IDL.Variant({Ok: Cycles, Err: NotifyError});
+  return IDL.Service({
+    get_icp_xdr_conversion_rate: IDL.Func([], [IcpXdrConversionRateResponse], ['query']),
+    get_subnet_types_to_subnets: IDL.Func([], [SubnetTypesToSubnetsResponse], ['query']),
+    notify_create_canister: IDL.Func([NotifyCreateCanisterArg], [NotifyCreateCanisterResult], []),
+    notify_top_up: IDL.Func([NotifyTopUpArg], [NotifyTopUpResult], [])
+  });
+};
+export const init = ({IDL}) => {
+  const BlockIndex = IDL.Nat64;
+  const CyclesCanisterInitPayload = IDL.Record({
+    last_purged_notification: IDL.Opt(BlockIndex),
+    governance_canister_id: IDL.Principal,
+    minting_account_id: IDL.Opt(IDL.Text),
+    ledger_canister_id: IDL.Principal
+  });
+  return [CyclesCanisterInitPayload];
+};

package/declarations/cmc/index.d.ts

@@ -0,0 +1,45 @@
+import type {ActorConfig, ActorSubclass, Agent, HttpAgentOptions} from '@dfinity/agent';
+import type {IDL} from '@dfinity/candid';
+import type {Principal} from '@dfinity/principal';
+
+import {_SERVICE} from './cmc.did';
+
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const canisterId: string;
+
+export declare interface CreateActorOptions {
+  /**
+   * @see {@link Agent}
+   */
+  agent?: Agent;
+  /**
+   * @see {@link HttpAgentOptions}
+   */
+  agentOptions?: HttpAgentOptions;
+  /**
+   * @see {@link ActorConfig}
+   */
+  actorOptions?: ActorConfig;
+}
+
+/**
+ * Intializes an {@link ActorSubclass}, configured with the provided SERVICE interface of a canister.
+ * @constructs {@link ActorSubClass}
+ * @param {string | Principal} canisterId - ID of the canister the {@link Actor} will talk to
+ * @param {CreateActorOptions} options - see {@link CreateActorOptions}
+ * @param {CreateActorOptions["agent"]} options.agent - a pre-configured agent you'd like to use. Supercedes agentOptions
+ * @param {CreateActorOptions["agentOptions"]} options.agentOptions - options to set up a new agent
+ * @see {@link HttpAgentOptions}
+ * @param {CreateActorOptions["actorOptions"]} options.actorOptions - options for the Actor
+ * @see {@link ActorConfig}
+ */
+export declare const createActor: (
+  canisterId: string | Principal,
+  options?: CreateActorOptions
+) => ActorSubclass<_SERVICE>;
+
+/**
+ * Intialized Actor using default settings, ready to talk to a canister using its candid interface
+ * @constructs {@link ActorSubClass}
+ */
+export declare const cmc: ActorSubclass<_SERVICE>;

package/declarations/cmc/index.js

@@ -0,0 +1,32 @@
+import {Actor, HttpAgent} from '@dfinity/agent';
+
+// Imports and re-exports candid interface
+import {idlFactory} from './cmc.did.js';
+export {idlFactory} from './cmc.did.js';
+
+// CANISTER_ID is replaced by webpack based on node environment
+
+export const createActor = (canisterId, options = {}) => {
+  const agent = options.agent || new HttpAgent({...options.agentOptions});
+
+  if (options.agent && options.agentOptions) {
+    console.warn(
+      'Detected both agent and agentOptions passed to createActor. Ignoring agentOptions and proceeding with the provided agent.'
+    );
+  }
+
+  // Fetch root key for certificate validation during development
+  if (process.env.DFX_NETWORK !== 'ic') {
+    agent.fetchRootKey().catch((err) => {
+      console.warn('Unable to fetch root key. Check to ensure that your local replica is running');
+      console.error(err);
+    });
+  }
+
+  // Creates an actor with using the candid interface and the HttpAgent
+  return Actor.createActor(idlFactory, {
+    agent,
+    canisterId,
+    ...options.actorOptions
+  });
+};

package/declarations/console/console.did.d.ts

@@ -0,0 +1,60 @@
+import type {ActorMethod} from '@dfinity/agent';
+import type {Principal} from '@dfinity/principal';
+
+export interface CreateSatelliteArgs {
+  block_index: [] | [bigint];
+  user: Principal;
+}
+export interface DeleteControllersArgs {
+  controllers: Array<Principal>;
+}
+export interface GetCreateSatelliteFeeArgs {
+  user: Principal;
+}
+export interface LoadRelease {
+  total: bigint;
+  chunks: bigint;
+}
+export interface MissionControl {
+  updated_at: bigint;
+  credits: Tokens;
+  mission_control_id: [] | [Principal];
+  owner: Principal;
+  created_at: bigint;
+}
+export interface RateConfig {
+  max_tokens: bigint;
+  time_per_token_ns: bigint;
+}
+export interface ReleasesVersion {
+  satellite: [] | [string];
+  mission_control: [] | [string];
+}
+export type Segment = {MissionControl: null} | {Satellite: null};
+export interface SetController {
+  metadata: Array<[string, string]>;
+  expires_at: [] | [bigint];
+}
+export interface SetControllersArgs {
+  controller: SetController;
+  controllers: Array<Principal>;
+}
+export interface Tokens {
+  e8s: bigint;
+}
+export interface _SERVICE {
+  add_invitation_code: ActorMethod<[string], undefined>;
+  create_satellite: ActorMethod<[CreateSatelliteArgs], Principal>;
+  del_controllers: ActorMethod<[DeleteControllersArgs], undefined>;
+  get_create_satellite_fee: ActorMethod<[GetCreateSatelliteFeeArgs], [] | [Tokens]>;
+  get_credits: ActorMethod<[], Tokens>;
+  get_releases_version: ActorMethod<[], ReleasesVersion>;
+  get_user_mission_control_center: ActorMethod<[], [] | [MissionControl]>;
+  init_user_mission_control_center: ActorMethod<[[] | [string]], MissionControl>;
+  list_user_mission_control_centers: ActorMethod<[], Array<[Principal, MissionControl]>>;
+  load_release: ActorMethod<[Segment, Uint8Array | number[], string], LoadRelease>;
+  reset_release: ActorMethod<[Segment], undefined>;
+  set_controllers: ActorMethod<[SetControllersArgs], undefined>;
+  update_rate_config: ActorMethod<[Segment, RateConfig], undefined>;
+  version: ActorMethod<[], string>;
+}

package/declarations/console/console.factory.did.js

@@ -0,0 +1,62 @@
+export const idlFactory = ({IDL}) => {
+  const CreateSatelliteArgs = IDL.Record({
+    block_index: IDL.Opt(IDL.Nat64),
+    user: IDL.Principal
+  });
+  const DeleteControllersArgs = IDL.Record({
+    controllers: IDL.Vec(IDL.Principal)
+  });
+  const GetCreateSatelliteFeeArgs = IDL.Record({user: IDL.Principal});
+  const Tokens = IDL.Record({e8s: IDL.Nat64});
+  const ReleasesVersion = IDL.Record({
+    satellite: IDL.Opt(IDL.Text),
+    mission_control: IDL.Opt(IDL.Text)
+  });
+  const MissionControl = IDL.Record({
+    updated_at: IDL.Nat64,
+    credits: Tokens,
+    mission_control_id: IDL.Opt(IDL.Principal),
+    owner: IDL.Principal,
+    created_at: IDL.Nat64
+  });
+  const Segment = IDL.Variant({
+    MissionControl: IDL.Null,
+    Satellite: IDL.Null
+  });
+  const LoadRelease = IDL.Record({total: IDL.Nat64, chunks: IDL.Nat64});
+  const SetController = IDL.Record({
+    metadata: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text)),
+    expires_at: IDL.Opt(IDL.Nat64)
+  });
+  const SetControllersArgs = IDL.Record({
+    controller: SetController,
+    controllers: IDL.Vec(IDL.Principal)
+  });
+  const RateConfig = IDL.Record({
+    max_tokens: IDL.Nat64,
+    time_per_token_ns: IDL.Nat64
+  });
+  return IDL.Service({
+    add_invitation_code: IDL.Func([IDL.Text], [], []),
+    create_satellite: IDL.Func([CreateSatelliteArgs], [IDL.Principal], []),
+    del_controllers: IDL.Func([DeleteControllersArgs], [], []),
+    get_create_satellite_fee: IDL.Func([GetCreateSatelliteFeeArgs], [IDL.Opt(Tokens)], ['query']),
+    get_credits: IDL.Func([], [Tokens], ['query']),
+    get_releases_version: IDL.Func([], [ReleasesVersion], ['query']),
+    get_user_mission_control_center: IDL.Func([], [IDL.Opt(MissionControl)], ['query']),
+    init_user_mission_control_center: IDL.Func([IDL.Opt(IDL.Text)], [MissionControl], []),
+    list_user_mission_control_centers: IDL.Func(
+      [],
+      [IDL.Vec(IDL.Tuple(IDL.Principal, MissionControl))],
+      ['query']
+    ),
+    load_release: IDL.Func([Segment, IDL.Vec(IDL.Nat8), IDL.Text], [LoadRelease], []),
+    reset_release: IDL.Func([Segment], [], []),
+    set_controllers: IDL.Func([SetControllersArgs], [], []),
+    update_rate_config: IDL.Func([Segment, RateConfig], [], []),
+    version: IDL.Func([], [IDL.Text], ['query'])
+  });
+};
+export const init = ({IDL}) => {
+  return [];
+};

package/declarations/console/console.factory.did.mjs

@@ -0,0 +1,62 @@
+export const idlFactory = ({IDL}) => {
+  const CreateSatelliteArgs = IDL.Record({
+    block_index: IDL.Opt(IDL.Nat64),
+    user: IDL.Principal
+  });
+  const DeleteControllersArgs = IDL.Record({
+    controllers: IDL.Vec(IDL.Principal)
+  });
+  const GetCreateSatelliteFeeArgs = IDL.Record({user: IDL.Principal});
+  const Tokens = IDL.Record({e8s: IDL.Nat64});
+  const ReleasesVersion = IDL.Record({
+    satellite: IDL.Opt(IDL.Text),
+    mission_control: IDL.Opt(IDL.Text)
+  });
+  const MissionControl = IDL.Record({
+    updated_at: IDL.Nat64,
+    credits: Tokens,
+    mission_control_id: IDL.Opt(IDL.Principal),
+    owner: IDL.Principal,
+    created_at: IDL.Nat64
+  });
+  const Segment = IDL.Variant({
+    MissionControl: IDL.Null,
+    Satellite: IDL.Null
+  });
+  const LoadRelease = IDL.Record({total: IDL.Nat64, chunks: IDL.Nat64});
+  const SetController = IDL.Record({
+    metadata: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text)),
+    expires_at: IDL.Opt(IDL.Nat64)
+  });
+  const SetControllersArgs = IDL.Record({
+    controller: SetController,
+    controllers: IDL.Vec(IDL.Principal)
+  });
+  const RateConfig = IDL.Record({
+    max_tokens: IDL.Nat64,
+    time_per_token_ns: IDL.Nat64
+  });
+  return IDL.Service({
+    add_invitation_code: IDL.Func([IDL.Text], [], []),
+    create_satellite: IDL.Func([CreateSatelliteArgs], [IDL.Principal], []),
+    del_controllers: IDL.Func([DeleteControllersArgs], [], []),
+    get_create_satellite_fee: IDL.Func([GetCreateSatelliteFeeArgs], [IDL.Opt(Tokens)], ['query']),
+    get_credits: IDL.Func([], [Tokens], ['query']),
+    get_releases_version: IDL.Func([], [ReleasesVersion], ['query']),
+    get_user_mission_control_center: IDL.Func([], [IDL.Opt(MissionControl)], ['query']),
+    init_user_mission_control_center: IDL.Func([IDL.Opt(IDL.Text)], [MissionControl], []),
+    list_user_mission_control_centers: IDL.Func(
+      [],
+      [IDL.Vec(IDL.Tuple(IDL.Principal, MissionControl))],
+      ['query']
+    ),
+    load_release: IDL.Func([Segment, IDL.Vec(IDL.Nat8), IDL.Text], [LoadRelease], []),
+    reset_release: IDL.Func([Segment], [], []),
+    set_controllers: IDL.Func([SetControllersArgs], [], []),
+    update_rate_config: IDL.Func([Segment, RateConfig], [], []),
+    version: IDL.Func([], [IDL.Text], ['query'])
+  });
+};
+export const init = ({IDL}) => {
+  return [];
+};

package/declarations/console/index.d.ts

@@ -0,0 +1,45 @@
+import type {ActorConfig, ActorSubclass, Agent, HttpAgentOptions} from '@dfinity/agent';
+import type {IDL} from '@dfinity/candid';
+import type {Principal} from '@dfinity/principal';
+
+import {_SERVICE} from './console.did';
+
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const canisterId: string;
+
+export declare interface CreateActorOptions {
+  /**
+   * @see {@link Agent}
+   */
+  agent?: Agent;
+  /**
+   * @see {@link HttpAgentOptions}
+   */
+  agentOptions?: HttpAgentOptions;
+  /**
+   * @see {@link ActorConfig}
+   */
+  actorOptions?: ActorConfig;
+}
+
+/**
+ * Intializes an {@link ActorSubclass}, configured with the provided SERVICE interface of a canister.
+ * @constructs {@link ActorSubClass}
+ * @param {string | Principal} canisterId - ID of the canister the {@link Actor} will talk to
+ * @param {CreateActorOptions} options - see {@link CreateActorOptions}
+ * @param {CreateActorOptions["agent"]} options.agent - a pre-configured agent you'd like to use. Supercedes agentOptions
+ * @param {CreateActorOptions["agentOptions"]} options.agentOptions - options to set up a new agent
+ * @see {@link HttpAgentOptions}
+ * @param {CreateActorOptions["actorOptions"]} options.actorOptions - options for the Actor
+ * @see {@link ActorConfig}
+ */
+export declare const createActor: (
+  canisterId: string | Principal,
+  options?: CreateActorOptions
+) => ActorSubclass<_SERVICE>;
+
+/**
+ * Intialized Actor using default settings, ready to talk to a canister using its candid interface
+ * @constructs {@link ActorSubClass}
+ */
+export declare const console: ActorSubclass<_SERVICE>;

package/declarations/console/index.js

@@ -0,0 +1,32 @@
+import {Actor, HttpAgent} from '@dfinity/agent';
+
+// Imports and re-exports candid interface
+import {idlFactory} from './console.did.js';
+export {idlFactory} from './console.did.js';
+
+// CANISTER_ID is replaced by webpack based on node environment
+
+export const createActor = (canisterId, options = {}) => {
+  const agent = options.agent || new HttpAgent({...options.agentOptions});
+
+  if (options.agent && options.agentOptions) {
+    console.warn(
+      'Detected both agent and agentOptions passed to createActor. Ignoring agentOptions and proceeding with the provided agent.'
+    );
+  }
+
+  // Fetch root key for certificate validation during development
+  if (process.env.DFX_NETWORK !== 'ic') {
+    agent.fetchRootKey().catch((err) => {
+      console.warn('Unable to fetch root key. Check to ensure that your local replica is running');
+      console.error(err);
+    });
+  }
+
+  // Creates an actor with using the candid interface and the HttpAgent
+  return Actor.createActor(idlFactory, {
+    agent,
+    canisterId,
+    ...options.actorOptions
+  });
+};