@twin.org/crypto 0.0.1-next.2 → 0.0.1-next.20

package/dist/cjs/index.cjs

@@ -8,11 +8,13 @@ var blake2b = require('@noble/hashes/blake2b');
 var bip32 = require('@scure/bip32');
 var slip10_js = require('micro-key-producer/slip10.js');
 var chacha = require('@noble/ciphers/chacha');
+var blake3 = require('@noble/hashes/blake3');
 var hmac = require('@noble/hashes/hmac');
 var sha1 = require('@noble/hashes/sha1');
 var sha256 = require('@noble/hashes/sha256');
 var sha512 = require('@noble/hashes/sha512');
 var pbkdf2 = require('@noble/hashes/pbkdf2');
+var sha3 = require('@noble/hashes/sha3');
 var bip39 = require('@scure/bip39');
 var english = require('@scure/bip39/wordlists/english');
 var otp = require('micro-key-producer/otp.js');
@@ -727,6 +729,81 @@ class Zip215 {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with Blake3 Signature scheme.
+ */
+class Blake3 {
+    /**
+     * Blake3 256.
+     */
+    static SIZE_256 = 32;
+    /**
+     * Blake3 512.
+     */
+    static SIZE_512 = 64;
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "Blake3";
+    /**
+     * The instance of the hash.
+     * @internal
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _instance;
+    /**
+     * Create a new instance of Blake3.
+     * @param outputLength The output length.
+     * @param key Optional key for the hash.
+     */
+    constructor(outputLength, key) {
+        this._instance = blake3.blake3.create({
+            dkLen: outputLength,
+            key
+        });
+    }
+    /**
+     * Perform Sum 256 on the block.
+     * @param block The block to operate on.
+     * @param key Optional key for the hash.
+     * @returns The sum 256 of the block.
+     */
+    static sum256(block, key) {
+        core.Guards.uint8Array(Blake3._CLASS_NAME, "block", block);
+        return new Blake3(Blake3.SIZE_256, key).update(block).digest();
+    }
+    /**
+     * Perform Sum 512 on the block.
+     * @param block The block to operate on.
+     * @param key Optional key for the hash.
+     * @returns The sum 512 of the block.
+     */
+    static sum512(block, key) {
+        core.Guards.uint8Array(Blake3._CLASS_NAME, "block", block);
+        return new Blake3(Blake3.SIZE_512, key).update(block).digest();
+    }
+    /**
+     * Update the hash with the block.
+     * @param block The block to update the hash with.
+     * @returns The instance for chaining.
+     */
+    update(block) {
+        core.Guards.uint8Array(Blake3._CLASS_NAME, "block", block);
+        this._instance.update(block);
+        return this;
+    }
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest() {
+        return this._instance.digest();
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -1160,6 +1237,127 @@ class Sha256 {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+// eslint-disable-next-line camelcase
+/**
+ * Perform a SHA-3 hash on the block.
+ */
+class Sha3 {
+    /**
+     * Sha3 224.
+     */
+    static SIZE_224 = 224;
+    /**
+     * Sha3 256.
+     */
+    static SIZE_256 = 256;
+    /**
+     * Sha3 384.
+     */
+    static SIZE_384 = 384;
+    /**
+     * Sha3 512.
+     */
+    static SIZE_512 = 512;
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "Sha3";
+    /**
+     * The instance of the hash.
+     * @internal
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _instance;
+    /**
+     * Create a new instance of Sha3.
+     * @param bits The number of bits.
+     */
+    constructor(bits = Sha3.SIZE_256) {
+        if (bits !== Sha3.SIZE_224 &&
+            bits !== Sha3.SIZE_256 &&
+            bits !== Sha3.SIZE_384 &&
+            bits !== Sha3.SIZE_512) {
+            throw new core.GeneralError(Sha3._CLASS_NAME, "bitSize", { bitSize: bits });
+        }
+        if (bits === Sha3.SIZE_224) {
+            // eslint-disable-next-line camelcase
+            this._instance = sha3.sha3_224.create();
+        }
+        else if (bits === Sha3.SIZE_256) {
+            // eslint-disable-next-line camelcase
+            this._instance = sha3.sha3_256.create();
+        }
+        else if (bits === Sha3.SIZE_384) {
+            // eslint-disable-next-line camelcase
+            this._instance = sha3.sha3_384.create();
+        }
+        else {
+            // eslint-disable-next-line camelcase
+            this._instance = sha3.sha3_512.create();
+        }
+    }
+    /**
+     * Perform Sum 256 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 256 of the block.
+     */
+    static sum256(block) {
+        const b2b = new Sha3(Sha3.SIZE_256);
+        b2b.update(block);
+        return b2b.digest();
+    }
+    /**
+     * Perform Sum 224 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 224 of the block.
+     */
+    static sum224(block) {
+        const b2b = new Sha3(Sha3.SIZE_224);
+        b2b.update(block);
+        return b2b.digest();
+    }
+    /**
+     * Perform Sum 384 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 384 of the block.
+     */
+    static sum384(block) {
+        const b2b = new Sha3(Sha3.SIZE_384);
+        b2b.update(block);
+        return b2b.digest();
+    }
+    /**
+     * Perform Sum 512 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 512 of the block.
+     */
+    static sum512(block) {
+        const b2b = new Sha3(Sha3.SIZE_512);
+        b2b.update(block);
+        return b2b.digest();
+    }
+    /**
+     * Update the hash with the block.
+     * @param block The block to update the hash with.
+     * @returns The instance for chaining.
+     */
+    update(block) {
+        core.Guards.uint8Array(Sha3._CLASS_NAME, "block", block);
+        this._instance.update(block);
+        return this;
+    }
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest() {
+        return this._instance.digest();
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /* eslint-disable camelcase */
@@ -1552,6 +1750,7 @@ exports.Bip32Path = Bip32Path;
 exports.Bip39 = Bip39;
 exports.Bip44 = Bip44;
 exports.Blake2b = Blake2b;
+exports.Blake3 = Blake3;
 exports.ChaCha20Poly1305 = ChaCha20Poly1305;
 exports.Ed25519 = Ed25519;
 exports.HmacSha1 = HmacSha1;
@@ -1565,6 +1764,7 @@ exports.Pbkdf2 = Pbkdf2;
 exports.Secp256k1 = Secp256k1;
 exports.Sha1 = Sha1;
 exports.Sha256 = Sha256;
+exports.Sha3 = Sha3;
 exports.Sha512 = Sha512;
 exports.Slip0010 = Slip0010;
 exports.Totp = Totp;

package/dist/esm/index.mjs

@@ -6,11 +6,13 @@ import { blake2b } from '@noble/hashes/blake2b';
 import { HDKey as HDKey$1 } from '@scure/bip32';
 import { HDKey } from 'micro-key-producer/slip10.js';
 import { chacha20poly1305 } from '@noble/ciphers/chacha';
+import { blake3 } from '@noble/hashes/blake3';
 import { hmac } from '@noble/hashes/hmac';
 import { sha1 } from '@noble/hashes/sha1';
 import { sha256, sha224 } from '@noble/hashes/sha256';
 import { sha512_224, sha512_256, sha384, sha512 } from '@noble/hashes/sha512';
 import { pbkdf2 } from '@noble/hashes/pbkdf2';
+import { sha3_224, sha3_256, sha3_384, sha3_512 } from '@noble/hashes/sha3';
 import * as bip39 from '@scure/bip39';
 import { wordlist } from '@scure/bip39/wordlists/english';
 import * as otp from 'micro-key-producer/otp.js';
@@ -705,6 +707,81 @@ class Zip215 {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with Blake3 Signature scheme.
+ */
+class Blake3 {
+    /**
+     * Blake3 256.
+     */
+    static SIZE_256 = 32;
+    /**
+     * Blake3 512.
+     */
+    static SIZE_512 = 64;
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "Blake3";
+    /**
+     * The instance of the hash.
+     * @internal
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _instance;
+    /**
+     * Create a new instance of Blake3.
+     * @param outputLength The output length.
+     * @param key Optional key for the hash.
+     */
+    constructor(outputLength, key) {
+        this._instance = blake3.create({
+            dkLen: outputLength,
+            key
+        });
+    }
+    /**
+     * Perform Sum 256 on the block.
+     * @param block The block to operate on.
+     * @param key Optional key for the hash.
+     * @returns The sum 256 of the block.
+     */
+    static sum256(block, key) {
+        Guards.uint8Array(Blake3._CLASS_NAME, "block", block);
+        return new Blake3(Blake3.SIZE_256, key).update(block).digest();
+    }
+    /**
+     * Perform Sum 512 on the block.
+     * @param block The block to operate on.
+     * @param key Optional key for the hash.
+     * @returns The sum 512 of the block.
+     */
+    static sum512(block, key) {
+        Guards.uint8Array(Blake3._CLASS_NAME, "block", block);
+        return new Blake3(Blake3.SIZE_512, key).update(block).digest();
+    }
+    /**
+     * Update the hash with the block.
+     * @param block The block to update the hash with.
+     * @returns The instance for chaining.
+     */
+    update(block) {
+        Guards.uint8Array(Blake3._CLASS_NAME, "block", block);
+        this._instance.update(block);
+        return this;
+    }
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest() {
+        return this._instance.digest();
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -1138,6 +1215,127 @@ class Sha256 {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+// eslint-disable-next-line camelcase
+/**
+ * Perform a SHA-3 hash on the block.
+ */
+class Sha3 {
+    /**
+     * Sha3 224.
+     */
+    static SIZE_224 = 224;
+    /**
+     * Sha3 256.
+     */
+    static SIZE_256 = 256;
+    /**
+     * Sha3 384.
+     */
+    static SIZE_384 = 384;
+    /**
+     * Sha3 512.
+     */
+    static SIZE_512 = 512;
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "Sha3";
+    /**
+     * The instance of the hash.
+     * @internal
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _instance;
+    /**
+     * Create a new instance of Sha3.
+     * @param bits The number of bits.
+     */
+    constructor(bits = Sha3.SIZE_256) {
+        if (bits !== Sha3.SIZE_224 &&
+            bits !== Sha3.SIZE_256 &&
+            bits !== Sha3.SIZE_384 &&
+            bits !== Sha3.SIZE_512) {
+            throw new GeneralError(Sha3._CLASS_NAME, "bitSize", { bitSize: bits });
+        }
+        if (bits === Sha3.SIZE_224) {
+            // eslint-disable-next-line camelcase
+            this._instance = sha3_224.create();
+        }
+        else if (bits === Sha3.SIZE_256) {
+            // eslint-disable-next-line camelcase
+            this._instance = sha3_256.create();
+        }
+        else if (bits === Sha3.SIZE_384) {
+            // eslint-disable-next-line camelcase
+            this._instance = sha3_384.create();
+        }
+        else {
+            // eslint-disable-next-line camelcase
+            this._instance = sha3_512.create();
+        }
+    }
+    /**
+     * Perform Sum 256 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 256 of the block.
+     */
+    static sum256(block) {
+        const b2b = new Sha3(Sha3.SIZE_256);
+        b2b.update(block);
+        return b2b.digest();
+    }
+    /**
+     * Perform Sum 224 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 224 of the block.
+     */
+    static sum224(block) {
+        const b2b = new Sha3(Sha3.SIZE_224);
+        b2b.update(block);
+        return b2b.digest();
+    }
+    /**
+     * Perform Sum 384 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 384 of the block.
+     */
+    static sum384(block) {
+        const b2b = new Sha3(Sha3.SIZE_384);
+        b2b.update(block);
+        return b2b.digest();
+    }
+    /**
+     * Perform Sum 512 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 512 of the block.
+     */
+    static sum512(block) {
+        const b2b = new Sha3(Sha3.SIZE_512);
+        b2b.update(block);
+        return b2b.digest();
+    }
+    /**
+     * Update the hash with the block.
+     * @param block The block to update the hash with.
+     * @returns The instance for chaining.
+     */
+    update(block) {
+        Guards.uint8Array(Sha3._CLASS_NAME, "block", block);
+        this._instance.update(block);
+        return this;
+    }
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest() {
+        return this._instance.digest();
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /* eslint-disable camelcase */
@@ -1525,4 +1723,4 @@ class PasswordValidator {
     }
 }
 
-export { Bech32, Bip32Path, Bip39, Bip44, Blake2b, ChaCha20Poly1305, Ed25519, HmacSha1, HmacSha256, HmacSha512, Hotp, KeyType, PasswordGenerator, PasswordValidator, Pbkdf2, Secp256k1, Sha1, Sha256, Sha512, Slip0010, Totp, X25519, Zip215 };
+export { Bech32, Bip32Path, Bip39, Bip44, Blake2b, Blake3, ChaCha20Poly1305, Ed25519, HmacSha1, HmacSha256, HmacSha512, Hotp, KeyType, PasswordGenerator, PasswordValidator, Pbkdf2, Secp256k1, Sha1, Sha256, Sha3, Sha512, Slip0010, Totp, X25519, Zip215 };

package/dist/types/hashes/blake3.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Class to help with Blake3 Signature scheme.
+ */
+export declare class Blake3 {
+    /**
+     * Blake3 256.
+     */
+    static SIZE_256: number;
+    /**
+     * Blake3 512.
+     */
+    static SIZE_512: number;
+    /**
+     * Create a new instance of Blake3.
+     * @param outputLength The output length.
+     * @param key Optional key for the hash.
+     */
+    constructor(outputLength: number, key?: Uint8Array);
+    /**
+     * Perform Sum 256 on the block.
+     * @param block The block to operate on.
+     * @param key Optional key for the hash.
+     * @returns The sum 256 of the block.
+     */
+    static sum256(block: Uint8Array, key?: Uint8Array): Uint8Array;
+    /**
+     * Perform Sum 512 on the block.
+     * @param block The block to operate on.
+     * @param key Optional key for the hash.
+     * @returns The sum 512 of the block.
+     */
+    static sum512(block: Uint8Array, key?: Uint8Array): Uint8Array;
+    /**
+     * Update the hash with the block.
+     * @param block The block to update the hash with.
+     * @returns The instance for chaining.
+     */
+    update(block: Uint8Array): Blake3;
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest(): Uint8Array;
+}

package/dist/types/hashes/sha3.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Perform a SHA-3 hash on the block.
+ */
+export declare class Sha3 {
+    /**
+     * Sha3 224.
+     */
+    static readonly SIZE_224: number;
+    /**
+     * Sha3 256.
+     */
+    static readonly SIZE_256: number;
+    /**
+     * Sha3 384.
+     */
+    static readonly SIZE_384: number;
+    /**
+     * Sha3 512.
+     */
+    static readonly SIZE_512: number;
+    /**
+     * Create a new instance of Sha3.
+     * @param bits The number of bits.
+     */
+    constructor(bits?: number);
+    /**
+     * Perform Sum 256 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 256 of the block.
+     */
+    static sum256(block: Uint8Array): Uint8Array;
+    /**
+     * Perform Sum 224 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 224 of the block.
+     */
+    static sum224(block: Uint8Array): Uint8Array;
+    /**
+     * Perform Sum 384 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 384 of the block.
+     */
+    static sum384(block: Uint8Array): Uint8Array;
+    /**
+     * Perform Sum 512 on the block.
+     * @param block The block to operate on.
+     * @returns The sum 512 of the block.
+     */
+    static sum512(block: Uint8Array): Uint8Array;
+    /**
+     * Update the hash with the block.
+     * @param block The block to update the hash with.
+     * @returns The instance for chaining.
+     */
+    update(block: Uint8Array): Sha3;
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest(): Uint8Array;
+}

package/dist/types/index.d.ts

@@ -6,12 +6,14 @@ export * from "./curves/secp256k1";
 export * from "./curves/x25519";
 export * from "./curves/zip215";
 export * from "./hashes/blake2b";
+export * from "./hashes/blake3";
 export * from "./hashes/hmacSha1";
 export * from "./hashes/hmacSha256";
 export * from "./hashes/hmacSha512";
 export * from "./hashes/pbkdf2";
 export * from "./hashes/sha1";
 export * from "./hashes/sha256";
+export * from "./hashes/sha3";
 export * from "./hashes/sha512";
 export * from "./keys/bip32Path";
 export * from "./keys/bip39";

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/crypto - Changelog
 
-## 0.0.1-next.1
+## 0.0.1-next.20
 
 - Added: Bip44

package/docs/reference/classes/Bech32.md

@@ -22,11 +22,15 @@ Encode the buffer.
 
 #### Parameters
 
-• **humanReadablePart**: `string`
+##### humanReadablePart
+
+`string`
 
 The header.
 
-• **data**: `Uint8Array`
+##### data
+
+`Uint8Array`
 
 The data to encode.
 
@@ -46,7 +50,9 @@ Decode a bech32 string.
 
 #### Parameters
 
-• **bech**: `string`
+##### bech
+
+`string`
 
 The text to decode.
 
@@ -78,7 +84,9 @@ Is the input a bech 32 address.
 
 #### Parameters
 
-• **bech**: `unknown`
+##### bech
+
+`unknown`
 
 The value to test.
 

package/docs/reference/classes/Bip32Path.md

@@ -12,7 +12,9 @@ Create a new instance of Bip32Path.
 
 #### Parameters
 
-• **initialPath?**: `string`
+##### initialPath?
+
+`string`
 
 Initial path to create.
 
@@ -30,7 +32,9 @@ Construct a new path by cloning an existing one.
 
 #### Parameters
 
-• **bip32Path**: [`Bip32Path`](Bip32Path.md)
+##### bip32Path
+
+[`Bip32Path`](Bip32Path.md)
 
 The path to clone.
 
@@ -64,7 +68,9 @@ Push a new index on to the path.
 
 #### Parameters
 
-• **index**: `number`
+##### index
+
+`number`
 
 The index to add to the path.
 
@@ -82,7 +88,9 @@ Push a new hardened index on to the path.
 
 #### Parameters
 
-• **index**: `number`
+##### index
+
+`number`
 
 The index to add to the path.