@twin.org/crypto 0.0.1-next.6 → 0.0.1-next.62

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,188 @@
 # @twin.org/crypto - Changelog
 
-## 0.0.1-next.6
+## [0.0.1-next.62](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.61...crypto-v0.0.1-next.62) (2025-06-17)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.61 to 0.0.1-next.62
+
+## [0.0.1-next.61](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.60...crypto-v0.0.1-next.61) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.60 to 0.0.1-next.61
+
+## [0.0.1-next.60](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.59...crypto-v0.0.1-next.60) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.59 to 0.0.1-next.60
+
+## [0.0.1-next.59](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.58...crypto-v0.0.1-next.59) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.58 to 0.0.1-next.59
+
+## [0.0.1-next.58](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.57...crypto-v0.0.1-next.58) (2025-06-13)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.57 to 0.0.1-next.58
+
+## [0.0.1-next.57](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.56...crypto-v0.0.1-next.57) (2025-06-10)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.56 to 0.0.1-next.57
+
+## [0.0.1-next.56](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.55...crypto-v0.0.1-next.56) (2025-05-08)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.55 to 0.0.1-next.56
+
+## [0.0.1-next.55](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.54...crypto-v0.0.1-next.55) (2025-05-07)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.54 to 0.0.1-next.55
+
+## [0.0.1-next.54](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.53...crypto-v0.0.1-next.54) (2025-05-06)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.53 to 0.0.1-next.54
+
+## [0.0.1-next.53](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.52...crypto-v0.0.1-next.53) (2025-05-01)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.52 to 0.0.1-next.53
+
+## [0.0.1-next.52](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.51...crypto-v0.0.1-next.52) (2025-04-17)
+
+
+### Features
+
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.51 to 0.0.1-next.52
+
+## [0.0.1-next.51](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.50...crypto-v0.0.1-next.51) (2025-03-27)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.50 to 0.0.1-next.51
+
+## [0.0.1-next.50](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.49...crypto-v0.0.1-next.50) (2025-03-26)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.49 to 0.0.1-next.50
+
+## 0.0.1-next.49
 
 - Added: Bip44

package/docs/reference/classes/Bech32.md

@@ -4,13 +4,13 @@ Bech32 encoding and decoding.
 
 ## Constructors
 
-### new Bech32()
+### Constructor
 
-> **new Bech32**(): [`Bech32`](Bech32.md)
+> **new Bech32**(): `Bech32`
 
 #### Returns
 
-[`Bech32`](Bech32.md)
+`Bech32`
 
 ## Methods
 
@@ -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

@@ -4,39 +4,43 @@ Class to help with bip32 paths.
 
 ## Constructors
 
-### new Bip32Path()
+### Constructor
 
-> **new Bip32Path**(`initialPath`?): [`Bip32Path`](Bip32Path.md)
+> **new Bip32Path**(`initialPath?`): `Bip32Path`
 
 Create a new instance of Bip32Path.
 
 #### Parameters
 
-• **initialPath?**: `string`
+##### initialPath?
+
+`string`
 
 Initial path to create.
 
 #### Returns
 
-[`Bip32Path`](Bip32Path.md)
+`Bip32Path`
 
 ## Methods
 
 ### fromPath()
 
-> `static` **fromPath**(`bip32Path`): [`Bip32Path`](Bip32Path.md)
+> `static` **fromPath**(`bip32Path`): `Bip32Path`
 
 Construct a new path by cloning an existing one.
 
 #### Parameters
 
-• **bip32Path**: [`Bip32Path`](Bip32Path.md)
+##### bip32Path
+
+`Bip32Path`
 
 The path to clone.
 
 #### Returns
 
-[`Bip32Path`](Bip32Path.md)
+`Bip32Path`
 
 A new instance of Bip32Path.
 
@@ -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.
 

package/docs/reference/classes/Bip39.md

@@ -4,13 +4,13 @@ Implementation of Bip39 for mnemonic generation.
 
 ## Constructors
 
-### new Bip39()
+### Constructor
 
-> **new Bip39**(): [`Bip39`](Bip39.md)
+> **new Bip39**(): `Bip39`
 
 #### Returns
 
-[`Bip39`](Bip39.md)
+`Bip39`
 
 ## Methods
 
@@ -22,11 +22,15 @@ Generate a random mnemonic.
 
 #### Parameters
 
-• **strength**: `number` = `256`
+##### strength
+
+`number` = `256`
 
 The strength of the mnemonic to generate, defaults to 256.
 
-• **words**: `string`[] = `wordlist`
+##### words
+
+`string`[] = `wordlist`
 
 The wordlist to use, defaults to the English wordlist.
 
@@ -50,11 +54,15 @@ Generate a mnemonic from the entropy.
 
 #### Parameters
 
-• **entropy**: `Uint8Array`
+##### entropy
+
+`Uint8Array`
 
 The entropy to generate.
 
-• **words**: `string`[] = `wordlist`
+##### words
+
+`string`[] = `wordlist`
 
 The wordlist to use, defaults to the English wordlist.
 
