@holochain/client 0.18.0-dev.1 → 0.18.0-dev.10

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

@@ -1,5 +1,5 @@
 import { Action, DhtOp, Entry, ZomeCallCapGrant } from "../../hdk/index.js";
-import { ActionHash, AgentPubKey, CellId, DnaHash, DnaProperties, Duration, HoloHash, HoloHashB64, InstalledAppId, KitsuneAgent, KitsuneSpace, RoleName, Signature, Timestamp, WasmHash } from "../../types.js";
+import { ActionHash, AgentPubKey, CellId, DnaHash, DnaHashB64, DnaProperties, Duration, HoloHash, HoloHashB64, InstalledAppId, KitsuneAgent, KitsuneSpace, RoleName, Signature, Timestamp, WasmHash } from "../../types.js";
 import { Requester } from "../common.js";
 /**
  * @public
@@ -52,7 +52,7 @@ export type PausedAppReason = {
 /**
  * @public
  */
-export type DisabledAppReason = "never_started" | "user" | {
+export type DisabledAppReason = "never_started" | "user" | "not_started_after_providing_memproofs" | {
     error: string;
 };
 /**
@@ -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
  */
@@ -228,6 +234,7 @@ export type CoordinatorZome = ZomeDefinition;
 export type DnaDefinition = {
     name: string;
     modifiers: DnaModifiers;
+    lineage: DnaHashB64[];
     integrity_zomes: IntegrityZome[];
     coordinator_zomes: CoordinatorZome[];
 };
@@ -239,6 +246,14 @@ export type GetDnaDefinitionRequest = DnaHash;
  * @public
  */
 export type GetDnaDefinitionResponse = DnaDefinition;
+/**
+ * @public
+ */
+export type GetCompatibleCellsRequest = DnaHashB64;
+/**
+ * @public
+ */
+export type GetCompatibleCellsResponse = Set<[InstalledAppId, Set<CellId>]>;
 /**
  * @public
  */
@@ -356,6 +371,7 @@ export type AppManifest = {
     name: string;
     description?: string;
     roles: Array<AppRoleManifest>;
+    membrane_proofs_deferred: boolean;
 };
 /**
  * @public
@@ -393,9 +409,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.
@@ -605,6 +619,26 @@ export type DnaManifest = {
      * The order is significant: it determines initialization order.
      */
     zomes: Array<ZomeManifest>;
+    /**
+     *  A list of past "ancestors" of this DNA.
+     *
+     * Whenever a DNA is created which is intended to be used as a migration from
+     * a previous DNA, the lineage should be updated to include the hash of the
+     * DNA being migrated from. DNA hashes may also be removed from this list if
+     * it is desired to remove them from the lineage.
+     *
+     * The meaning of the "ancestor" relationship is as follows:
+     * - For any DNA, there is a migration path from any of its ancestors to itself.
+     * - When an app depends on a DnaHash via UseExisting, it means that any installed
+     *     DNA in the lineage which contains that DnaHash can be used.
+     * - The app's Coordinator interface is expected to be compatible across the lineage.
+     *     (Though this cannot be enforced, since Coordinators can be swapped out at
+     *      will by the user, the intention is still there.)
+     *
+     * Holochain does nothing to ensure the correctness of the lineage, it is up to
+     * the app developer to make the necessary guarantees.
+     */
+    lineage: DnaHashB64[];
 };
 /**
  * @public

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

@@ -2,7 +2,7 @@ import { CapSecret, GrantedFunctions } from "../../hdk/index.js";
 import type { AgentPubKey, CellId } from "../../types.js";
 import { WsClient } from "../client.js";
 import { Requester, Transformer, WebsocketConnectionOptions } from "../common.js";
-import { AddAgentInfoRequest, AddAgentInfoResponse, AdminApi, AgentInfoRequest, AgentInfoResponse, AttachAppInterfaceRequest, AttachAppInterfaceResponse, DeleteCloneCellRequest, DeleteCloneCellResponse, DisableAppRequest, DisableAppResponse, DumpFullStateRequest, DumpFullStateResponse, DumpNetworkStatsRequest, DumpNetworkStatsResponse, DumpStateRequest, DumpStateResponse, EnableAppRequest, EnableAppResponse, GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse, GetDnaDefinitionRequest, GetDnaDefinitionResponse, GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse, InstallAppRequest, InstallAppResponse, IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse, ListAppInterfacesRequest, ListAppInterfacesResponse, ListAppsRequest, ListAppsResponse, ListCellIdsRequest, ListCellIdsResponse, ListDnasRequest, ListDnasResponse, RegisterDnaRequest, RegisterDnaResponse, StorageInfoRequest, StorageInfoResponse, UninstallAppRequest, UninstallAppResponse, UpdateCoordinatorsRequest, UpdateCoordinatorsResponse } from "./types.js";
+import { AddAgentInfoRequest, AddAgentInfoResponse, AdminApi, AgentInfoRequest, AgentInfoResponse, AttachAppInterfaceRequest, AttachAppInterfaceResponse, DeleteCloneCellRequest, DeleteCloneCellResponse, DisableAppRequest, DisableAppResponse, DumpFullStateRequest, DumpFullStateResponse, DumpNetworkStatsRequest, DumpNetworkStatsResponse, DumpStateRequest, DumpStateResponse, EnableAppRequest, EnableAppResponse, GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse, GetCompatibleCellsRequest, GetCompatibleCellsResponse, GetDnaDefinitionRequest, GetDnaDefinitionResponse, GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse, InstallAppRequest, InstallAppResponse, IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse, ListAppInterfacesRequest, ListAppInterfacesResponse, ListAppsRequest, ListAppsResponse, ListCellIdsRequest, ListCellIdsResponse, ListDnasRequest, ListDnasResponse, RegisterDnaRequest, RegisterDnaResponse, StorageInfoRequest, StorageInfoResponse, UninstallAppRequest, UninstallAppResponse, UpdateCoordinatorsRequest, UpdateCoordinatorsResponse } from "./types.js";
 /**
  * A class for interacting with a conductor's Admin API.
  *
@@ -61,6 +61,7 @@ export declare class AdminWebsocket implements AdminApi {
      * Get the DNA definition for the specified DNA hash.
      */
     getDnaDefinition: Requester<GetDnaDefinitionRequest, GetDnaDefinitionResponse>;
