feat: remove ic-management converters (#355)

dfinity · Jun 20, 2023 · 0ae7ea8 · 0ae7ea8
1 parent a25fbfa
commit 0ae7ea8
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 234 deletions.
diff --git a/packages/ic-management/README.md b/packages/ic-management/README.md
@@ -39,11 +39,11 @@ const agent = await createAgent({
   host: HOST,
 });
 
-const { getCanisterDetails } = ICMgmtCanister.create({
+const { canisterStatus } = ICMgmtCanister.create({
   agent,
 });
 
-const details = await getCanisterDetails(YOUR_CANISTER_ID);
+const { status, memory_size, ...rest } = await canisterStatus(YOUR_CANISTER_ID);
 ```
 
 ## Features

diff --git a/packages/ic-management/src/errors/ic-management.errors.spec.ts b/packages/ic-management/src/errors/ic-management.errors.spec.ts
diff --git a/packages/ic-management/src/errors/ic-management.errors.ts b/packages/ic-management/src/errors/ic-management.errors.ts
diff --git a/packages/ic-management/src/ic-management.canister.spec.ts b/packages/ic-management/src/ic-management.canister.spec.ts
@@ -2,15 +2,9 @@ import type { ManagementCanisterRecord } from "@dfinity/agent";
 import { ActorSubclass, HttpAgent } from "@dfinity/agent";
 import { Principal } from "@dfinity/principal";
 import { mock } from "jest-mock-extended";
-import { UserNotTheControllerError } from "./errors/ic-management.errors";
 import { ICManagementCanister } from "./ic-management.canister";
-import {
-  mockCanisterDetails,
-  mockCanisterId,
-  mockCanisterSettings,
-} from "./ic-management.mock";
-import { CanisterStatusDidResponse } from "./types/ic-management.did";
-import { toCanisterDetails } from "./utils/ic-management.converters";
+import { mockCanisterId, mockCanisterSettings } from "./ic-management.mock";
+import { CanisterStatusResponse } from "./types/ic-management.responses";
 
 describe("ICManagementCanister", () => {
   const mockAgent: HttpAgent = mock<HttpAgent>();
@@ -23,7 +17,7 @@ describe("ICManagementCanister", () => {
   };
 
   describe("ICManagementCanister.getCanisterDetails", () => {
-    it("returns account identifier when success", async () => {
+    it("returns canister status when success", async () => {
       const settings = {
         freezing_threshold: BigInt(2),
         controllers: [
@@ -34,7 +28,7 @@ describe("ICManagementCanister", () => {
         memory_allocation: BigInt(4),
         compute_allocation: BigInt(10),
       };
-      const response: CanisterStatusDidResponse = {
+      const response: CanisterStatusResponse = {
         status: { running: null },
         memory_size: BigInt(1000),
         cycles: BigInt(10_000),
@@ -46,24 +40,9 @@ describe("ICManagementCanister", () => {
 
       const icManagement = await createICManagement(service);
 
-      const res = await icManagement.getCanisterDetails(mockCanisterDetails.id);
+      const res = await icManagement.canisterStatus(mockCanisterId);
 
-      expect(res).toEqual(
-        toCanisterDetails({ response, canisterId: mockCanisterDetails.id })
-      );
-    });
-
-    it("throws UserNotTheControllerError", async () => {
-      const error = new Error("code: 403");
-      const service = mock<ManagementCanisterRecord>();
-      service.canister_status.mockRejectedValue(error);
-
-      const icManagement = await createICManagement(service);
-
-      const call = () =>
-        icManagement.getCanisterDetails(Principal.fromText("aaaaa-aa"));
-
-      expect(call).rejects.toThrowError(UserNotTheControllerError);
+      expect(res).toEqual(response);
     });
 
     it("throws Error", async () => {
@@ -74,7 +53,7 @@ describe("ICManagementCanister", () => {
       const icManagement = await createICManagement(service);
 
       const call = () =>
-        icManagement.getCanisterDetails(Principal.fromText("aaaaa-aa"));
+        icManagement.canisterStatus(Principal.fromText("aaaaa-aa"));
 
       expect(call).rejects.toThrowError(Error);
     });
@@ -112,21 +91,6 @@ describe("ICManagementCanister", () => {
       expect(service.update_settings).toBeCalled();
     });
 
-    it("throws UserNotTheControllerError", async () => {
-      const error = new Error("code: 403");
-      const service = mock<ManagementCanisterRecord>();
-      service.update_settings.mockRejectedValue(error);
-
-      const icManagement = await createICManagement(service);
-
-      const call = () =>
-        icManagement.updateSettings({
-          canisterId: mockCanisterId,
-          settings: mockCanisterSettings,
-        });
-      expect(call).rejects.toThrowError(UserNotTheControllerError);
-    });
-
     it("throws Error", async () => {
       const error = new Error("Test");
       const service = mock<ManagementCanisterRecord>();

diff --git a/packages/ic-management/src/ic-management.canister.ts b/packages/ic-management/src/ic-management.canister.ts
@@ -4,14 +4,9 @@ import {
 } from "@dfinity/agent";
 import { Principal } from "@dfinity/principal";
 import { toNullable } from "@dfinity/utils";
-import { mapError } from "./errors/ic-management.errors";
 import type { ICManagementCanisterOptions } from "./types/canister.options";
-import type { CanisterStatusDidResponse } from "./types/ic-management.did";
-import type {
-  CanisterDetails,
-  CanisterSettings,
-} from "./types/ic-management.response";
-import { toCanisterDetails } from "./utils/ic-management.converters";
+import type { UpdateSettingsParams } from "./types/ic-management.params";
+import type { CanisterStatusResponse } from "./types/ic-management.responses";
 
 export class ICManagementCanister {
   private constructor(private readonly service: ManagementCanisterRecord) {
@@ -30,62 +25,36 @@ export class ICManagementCanister {
    * Returns canister details (memory size, status, etc.)
    *
    * @param {Principal} canisterId
-   * @returns Promise<CanisterDetails>
-   * @throws UserNotTheController, Error
+   * @returns Promise<CanisterStatusResponse>
    */
-  public getCanisterDetails = async (
-    canisterId: Principal
-  ): Promise<CanisterDetails> => {
-    try {
-      const rawResponse: CanisterStatusDidResponse =
-        await this.service.canister_status({
-          canister_id: canisterId,
-        });
-      return toCanisterDetails({
-        response: rawResponse,
-        canisterId,
-      });
-    } catch (error: unknown) {
-      throw mapError(error);
-    }
-  };
+  canisterStatus = (canisterId: Principal): Promise<CanisterStatusResponse> =>
+    this.service.canister_status({
+      canister_id: canisterId,
+    });
 
   /**
    * Update canister settings
    *
    * @param {Object} params
    * @param {Principal} params.canisterId
    * @param {CanisterSettings} params.settings
-   * @returns Promise<void>
-   * @throws UserNotTheController, Error
    */
-  public updateSettings = async ({
+  updateSettings = async ({
     canisterId,
     settings: {
       controllers,
       freezingThreshold,
       memoryAllocation,
       computeAllocation,
     },
-  }: {
-    canisterId: Principal;
-    settings: Partial<CanisterSettings>;
-  }): Promise<void> => {
-    try {
-      // Empty array does not change the value in the settings.
-      await this.service.update_settings({
-        canister_id: canisterId,
-        settings: {
-          controllers: toNullable(
-            controllers?.map((c) => Principal.fromText(c))
-          ),
-          freezing_threshold: toNullable(freezingThreshold),
-          memory_allocation: toNullable(memoryAllocation),
-          compute_allocation: toNullable(computeAllocation),
-        },
-      });
-    } catch (error: unknown) {
-      throw mapError(error);
-    }
-  };
+  }: UpdateSettingsParams): Promise<void> =>
+    this.service.update_settings({
+      canister_id: canisterId,
+      settings: {
+        controllers: toNullable(controllers?.map((c) => Principal.fromText(c))),
+        freezing_threshold: toNullable(freezingThreshold),
+        memory_allocation: toNullable(memoryAllocation),
+        compute_allocation: toNullable(computeAllocation),
+      },
+    });
 }
diff --git a/packages/ic-management/src/ic-management.mock.ts b/packages/ic-management/src/ic-management.mock.ts
@@ -1,9 +1,5 @@
 import { Identity } from "@dfinity/agent";
 import { Principal } from "@dfinity/principal";
-import {
-  CanisterDetails,
-  CanisterStatus,
-} from "./types/ic-management.response";
 
 export const mockPrincipalText =
   "xlmdg-vkosz-ceopx-7wtgu-g3xmd-koiyc-awqaq-7modz-zf6r6-364rh-oqe";
@@ -16,19 +12,6 @@ export const mockIdentity = {
 
 export const mockCanisterId = Principal.fromText("ryjl3-tyaaa-aaaaa-aaaba-cai");
 
-export const mockCanisterDetails: CanisterDetails = {
-  id: mockCanisterId,
-  status: CanisterStatus.Running,
-  memorySize: BigInt(10),
-  cycles: BigInt(30),
-  settings: {
-    controllers: [mockIdentity.getPrincipal().toText()],
-    freezingThreshold: BigInt(30),
-    memoryAllocation: BigInt(1000),
-    computeAllocation: BigInt(2000),
-  },
-};
-
 export const mockCanisterSettings = {
   freezing_threshold: BigInt(2),
   controllers: [

diff --git a/packages/ic-management/src/index.ts b/packages/ic-management/src/index.ts
@@ -1,2 +1,3 @@
 export { ICManagementCanister } from "./ic-management.canister";
-export * from "./types/ic-management.response";
+export * from "./types/ic-management.params";
+export * from "./types/ic-management.responses";
diff --git a/packages/ic-management/src/types/ic-management.params.ts b/packages/ic-management/src/types/ic-management.params.ts
@@ -0,0 +1,14 @@
+import type { Principal } from "@dfinity/principal";
+import type { QueryParams } from "@dfinity/utils/src";
+
+export interface CanisterSettings {
+  controllers?: string[];
+  freezingThreshold?: bigint;
+  memoryAllocation?: bigint;
+  computeAllocation?: bigint;
+}
+
+export type UpdateSettingsParams = {
+  canisterId: Principal;
+  settings: CanisterSettings;
+} & Omit<QueryParams, "certified">;
diff --git a/packages/ic-management/src/types/ic-management.response.ts b/packages/ic-management/src/types/ic-management.response.ts
diff --git a/...management/src/types/ic-management.did.ts → ...ment/src/types/ic-management.responses.ts b/...management/src/types/ic-management.did.ts → ...ment/src/types/ic-management.responses.ts
@@ -1,14 +1,18 @@
 import type { definite_canister_settings } from "../../candid/ic-management";
 
-export type CanisterStatusDid =
-  | { stopped: null }
-  | { stopping: null }
-  | { running: null };
-
-export type CanisterStatusDidResponse = {
-  status: CanisterStatusDid;
+export interface CanisterStatusResponse {
+  status:
+    | {
+        stopped: null;
+      }
+    | {
+        stopping: null;
+      }
+    | {
+        running: null;
+      };
   memory_size: bigint;
   cycles: bigint;
   settings: definite_canister_settings;
   module_hash: [] | [Array<number>];
-};
+}
diff --git a/packages/ic-management/src/utils/ic-management.converters.ts b/packages/ic-management/src/utils/ic-management.converters.ts