@holochain/client 0.18.0-dev.0 → 0.18.0-dev.2

package/README.md

@@ -30,64 +30,92 @@ npm install --save-exact @holochain/client
 
 ## Sample usage
 
-### Use AppAgentWebsocket with implicit zome call signing
+### Use AppWebsocket with implicit zome call signing
 ```typescript
-import { ActionHash, AdminWebsocket, AppAgentWebsocket, CellType } from "@holochain/client";
-
-const adminWs = await AdminWebsocket.connect({url: "ws://127.0.0.1:65000"});
+import {
+  AdminWebsocket,
+  AppWebsocket,
+  CellType,
+  type ActionHash,
+  type CallZomeRequest,
+} from "@holochain/client";
+
+const adminWs = await AdminWebsocket.connect({
+  url: new URL("ws://127.0.0.1:65000"),
+  wsClientOptions: { origin: "my-happ" },
+});
 const agent_key = await adminWs.generateAgentPubKey();
-const role_name = "role";
+const role_name = "foo";
 const installed_app_id = "test-app";
 const appInfo = await adminWs.installApp({
   agent_key,
-  path: "path/to/happ/file",
+  path: "./test/e2e/fixture/test.happ",
   installed_app_id,
   membrane_proofs: {},
 });
 await adminWs.enableApp({ installed_app_id });
 if (!(CellType.Provisioned in appInfo.cell_info[role_name][0])) {
-  process.exit();
+  throw new Error(`No cell found under role name ${role_name}`);
 }
 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(installed_app_id, {url: "ws://127.0.0.1:65001"});
+await adminWs.attachAppInterface({ port: 65001, allowed_origins: "my-happ" });
+const issuedToken = await adminWs.issueAppAuthenticationToken({
+  installed_app_id,
+});
+const appWs = await AppWebsocket.connect({
+  url: new URL("ws://127.0.0.1:65001"),
+  token: issuedToken.token,
+  wsClientOptions: { origin: "my-happ" },
+});
 
 const zomeCallPayload: CallZomeRequest = {
   cell_id,
-  zome_name: "zome_name",
-  fn_name: "create_entry",
+  zome_name: "foo",
+  fn_name: "foo",
   provenance: agent_key,
-  payload: "some_content",
+  payload: null,
 };
 
-const response: ActionHash = await appAgentWs.callZome(zomeCallPayload, 30000);
+const response: ActionHash = await appWs.callZome(zomeCallPayload, 30000);
+console.log("zome call response is", response);
 
-await appAgentWs.appWebsocket.client.close();
+await appWs.client.close();
 await adminWs.client.close();
 ```
 
