@holochain/client 0.19.0-dev.7 → 0.19.0-rc.0

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

@@ -303,14 +303,6 @@ export type GetDnaDefinitionRequest = DnaHash;
  * @public
  */
 export type GetDnaDefinitionResponse = DnaDefinition;
-/**
- * @public
- */
-export type GetCompatibleCellsRequest = DnaHashB64;
-/**
- * @public
- */
-export type GetCompatibleCellsResponse = Set<[InstalledAppId, Set<CellId>]>;
 /**
  * @public
  */
@@ -445,8 +437,8 @@ export type AppBundleSource = {
     type: "path";
     value: string;
 } | {
-    type: "bundle";
-    value: AppBundle;
+    type: "bytes";
+    value: Uint8Array;
 };
 /**
  * @public
@@ -568,12 +560,12 @@ export type AgentInfoRequest = {
 /**
  * @public
  */
-export type AgentInfoResponse = Array<AgentInfoSigned>;
+export type AgentInfoResponse = Array<string>;
 /**
  * @public
  */
 export type AddAgentInfoRequest = {
-    agent_infos: Array<AgentInfoSigned>;
+    agent_infos: Array<string>;
 };
 /**
  * @public
@@ -859,10 +851,272 @@ export interface IssueAppAuthenticationTokenResponse {
  * @public
  */
 export type DumpNetworkStatsRequest = void;
