@holochain/client 0.19.0-dev.4 → 0.19.0-dev.6

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

@@ -130,7 +130,38 @@ export type MembraneProof = Uint8Array;
  * @public
  */
 export type MemproofMap = {
-    [key: string]: MembraneProof;
+    [key: RoleName]: MembraneProof;
+};
+/**
+ * @public
+ */
+export type RoleSettingsMap = {
+    [key: RoleName]: RoleSettings;
+};
+/**
+ * @public
+ */
+export type RoleSettings = {
+    type: "UseExisting";
+    cell_id: CellId;
+} | {
+    type: "Provisioned";
+    membrane_proof?: MembraneProof;
+    modifiers?: DnaModifiersOpt;
+};
+/**
+ *  @public
+ * Any value that is serializable to a Yaml value
+ */
+export type YamlProperties = unknown;
+/**
+ * @public
+ */
+export type DnaModifiersOpt = {
+    network_seed?: NetworkSeed;
+    properties?: YamlProperties;
+    origin_time?: Timestamp;
+    quantum_time?: Duration;
 };
 /**
  * @public
@@ -425,16 +456,15 @@ export type InstallAppRequest = {
      * 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: MemproofMap;
     /**
      * Optional global network seed override.  If set will override the network seed value for all
      * DNAs in the bundle.
      */
     network_seed?: NetworkSeed;
+    /**
+     * Specify role specific settings or modifiers that will override any settings in the dna manifest.
+     */
+    roles_settings?: RoleSettingsMap;
     /**
      * 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

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

@@ -1,25 +1,5 @@
 import { UnsubscribeFunction } from "emittery";
 import { AgentPubKey, AppAuthenticationToken, AppInfo, CapSecret, CellId, ClonedCell, DnaHash, DnaProperties, EntryHash, FunctionName, InstalledAppId, MembraneProof, MemproofMap, NetworkInfo, NetworkSeed, Nonce256Bit, RoleName, Timestamp, Transformer, WebsocketConnectionOptions, ZomeName, PreflightRequest, SignedAction, SignedActionHashed } from "../../index.js";
-/**
- * @public
- */
-export type NonProvenanceCallZomeRequest = Omit<CallZomeRequest, "provenance">;
-/**
- * @public
- */
-export type RoleNameCallZomeRequest = Omit<NonProvenanceCallZomeRequest, "cell_id"> & {
-    role_name: RoleName;
-};
-/**
- * @public
- */
-export type RoleNameCallZomeRequestSigned = Omit<CallZomeRequestSigned, "cell_id"> & {
-    role_name: RoleName;
-};
-/**
- * @public
- */
-export type AppCallZomeRequest = NonProvenanceCallZomeRequest | RoleNameCallZomeRequest | CallZomeRequest | CallZomeRequestAllParams;
 /**
  * @public
  */
