refactor(app-ws)!: simplify zome call signing (#295)

* build: remove serialization pkg & add sha2 pkg * refactor: zome call signing to match conductor api * docs: add entry to changelog about zome call signing * refactor! rename zome call unsigned type name * ci: upgrade actions * docs: rebuild --------- Co-authored-by: Jost Schulte <[email protected]>
holochain · Nov 21, 2024 · c7cb501 · c7cb501
1 parent 4855813
commit c7cb501
Show file tree

Hide file tree

Showing 19 changed files with 130 additions and 93 deletions.
diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml
@@ -24,12 +24,12 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install nix
-        uses: cachix/install-nix-action@v27
+        uses: cachix/install-nix-action@v30
         with:
-          install_url: https://releases.nixos.org/nix/nix-2.22.0/install
+          install_url: https://releases.nixos.org/nix/nix-2.24.9/install
 
       - name: Set up cachix
-        uses: cachix/cachix-action@v14
+        uses: cachix/cachix-action@v15
         with:
           name: holochain-ci
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Added
 ### Fixed
 ### Changed
+- Zome call signing has been changed in Holochain to remove the requirement of imitating Holochain serialization. Signing is now a simplified process of serializing zome call parameters using MessagePack, then computing a SHA2 512-bit hash of the serialized bytes and signing the hash. The zome call payload consists of the serialized bytes and the signature.
 ### Removed
 
 ## 2024-11-12: v0.19.0-dev.2

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/docs/client.appcallzomerequest.md b/docs/client.appcallzomerequest.md
@@ -8,7 +8,7 @@
 **Signature:**
 
 ```typescript
-export type AppCallZomeRequest = NonProvenanceCallZomeRequest | RoleNameCallZomeRequest | CallZomeRequestSigned | RoleNameCallZomeRequestSigned;
+export type AppCallZomeRequest = NonProvenanceCallZomeRequest | RoleNameCallZomeRequest | CallZomeRequest;
 ```
-**References:** [NonProvenanceCallZomeRequest](./client.nonprovenancecallzomerequest.md)<!-- -->, [RoleNameCallZomeRequest](./client.rolenamecallzomerequest.md)<!-- -->, [CallZomeRequestSigned](./client.callzomerequestsigned.md)<!-- -->, [RoleNameCallZomeRequestSigned](./client.rolenamecallzomerequestsigned.md)
+**References:** [NonProvenanceCallZomeRequest](./client.nonprovenancecallzomerequest.md)<!-- -->, [RoleNameCallZomeRequest](./client.rolenamecallzomerequest.md)<!-- -->, [CallZomeRequest](./client.callzomerequest.md)
 
diff --git a/docs/client.callzomerequest.md b/docs/client.callzomerequest.md
@@ -8,7 +8,7 @@
 **Signature:**
 
 ```typescript
-export type CallZomeRequest = CallZomeRequestGeneric<any>;
+export type CallZomeRequest = CallZomeRequestGeneric<unknown>;
 ```
 **References:** [CallZomeRequestGeneric](./client.callzomerequestgeneric.md)
 
diff --git a/...ent.callzomerequestunsigned.cap_secret.md → ...lient.callzomerequestparams.cap_secret.md b/...ent.callzomerequestunsigned.cap_secret.md → ...lient.callzomerequestparams.cap_secret.md
@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [CallZomeRequestUnsigned](./client.callzomerequestunsigned.md) &gt; [cap\_secret](./client.callzomerequestunsigned.cap_secret.md)
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [CallZomeRequestParams](./client.callzomerequestparams.md) &gt; [cap\_secret](./client.callzomerequestparams.cap_secret.md)
 
-## CallZomeRequestUnsigned.cap\_secret property
+## CallZomeRequestParams.cap\_secret property
 
 **Signature:**
 

diff --git a/...ent.callzomerequestunsigned.expires_at.md → ...lient.callzomerequestparams.expires_at.md b/...ent.callzomerequestunsigned.expires_at.md → ...lient.callzomerequestparams.expires_at.md
@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [CallZomeRequestUnsigned](./client.callzomerequestunsigned.md) &gt; [expires\_at](./client.callzomerequestunsigned.expires_at.md)
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [CallZomeRequestParams](./client.callzomerequestparams.md) &gt; [expires\_at](./client.callzomerequestparams.expires_at.md)
 
-## CallZomeRequestUnsigned.expires\_at property
+## CallZomeRequestParams.expires\_at property
 
 **Signature:**
 

diff --git a/docs/client.callzomerequestunsigned.md → docs/client.callzomerequestparams.md b/docs/client.callzomerequestunsigned.md → docs/client.callzomerequestparams.md
@@ -1,14 +1,14 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [CallZomeRequestUnsigned](./client.callzomerequestunsigned.md)
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [CallZomeRequestParams](./client.callzomerequestparams.md)
 
-## CallZomeRequestUnsigned interface
+## CallZomeRequestParams interface
 
 
 **Signature:**
 
 ```typescript
-export interface CallZomeRequestUnsigned extends CallZomeRequest 
+export interface CallZomeRequestParams extends CallZomeRequest 
 ```
 **Extends:** [CallZomeRequest](./client.callzomerequest.md)
 
@@ -37,7 +37,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[cap\_secret](./client.callzomerequestunsigned.cap_secret.md)
+[cap\_secret](./client.callzomerequestparams.cap_secret.md)
 
 
 </td><td>
@@ -54,7 +54,7 @@ Description
 </td></tr>
 <tr><td>
 
-[expires\_at](./client.callzomerequestunsigned.expires_at.md)
+[expires\_at](./client.callzomerequestparams.expires_at.md)
 
 
 </td><td>
@@ -71,7 +71,7 @@ number
 </td></tr>
 <tr><td>
 
-[nonce](./client.callzomerequestunsigned.nonce.md)
+[nonce](./client.callzomerequestparams.nonce.md)
 
 
 </td><td>

diff --git a/docs/client.callzomerequestunsigned.nonce.md → docs/client.callzomerequestparams.nonce.md b/docs/client.callzomerequestunsigned.nonce.md → docs/client.callzomerequestparams.nonce.md
@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [CallZomeRequestUnsigned](./client.callzomerequestunsigned.md) &gt; [nonce](./client.callzomerequestunsigned.nonce.md)
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [CallZomeRequestParams](./client.callzomerequestparams.md) &gt; [nonce](./client.callzomerequestparams.nonce.md)
 
-## CallZomeRequestUnsigned.nonce property
+## CallZomeRequestParams.nonce property
 
 **Signature:**
 

diff --git a/docs/client.callzomerequestsigned.bytes.md b/docs/client.callzomerequestsigned.bytes.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [CallZomeRequestSigned](./client.callzomerequestsigned.md) &gt; [bytes](./client.callzomerequestsigned.bytes.md)
+
+## CallZomeRequestSigned.bytes property
+
+**Signature:**
+
+```typescript
+bytes: Uint8Array;
+```
diff --git a/docs/client.callzomerequestsigned.md b/docs/client.callzomerequestsigned.md
@@ -8,9 +8,8 @@
 **Signature:**
 
 ```typescript
-export interface CallZomeRequestSigned extends CallZomeRequestUnsigned 
+export interface CallZomeRequestSigned 
 ```
-**Extends:** [CallZomeRequestUnsigned](./client.callzomerequestunsigned.md)
 
 ## Properties
 
@@ -37,6 +36,23 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[bytes](./client.callzomerequestsigned.bytes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Uint8Array
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
 [signature](./client.callzomerequestsigned.signature.md)
 
 

diff --git a/docs/client.md b/docs/client.md
@@ -594,7 +594,7 @@ Description
 </td></tr>
 <tr><td>
 
-[CallZomeRequestSigned](./client.callzomerequestsigned.md)
+[CallZomeRequestParams](./client.callzomerequestparams.md)
 
 
 </td><td>
@@ -604,7 +604,7 @@ Description
 </td></tr>
 <tr><td>
 
-[CallZomeRequestUnsigned](./client.callzomerequestunsigned.md)
+[CallZomeRequestSigned](./client.callzomerequestsigned.md)
 
 
 </td><td>

diff --git a/flake.lock b/flake.lock