fix!: simplify zome call signing (#244)

Co-authored-by: Jost Schulte <[email protected]>

CHANGELOG.md

@@ -7,6 +7,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ### Added
 ### Removed
 ### Changed
+- Update JS client due to modified zome call signing.
 ### Fixed
 
 ## 2024-11-14: v0.18.0-dev.1

package.json

@@ -43,7 +43,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@holochain/client": "^0.19.0-dev.2",
+    "@holochain/client": "^0.19.0-dev.5",
     "get-port": "^6.1.2",
     "lodash": "^4.17.21",
     "uuid": "^8.3.2",

ts/src/common.ts

@@ -190,7 +190,6 @@ export const getCallableCell = (
       {
         ...request,
         cell_id: cell.cell_id,
-        provenance: request.provenance ?? cell.cell_id[1],
         payload: request.payload ?? null,
       },
       timeout

ts/src/trycp/conductor/conductor.ts

@@ -927,28 +927,20 @@ export class TryCpConductor implements IConductor {
      * @param request - {@link CallZomeRequest}.
      * @returns The result of the zome call.
      */
-    const callZome = async <T>(
-      request: CallZomeRequest | CallZomeRequestSigned
-    ) => {
+    const callZome = async <T>(request: CallZomeRequest) => {
       // authorize signing credentials
       if (!getSigningCredentials(request.cell_id)) {
         await this.adminWs().authorizeSigningCredentials(request.cell_id);
       }
 
-      let signedRequest: CallZomeRequestSigned;
-      if ("signature" in request) {
-        signedRequest = request;
-      } else {
-        // sign zome call
-        const signingCredentials = getSigningCredentials(request.cell_id);
-        if (!signingCredentials) {
-          throw new Error(
-            `cannot sign zome call: no signing credentials have been authorized for cell ${request.cell_id}`
-          );
-        }
-        const signedZomeCall = await signZomeCall(request);
-        signedRequest = signedZomeCall;
+      // sign zome call
+      const signingCredentials = getSigningCredentials(request.cell_id);
+      if (!signingCredentials) {
+        throw new Error(
+          `cannot sign zome call: no signing credentials have been authorized for cell ${request.cell_id}`
+        );
       }
+      const signedRequest = await signZomeCall(request);
       const response = await this.callAppApi(port, {
         type: "call_zome",
         data: signedRequest,

ts/src/trycp/trycp-client.ts

@@ -190,7 +190,7 @@ export class TryCpClient {
    * @returns A promise that resolves to the {@link TryCpSuccessResponse}
    */
   call(request: TryCpRequest) {
-    const requestDebugLog = this.getFormattedRequestLog(request);
+    const requestDebugLog = JSON.stringify(request);
     logger.debug(`request ${requestDebugLog}\n`);
 
     const callPromise = new Promise<TryCpSuccessResponse>((resolve, reject) => {
@@ -307,27 +307,4 @@ export class TryCpClient {
     }
     return debugLog;
   }
-
-  private getFormattedRequestLog(request: TryCpRequest) {
-    let debugLog = cloneDeep(request);
-    if (
-      debugLog.type === "call_app_interface" &&
-      "data" in debugLog.message &&
-      debugLog.message.type === "call_zome"
-    ) {
-      const messageData = debugLog.message.data as CallZomeRequestSigned;
-      debugLog.message.data = Object.assign(debugLog.message.data, {
-        cell_id: [
-          Buffer.from(messageData.cell_id[0]).toString("base64"),
-          Buffer.from(messageData.cell_id[1]).toString("base64"),
-        ],
-        provenance: Buffer.from(messageData.provenance).toString("base64"),
-      });
-    }
-    if ("content" in request) {
-      // Call "save_dna" submits a DNA as binary
-      debugLog = Object.assign(debugLog, { content: undefined });
-    }
-    return JSON.stringify(debugLog);
-  }
 }

ts/src/types.ts

@@ -18,6 +18,7 @@ import type {
   ProvisionedCell,
   RegisterDnaRequest,
   RoleName,
+  CallZomeRequestSigned,
 } from "@holochain/client";
 
 /**
@@ -47,7 +48,9 @@ export type IAdminWebsocket = Omit<
  *
  * @public
  */
-export type IAppWebsocket = Pick<AppWebsocket, "callZome">;
+export type IAppWebsocket = {
+  callZome: <T>(request: CallZomeRequest, timeout?: number) => Promise<T>;
+};
 
 /**
  * Base interface of a Tryorama conductor. Both {@link Conductor} and
@@ -79,11 +82,8 @@ export interface IConductor {
  */
 export type CellZomeCallRequest = Omit<
   CallZomeRequest,
-  "cap_secret" | "cell_id" | "payload" | "provenance"
-> & {
-  provenance?: AgentPubKey;
-  payload?: unknown;
-};
+  "cap_secret" | "cell_id"
+>;
 
 /**
  * The function for calling a zome from a specific cell.

ts/test/trycp/conductor.ts

@@ -524,7 +524,6 @@ test("TryCP Conductor - receive a signal", async (t) => {
   const cell_id = appInfo.cell_info[ROLE_NAME][0][CellType.Provisioned].cell_id;
 
   appWs.callZome({
-    cap_secret: null,
     cell_id,
     zome_name: "coordinator",
     fn_name: "signal_loopback",
@@ -605,7 +604,6 @@ test("TryCP Conductor - create and read an entry using the entry zome", async (t
 
   const entryContent = "test-content";
   const createEntryHash = await appWs.callZome<EntryHash>({
-    cap_secret: null,
     cell_id,
     zome_name: "coordinator",
     fn_name: "create",
@@ -620,7 +618,6 @@ test("TryCP Conductor - create and read an entry using the entry zome", async (t
   );
 
   const readEntryResponse = await appWs.callZome<typeof entryContent>({
-    cap_secret: null,
     cell_id,
     zome_name: "coordinator",
     fn_name: "read",
@@ -755,7 +752,6 @@ test("TryCP Conductor - create and read an entry using the entry zome, 1 conduct
 
   const entryContent = "test-content";
   const createEntryHash = await appWs.callZome<EntryHash>({
-    cap_secret: null,
     cell_id: cellId1,
     zome_name: "coordinator",
     fn_name: "create",
@@ -770,7 +766,6 @@ test("TryCP Conductor - create and read an entry using the entry zome, 1 conduct
   );
 
   const readEntryResponse = await appWs.callZome<typeof entryContent>({
-    cap_secret: null,
     cell_id: cellId2,
     zome_name: "coordinator",
     fn_name: "read",
@@ -834,7 +829,6 @@ test("TryCP Conductor - clone cell management", async (t) => {
     zome_name: "coordinator",
     fn_name: "create",
     payload: testContent,
-    cap_secret: null,
     provenance: agentPubKey,
   });
 
@@ -847,7 +841,6 @@ test("TryCP Conductor - clone cell management", async (t) => {
       zome_name: "coordinator",
       fn_name: "read",
       payload: entryActionHash,
-      cap_secret: null,
       provenance: agentPubKey,
     }),
     "disabled clone cell cannot be called"
@@ -867,7 +860,6 @@ test("TryCP Conductor - clone cell management", async (t) => {
     zome_name: "coordinator",
     fn_name: "read",
     payload: entryActionHash,
-    cap_secret: null,
     provenance: agentPubKey,
   });
   t.equal(readEntryResponse, testContent, "enabled clone cell can be called");