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

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;
 };
 /**
@@ -234,6 +234,7 @@ export type CoordinatorZome = ZomeDefinition;
 export type DnaDefinition = {
     name: string;
     modifiers: DnaModifiers;
+    lineage: DnaHashB64[];
     integrity_zomes: IntegrityZome[];
     coordinator_zomes: CoordinatorZome[];
 };
@@ -245,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
  */
@@ -610,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

@@ -90,6 +90,14 @@ export type ProvideMemproofsRequest = MemproofMap;
  * @public
  */
 export type ProvideMemproofsResponse = void;
+/**
+ * @public
+ */
+export type EnableRequest = void;
+/**
+ * @public
+ */
+export type EnableResponse = void;
 /**
  * @public
  */

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

@@ -20,6 +20,7 @@ export declare class AppWebsocket implements AppClient {
     private readonly appInfoRequester;
     private readonly callZomeRequester;
     private readonly provideMemproofRequester;
+    private readonly enableAppRequester;
     private readonly createCloneCellRequester;
     private readonly enableCloneCellRequester;
     private readonly disableCloneCellRequester;
@@ -46,6 +47,11 @@ export declare class AppWebsocket implements AppClient {
      * @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.
      *

package/lib/api/app/websocket.js

@@ -26,6 +26,7 @@ export class AppWebsocket {
     appInfoRequester;
     callZomeRequester;
     provideMemproofRequester;
+    enableAppRequester;
     createCloneCellRequester;
     enableCloneCellRequester;
     disableCloneCellRequester;
@@ -41,6 +42,7 @@ export class AppWebsocket {
         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);
@@ -115,6 +117,13 @@ export class AppWebsocket {
     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/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.4",
+  "version": "0.18.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",