+/**
+ * Stats for a transport connection.
+ *
+ * This is intended to be a state dump that gives some insight into what the transport is doing.
+ *
+ * @public
+ */
+export interface TransportStats {
+    /**
+     * The networking backend that is in use.
+     */
+    backend: string;
+    /**
+     * The list of peer urls that this Kitsune2 instance can currently be reached at.
+     */
+    peer_urls: string[];
+    /**
+     * The list of current connections.
+     *
+     * @public
+     */
+    connections: TransportConnectionStats[];
+}
+/**
+ * Stats for a single transport connection.
+ *
+ * @public
+ */
+export interface TransportConnectionStats {
+    /**
+     * The public key of the remote peer.
+     */
+    pub_key: string;
+    /**
+     * The message count sent on this connection.
+     */
+    send_message_count: number;
+    /**
+     * The bytes sent on this connection.
+     */
+    send_bytes: number;
+    /**
+     * The message count received on this connection.
+     */
+    recv_message_count: number;
+    /**
+     * The bytes received on this connection
+     */
+    recv_bytes: number;
+    /**
+     * UNIX epoch timestamp in seconds when this connection was opened.
+     */
+    opened_at_s: number;
+    /**
+     * True if this connection has successfully upgraded to webrtc.
+     */
+    is_webrtc: boolean;
+}
+/**
+ * @public
+ */
+export type DumpNetworkStatsResponse = TransportStats;
+/**
+ * Arguments for dumping network metrics.
+ *
+ * @public
+ */
+export interface DumpNetworkMetricsRequest {
+    /**
+     * The DNA hash of the app network to dump.
+     */
+    dna?: DnaHash;
+    /**
+     * Include DHT summary in the response.
+     */
+    include_dht_summary: boolean;
+}
+/**
+ * The definition of a storage arc compatible with the concept of
+ * storage and querying of items in a store that fall within that arc.
+ *
+ * @public
+ */
+export type DhtArc = {
+    /**
+     * No DHT locations are contained within this arc.
+     */
+    type: "empty";
+} | {
+    /**
+     * A specific range of DHT locations are contained within this arc.
+     *
+     * The lower and upper bounds are inclusive.
+     */
+    type: "arc";
+    value: [number, number];
+};
+/**
+ * Summary of a local agent's network state.
+ *
+ * @public
+ */
+export interface LocalAgentSummary {
+    /**
+     * The agent's public key.
+     */
+    agent: AgentPubKey;
+    /**
+     * The current storage arc that the agent is declaring.
+     *
+     * This is the arc that the agent is claiming that it is an authority for.
+     */
+    storage_arc: DhtArc;
+    /**
+     * The target arc that the agent is trying to achieve as a storage arc.
+     *
+     * This is not declared to other peers on the network. It is used during gossip to try to sync
+     * ops in the target arc. Once the DHT state appears to be in sync with the target arc, the
+     * storage arc can be updated towards the target arc.
+     */
+    target_arc: DhtArc;
+}
+/**
+ * Summary of the fetch state.
+ *
+ * @public
+ */
+export interface FetchStateSummary {
+    /**
+     * The op ids that are currently being fetched.
+     *
+     * Each op id is associated with one or more peer URL from which the op data could be
+     * requested.
+     */
+    pending_requests: Record<HoloHashB64, string[]>;
+    /**
+     * The peer URL for nodes that are currently on backoff because of failed fetch requests, and the timestamp when that backoff will expire.
+     *
+     * If peers are in here then they are not being used as potential sources in
+     * [`FetchStateSummary::pending_requests`].
+     */
+    peers_on_backoff: Map<string, number>;
+}
+/**
+ * DHT segment state.
+ *
+ * @public
+ */
+export interface DhtSegmentState {
+    /**
+     * The top hash of the DHT ring segment.
+     */
+    disc_top_hash: Uint8Array;
+    /**
+     * The boundary timestamp of the DHT ring segment.
+     */
+    disc_boundary: Timestamp;
+    /**
+     * The top hashes of each DHT ring segment.
+     */
+    ring_top_hashes: Uint8Array[];
+}
+/**
+ * Peer metadata dump.
+ *
+ * @public
+ */
+export interface PeerMeta {
+    /**
+     * The timestamp of the last gossip round.
+     */
+    last_gossip_timestamp?: Timestamp;
+    /**
+     * The bookmark of the last op bookmark received.
+     */
+    new_ops_bookmark?: Timestamp;
+    /**
+     * The number of behavior errors observed.
+     */
+    peer_behavior_errors?: number;
+    /**
+     * The number of local errors.
+     */
+    local_errors?: number;
+    /**
+     * The number of busy peer errors.
+     */
+    peer_busy?: number;
+    /**
+     * The number of terminated rounds.
+     *
+     * Note that termination is not necessarily an error.
+     */
+    peer_terminated?: number;
+    /**
+     * The number of completed rounds.
+     */
+    completed_rounds?: number;
+    /**
+     * The number of peer timeouts.
+     */
+    peer_timeouts?: number;
+}
+/**
+ * Gossip round state summary.
+ *
+ * @public
+ */
+export interface GossipRoundStateSummary {
+    /**
+     * The URL of the peer with which the round is initiated.
+     */
+    session_with_peer: string;
+}
+/**
+ * Gossip state summary.
+ *
+ * @public
+ */
+export interface GossipStateSummary {
+    /**
+     * The current initiated round summary.
+     */
+    initiated_round?: GossipRoundStateSummary;
+    /**
+     * The list of accepted round summaries.
+     */
+    accepted_rounds: GossipRoundStateSummary[];
+    /**
+     * DHT summary.
+     */
+    dht_summary: Record<string, DhtSegmentState>;
+    /**
+     * Peer metadata dump for each agent in this space.
+     */
+    peer_meta: Record<string, PeerMeta>;
+}
+/**
+ * Network metrics from Kitsune2.
+ *
+ * @public
+ */
+export interface NetworkMetrics {
+    /**
+     * A summary of the fetch queue.
+     *
+     * The fetch queue is used to retrieve op data based on op ids that have been discovered
+     * through publish or gossip.
+     */
+    fetch_state_summary: FetchStateSummary;
+    /**
+     * A summary of the gossip state.
+     *
+     * This includes both live gossip rounds and metrics about peers that we've gossiped with.
+     * Optionally, it can include a summary of the DHT state as Kitsune2 sees it.
+     */
+    gossip_state_summary: GossipStateSummary;
+    /**
+     * A summary of the state of each local agent.
+     */
+    local_agents: LocalAgentSummary[];
+}
 /**
  * @public
  */
