fix: usage of ic-management locally (#377)

dfinity · Jul 3, 2023 · 93f718c · 93f718c
1 parent a35f65b
commit 93f718c
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 18 deletions.
diff --git a/packages/ic-management/README.md b/packages/ic-management/README.md
@@ -54,7 +54,7 @@ const { status, memory_size, ...rest } = await canisterStatus(YOUR_CANISTER_ID);
 
 ### :factory: ICManagementCanister
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L24)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L25)
 
 #### Methods
 
@@ -76,7 +76,7 @@ const { status, memory_size, ...rest } = await canisterStatus(YOUR_CANISTER_ID);
 | -------- | ---------------------------------------------------------------- |
 | `create` | `(options: ICManagementCanisterOptions) => ICManagementCanister` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L29)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L30)
 
 ##### :gear: createCanister
 
@@ -86,7 +86,7 @@ Create a new canister
 | ---------------- | ------------------------------------------------------------------------------------ |
 | `createCanister` | `({ settings, senderCanisterVerion, }?: CreateCanisterParams) => Promise<Principal>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L50)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L70)
 
 ##### :gear: updateSettings
 
@@ -96,7 +96,7 @@ Update canister settings
 | ---------------- | ------------------------------------------------------------------------------------------ |
 | `updateSettings` | `({ canisterId, senderCanisterVerion, settings, }: UpdateSettingsParams) => Promise<void>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L71)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L91)
 
 ##### :gear: installCode
 
@@ -106,7 +106,7 @@ Install code to a canister
 | ------------- | ---------------------------------------------------------------------------------------------------- |
 | `installCode` | `({ mode, canisterId, wasmModule, arg, senderCanisterVerion, }: InstallCodeParams) => Promise<void>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L93)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L113)
 
 ##### :gear: uninstallCode
 
@@ -116,7 +116,7 @@ Uninstall code from a canister
 | --------------- | ------------------------------------------------------------------------------- |
 | `uninstallCode` | `({ canisterId, senderCanisterVerion, }: UninstallCodeParams) => Promise<void>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L116)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L136)
 
 ##### :gear: startCanister
 
@@ -126,7 +126,7 @@ Start a canister
 | --------------- | ------------------------------------------ |
 | `startCanister` | `(canisterId: Principal) => Promise<void>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L131)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L151)
 
 ##### :gear: stopCanister
 
@@ -136,7 +136,7 @@ Stop a canister
 | -------------- | ------------------------------------------ |
 | `stopCanister` | `(canisterId: Principal) => Promise<void>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L140)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L160)
 
 ##### :gear: canisterStatus
 
@@ -146,7 +146,7 @@ Get canister details (memory size, status, etc.)
 | ---------------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
 | `canisterStatus` | `(canisterId: Principal) => Promise<{ status: { stopped: null; } or { stopping: null; } | { running: null; }; memory_size: bigint; cycles: bigint; settings: definite_canister_settings; idle_cycles_burned_per_day: bigint; module_hash: [] | [...]; }>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L149)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L169)
 
 ##### :gear: canisterInfo
 
@@ -156,7 +156,7 @@ Get canister info (controllers, module hash, changes, etc.)
 | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `canisterInfo` | `({ canisterId, numRequestChanges, }: CanisterInfoParams) => Promise<{ controllers: Principal[]; module_hash: [] or [Uint8Array]; recent_changes: change[]; total_num_changes: bigint; }>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L162)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L182)
 
 ##### :gear: deleteCanister
 