-### Use AppWebsocket with implicit zome call signing
+### Subscribe to signals
 ```typescript
 import { AdminWebsocket, AppWebsocket, CellType } from "@holochain/client";
 
-const adminWs = await AdminWebsocket.connect({url: "ws://127.0.0.1:65000"});
+const adminWs = await AdminWebsocket.connect({
+  url: new URL("ws://127.0.0.1:65000"),
+  wsClientOptions: { origin: "my-happ" },
+});
 const agent_key = await adminWs.generateAgentPubKey();
+const role_name = "foo";
 const installed_app_id = "test-app";
 const appInfo = await adminWs.installApp({
   agent_key,
-  path: "path/to/happ/file",
+  path: "./test/e2e/fixture/test.happ",
   installed_app_id,
   membrane_proofs: {},
 });
 await adminWs.enableApp({ installed_app_id });
-if (!(CellType.Provisioned in appInfo.cell_info["role"][0])) {
-  process.exit();
+if (!(CellType.Provisioned in appInfo.cell_info[role_name][0])) {
+  throw new Error(`No cell found under role name ${role_name}`);
 }
-const { cell_id } = appInfo.cell_info["role"][0][CellType.Provisioned];
+const { cell_id } = appInfo.cell_info[role_name][0][CellType.Provisioned];
 await adminWs.authorizeSigningCredentials(cell_id);
-await adminWs.attachAppInterface({ port: 65001 });
-const appWs = await AppWebsocket.connect({url: "ws://127.0.0.1:65001"});
+await adminWs.attachAppInterface({ port: 65001, allowed_origins: "my-happ" });
+const issuedToken = await adminWs.issueAppAuthenticationToken({
+  installed_app_id,
+});
+const appWs = await AppWebsocket.connect({
+  url: new URL("ws://127.0.0.1:65001"),
+  token: issuedToken.token,
+  wsClientOptions: { origin: "my-happ" },
+});
 
 let signalCb;
 const signalReceived = new Promise<void>((resolve) => {
@@ -103,7 +131,7 @@ appWs.on("signal", signalCb);
 // trigger an emit_signal
 await appWs.callZome({
   cell_id,
-  zome_name: "zome",
+  zome_name: "foo",
   fn_name: "emitter",
   provenance: agent_key,
   payload: null,
@@ -165,7 +193,7 @@ Holochain is an open source project.  We welcome all sorts of participation and
 
  [![License: CAL 1.0](https://img.shields.io/badge/License-CAL%201.0-blue.svg)](https://github.com/holochain/cryptographic-autonomy-license)
 
-Copyright (C) 2020-2023, Holochain Foundation
+Copyright (C) 2020-2024, Holochain Foundation
 
 This program is free software: you can redistribute it and/or modify it under the terms of the license
 provided in the LICENSE file (CAL-1.0).  This program is distributed in the hope that it will be useful,

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

@@ -66,7 +66,7 @@ export type InstalledAppInfoStatus = {
     disabled: {
         reason: DisabledAppReason;
     };
-} | "running";
+} | "awaiting_memproofs" | "running";
 /**
  * @public
  */
@@ -125,6 +125,12 @@ export type AppInfo = {
  * @public
  */
 export type MembraneProof = Uint8Array;
+/**
+ * @public
+ */
+export type MemproofMap = {
+    [key: string]: MembraneProof;
+};
 /**
  * @public
  */
@@ -356,6 +362,7 @@ export type AppManifest = {
     name: string;
     description?: string;
     roles: Array<AppRoleManifest>;
+    membrane_proofs_deferred: boolean;
 };
 /**
  * @public
@@ -393,9 +400,7 @@ export type InstallAppRequest = {
      * 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;
-    };
+    membrane_proofs: MemproofMap;
     /**
      * Optional global network seed override.  If set will override the network seed value for all
      * DNAs in the bundle.

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

@@ -1,5 +1,5 @@
 import { UnsubscribeFunction } from "emittery";
-import { AgentPubKey, AppAuthenticationToken, AppInfo, CapSecret, CellId, ClonedCell, DnaHash, DnaProperties, FunctionName, MembraneProof, NetworkInfo, NetworkSeed, Nonce256Bit, RoleName, Timestamp, WebsocketConnectionOptions, ZomeName } from "../../index.js";
+import { AgentPubKey, AppAuthenticationToken, AppInfo, CapSecret, CellId, ClonedCell, DnaHash, DnaProperties, FunctionName, InstalledAppId, MembraneProof, MemproofMap, NetworkInfo, NetworkSeed, Nonce256Bit, RoleName, Timestamp, Transformer, WebsocketConnectionOptions, ZomeName } from "../../index.js";
 /**
  * @public
  */
@@ -82,6 +82,14 @@ export type CallZomeResponse = CallZomeResponseGeneric<any>;
  * @public
  */
 export type AppInfoResponse = AppInfo | null;
+/**
+ * @public
+ */
+export type ProvideMemproofsRequest = MemproofMap;
+/**
+ * @public
+ */
+export type ProvideMemproofsResponse = void;
 /**
  * @public
  */
@@ -214,6 +222,7 @@ export interface AppClient {
     on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction;
     appInfo(): Promise<AppInfoResponse>;
     myPubKey: AgentPubKey;
+    installedAppId: InstalledAppId;
     createCloneCell(args: AppCreateCloneCellRequest): Promise<CreateCloneCellResponse>;
     enableCloneCell(args: AppEnableCloneCellRequest): Promise<EnableCloneCellResponse>;
     disableCloneCell(args: AppDisableCloneCellRequest): Promise<DisableCloneCellResponse>;
@@ -224,4 +233,9 @@ export interface AppClient {
  */
 export interface AppWebsocketConnectionOptions extends WebsocketConnectionOptions {
     token?: AppAuthenticationToken;
+    callZomeTransform?: CallZomeTransform;
 }
+/**
+ * @public
+ */
+export type CallZomeTransform = Transformer<CallZomeRequest | CallZomeRequestSigned, Promise<CallZomeRequestSigned>, CallZomeResponseGeneric<Uint8Array>, CallZomeResponse>;

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

@@ -1,6 +1,6 @@
 import { UnsubscribeFunction } from "emittery";
-import { AgentPubKey, CellId, RoleName } from "../../types.js";
-import { AppInfo } from "../admin/index.js";
+import { AgentPubKey, CellId, InstalledAppId, RoleName } from "../../types.js";
+import { AppInfo, MemproofMap } from "../admin/index.js";
 import { AppCallZomeRequest, AppClient, AppEvents, AppNetworkInfoRequest, AppCreateCloneCellRequest, AppDisableCloneCellRequest, AppEnableCloneCellRequest, AppSignalCb, CallZomeRequest, CallZomeRequestSigned, CallZomeResponse, CreateCloneCellResponse, DisableCloneCellResponse, EnableCloneCellResponse, NetworkInfoResponse, AppWebsocketConnectionOptions } from "./types.js";
 import { WsClient } from "../client.js";
 /**
@@ -12,11 +12,14 @@ import { WsClient } from "../client.js";
 export declare class AppWebsocket implements AppClient {
     readonly client: WsClient;
     readonly myPubKey: AgentPubKey;
+    readonly installedAppId: InstalledAppId;
     private readonly defaultTimeout;
     private readonly emitter;
+    private readonly callZomeTransform;
     cachedAppInfo?: AppInfo | null;
     private readonly appInfoRequester;
     private readonly callZomeRequester;
+    private readonly provideMemproofRequester;
     private readonly createCloneCellRequester;
     private readonly enableCloneCellRequester;
     private readonly disableCloneCellRequester;
@@ -37,6 +40,12 @@ export declare class AppWebsocket implements AppClient {
      * @returns The app's {@link AppInfo}.
      */
     appInfo(timeout?: number): Promise<AppInfo>;
+    /**
+     * Provide membrane proofs for the app.
+     *
+     * @param memproofs - A map of {@link MembraneProof}s.
+     */
+    provideMemproofs(memproofs: MemproofMap): Promise<void>;
     /**
      * Get a cell id by its role name or clone id.
      *

package/lib/api/app/websocket.js

@@ -18,23 +18,29 @@ import { WsClient } from "../client.js";
 export class AppWebsocket {
     client;
     myPubKey;
+    installedAppId;
     defaultTimeout;
     emitter;
+    callZomeTransform;
     cachedAppInfo;
     appInfoRequester;
     callZomeRequester;
+    provideMemproofRequester;
     createCloneCellRequester;
     enableCloneCellRequester;
     disableCloneCellRequester;
     networkInfoRequester;
-    constructor(client, appInfo, defaultTimeout) {
+    constructor(client, appInfo, callZomeTransform, defaultTimeout) {
         this.client = client;
         this.myPubKey = appInfo.agent_pub_key;
+        this.installedAppId = appInfo.installed_app_id;
         this.defaultTimeout = defaultTimeout ?? DEFAULT_TIMEOUT;
+        this.callZomeTransform = callZomeTransform ?? defaultCallZomeTransform;
         this.emitter = new Emittery();
         this.cachedAppInfo = appInfo;
         this.appInfoRequester = AppWebsocket.requester(this.client, "app_info", this.defaultTimeout);
-        this.callZomeRequester = AppWebsocket.requester(this.client, "call_zome", this.defaultTimeout, callZomeTransform);
+        this.callZomeRequester = AppWebsocket.requester(this.client, "call_zome", this.defaultTimeout, this.callZomeTransform);
+        this.provideMemproofRequester = AppWebsocket.requester(this.client, "provide_memproofs", this.defaultTimeout);
         this.createCloneCellRequester = AppWebsocket.requester(this.client, "create_clone_cell", this.defaultTimeout);
         this.enableCloneCellRequester = AppWebsocket.requester(this.client, "enable_clone_cell", this.defaultTimeout);
         this.disableCloneCellRequester = AppWebsocket.requester(this.client, "disable_clone_cell", this.defaultTimeout);
@@ -85,7 +91,7 @@ export class AppWebsocket {
         if (!appInfo) {
             throw new HolochainError("AppNotFound", `The app your connection token was issued for was not found. The app needs to be installed and enabled.`);
         }
-        return new AppWebsocket(client, appInfo, options.defaultTimeout);
+        return new AppWebsocket(client, appInfo, options.callZomeTransform, options.defaultTimeout);
     }
     /**
      * Request the app's info, including all cell infos.
@@ -101,6 +107,14 @@ export class AppWebsocket {
         this.cachedAppInfo = appInfo;
         return appInfo;
     }
+    /**
+     * Provide membrane proofs for the app.
+     *
+     * @param memproofs - A map of {@link MembraneProof}s.
+     */
+    async provideMemproofs(memproofs) {
+        await this.provideMemproofRequester(memproofs);
+    }
     /**
      * Get a cell id by its role name or clone id.
      *
@@ -236,7 +250,7 @@ export class AppWebsocket {
         return false;
     }
 }
-const callZomeTransform = {
+const defaultCallZomeTransform = {
     input: async (request) => {
         if ("signature" in request) {
             return request;

package/package.json

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