@holochain/client 0.12.1 → 0.12.3

package/README.md

@@ -25,46 +25,99 @@ npm install --save-exact @holochain/client
 
 ### Use AppAgentWebsocket with implicit zome call signing
 ```typescript
-  const signalCb = (signal: AppSignal) => {
-    // implementation of signal handler
-    resolve()
-  }
-
-  const TIMEOUT = 12000
-  // default timeout is set to 12000
-  const appWs = await AppWebsocket.connect(`ws://127.0.0.1:${appPort}`, 12000)
-
-  const client = new AppAgentWebsocket(appWs, 'installed_app_id');
-  client.on("signal", signalCb);
-
-  // default timeout set here (30000) will overwrite the defaultTimeout(12000) set above
-  await client.callZome({
-   role_name: 'dnas_role_name', // role_name is unique per app, so you can unambiguously identify your dna with role_name in this client
-   zome_name: "test_zome",
-   fn_name: 'test_emitter_fn',
-   payload: null,
-  }, 30000)
+import { AdminWebsocket, AppAgentWebsocket, CellType } from "@holochain/client";
+
+const adminWs = await AdminWebsocket.connect("ws://127.0.0.1:65000");
+const agent_key = await adminWs.generateAgentPubKey();
+const role_name = "role";
+const installed_app_id = "test-app";
+const appInfo = await adminWs.installApp({
+  agent_key,
+  path: "path/to/happ/file",
+  installed_app_id,
+  membrane_proofs: {},
+});
+await adminWs.enableApp({ installed_app_id });
+if (!(CellType.Provisioned in appInfo.cell_info[role_name][0])) {
+  process.exit();
+}
+const { cell_id } = appInfo.cell_info[role_name][0][CellType.Provisioned];
+await adminWs.authorizeSigningCredentials(cell_id);
+await adminWs.attachAppInterface({ port: 65001 });
+const appAgentWs = await AppAgentWebsocket.connect(
+  "ws://127.0.0.1:65001",
+  installed_app_id
+);
+
+let signalCb;
+const signalReceived = new Promise<void>((resolve) => {
+  signalCb = (signal) => {
+    console.log("signal received", signal);
+    // act on signal
+    resolve();
+  };
+});
+
+appAgentWs.on("signal", signalCb);
+
+// trigger an emit_signal
+await appAgentWs.callZome({
+  role_name,
+  zome_name: "zome",
+  fn_name: "emitter",
+  payload: null,
+});
+await signalReceived;
+
+await appAgentWs.appWebsocket.client.close();
+await adminWs.client.close();
 ```
 
 ### Use AppWebsocket with implicit zome call signing
 ```typescript