+    getCompatibleCells: Requester<GetCompatibleCellsRequest, GetCompatibleCellsResponse>;
     /**
      * Uninstall the specified app from Holochain.
      */

package/lib/api/admin/websocket.js

@@ -78,6 +78,9 @@ export class AdminWebsocket {
      * Get the DNA definition for the specified DNA hash.
      */
     getDnaDefinition = this._requester("get_dna_definition");
+    /// Find installed cells which use a DNA that's forward-compatible with the given DNA hash.
+    /// Namely, this finds cells with DNAs whose manifest lists the given DNA hash in its `lineage` field.
+    getCompatibleCells = this._requester("get_compatible_cells");
     /**
      * Uninstall the specified app from Holochain.
      */

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, InstalledAppId, MembraneProof, NetworkInfo, NetworkSeed, Nonce256Bit, RoleName, Timestamp, Transformer, WebsocketConnectionOptions, ZomeName } from "../../index.js";
+import { AgentPubKey, AppAuthenticationToken, AppInfo, CapSecret, CellId, ClonedCell, DnaHash, DnaProperties, EntryHash, FunctionName, InstalledAppId, MembraneProof, MemproofMap, NetworkInfo, NetworkSeed, Nonce256Bit, RoleName, Timestamp, Transformer, WebsocketConnectionOptions, ZomeName } from "../../index.js";
 /**
  * @public
  */
@@ -40,7 +40,7 @@ export type AppNetworkInfoRequest = Omit<NetworkInfoRequest, "agent_pub_key">;
  * @public
  */
 export interface AppEvents {
-    signal: AppSignal;
+    signal: Signal;
 }
 /**
  * @public
@@ -82,6 +82,22 @@ export type CallZomeResponse = CallZomeResponseGeneric<any>;
  * @public
  */
 export type AppInfoResponse = AppInfo | null;