@@ -45,32 +25,33 @@ export interface AppEvents {
 /**
  * @public
  */
-export interface CallZomeRequestAllParams extends CallZomeRequest {
-    cap_secret: CapSecret | null;
-    nonce: Nonce256Bit;
-    expires_at: number;
-}
+export type CallZomeRequestGeneric<Payload> = {
+    cell_id: CellId;
+    zome_name: ZomeName;
+    fn_name: FunctionName;
+    provenance?: AgentPubKey;
+    payload?: Payload;
+    cap_secret?: CapSecret;
+    nonce?: Nonce256Bit;
+    expires_at?: number;
+};
 /**
  * @public
  */
-export interface CallZomeRequestSigned {
-    bytes: Uint8Array;
-    signature: Uint8Array;
-}
+export type CallZomeRequest = CallZomeRequestGeneric<any>;
 /**
  * @public
  */
-export type CallZomeRequestGeneric<Payload> = {
-    cell_id: CellId;
-    zome_name: ZomeName;
-    fn_name: FunctionName;
-    payload: Payload;
-    provenance: AgentPubKey;
+export type RoleNameCallZomeRequest = Omit<CallZomeRequest, "cell_id"> & {
+    role_name: RoleName;
 };
 /**
  * @public
  */
-export type CallZomeRequest = CallZomeRequestGeneric<any>;
+export interface CallZomeRequestSigned {
+    bytes: Uint8Array;
+    signature: Uint8Array;
+}
 /**
  * @public
  */
@@ -446,7 +427,7 @@ export type NetworkInfoResponse = NetworkInfo[];
  * @public
  */
 export interface AppClient {
-    callZome(args: AppCallZomeRequest, timeout?: number): Promise<any>;
+    callZome(args: CallZomeRequest | RoleNameCallZomeRequest, timeout?: number): Promise<any>;
     on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: SignalCb): UnsubscribeFunction;
     appInfo(): Promise<AppInfoResponse>;
     myPubKey: AgentPubKey;

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

@@ -1,7 +1,7 @@
 import { UnsubscribeFunction } from "emittery";
 import { AgentPubKey, CellId, InstalledAppId, RoleName } from "../../types.js";
 import { AppInfo, MemproofMap } from "../admin/index.js";
-import { AppCallZomeRequest, AppClient, AppEvents, AppNetworkInfoRequest, AppCreateCloneCellRequest, AppDisableCloneCellRequest, AppEnableCloneCellRequest, SignalCb, CallZomeRequest, CallZomeRequestSigned, NetworkInfoResponse, AppWebsocketConnectionOptions, GetCountersigningSessionStateRequest, GetCountersigningSessionStateResponse, AbandonCountersigningSessionStateRequest, PublishCountersigningSessionStateRequest } from "./types.js";
+import { AppClient, AppEvents, AppNetworkInfoRequest, AppCreateCloneCellRequest, AppDisableCloneCellRequest, AppEnableCloneCellRequest, SignalCb, CallZomeRequest, CallZomeRequestSigned, NetworkInfoResponse, AppWebsocketConnectionOptions, GetCountersigningSessionStateRequest, GetCountersigningSessionStateResponse, AbandonCountersigningSessionStateRequest, PublishCountersigningSessionStateRequest, RoleNameCallZomeRequest } from "./types.js";
 import { WsClient } from "../client.js";
 /**
  * A class to establish a websocket connection to an App interface, for a
@@ -70,7 +70,7 @@ export declare class AppWebsocket implements AppClient {
      * @param timeout - A timeout to override the default.
      * @returns The zome call's response.
      */
-    callZome<ReturnType>(request: AppCallZomeRequest, timeout?: number): Promise<ReturnType>;
+    callZome<ReturnType>(request: CallZomeRequest | RoleNameCallZomeRequest, timeout?: number): Promise<ReturnType>;
     /**
      * Clone an existing provisioned cell.
      *

package/lib/api/app/websocket.js

@@ -167,17 +167,16 @@ export class AppWebsocket {
         if ("role_name" in request && request.role_name) {
             const appInfo = this.cachedAppInfo || (await this.appInfo());
             const cell_id = this.getCellIdFromRoleName(request.role_name, appInfo);
-            const zomeCallPayload = {
+            request = {
                 ...omit(request, "role_name"),
-                provenance: this.myPubKey,
+                // Some problem here with the launcher with just the `cell_id`.
                 cell_id: [cell_id[0], cell_id[1]],
             };
-            return this.callZomeRequester(zomeCallPayload, timeout);
         }
-        else if ("cell_id" in request && request.cell_id) {
-            return this.callZomeRequester(request, timeout);
+        else if (!("cell_id" in request)) {
+            throw new HolochainError("MissingRoleNameOrCellId", "callZome requires a role_name or cell_id argument");
         }
-        throw new HolochainError("MissingRoleNameOrCellId", "callZome requires a role_name or cell_id argument");
+        return this.callZomeRequester(request, timeout);
     }
     /**
      * Clone an existing provisioned cell.
@@ -345,7 +344,7 @@ export const signZomeCall = async (request) => {
     if (!signingCredentialsForCell) {
         throw new HolochainError("NoSigningCredentialsForCell", `no signing credentials have been authorized for cell [${encodeHashToBase64(request.cell_id[0])}, ${encodeHashToBase64(request.cell_id[1])}]`);
     }
-    const unsignedZomeCallPayload = {
+    const zome_call_params = {
         cap_secret: signingCredentialsForCell.capSecret,
         cell_id: request.cell_id,
         zome_name: request.zome_name,
@@ -355,7 +354,7 @@ export const signZomeCall = async (request) => {
         nonce: await randomNonce(),
         expires_at: getNonceExpiration(),
     };
-    const bytes = encode(unsignedZomeCallPayload);
+    const bytes = encode(zome_call_params);
     const bytesHash = new Uint8Array(sha512.array(bytes));
     await _sodium.ready;
     const sodium = _sodium;

package/lib/environments/launcher.d.ts

@@ -1,5 +1,5 @@
 import { AppAuthenticationToken, CallZomeRequest } from "../api/index.js";
-import { CallZomeRequestSigned, CallZomeRequestAllParams } from "../api/index.js";
+import { CallZomeRequestSigned } from "../api/index.js";
 import { InstalledAppId } from "../types.js";
 export interface LauncherEnvironment {
     APP_INTERFACE_PORT?: number;
@@ -32,7 +32,7 @@ interface CallZomeRequestSignedElectron extends Omit<CallZomeRequestSigned, "cap
     nonce: Array<number>;
     expiresAt: number;
 }
-interface CallZomeRequestUnsignedElectron extends Omit<CallZomeRequestAllParams, "cap_secret" | "cell_id" | "provenance" | "nonce" | "zome_name" | "fn_name" | "expires_at"> {
+interface CallZomeRequestUnsignedElectron extends Omit<CallZomeRequest, "cap_secret" | "cell_id" | "provenance" | "nonce" | "zome_name" | "fn_name" | "expires_at"> {
     cellId: [Array<number>, Array<number>];
     provenance: Array<number>;
     zomeName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/client",
-  "version": "0.19.0-dev.4",
+  "version": "0.19.0-dev.6",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (https://holochain.org)",
   "license": "CAL-1.0",
@@ -55,6 +55,7 @@
   "devDependencies": {
     "@microsoft/api-documenter": "^7.21.7",
     "@microsoft/api-extractor": "^7.34.4",
+    "@types/js-yaml": "4.0.9",
     "@types/libsodium-wrappers": "^0.7.11",
     "@types/lodash-es": "^4.17.6",
     "@types/tape": "^4.13.2",
@@ -65,7 +66,7 @@
     "eslint-config-prettier": "^8.10.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-tsdoc": "^0.2.17",
-    "js-yaml": "^3.14.1",
+    "js-yaml": "^4.1.0",
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "tape": "^5.6.6",