-  const signalCb = (signal: AppSignal) => {
-    // impl...
-    resolve()
-  }
-
-  const TIMEOUT = 12000
-  // default timeout is set to 12000
-  const client = await AppWebsocket.connect(`ws://127.0.0.1:${appPort}`, TIMEOUT, signalCb)
-
-  // default timeout set here (30000) will overwrite the defaultTimeout(12000) set above
-  await client.callZome({
-   cell_id,
-   zome_name: "test_zome",
-   fn_name: 'test_emitter_fn',
-   provenance: agentPubKey,
-   payload: null,
-  }, 30000)
+import { AdminWebsocket, AppWebsocket, CellType } from "@holochain/client";
+
+const adminWs = await AdminWebsocket.connect("ws://127.0.0.1:65000");
+const agent_key = await adminWs.generateAgentPubKey();
+const installed_app_id = "test-app";
+const appInfo = await adminWs.installApp({
+  agent_key,
+  path: "path/to/happ/file",
+  installed_app_id,
+  membrane_proofs: {},
+});
+await adminWs.enableApp({ installed_app_id });
+if (!(CellType.Provisioned in appInfo.cell_info["role"][0])) {
+  process.exit();
+}
+const { cell_id } = appInfo.cell_info["role"][0][CellType.Provisioned];
+await adminWs.authorizeSigningCredentials(cell_id);
+await adminWs.attachAppInterface({ port: 65001 });
+const appWs = await AppWebsocket.connect("ws://127.0.0.1:65001");
+
+let signalCb;
+const signalReceived = new Promise<void>((resolve) => {
+  signalCb = (signal) => {
+    console.log("signal received", signal);
+    // act on signal
+    resolve();
+  };
+});
+
+appWs.on("signal", signalCb);
+
+// trigger an emit_signal
+await appWs.callZome({
+  cell_id,
+  zome_name: "zome",
+  fn_name: "emitter",
+  provenance: agent_key,
+  payload: null,
+});
+await signalReceived;
+
+await appWs.client.close();
+await adminWs.client.close();
 ```
 
 ### Managing zome call signing credentials in a pure JavaScript browser application
@@ -119,7 +172,7 @@ nix-shell
 
 Holochain is an open source project.  We welcome all sorts of participation and are actively working on increasing surface area to accept it.  Please see our [contribution guidelines](/CONTRIBUTING.md) for our general practices and protocols on participating in the community, as well as specific expectations around things like code formatting, testing practices, continuous integration, etc.
 
-* Connect with us on our [forum](https://forum.holochain.org)
+* Connect with us on [Discord](https://discord.gg/k55DS5dmPH)
 
 ## License
 

package/lib/api/app-agent/websocket.js

@@ -92,7 +92,14 @@ export class AppAgentWebsocket {
      * @returns The zome call's response.
      */
     async callZome(request, timeout) {
-        if (!("provenance" in request)) {
+        if ("provenance" in request) {
+            if (request.provenance !== this.myPubKey &&
+                "role_name" in request &&
+                request.role_name) {
+                throw new Error("Cannot find other agent's cells based on role name. Use cell id when providing a provenance.");
+            }
+        }
+        else {
             request = {
                 ...request,
                 provenance: this.myPubKey,
@@ -111,9 +118,7 @@ export class AppAgentWebsocket {
         else if ("cell_id" in request && request.cell_id) {
             return this.appWebsocket.callZome(request, timeout);
         }
-        else {
-            throw new Error("callZome requires a role_name or cell_id arg");
-        }
+        throw new Error("callZome requires a role_name or cell_id arg");
     }
     /**
      * Clone an existing provisioned cell.

package/lib/utils/fake-hash.d.ts

@@ -1,4 +1,4 @@
-import { ActionHash, AgentPubKey, EntryHash } from "../types.js";
+import { DnaHash, ActionHash, AgentPubKey, EntryHash } from "../types.js";
 /**
  * Generate a valid hash of a non-existing entry.
  *
@@ -25,3 +25,11 @@ export declare function fakeAgentPubKey(): Promise<AgentPubKey>;
  * @public
  */
 export declare function fakeActionHash(): Promise<ActionHash>;
+/**
+ * Generate a valid hash of a non-existing DNA.
+ *
+ * @returns A {@link DnaHash}.
+ *
+ * @public
+ */
+export declare function fakeDnaHash(): Promise<DnaHash>;

package/lib/utils/fake-hash.js

@@ -34,3 +34,14 @@ export async function fakeActionHash() {
     const randomBytes = await randomByteArray(36);
     return new Uint8Array([0x84, 0x29, 0x24, ...randomBytes]);
 }
+/**
+ * Generate a valid hash of a non-existing DNA.
+ *
+ * @returns A {@link DnaHash}.
+ *
+ * @public
+ */
+export async function fakeDnaHash() {
+    const randomBytes = await randomByteArray(36);
+    return new Uint8Array([0x84, 0x2d, 0x24, ...randomBytes]);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/client",
-  "version": "0.12.1",
+  "version": "0.12.3",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (http://holochain.org)",
   "license": "CAL-1.0",