+/**
+ * @public
+ */
+export type ProvideMemproofsRequest = MemproofMap;
+/**
+ * @public
+ */
+export type ProvideMemproofsResponse = void;
+/**
+ * @public
+ */
+export type EnableRequest = void;
+/**
+ * @public
+ */
+export type EnableResponse = void;
 /**
  * @public
  */
@@ -177,10 +193,18 @@ export declare const SignalType: {
 /**
  * @public
  */
-export type Signal = {
+export type RawSignal = {
     [SignalType.App]: EncodedAppSignal;
 } | {
-    [SignalType.System]: unknown;
+    [SignalType.System]: SystemSignal;
+};
+/**
+ * @public
+ */
+export type Signal = {
+    [SignalType.App]: AppSignal;
+} | {
+    [SignalType.System]: SystemSignal;
 };
 /**
  * @public
@@ -201,7 +225,13 @@ export type AppSignal = {
 /**
  * @public
  */
-export type AppSignalCb = (signal: AppSignal) => void;
+export type SystemSignal = {
+    SuccessfulCountersigning: EntryHash;
+};
+/**
+ * @public
+ */
+export type SignalCb = (signal: Signal) => void;
 /**
  * @public
  */
@@ -211,7 +241,7 @@ export type NetworkInfoResponse = NetworkInfo[];
  */
 export interface AppClient {
     callZome(args: AppCallZomeRequest, timeout?: number): Promise<any>;
-    on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction;
+    on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: SignalCb): UnsubscribeFunction;
     appInfo(): Promise<AppInfoResponse>;
     myPubKey: AgentPubKey;
     installedAppId: InstalledAppId;
@@ -227,4 +257,7 @@ export interface AppWebsocketConnectionOptions extends WebsocketConnectionOption
     token?: AppAuthenticationToken;
     callZomeTransform?: CallZomeTransform;
 }
+/**
+ * @public
+ */
 export type CallZomeTransform = Transformer<CallZomeRequest | CallZomeRequestSigned, Promise<CallZomeRequestSigned>, CallZomeResponseGeneric<Uint8Array>, CallZomeResponse>;

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 } 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 { AppInfo, MemproofMap } from "../admin/index.js";
+import { AppCallZomeRequest, AppClient, AppEvents, AppNetworkInfoRequest, AppCreateCloneCellRequest, AppDisableCloneCellRequest, AppEnableCloneCellRequest, SignalCb, CallZomeRequest, CallZomeRequestSigned, CallZomeResponse, CreateCloneCellResponse, DisableCloneCellResponse, EnableCloneCellResponse, NetworkInfoResponse, AppWebsocketConnectionOptions } from "./types.js";
 import { WsClient } from "../client.js";
 /**
  * A class to establish a websocket connection to an App interface, for a
@@ -19,6 +19,8 @@ export declare class AppWebsocket implements AppClient {
     cachedAppInfo?: AppInfo | null;
     private readonly appInfoRequester;
     private readonly callZomeRequester;
+    private readonly provideMemproofRequester;
+    private readonly enableAppRequester;
     private readonly createCloneCellRequester;
     private readonly enableCloneCellRequester;
     private readonly disableCloneCellRequester;
@@ -39,6 +41,17 @@ 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>;
+    /**
+     * Enablie an app only if the app is in the `AppStatus::Disabled(DisabledAppReason::NotStartedAfterProvidingMemproofs)`
+     * state. Attempting to enable the app from other states (other than Running) will fail.
+     */
+    enableApp(): Promise<void>;
     /**
      * Get a cell id by its role name or clone id.
      *
@@ -88,7 +101,7 @@ export declare class AppWebsocket implements AppClient {
      * @param listener - The function to call when event is triggered.
      * @returns A function to unsubscribe the event listener.
      */
-    on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction;
+    on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: SignalCb): UnsubscribeFunction;
     private static requester;
     private containsCell;
 }

package/lib/api/app/websocket.js