@@ -166,7 +166,7 @@ Deletes a canister
 | ---------------- | ------------------------------------------ |
 | `deleteCanister` | `(canisterId: Principal) => Promise<void>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L177)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L197)
 
 ##### :gear: provisionalCreateCanisterWithCycles
 
@@ -176,7 +176,7 @@ Creates a canister. Only available on development instances.
 | ------------------------------------- | ------------------------------------------------------------------------------------------------------- |
 | `provisionalCreateCanisterWithCycles` | `({ settings, amount, canisterId, }?: ProvisionalCreateCanisterWithCyclesParams) => Promise<Principal>` |
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L189)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ic-management/src/ic-management.canister.ts#L209)
 
 <!-- TSDOC_END -->
 

diff --git a/packages/ic-management/src/ic-management.canister.ts b/packages/ic-management/src/ic-management.canister.ts
@@ -1,3 +1,4 @@
+import type { CallConfig } from "@dfinity/agent";
 import { Principal } from "@dfinity/principal";
 import { createServices, toNullable } from "@dfinity/utils";
 import type { _SERVICE as IcManagementService } from "../candid/ic-management";
@@ -27,10 +28,29 @@ export class ICManagementCanister {
   }
 
   public static create(options: ICManagementCanisterOptions) {
+    // Source getManagementCanister in agent-js.
+    // Allow usage of the ICManagementCanister wrapper locally.
+    const transform = (
+      _methodName: string,
+      args: unknown[],
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      _callConfig: CallConfig
+    ) => {
+      const first = args[0] as { canister_id: string };
+      let effectiveCanisterId = Principal.fromHex("");
+      if (first && typeof first === "object" && first.canister_id) {
+        effectiveCanisterId = Principal.from(first.canister_id as unknown);
+      }
+      return { effectiveCanisterId };
+    };
+
     const { service } = createServices<IcManagementService>({
       options: {
         ...options,
-        canisterId: Principal.fromText("aaaaa-aa"),
+        // Resolve to "aaaaa-aa" on mainnet
+        canisterId: Principal.fromHex(""),
+        callTransform: transform,
+        queryTransform: transform,
       },
       idlFactory,
       certifiedIdlFactory,

diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -101,9 +101,9 @@ Parameters:
 
 #### :gear: createServices
 
-| Function         | Type                                                                                                                                                                                                                                                            |
-| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `createServices` | `<T>({ options: { canisterId, serviceOverride, certifiedServiceOverride, agent: agentOption, }, idlFactory, certifiedIdlFactory, }: { options: RequiredCanisterOptions<T>; idlFactory: InterfaceFactory; certifiedIdlFactory: InterfaceFactory; }) => { ...; }` |
+| Function         | Type                                                                                                                                                                                                                                                                                                                                 |
+| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `createServices` | `<T>({ options: { canisterId, serviceOverride, certifiedServiceOverride, agent: agentOption, callTransform, queryTransform, }, idlFactory, certifiedIdlFactory, }: { options: Required<Pick<CanisterOptions<T>, "canisterId">> and Omit<CanisterOptions<T>, "canisterId"> & Pick<...>; idlFactory: InterfaceFactory; certifiedId...` |
 
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/actor.utils.ts#L13)
 

diff --git a/packages/utils/src/utils/actor.utils.ts b/packages/utils/src/utils/actor.utils.ts
@@ -1,4 +1,4 @@
-import type { ActorSubclass, Agent } from "@dfinity/agent";
+import type { ActorConfig, ActorSubclass, Agent } from "@dfinity/agent";
 import { Actor } from "@dfinity/agent";
 import type { IDL } from "@dfinity/candid";
 import type { Principal } from "@dfinity/principal";
@@ -16,11 +16,14 @@ export const createServices = <T>({
     serviceOverride,
     certifiedServiceOverride,
     agent: agentOption,
+    callTransform,
+    queryTransform,
   },
   idlFactory,
   certifiedIdlFactory,
 }: {
-  options: RequiredCanisterOptions<T>;
+  options: RequiredCanisterOptions<T> &
+    Pick<ActorConfig, "queryTransform" | "callTransform">;
   idlFactory: IDL.InterfaceFactory;
   certifiedIdlFactory: IDL.InterfaceFactory;
 }): {
@@ -36,13 +39,17 @@ export const createServices = <T>({
     Actor.createActor<T>(idlFactory, {
       agent,
       canisterId,
+      callTransform,
+      queryTransform,
     });
 
   const certifiedService: ActorSubclass<T> =
     certifiedServiceOverride ??
     Actor.createActor<T>(certifiedIdlFactory, {
       agent,
       canisterId,
+      callTransform,
+      queryTransform,
     });
 
   return { service, certifiedService, agent, canisterId };