-export type DumpNetworkStatsResponse = string;
+export type DumpNetworkMetricsResponse = Record<DnaHashB64, NetworkMetrics>;
 /**
  * @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, GetCompatibleCellsRequest, GetCompatibleCellsResponse, GetDnaDefinitionRequest, GetDnaDefinitionResponse, GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse, InstallAppRequest, InstallAppResponse, IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse, ListAppInterfacesRequest, ListAppInterfacesResponse, ListAppsRequest, ListAppsResponse, ListCellIdsRequest, ListCellIdsResponse, ListDnasRequest, ListDnasResponse, RegisterDnaRequest, RegisterDnaResponse, RevokeAgentKeyRequest, RevokeAgentKeyResponse, StorageInfoRequest, StorageInfoResponse, UninstallAppRequest, UninstallAppResponse, UpdateCoordinatorsRequest, UpdateCoordinatorsResponse } from "./types.js";
+import { AddAgentInfoRequest, AddAgentInfoResponse, AdminApi, AgentInfoRequest, AgentInfoResponse, AttachAppInterfaceRequest, AttachAppInterfaceResponse, DeleteCloneCellRequest, DeleteCloneCellResponse, DisableAppRequest, DisableAppResponse, DumpFullStateRequest, DumpFullStateResponse, DumpNetworkMetricsRequest, DumpNetworkMetricsResponse, 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, RevokeAgentKeyRequest, RevokeAgentKeyResponse, StorageInfoRequest, StorageInfoResponse, UninstallAppRequest, UninstallAppResponse, UpdateCoordinatorsRequest, UpdateCoordinatorsResponse } from "./types.js";
 /**
  * A class for interacting with a conductor's Admin API.
  *
@@ -65,7 +65,6 @@ 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.
      */