@@ -25,6 +25,8 @@ export class AppWebsocket {
     cachedAppInfo;
     appInfoRequester;
     callZomeRequester;
+    provideMemproofRequester;
+    enableAppRequester;
     createCloneCellRequester;
     enableCloneCellRequester;
     disableCloneCellRequester;
@@ -39,6 +41,8 @@ export class AppWebsocket {
         this.cachedAppInfo = appInfo;
         this.appInfoRequester = AppWebsocket.requester(this.client, "app_info", this.defaultTimeout);
         this.callZomeRequester = AppWebsocket.requester(this.client, "call_zome", this.defaultTimeout, this.callZomeTransform);
+        this.provideMemproofRequester = AppWebsocket.requester(this.client, "provide_memproofs", this.defaultTimeout);
+        this.enableAppRequester = AppWebsocket.requester(this.client, "enable_app", 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);
@@ -53,9 +57,7 @@ export class AppWebsocket {
             }
         });
         this.client.on("signal", (signal) => {
-            if (this.containsCell(signal.cell_id)) {
-                this.emitter.emit("signal", signal).catch(console.error);
-            }
+            this.emitter.emit("signal", signal).catch(console.error);
         });
     }
     /**
@@ -85,7 +87,7 @@ export class AppWebsocket {
             }
             await client.authenticate({ token: options.token });
         }
-        const appInfo = await this.requester(client, "app_info", DEFAULT_TIMEOUT)(null);
+        const appInfo = await AppWebsocket.requester(client, "app_info", DEFAULT_TIMEOUT)(null);
         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.`);
         }
@@ -105,6 +107,21 @@ 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);
+    }
+    /**
+     * Enablie an app only if the app is in the `AppStatus::Disabled(DisabledAppReason::NotStartedAfterProvidingMemproofs)`
+     * state. Attempting to enable the app from other states (other than Running) will fail.
+     */
+    async enableApp() {
+        await this.enableAppRequester();
+    }
     /**
      * Get a cell id by its role name or clone id.
      *

package/lib/api/client.js

@@ -52,18 +52,21 @@ export class WsClient extends Emittery {
                 const deserializedSignal = decode(message.data);
                 assertHolochainSignal(deserializedSignal);
                 if (SignalType.System in deserializedSignal) {
-                    // We have received a system signal, do nothing
-                    return;
+                    this.emit("signal", {
+                        System: deserializedSignal[SignalType.System],
+                    });
+                }
+                else {
+                    const encodedAppSignal = deserializedSignal[SignalType.App];
+                    // In order to return readable content to the UI, the signal payload must also be deserialized.
+                    const payload = decode(encodedAppSignal.signal);
+                    const signal = {
+                        cell_id: encodedAppSignal.cell_id,
+                        zome_name: encodedAppSignal.zome_name,
+                        payload,
+                    };
+                    this.emit("signal", { App: signal });
                 }
-                const encodedAppSignal = deserializedSignal[SignalType.App];
-                // In order to return readable content to the UI, the signal payload must also be deserialized.
-                const payload = decode(encodedAppSignal.signal);
-                const signal = {
-                    cell_id: encodedAppSignal.cell_id,
-                    zome_name: encodedAppSignal.zome_name,
-                    payload,
-                };
-                this.emit("signal", signal);
             }
             else if (message.type === "response") {
                 this.handleResponse(message);

package/lib/hdk/countersigning.d.ts

@@ -18,6 +18,23 @@ export interface PreflightRequest {
     action_base: ActionBase;
     preflight_bytes: PreflightBytes;
 }
+/**
+ * @public
+ */
+export interface PreflightResponse {
+    /**
+     * The request associated with this response.
+     */
+    request: PreflightRequest;
+    /**
+     * The chain state declaration for the agent that produced this response.
+     */
+    agent_state: CountersigningAgentState;
+    /**
+     * The signature of this response, by the agent that created it.
+     */
+    signature: Signature;
+}
 /**
  * @public
  */

package/lib/hdk/dht-ops.d.ts

