@holochain/client 0.16.0 → 0.16.2

package/README.md

@@ -30,7 +30,7 @@ npm install --save-exact @holochain/client
 
 ### Use AppAgentWebsocket with implicit zome call signing
 ```typescript
-import { AdminWebsocket, AppAgentWebsocket, CellType } from "@holochain/client";
+import { ActionHash, AdminWebsocket, AppAgentWebsocket, CellType } from "@holochain/client";
 
 const adminWs = await AdminWebsocket.connect("ws://127.0.0.1:65000");
 const agent_key = await adminWs.generateAgentPubKey();
@@ -54,25 +54,15 @@ const appAgentWs = await AppAgentWebsocket.connect(
   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);
+const zomeCallPayload: CallZomeRequest = {
+  cell_id,
+  zome_name: "zome_name",
+  fn_name: "create_entry",
+  provenance: agent_key,
+  payload: "some_content",
+};
 
-// trigger an emit_signal
-await appAgentWs.callZome({
-  role_name,
-  zome_name: "zome",
-  fn_name: "emitter",
-  payload: null,
-});
-await signalReceived;
+const response: ActionHash = await appAgentWs.callZome(zomeCallPayload, 30000);
 
 await appAgentWs.appWebsocket.client.close();
 await adminWs.client.close();

package/lib/api/admin/types.d.ts

@@ -194,7 +194,7 @@ export type RegisterDnaResponse = HoloHash;
  */
 export type DnaModifiers = {
     network_seed: NetworkSeed;
-    properties: DnaProperties;
+    properties: Uint8Array;
     origin_time: Timestamp;
     quantum_time: Duration;
 };
@@ -382,12 +382,33 @@ export type NetworkSeed = string;
  * @public
  */
 export type InstallAppRequest = {
+    /**
+     * The agent to use when creating Cells for this App.
+     */
     agent_key: AgentPubKey;
+    /**
+     * The unique identifier for an installed app in this conductor.
+     * If not specified, it will be derived from the app name in the bundle manifest.
+     */
     installed_app_id?: InstalledAppId;
+    /**
+     * Include proof-of-membrane-membership data for cells that require it,
+     * keyed by the CellNick specified in the app bundle manifest.
+     */
     membrane_proofs: {
         [key: string]: MembraneProof;
     };
+    /**
+     * Optional global network seed override.  If set will override the network seed value for all
+     * DNAs in the bundle.
+     */
     network_seed?: NetworkSeed;
+    /**
+     * Optional: If app installation fails due to genesis failure, normally the app will be immediately uninstalled.
+     * When this flag is set, the app is left installed with empty cells intact. This can be useful for
+     * using graft_records_onto_source_chain, or for diagnostics.
+     */
+    ignore_genesis_failure?: boolean;
 } & AppBundleSource;
 /**
  * @public

package/lib/api/app/websocket.js

@@ -2,7 +2,7 @@ import { hashZomeCall } from "@holochain/serialization";
 import { decode, encode } from "@msgpack/msgpack";
 import _sodium from "libsodium-wrappers";
 import Emittery from "emittery";
-import { getLauncherEnvironment, isLauncher, signZomeCallTauri, } from "../../environments/launcher.js";
+import { getLauncherEnvironment, signZomeCallTauri, signZomeCallElectron, } from "../../environments/launcher.js";
 import { encodeHashToBase64 } from "../../utils/base64.js";
 import { WsClient } from "../client.js";
 import { DEFAULT_TIMEOUT, catchError, promiseTimeout, requesterTransformer, } from "../common.js";
@@ -98,10 +98,14 @@ const callZomeTransform = {
         if ("signature" in request) {
             return request;
         }
-        const signedZomeCall = isLauncher
-            ? await signZomeCallTauri(request)
-            : await signZomeCall(request);
-        return signedZomeCall;
+        const env = getLauncherEnvironment();
+        if (!env) {
+            return signZomeCall(request);
+        }
+        else if (env.FRAMEWORK === "electron") {
+            return signZomeCallElectron(request);
+        }
+        return signZomeCallTauri(request);
     },
     output: (response) => decode(response),
 };

package/lib/api/app-agent/types.d.ts

@@ -1,6 +1,6 @@
 import { UnsubscribeFunction } from "emittery";
 import { AgentPubKey, RoleName } from "../../index.js";
-import { AppInfoResponse, AppSignal, AppSignalCb, CallZomeRequest, CallZomeRequestSigned, DisableCloneCellRequest, EnableCloneCellRequest, EnableCloneCellResponse } from "../app/index.js";
+import { AppInfoResponse, AppSignal, AppSignalCb, CallZomeRequest, CallZomeRequestSigned, DisableCloneCellRequest, EnableCloneCellRequest, EnableCloneCellResponse, NetworkInfoRequest, NetworkInfoResponse } from "../app/index.js";
 import { CreateCloneCellRequest, CreateCloneCellResponse, DisableCloneCellResponse } from "../index.js";
 /**
  * @public
@@ -34,6 +34,10 @@ export type AppEnableCloneCellRequest = Omit<EnableCloneCellRequest, "app_id">;
  * @public
  */
 export type AppDisableCloneCellRequest = Omit<DisableCloneCellRequest, "app_id">;
+/**
+ * @public
+ */
+export type AppAgentNetworkInfoRequest = Omit<NetworkInfoRequest, "agent_pub_key">;
 /**
  * @public
  */
@@ -51,4 +55,5 @@ export interface AppAgentClient {
     createCloneCell(args: AppCreateCloneCellRequest): Promise<CreateCloneCellResponse>;
     enableCloneCell(args: AppEnableCloneCellRequest): Promise<EnableCloneCellResponse>;
     disableCloneCell(args: AppDisableCloneCellRequest): Promise<DisableCloneCellResponse>;
+    networkInfo(args: AppAgentNetworkInfoRequest): Promise<NetworkInfoResponse>;
 }

package/lib/api/app-agent/websocket.d.ts

@@ -1,9 +1,9 @@
 import Emittery, { UnsubscribeFunction } from "emittery";
 import { AgentPubKey, CellId, InstalledAppId, RoleName } from "../../types.js";
 import { AppInfo } from "../admin/types.js";
-import { AppSignalCb, CallZomeResponse, CreateCloneCellResponse, DisableCloneCellResponse, EnableCloneCellResponse } from "../app/types.js";
+import { AppSignalCb, CallZomeResponse, CreateCloneCellResponse, DisableCloneCellResponse, EnableCloneCellResponse, NetworkInfoResponse } from "../app/types.js";
 import { AppWebsocket } from "../app/websocket.js";
-import { AppAgentCallZomeRequest, AppAgentClient, AppAgentEvents, AppCreateCloneCellRequest, AppDisableCloneCellRequest, AppEnableCloneCellRequest } from "./types.js";
+import { AppAgentCallZomeRequest, AppAgentClient, AppAgentEvents, AppAgentNetworkInfoRequest, AppCreateCloneCellRequest, AppDisableCloneCellRequest, AppEnableCloneCellRequest } from "./types.js";
 /**
  * A class to establish a websocket connection to an App interface, for a
  * specific agent and app.
@@ -68,6 +68,12 @@ export declare class AppAgentWebsocket implements AppAgentClient {
      * @param args - Specify the clone cell to disable.
      */
     disableCloneCell(args: AppDisableCloneCellRequest): Promise<DisableCloneCellResponse>;
+    /**
+     * Request network info about gossip status.
+     *  @param args - Specify the DNAs for which you want network info
+     *  @returns Network info for the specified DNAs
+     */
+    networkInfo(args: AppAgentNetworkInfoRequest): Promise<NetworkInfoResponse>;
     /**
      * Register an event listener for signals.
      *

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

@@ -23,8 +23,9 @@ export class AppAgentWebsocket {
         // Please retain until the upstream is fixed https://github.com/sindresorhus/emittery/issues/86.
         Object.getOwnPropertyNames(Emittery.prototype).forEach((name) => {
             const to_bind = this.emitter[name];
-            if (typeof to_bind === 'function') {
-                this.emitter[name] = to_bind.bind(this.emitter);
+            if (typeof to_bind === "function") {
+                this.emitter[name] =
+                    to_bind.bind(this.emitter);
             }
         });
         const env = getLauncherEnvironment();
@@ -159,6 +160,17 @@ export class AppAgentWebsocket {
             ...args,
         });
     }
+    /**
+     * Request network info about gossip status.
+     *  @param args - Specify the DNAs for which you want network info
+     *  @returns Network info for the specified DNAs
+     */
+    async networkInfo(args) {
+        return this.appWebsocket.networkInfo({
+            ...args,
+            agent_pub_key: this.myPubKey,
+        });
+    }
     /**
      * Register an event listener for signals.
      *

package/lib/environments/launcher.d.ts

@@ -1,18 +1,39 @@
 import { CallZomeRequest } from "../api/app/types.js";
-import { CallZomeRequestSigned } from "../api/app/websocket.js";
+import { CallZomeRequestSigned, CallZomeRequestUnsigned } from "../api/app/websocket.js";
 import { InstalledAppId } from "../types.js";
 export interface LauncherEnvironment {
     APP_INTERFACE_PORT?: number;
     ADMIN_INTERFACE_PORT?: number;
     INSTALLED_APP_ID?: InstalledAppId;
+    FRAMEWORK?: "tauri" | "electron";
 }
 declare const __HC_LAUNCHER_ENV__ = "__HC_LAUNCHER_ENV__";
-export declare const isLauncher: boolean;
+export declare const isLauncher: () => boolean;
 export declare const getLauncherEnvironment: () => LauncherEnvironment | undefined;
 declare global {
     interface Window {
-        [__HC_LAUNCHER_ENV__]: LauncherEnvironment | undefined;
+        [__HC_LAUNCHER_ENV__]?: LauncherEnvironment;
+        electronAPI?: {
+            signZomeCall: (data: CallZomeRequestUnsignedElectron) => CallZomeRequestSignedElectron;
+        };
     }
 }
+interface CallZomeRequestSignedElectron extends Omit<CallZomeRequestSigned, "cap_secret" | "cell_id" | "provenance" | "nonce" | "zome_name" | "fn_name" | "expires_at"> {
+    cellId: [Array<number>, Array<number>];
+    provenance: Array<number>;
+    zomeName: string;
+    fnName: string;
+    nonce: Array<number>;
+    expiresAt: number;
+}
+interface CallZomeRequestUnsignedElectron extends Omit<CallZomeRequestUnsigned, "cap_secret" | "cell_id" | "provenance" | "nonce" | "zome_name" | "fn_name" | "expires_at"> {
+    cellId: [Array<number>, Array<number>];
+    provenance: Array<number>;
+    zomeName: string;
+    fnName: string;
+    nonce: Array<number>;
+    expiresAt: number;
+}
 export declare const signZomeCallTauri: (request: CallZomeRequest) => Promise<CallZomeRequestSigned>;
+export declare const signZomeCallElectron: (request: CallZomeRequest) => Promise<CallZomeRequestSigned>;
 export {};

package/lib/environments/launcher.js

@@ -2,8 +2,8 @@ import { encode } from "@msgpack/msgpack";
 import { invoke } from "@tauri-apps/api/tauri";
 import { getNonceExpiration, randomNonce } from "../api/zome-call-signing.js";
 const __HC_LAUNCHER_ENV__ = "__HC_LAUNCHER_ENV__";
-export const isLauncher = globalThis.window && __HC_LAUNCHER_ENV__ in globalThis.window;
-export const getLauncherEnvironment = () => isLauncher ? globalThis.window[__HC_LAUNCHER_ENV__] : undefined;
+export const isLauncher = () => globalThis.window && __HC_LAUNCHER_ENV__ in globalThis.window;
+export const getLauncherEnvironment = () => isLauncher() ? globalThis.window[__HC_LAUNCHER_ENV__] : undefined;
 export const signZomeCallTauri = async (request) => {
     const zomeCallUnsigned = {
         provenance: Array.from(request.provenance),
@@ -31,3 +31,33 @@ export const signZomeCallTauri = async (request) => {
     };
     return signedZomeCall;
 };
+export const signZomeCallElectron = async (request) => {
+    if (!window.electronAPI) {
+        throw Error("Unable to signZomeCallElectron. window.electronAPI not defined");
+    }
+    const zomeCallUnsignedElectron = {
+        provenance: Array.from(request.provenance),
+        cellId: [Array.from(request.cell_id[0]), Array.from(request.cell_id[1])],
+        zomeName: request.zome_name,
+        fnName: request.fn_name,
+        payload: Array.from(encode(request.payload)),
+        nonce: Array.from(await randomNonce()),
+        expiresAt: getNonceExpiration(),
+    };
+    const zomeCallSignedElectron = await window.electronAPI.signZomeCall(zomeCallUnsignedElectron);
+    const zomeCallSigned = {
+        provenance: Uint8Array.from(zomeCallSignedElectron.provenance),
+        cap_secret: null,
+        cell_id: [
+            Uint8Array.from(zomeCallSignedElectron.cellId[0]),
+            Uint8Array.from(zomeCallSignedElectron.cellId[1]),
+        ],
+        zome_name: zomeCallSignedElectron.zomeName,
+        fn_name: zomeCallSignedElectron.fnName,
+        payload: Uint8Array.from(zomeCallSignedElectron.payload),
+        signature: Uint8Array.from(zomeCallSignedElectron.signature),
+        expires_at: zomeCallSignedElectron.expiresAt,
+        nonce: Uint8Array.from(zomeCallSignedElectron.nonce),
+    };
+    return zomeCallSigned;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/client",
-  "version": "0.16.0",
+  "version": "0.16.2",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (http://holochain.org)",
   "license": "CAL-1.0",
@@ -40,34 +40,32 @@
   },
   "dependencies": {
     "@holochain/serialization": "^0.1.0-beta-rc.3",
-    "@msgpack/msgpack": "^2.7.2",
-    "@noble/ed25519": "^2.0.0",
-    "@tauri-apps/api": "^1.2.0",
+    "@msgpack/msgpack": "^2.8.0",
+    "@tauri-apps/api": "^1.4.0",
     "emittery": "^1.0.1",
     "isomorphic-ws": "^5.0.0",
-    "js-base64": "^3.7.3",
-    "libsodium-wrappers": "^0.7.11",
+    "js-base64": "^3.7.5",
+    "libsodium-wrappers": "^0.7.13",
     "lodash-es": "^4.17.21",
-    "ws": "^8.13.0"
+    "ws": "^8.14.2"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.21.7",
     "@microsoft/api-extractor": "^7.34.4",
-    "@types/js-yaml": "^3.12.7",
-    "@types/libsodium-wrappers": "^0.7.10",
+    "@types/libsodium-wrappers": "^0.7.11",
     "@types/lodash-es": "^4.17.6",
     "@types/tape": "^4.13.2",
-    "@types/ws": "^8.5.3",
+    "@types/ws": "^8.5.5",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
-    "eslint": "^8.46.0",
+    "eslint": "^8.49.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-tsdoc": "^0.2.17",
     "js-yaml": "^3.14.1",
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
-    "tape": "^5.5.3",
+    "tape": "^5.6.6",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.5"
   }