@holochain/client 0.17.0-dev.2 → 0.17.0-dev.3

package/lib/tsdoc-metadata.json

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

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

@@ -4,32 +4,36 @@ import { DnaHash, ActionHash, AgentPubKey, EntryHash } from "../types.js";
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
+ * @param coreByte - Optionally specify a byte to repeat for all core 32 bytes. If undefined will generate random core 32 bytes.
  * @returns An {@link EntryHash}.
  *
  * @public
  */
-export declare function fakeEntryHash(): Promise<EntryHash>;
+export declare function fakeEntryHash(coreByte?: number | undefined): Promise<EntryHash>;
 /**
  * Generate a valid agent key of a non-existing agent.
  *
+ * @param coreByte - Optionally specify a byte to repeat for all core 32 bytes. If undefined will generate random core 32 bytes.
  * @returns An {@link AgentPubKey}.
  *
  * @public
  */
-export declare function fakeAgentPubKey(): Promise<AgentPubKey>;
+export declare function fakeAgentPubKey(coreByte?: number | undefined): Promise<AgentPubKey>;
 /**
  * Generate a valid hash of a non-existing action.
  *
+ * @param coreByte - Optionally specify a byte to repeat for all core 32 bytes. If undefined will generate random core 32 bytes.
  * @returns An {@link ActionHash}.
  *
  * @public
  */
-export declare function fakeActionHash(): Promise<ActionHash>;
+export declare function fakeActionHash(coreByte?: number | undefined): Promise<ActionHash>;
 /**
  * Generate a valid hash of a non-existing DNA.
  *
+ * @param coreByte - Optionally specify a byte to repeat for all core 32 bytes. If undefined will generate random core 32 bytes.
  * @returns A {@link DnaHash}.
  *
  * @public
  */
-export declare function fakeDnaHash(): Promise<DnaHash>;
+export declare function fakeDnaHash(coreByte?: number | undefined): Promise<DnaHash>;

package/lib/utils/fake-hash.js

@@ -1,47 +1,60 @@
+import { range } from "lodash-es";
 import { randomByteArray } from "../api/zome-call-signing.js";
+import { dhtLocationFrom32 } from "./hash-parts.js";
+async function fakeValidHash(prefix, coreByte) {
+    let core;
+    if (coreByte === undefined) {
+        core = await randomByteArray(32);
+    }
+    else {
+        core = Uint8Array.from(range(0, 32).map(() => coreByte));
+    }
+    const checksum = dhtLocationFrom32(core);
+    return new Uint8Array([...prefix, ...core, ...Array.from(checksum)]);
+}
 /**
  * Generate a valid hash of a non-existing entry.
  *
  * From https://github.com/holochain/holochain/blob/develop/crates/holo_hash/src/hash_type/primitive.rs
  *
+ * @param coreByte - Optionally specify a byte to repeat for all core 32 bytes. If undefined will generate random core 32 bytes.
  * @returns An {@link EntryHash}.
  *
  * @public
  */