@@ -1,4 +1,4 @@
-import { Signature } from "../types.js";
+import { ActionHash, AgentPubKey, Signature, Timestamp } from "../types.js";
 import { Entry } from "./entry.js";
 import { CreateLink, Delete, DeleteLink, Action, NewEntryAction, Update } from "./action.js";
 /**
@@ -19,6 +19,27 @@ export declare enum DhtOpType {
  * @public
  */
 export type DhtOp = {
+    ChainOp: ChainOp;
+} | {
+    WarrantOp: WarrantOp;
+};
+/**
+ * @public
+ */
+export interface WarrantOp {
+    /** The warrant which was issued */
+    warrant: Warrant;
+    /** author of the warrant */
+    author: AgentPubKey;
+    /** signature of (Warrant, Timestamp) by the author */
+    signature: Signature;
+    /** time when the warrant was issued */
+    timestamp: Timestamp;
+}
+/**
+ * @public
+ */
+export type ChainOp = {
     [DhtOpType.StoreRecord]: [Signature, Action, Entry | undefined];
 } | {
     [DhtOpType.StoreEntry]: [Signature, NewEntryAction, Entry];
@@ -41,6 +62,55 @@ export type DhtOp = {
 } | {
     [DhtOpType.RegisterRemoveLink]: [Signature, DeleteLink];
 };
+/**
+ * @public
+ */
+export interface Warrant {
+    /**
+     * Signifies evidence of a breach of chain integrity
+     */
+    ChainIntegrity: ChainIntegrityWarrant;
+}
+/**
+ * @public
+ */
+export type ChainIntegrityWarrant = {
+    /**
+     * Something invalid was authored on a chain.
+     * When we receive this warrant, we fetch the Action and validate it
+     * under every applicable DhtOpType.
+     */
+    InvalidChainOp: {
+        /** The author of the action */
+        action_author: AgentPubKey;
+        /** The hash of the action to fetch by */
+        action: ActionHashAndSig;
+        /** Whether to run app or sys validation */
+        validation_type: ValidationType;
+    } | {
+        /** Proof of chain fork. */
+        ChainFork: {
+            /** Author of the chain which is forked */
+            chain_author: AgentPubKey;
+            /** Two actions of the same seq number which prove the fork */
+            action_pair: [ActionHashAndSig, ActionHashAndSig];
+        };
+    };
+};
+/**
+ * @public
+ */
+export type ValidationType = {
+    /** Sys validation */
+    Sys: null;
+    /** App validation */
+    App: null;
+};
+/**
+ * Action hash with the signature of the action at that hash
+ * @public
+ */
+export type ActionHashAndSig = [ActionHash, Signature];
 /**
  * @public
  */

package/lib/hdk/link.d.ts

@@ -39,6 +39,7 @@ export type RateUnits = number;
  */
 export interface Link {
     author: AgentPubKey;
+    base: AnyLinkableHash;
     target: AnyLinkableHash;
     timestamp: Timestamp;
     zome_index: ZomeIndex;

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.43.1"
+      "packageVersion": "7.47.0"
     }
   ]
 }

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

@@ -1,6 +1,6 @@
 import { ActionHash, AgentPubKey, EntryHash } from "../types.js";
 /**
- * Hash type labels and their 3 byte values (forming the first 3 bytes of hash)
+ * Hash type labels and their 3 byte values (forming the first 3 bytes of hash).
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
@@ -14,18 +14,18 @@ export declare const HASH_TYPE_PREFIX: {
     External: Uint8Array;
 };
 /**
- * Get dht location (last 4 bytes) from a hash
+ * Get hash type (initial 3 bytes) from a hash.
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
  * @param hash - The full 39 byte hash.
- * @returns The last 4 bytes of the hash.
+ * @returns The initial 3 bytes of the hash.
  *
  * @public
  */
-export declare function sliceDhtLocation(hash: AgentPubKey | EntryHash | ActionHash): Uint8Array;
+export declare function sliceHashType(hash: AgentPubKey | EntryHash | ActionHash): Uint8Array;
 /**
- * Get core (center 32 bytes) from a hash
+ * Get core hash from a Holochain hash (32 bytes).
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
@@ -36,18 +36,18 @@ export declare function sliceDhtLocation(hash: AgentPubKey | EntryHash | ActionH
  */
 export declare function sliceCore32(hash: AgentPubKey | EntryHash | ActionHash): Uint8Array;
 /**
- * Get hash type (initial 3 bytes) from a hash
+ * Get DHT location (last 4 bytes) from a hash.
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
  * @param hash - The full 39 byte hash.
- * @returns The initial 3 bytes of the hash.
+ * @returns The last 4 bytes of the hash.
  *
  * @public
  */