@@ -72,17 +80,21 @@ Error if the length of the entropy is not a multiple of 4, or is less than 16 or
 
 ### mnemonicToSeed()
 
-> `static` **mnemonicToSeed**(`mnemonic`, `password`?): `Uint8Array`
+> `static` **mnemonicToSeed**(`mnemonic`, `password?`): `Uint8Array`
 
 Convert a mnemonic to a seed.
 
 #### Parameters
 
-• **mnemonic**: `string`
+##### mnemonic
+
+`string`
 
 The mnemonic to convert.
 
-• **password?**: `string`
+##### password?
+
+`string`
 
 The password to apply to the seed generation.
 
@@ -102,11 +114,15 @@ Convert the mnemonic back to entropy.
 
 #### Parameters
 
-• **mnemonic**: `string`
+##### mnemonic
+
+`string`
 
 The mnemonic to convert.
 
-• **words**: `string`[] = `wordlist`
+##### words
+
+`string`[] = `wordlist`
 
 The wordlist to use, defaults to the English wordlist.
 

package/docs/reference/classes/Bip44.md

@@ -4,13 +4,13 @@ Implementation of Bip44 for address generation.
 
 ## Constructors
 
-### new Bip44()
+### Constructor
 
-> **new Bip44**(): [`Bip44`](Bip44.md)
+> **new Bip44**(): `Bip44`
 
 #### Returns
 
-[`Bip44`](Bip44.md)
+`Bip44`
 
 ## Methods
 
@@ -22,27 +22,39 @@ Generate a bip44 key pair from the seed and parts.
 
 #### Parameters
 
-• **seed**: `Uint8Array`
+##### seed
+
+`Uint8Array`
 
 The account seed.
 
-• **keyType**: [`KeyType`](../type-aliases/KeyType.md)
+##### keyType
+
+[`KeyType`](../type-aliases/KeyType.md)
 
 The key type.
 
-• **coinType**: `number`
+##### coinType
+
+`number`
 
 The coin type.
 
-• **accountIndex**: `number`
+##### accountIndex
+
+`number`
 
 The account index.
 
-• **isInternal**: `boolean`
+##### isInternal
+
+`boolean`
 
 Is this an internal address.
 
-• **addressIndex**: `number`
+##### addressIndex
+
+`number`
 
 The address index.
 
@@ -74,19 +86,27 @@ Generate a bip44 path based on all its parts.
 
 #### Parameters
 
-• **coinType**: `number`
+##### coinType
+
+`number`
 
 The coin type.
 
-• **accountIndex**: `number`
+##### accountIndex
+
+`number`
 
 The account index.
 
-• **isInternal**: `boolean`
+##### isInternal
+
+`boolean`
 
 Is this an internal address.
 
-• **addressIndex**: `number`
+##### addressIndex
+
+`number`
 
 The address index.
 
@@ -106,7 +126,9 @@ Create a bip44 base path for the provided coin type.
 
 #### Parameters
 
-• **coinType**: `number`
+##### coinType
+
+`number`
 
 The coin type.
 
@@ -118,6 +140,70 @@ The bip44 address base path.
 
 ***
 
+### address()
+
+> `static` **address**(`seed`, `keyType`, `coinType`, `accountIndex`, `isInternal`, `addressIndex`): `object`
+
+Generate an address from the seed and parts.
+
+#### Parameters
+
+##### seed
+
+`Uint8Array`
+
+The account seed.
+
+##### keyType
+
+[`KeyType`](../type-aliases/KeyType.md)
+
+The key type.
+
+##### coinType
+
+`number`
+
+The coin type.
+
+##### accountIndex
+
+`number`
+
+The account index.
+
+##### isInternal
+
+`boolean`
+
+Is this an internal address.
+
+##### addressIndex
+
+`number`
+
+The address index.
+
+#### Returns
+
+`object`
+
+The generated path and the associated keypair.
+
+##### address
+
+> **address**: `string`
+
+##### privateKey
+
+> **privateKey**: `Uint8Array`
+
+##### publicKey
+
+> **publicKey**: `Uint8Array`
+
+***
+
 ### addressBech32()
 
 > `static` **addressBech32**(`seed`, `keyType`, `hrp`, `coinType`, `accountIndex`, `isInternal`, `addressIndex`): `object`
@@ -126,31 +212,45 @@ Generate a bech32 address from the seed and parts.
 
 #### Parameters
 
-• **seed**: `Uint8Array`
+##### seed
+
+`Uint8Array`
 
 The account seed.
 
-• **keyType**: [`KeyType`](../type-aliases/KeyType.md)
+##### keyType
+
+[`KeyType`](../type-aliases/KeyType.md)
 
 The key type.
 
-• **hrp**: `string`
+##### hrp
+
+`string`
 
 The human readable part of the address.
 
-• **coinType**: `number`
+##### coinType
+
+`number`
 
 The coin type.
 
-• **accountIndex**: `number`
+##### accountIndex
+
+`number`
 
 The account index.
 
-• **isInternal**: `boolean`
+##### isInternal
+
+`boolean`
 
 Is this an internal address.
 
-• **addressIndex**: `number`
+##### addressIndex
+
+`number`
 
 The address index.