-export async function fakeEntryHash() {
-    const randomBytes = await randomByteArray(36);
-    return new Uint8Array([0x84, 0x21, 0x24, ...randomBytes]);
+export async function fakeEntryHash(coreByte = undefined) {
+    return fakeValidHash([0x84, 0x21, 0x24], coreByte);
 }
 /**
  * Generate a valid agent key of a non-existing agent.
  *
+ * @param coreByte - Optionally specify a byte to repeat for all core 32 bytes. If undefined will generate random core 32 bytes.
  * @returns An {@link AgentPubKey}.
  *
  * @public
  */
-export async function fakeAgentPubKey() {
-    const randomBytes = await randomByteArray(36);
-    return new Uint8Array([0x84, 0x20, 0x24, ...randomBytes]);
+export async function fakeAgentPubKey(coreByte = undefined) {
+    return fakeValidHash([0x84, 0x20, 0x24], coreByte);
 }
 /**
  * Generate a valid hash of a non-existing action.
  *
+ * @param coreByte - Optionally specify a byte to repeat for all core 32 bytes. If undefined will generate random core 32 bytes.
  * @returns An {@link ActionHash}.
  *
  * @public
  */
-export async function fakeActionHash() {
-    const randomBytes = await randomByteArray(36);
-    return new Uint8Array([0x84, 0x29, 0x24, ...randomBytes]);
+export async function fakeActionHash(coreByte = undefined) {
+    return fakeValidHash([0x84, 0x29, 0x24], coreByte);
 }
 /**
  * Generate a valid hash of a non-existing DNA.
  *
+ * @param coreByte - Optionally specify a byte to repeat for all core 32 bytes. If undefined will generate random core 32 bytes.
  * @returns A {@link DnaHash}.
  *
  * @public
  */
-export async function fakeDnaHash() {
-    const randomBytes = await randomByteArray(36);
-    return new Uint8Array([0x84, 0x2d, 0x24, ...randomBytes]);
+export async function fakeDnaHash(coreByte = undefined) {
+    return fakeValidHash([0x84, 0x2d, 0x24], coreByte);
 }

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

@@ -0,0 +1,71 @@
+import { ActionHash, AgentPubKey, EntryHash } from "../types.js";
+/**
+ * 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
+ *
+ * @public
+ */
+export declare const HASH_TYPE_PREFIX: {
+    Agent: Uint8Array;
+    Entry: Uint8Array;
+    Dna: Uint8Array;
+    Action: Uint8Array;
+    External: Uint8Array;
+};
+/**
+ * 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 last 4 bytes of the hash.
+ *
+ * @public
+ */
+export declare function sliceDhtLocation(hash: AgentPubKey | EntryHash | ActionHash): Uint8Array;
+/**
+ * Get core (center 32 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 core 32 bytes of the hash.
+ *
+ * @public
+ */
+export declare function sliceCore32(hash: AgentPubKey | EntryHash | ActionHash): Uint8Array;
+/**
+ * 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 initial 3 bytes of the hash.
+ *
+ * @public
+ */
+export declare function sliceHashType(hash: AgentPubKey | EntryHash | ActionHash): Uint8Array;
+/**
+ * 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
+ *
+ * @param hashCore - The core 32 bytes of the hash.
+ * @returns The last 4 bytes of the hash.
+ *
+ * @public
+ */
+export declare function dhtLocationFrom32(hashCore: Uint8Array): Uint8Array;
+/**
+ * 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
+ *
+ * @param hashCore - The core 32 bytes of the hash.
+ * @param hashType - The type of the hash.
+ * @returns The full 39 byte hash.
+ *
+ * @public
+ */
+export declare function hashFrom32AndType(hashCore: AgentPubKey | EntryHash | ActionHash, hashType: "Agent" | "Entry" | "Dna" | "Action" | "External"): Uint8Array;

package/lib/utils/hash-parts.js

@@ -0,0 +1,94 @@
+import blake2b from "@bitgo/blake2b";
+/**
+ * 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
+ *
+ * @public
+ */
+export const HASH_TYPE_PREFIX = {
+    Agent: Uint8Array.from([132, 32, 36]),
+    Entry: Uint8Array.from([132, 33, 36]),
+    Dna: Uint8Array.from([132, 45, 36]),
+    Action: Uint8Array.from([132, 41, 36]),
+    External: Uint8Array.from([132, 47, 36]),
+};
+/**
+ * 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 last 4 bytes of the hash.
+ *
+ * @public
+ */
+export function sliceDhtLocation(hash) {
+    return Uint8Array.from(hash.slice(36, 40));
+}
+/**
+ * Get core (center 32 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 core 32 bytes of the hash.
+ *
+ * @public
+ */
+export function sliceCore32(hash) {
+    return Uint8Array.from(hash.slice(3, 36));
+}
+/**
+ * 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 initial 3 bytes of the hash.
+ *
+ * @public
+ */
+export function sliceHashType(hash) {
+    return Uint8Array.from(hash.slice(0, 3));
+}
+/**
+ * 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
+ *
+ * @param hashCore - The core 32 bytes of the hash.
+ * @returns The last 4 bytes of the hash.
+ *
+ * @public
+ */
+export function dhtLocationFrom32(hashCore) {
+    const hash = new Uint8Array(16);
+    blake2b(hash.length).update(hashCore).digest(hash);
+    const out = hash.slice(0, 4);
+    [4, 8, 12].forEach((i) => {
+        out[0] ^= hash[i];
+        out[1] ^= hash[i + 1];
+        out[2] ^= hash[i + 2];
+        out[3] ^= hash[i + 3];
+    });
+    return out;
+}
+/**
+ * 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
+ *
+ * @param hashCore - The core 32 bytes of the hash.
+ * @param hashType - The type of the hash.
+ * @returns The full 39 byte hash.
+ *
+ * @public
+ */
+export function hashFrom32AndType(hashCore, hashType) {
+    return Uint8Array.from([
+        ...HASH_TYPE_PREFIX[hashType],
+        ...hashCore,
+        ...dhtLocationFrom32(hashCore),
+    ]);
+}

package/lib/utils/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./base64.js";
 export * from "./fake-hash.js";
+export * from "./hash-parts.js";

package/lib/utils/index.js

@@ -1,2 +1,3 @@
 export * from "./base64.js";
 export * from "./fake-hash.js";
+export * from "./hash-parts.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/client",
-  "version": "0.17.0-dev.2",
+  "version": "0.17.0-dev.3",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (http://holochain.org)",
   "license": "CAL-1.0",
@@ -33,12 +33,14 @@
   "scripts": {
     "lint": "eslint --fix --ext .ts src test .eslintrc.cjs",
     "test:app-agent": "RUST_LOG=error RUST_BACKTRACE=1 node --loader ts-node/esm test/e2e/app-agent-websocket.ts",
+    "test:utils": "RUST_LOG=error RUST_BACKTRACE=1 node --loader ts-node/esm test/e2e/utils.ts",
     "test": "RUST_LOG=error RUST_BACKTRACE=1 node --loader ts-node/esm test/index.ts",
     "build:lib": "rimraf ./lib && tsc -p tsconfig.build.json",
     "build:docs": "api-extractor run --local && api-documenter markdown -i docs/temp -o docs",
     "build": "npm run build:lib && npm run build:docs"
   },
   "dependencies": {
+    "@bitgo/blake2b": "^3.2.4",
     "@holochain/serialization": "^0.1.0-beta-rc.3",
     "@msgpack/msgpack": "^2.8.0",
     "@tauri-apps/api": "^1.4.0",