@@ -114,6 +113,7 @@ export declare class AdminWebsocket implements AdminApi {
     storageInfo: Requester<StorageInfoRequest, StorageInfoResponse>;
     issueAppAuthenticationToken: Requester<IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse>;
     dumpNetworkStats: Requester<DumpNetworkStatsRequest, DumpNetworkStatsResponse>;
+    dumpNetworkMetrics: Requester<DumpNetworkMetricsRequest, DumpNetworkMetricsResponse>;
     /**
      * Grant a capability for signing zome calls.
      *

package/lib/api/admin/websocket.js

@@ -81,9 +81,6 @@ 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.
      */
@@ -132,6 +129,7 @@ export class AdminWebsocket {
     storageInfo = this._requester("storage_info");
     issueAppAuthenticationToken = this._requester("issue_app_authentication_token");
     dumpNetworkStats = this._requester("dump_network_stats");
+    dumpNetworkMetrics = this._requester("dump_network_metrics");
     // zome call signing related methods
     /**
      * Grant a capability for signing zome calls.

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

@@ -1,9 +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 AppNetworkInfoRequest = Omit<NetworkInfoRequest, "agent_pub_key">;
+import { AgentPubKey, AppAuthenticationToken, AppInfo, CapSecret, CellId, ClonedCell, DnaHash, DnaProperties, EntryHash, FunctionName, InstalledAppId, MembraneProof, MemproofMap, NetworkSeed, Nonce256Bit, RoleName, Timestamp, Transformer, WebsocketConnectionOptions, ZomeName, PreflightRequest, SignedAction, SignedActionHashed, DumpNetworkStatsResponse, DumpNetworkMetricsResponse, DumpNetworkMetricsRequest } from "../../index.js";
 /**
  * @public
  */
@@ -150,23 +146,6 @@ export type EnableCloneCellRequest = DisableCloneCellRequest;
  * @public
  */
 export type EnableCloneCellResponse = CreateCloneCellResponse;
-/**
- * @public
- */
-export interface NetworkInfoRequest {
-    /**
-     * The calling agent
-     */
-    agent_pub_key: AgentPubKey;
-    /**
-     * Get network info for these DNAs
-     */
-    dnas: DnaHash[];
-    /**
-     * Timestamp in ms since which received amount of bytes from peers will be returned. Defaults to UNIX_EPOCH.
-     */
-    last_time_queried?: number;
-}
 /**
  * Cell id for which the countersigning session state is requested.
  *
@@ -418,10 +397,6 @@ export type SystemSignal = {
  * @public
  */
 export type SignalCb = (signal: Signal) => void;
-/**
- * @public
- */
-export type NetworkInfoResponse = NetworkInfo[];
 /**
  * @public
  */
@@ -431,10 +406,11 @@ export interface AppClient {
     appInfo(): Promise<AppInfoResponse>;
     myPubKey: AgentPubKey;
     installedAppId: InstalledAppId;
+    dumpNetworkStats(): Promise<DumpNetworkStatsResponse>;
+    dumpNetworkMetrics(args: DumpNetworkMetricsRequest): Promise<DumpNetworkMetricsResponse>;
     createCloneCell(args: CreateCloneCellRequest): Promise<CreateCloneCellResponse>;
     enableCloneCell(args: EnableCloneCellRequest): Promise<EnableCloneCellResponse>;
     disableCloneCell(args: DisableCloneCellRequest): Promise<DisableCloneCellResponse>;
-    networkInfo(args: AppNetworkInfoRequest): Promise<NetworkInfoResponse>;
 }
 /**
  * @public

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

@@ -1,8 +1,8 @@
 import { UnsubscribeFunction } from "emittery";
 import { AgentPubKey, InstalledAppId, RoleName } from "../../types.js";
-import { AppInfo, ClonedCell, MemproofMap } from "../admin/index.js";
-import { AppClient, AppEvents, AppNetworkInfoRequest, SignalCb, CallZomeRequest, CallZomeRequestSigned, CreateCloneCellRequest, DisableCloneCellRequest, EnableCloneCellRequest, NetworkInfoResponse, AppWebsocketConnectionOptions, GetCountersigningSessionStateRequest, GetCountersigningSessionStateResponse, AbandonCountersigningSessionStateRequest, PublishCountersigningSessionStateRequest, RoleNameCallZomeRequest } from "./types.js";
+import { AppInfo, ClonedCell, DumpNetworkMetricsRequest, DumpNetworkMetricsResponse, DumpNetworkStatsResponse, MemproofMap } from "../admin/index.js";
 import { WsClient } from "../client.js";
+import { AbandonCountersigningSessionStateRequest, AppClient, AppEvents, AppWebsocketConnectionOptions, CallZomeRequest, CallZomeRequestSigned, CreateCloneCellRequest, DisableCloneCellRequest, EnableCloneCellRequest, GetCountersigningSessionStateRequest, GetCountersigningSessionStateResponse, PublishCountersigningSessionStateRequest, RoleNameCallZomeRequest, SignalCb } from "./types.js";
 /**
  * A class to establish a websocket connection to an App interface, for a
  * specific agent and app.
@@ -24,7 +24,8 @@ export declare class AppWebsocket implements AppClient {
     private readonly createCloneCellRequester;
     private readonly enableCloneCellRequester;
     private readonly disableCloneCellRequester;
-    private readonly networkInfoRequester;
+    private readonly dumpNetworkStatsRequester;
+    private readonly dumpNetworkMetricsRequester;
     private readonly getCountersigningSessionStateRequester;
     private readonly abandonCountersigningSessionRequester;
     private readonly publishCountersigningSessionRequester;
@@ -44,6 +45,18 @@ export declare class AppWebsocket implements AppClient {
      * @returns The app's {@link AppInfo}.
      */
     appInfo(timeout?: number): Promise<AppInfo>;
+    /**
+     * Request network stats.
+     *
+     * @returns The conductor's {@link TransportStats}.
+     */
+    dumpNetworkStats(timeout?: number): Promise<DumpNetworkStatsResponse>;
+    /**
+     * Request network metrics.
+     *
+     * @returns The {@link NetworkMetrics}.
+     */
+    dumpNetworkMetrics(req: DumpNetworkMetricsRequest, timeout?: number): Promise<DumpNetworkMetricsResponse>;
     /**
      * Provide membrane proofs for the app.
      *
@@ -51,7 +64,7 @@ export declare class AppWebsocket implements AppClient {
      */
     provideMemproofs(memproofs: MemproofMap): Promise<void>;
     /**
-     * Enablie an app only if the app is in the `AppStatus::Disabled(DisabledAppReason::NotStartedAfterProvidingMemproofs)`
+     * Enable 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>;
@@ -91,12 +104,6 @@ export declare class AppWebsocket implements AppClient {
      * @param args - Specify the clone cell to disable.
      */
     disableCloneCell(args: DisableCloneCellRequest): Promise<void>;
-    /**
-     * 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: AppNetworkInfoRequest): Promise<NetworkInfoResponse>;
     /**
      * Get the state of a countersigning session.
      */

package/lib/api/app/websocket.js

@@ -1,14 +1,14 @@
+import { decode, encode } from "@msgpack/msgpack";
 import Emittery from "emittery";
+import { sha512 } from "js-sha512";
+import _sodium from "libsodium-wrappers";
 import { omit } from "lodash-es";
-import { CellType, } from "../admin/index.js";
-import { catchError, DEFAULT_TIMEOUT, getBaseRoleNameFromCloneId, HolochainError, isCloneId, promiseTimeout, requesterTransformer, } from "../common.js";
 import { getHostZomeCallSigner, getLauncherEnvironment, } from "../../environments/launcher.js";
-import { decode, encode } from "@msgpack/msgpack";
-import { getNonceExpiration, getSigningCredentials, randomNonce, } from "../zome-call-signing.js";
 import { encodeHashToBase64 } from "../../utils/index.js";
-import _sodium from "libsodium-wrappers";
+import { CellType, } from "../admin/index.js";
 import { WsClient } from "../client.js";
-import { sha512 } from "js-sha512";
+import { catchError, DEFAULT_TIMEOUT, getBaseRoleNameFromCloneId, HolochainError, isCloneId, promiseTimeout, requesterTransformer, } from "../common.js";
+import { getNonceExpiration, getSigningCredentials, randomNonce, } from "../zome-call-signing.js";
 /**
  * A class to establish a websocket connection to an App interface, for a
  * specific agent and app.
@@ -30,7 +30,8 @@ export class AppWebsocket {
     createCloneCellRequester;
     enableCloneCellRequester;
     disableCloneCellRequester;
-    networkInfoRequester;
+    dumpNetworkStatsRequester;
+    dumpNetworkMetricsRequester;
     getCountersigningSessionStateRequester;
     abandonCountersigningSessionRequester;
     publishCountersigningSessionRequester;
@@ -49,7 +50,8 @@ export class AppWebsocket {
         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);
-        this.networkInfoRequester = AppWebsocket.requester(this.client, "network_info", this.defaultTimeout);
+        this.dumpNetworkStatsRequester = AppWebsocket.requester(this.client, "dump_network_stats", this.defaultTimeout);
+        this.dumpNetworkMetricsRequester = AppWebsocket.requester(this.client, "dump_network_metrics", this.defaultTimeout);
         this.getCountersigningSessionStateRequester = AppWebsocket.requester(this.client, "get_countersigning_session_state", this.defaultTimeout);
         this.abandonCountersigningSessionRequester = AppWebsocket.requester(this.client, "abandon_countersigning_session", this.defaultTimeout);
         this.publishCountersigningSessionRequester = AppWebsocket.requester(this.client, "publish_countersigning_session", this.defaultTimeout);
@@ -107,6 +109,22 @@ export class AppWebsocket {
         this.cachedAppInfo = appInfo;
         return appInfo;
     }
+    /**
+     * Request network stats.
+     *
+     * @returns The conductor's {@link TransportStats}.
+     */
+    async dumpNetworkStats(timeout) {
+        return await this.dumpNetworkStatsRequester(undefined, timeout);
+    }
+    /**
+     * Request network metrics.
+     *
+     * @returns The {@link NetworkMetrics}.
+     */
+    async dumpNetworkMetrics(req, timeout) {
+        return await this.dumpNetworkMetricsRequester(req, timeout);
+    }
     /**
      * Provide membrane proofs for the app.
      *
@@ -116,7 +134,7 @@ export class AppWebsocket {
         await this.provideMemproofRequester(memproofs);
     }
     /**
-     * Enablie an app only if the app is in the `AppStatus::Disabled(DisabledAppReason::NotStartedAfterProvidingMemproofs)`
+     * Enable 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() {
@@ -212,17 +230,6 @@ export class AppWebsocket {
             ...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.networkInfoRequester({
-            ...args,
-            agent_pub_key: this.myPubKey,
-        });
-    }
     /**
      * Get the state of a countersigning session.
      */

package/lib/api/client.js

@@ -2,6 +2,7 @@ import { decode, encode } from "@msgpack/msgpack";
 import Emittery from "emittery";
 import IsoWebSocket from "isomorphic-ws";
 import { HolochainError } from "./common.js";
+import { encodeHashToBase64 } from "../utils/base64.js";
 /**
  * A WebSocket client which can make requests and receive responses,
  * as well as send and receive signals.
@@ -232,7 +233,19 @@ export class WsClient extends Emittery {
                 this.pendingRequests[id].reject(new Error("Response canceled by responder"));
             }
             else {
-                this.pendingRequests[id].resolve(decode(msg.data));
+                this.pendingRequests[id].resolve(decode(msg.data, {
+                    mapKeyConverter: (key) => {
+                        if (typeof key === "string" || typeof key === "number") {
+                            return key;
+                        }
+                        if (key && typeof key === "object" && key instanceof Uint8Array) {
+                            // Key of type byte array, must be a HoloHash.
+                            return encodeHashToBase64(key);
+                        }
+                        throw new HolochainError("DeserializationError", "Encountered map with key of type 'object', but not HoloHash " +
+                            key);
+                    },
+                }));
             }
             delete this.pendingRequests[id];
         }

package/lib/api/common.d.ts

@@ -65,7 +65,7 @@ export declare const getBaseRoleNameFromCloneId: (roleName: RoleName) => string;
  *
  * @public
  */
-export declare class CloneId {
+export declare class CloneIdHelper {
     private readonly roleName;
     private readonly index;
     constructor(roleName: RoleName, index: number);
@@ -74,7 +74,7 @@ export declare class CloneId {
      * @param roleName - Role id to parse.
      * @returns A clone id instance.
      */
-    static fromRoleName(roleName: RoleName): CloneId;
+    static fromRoleName(roleName: RoleName): CloneIdHelper;
     toString(): string;
     getBaseRoleName(): string;
 }

package/lib/api/common.js

@@ -85,7 +85,7 @@ export const getBaseRoleNameFromCloneId = (roleName) => {
  *
  * @public
  */
-export class CloneId {
+export class CloneIdHelper {
     roleName;
     index;
     constructor(roleName, index) {
@@ -102,7 +102,7 @@ export class CloneId {
         if (parts.length !== 2) {
             throw new HolochainError("MalformedCloneId", `clone id must consist of 'role_id.clone_index', but got ${roleName}`);
         }
-        return new CloneId(parts[0], parseInt(parts[1]));
+        return new CloneIdHelper(parts[0], parseInt(parts[1]));
     }
     toString() {
         return `${this.roleName}${CLONE_ID_DELIMITER}${this.index}`;

package/lib/api/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./admin/index.js";
 export * from "./app/index.js";
 export { IsoWebSocket, WsClient, type AppAuthenticationRequest, } from "./client.js";
-export { CloneId, HolochainError, getBaseRoleNameFromCloneId, isCloneId, type Requester, type Transformer, type WebsocketConnectionOptions, type WsClientOptions, } from "./common.js";
+export { CloneIdHelper, HolochainError, getBaseRoleNameFromCloneId, isCloneId, type Requester, type Transformer, type WebsocketConnectionOptions, type WsClientOptions, } from "./common.js";
 export * from "./zome-call-signing.js";

package/lib/api/index.js

@@ -1,5 +1,5 @@
 export * from "./admin/index.js";
 export * from "./app/index.js";
 export { IsoWebSocket, WsClient, } from "./client.js";
-export { CloneId, HolochainError, getBaseRoleNameFromCloneId, isCloneId, } from "./common.js";
+export { CloneIdHelper, HolochainError, getBaseRoleNameFromCloneId, isCloneId, } from "./common.js";
 export * from "./zome-call-signing.js";

package/lib/tsdoc-metadata.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/client",
-  "version": "0.19.0-dev.7",
+  "version": "0.19.0-rc.0",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (https://holochain.org)",
   "license": "CAL-1.0",
@@ -43,7 +43,7 @@
   },
   "dependencies": {
     "@bitgo/blake2b": "^3.2.4",
-    "@msgpack/msgpack": "^2.8.0",
+    "@msgpack/msgpack": "^3.1.1",
     "emittery": "^1.0.1",
     "isomorphic-ws": "^5.0.0",
     "js-base64": "^3.7.5",