-export declare function sliceHashType(hash: AgentPubKey | EntryHash | ActionHash): Uint8Array;
+export declare function sliceDhtLocation(hash: AgentPubKey | EntryHash | ActionHash): Uint8Array;
 /**
- * Generate dht location (last 4 bytes) from a core hash (middle 32 bytes)
+ * Generate DHT location (last 4 bytes) from a core hash (middle 32 bytes).
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
@@ -58,7 +58,7 @@ export declare function sliceHashType(hash: AgentPubKey | EntryHash | ActionHash
  */
 export declare function dhtLocationFrom32(hashCore: Uint8Array): Uint8Array;
 /**
- * Generate full hash from a core hash (middle 32 bytes) and hash type label
+ * Generate full hash from a core hash (middle 32 bytes) and hash type label.
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *

package/lib/utils/hash-parts.js

@@ -1,6 +1,10 @@
 import blake2b from "@bitgo/blake2b";
+const HASH_TYPE_START = 0;
+const HASH_TYPE_BYTE_LENGTH = 3;
+const CORE_HASH_BYTE_LENGTH = 32;
+const DHT_LOCATION_BYTE_LENGTH = 4;
 /**
- * Hash type labels and their 3 byte values (forming the first 3 bytes of hash)
+ * Hash type labels and their 3 byte values (forming the first 3 bytes of hash).
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
@@ -14,20 +18,20 @@ export const HASH_TYPE_PREFIX = {
     External: Uint8Array.from([132, 47, 36]),
 };
 /**
- * Get dht location (last 4 bytes) from a hash
+ * Get hash type (initial 3 bytes) from a hash.
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
  * @param hash - The full 39 byte hash.
- * @returns The last 4 bytes of the hash.
+ * @returns The initial 3 bytes of the hash.
  *
  * @public
  */
-export function sliceDhtLocation(hash) {
-    return Uint8Array.from(hash.slice(36, 40));
+export function sliceHashType(hash) {
+    return Uint8Array.from(hash.slice(0, 3));
 }
 /**
- * Get core (center 32 bytes) from a hash
+ * Get core hash from a Holochain hash (32 bytes).
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
@@ -37,23 +41,27 @@ export function sliceDhtLocation(hash) {
  * @public
  */
 export function sliceCore32(hash) {
-    return Uint8Array.from(hash.slice(3, 36));
+    const start = HASH_TYPE_START + HASH_TYPE_BYTE_LENGTH;
+    const end = start + CORE_HASH_BYTE_LENGTH;
+    return Uint8Array.from(hash.slice(start, end));
 }
 /**
- * Get hash type (initial 3 bytes) from a hash
+ * Get DHT location (last 4 bytes) from a hash.
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
  * @param hash - The full 39 byte hash.
- * @returns The initial 3 bytes of the hash.
+ * @returns The last 4 bytes of the hash.
  *
  * @public
  */
-export function sliceHashType(hash) {
-    return Uint8Array.from(hash.slice(0, 3));
+export function sliceDhtLocation(hash) {
+    const start = HASH_TYPE_START + HASH_TYPE_BYTE_LENGTH + CORE_HASH_BYTE_LENGTH;
+    const end = start + DHT_LOCATION_BYTE_LENGTH;
+    return Uint8Array.from(hash.slice(start, end));
 }
 /**
- * Generate dht location (last 4 bytes) from a core hash (middle 32 bytes)
+ * Generate DHT location (last 4 bytes) from a core hash (middle 32 bytes).
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
@@ -75,7 +83,7 @@ export function dhtLocationFrom32(hashCore) {
     return out;
 }
 /**
- * Generate full hash from a core hash (middle 32 bytes) and hash type label
+ * Generate full hash from a core hash (middle 32 bytes) and hash type label.
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *

package/package.json

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