@twin.org/crypto 0.0.1-next.8 → 0.0.1

package/docs/reference/classes/Sha3.md

@@ -0,0 +1,179 @@
+# Class: Sha3
+
+Perform a SHA-3 hash on the block.
+
+## Constructors
+
+### Constructor
+
+> **new Sha3**(`bits`): `Sha3`
+
+Create a new instance of Sha3.
+
+#### Parameters
+
+##### bits
+
+`number` = `Sha3.SIZE_256`
+
+The number of bits.
+
+#### Returns
+
+`Sha3`
+
+## Properties
+
+### SIZE\_224
+
+> `readonly` `static` **SIZE\_224**: `number` = `224`
+
+Sha3 224.
+
+***
+
+### SIZE\_256
+
+> `readonly` `static` **SIZE\_256**: `number` = `256`
+
+Sha3 256.
+
+***
+
+### SIZE\_384
+
+> `readonly` `static` **SIZE\_384**: `number` = `384`
+
+Sha3 384.
+
+***
+
+### SIZE\_512
+
+> `readonly` `static` **SIZE\_512**: `number` = `512`
+
+Sha3 512.
+
+## Methods
+
+### sum256()
+
+> `static` **sum256**(`block`): `Uint8Array`
+
+Perform Sum 256 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 256 of the block.
+
+***
+
+### sum224()
+
+> `static` **sum224**(`block`): `Uint8Array`
+
+Perform Sum 224 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 224 of the block.
+
+***
+
+### sum384()
+
+> `static` **sum384**(`block`): `Uint8Array`
+
+Perform Sum 384 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 384 of the block.
+
+***
+
+### sum512()
+
+> `static` **sum512**(`block`): `Uint8Array`
+
+Perform Sum 512 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 512 of the block.
+
+***
+
+### update()
+
+> **update**(`block`): `Sha3`
+
+Update the hash with the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to update the hash with.
+
+#### Returns
+
+`Sha3`
+
+The instance for chaining.
+
+***
+
+### digest()
+
+> **digest**(): `Uint8Array`
+
+Get the digest for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The instance for chaining.

package/docs/reference/classes/Sha512.md

@@ -4,21 +4,23 @@ Perform a SHA-512 hash on the block.
 
 ## Constructors
 
-### new Sha512()
+### Constructor
 
-> **new Sha512**(`bits`): [`Sha512`](Sha512.md)
+> **new Sha512**(`bits`): `Sha512`
 
 Create a new instance of Sha512.
 
 #### Parameters
 
-• **bits**: `number` = `Sha512.SIZE_512`
+##### bits
+
+`number` = `Sha512.SIZE_512`
 
 The number of bits.
 
 #### Returns
 
-[`Sha512`](Sha512.md)
+`Sha512`
 
 ## Properties
 
@@ -62,7 +64,9 @@ Perform Sum 512 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -82,7 +86,9 @@ Perform Sum 384 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -102,7 +108,9 @@ Perform Sum 256 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -122,7 +130,9 @@ Perform Sum 224 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -136,19 +146,21 @@ The sum 224 of the block.
 
 ### update()
 
-> **update**(`block`): [`Sha512`](Sha512.md)
+> **update**(`block`): `Sha512`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`Sha512`](Sha512.md)
+`Sha512`
 
 The instance for chaining.
 

package/docs/reference/classes/Slip0010.md

@@ -5,13 +5,13 @@ https://github.com/satoshilabs/slips/blob/master/slip-0010.md.
 
 ## Constructors
 
-### new Slip0010()
+### Constructor
 
-> **new Slip0010**(): [`Slip0010`](Slip0010.md)
+> **new Slip0010**(): `Slip0010`
 
 #### Returns
 
-[`Slip0010`](Slip0010.md)
+`Slip0010`
 
 ## Methods
 
@@ -23,11 +23,15 @@ Get the master key from the seed.
 
 #### Parameters
 
-• **seed**: `Uint8Array`
+##### seed
+
+`Uint8Array`
 
 The seed to generate the master key from.
 
-• **keyType**: [`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
+##### keyType
+
+[`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
 
 The key type.
 
@@ -59,15 +63,21 @@ Derive a key from the path.
 
 #### Parameters
 
-• **seed**: `Uint8Array`
+##### seed
+
+`Uint8Array`
 
 The seed.
 
-• **path**: [`Bip32Path`](Bip32Path.md)
+##### path
+
+[`Bip32Path`](Bip32Path.md)
 
 The path.
 
-• **keyType**: [`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
+##### keyType
+
+[`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
 
 The key type.
 
@@ -95,15 +105,21 @@ Get the public key from the private key.
 
 #### Parameters
 
-• **privateKey**: `Uint8Array`
+##### privateKey
+
+`Uint8Array`
 
 The private key.
 
-• **keyType**: [`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
+##### keyType
+
+[`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
 
 The key type.
 
-• **withZeroByte**: `boolean` = `true`
+##### withZeroByte
+
+`boolean` = `true`
 
 Include a zero bute prefix.
 

package/docs/reference/classes/Totp.md

@@ -5,13 +5,13 @@ Implementation of https://datatracker.ietf.org/doc/html/rfc4226 .
 
 ## Constructors
 
-### new Totp()
+### Constructor
 
-> **new Totp**(): [`Totp`](Totp.md)
+> **new Totp**(): `Totp`
 
 #### Returns
 
-[`Totp`](Totp.md)
+`Totp`
 
 ## Methods
 
@@ -23,15 +23,21 @@ Generate a time based One Time Password.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 Key for the one time password.
 
-• **interval**: `number` = `30`
+##### interval
+
+`number` = `30`
 
 The time step of the counter.
 
-• **timestamp**: `number` = `...`
+##### timestamp
+
+`number` = `...`
 
 The timestamp.
 
@@ -51,24 +57,34 @@ Check a One Time Password based on a timer.
 
 #### Parameters
 
-• **token**: `string`
+##### token
+
+`string`
 
 Passcode to validate.
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 Key for the one time password. This should be unique and secret for
 every user as it is the seed used to calculate the HMAC.
 
-• **window**: `number` = `2`
+##### window
+
+`number` = `2`
 
 The allowable margin for the counter.
 
-• **interval**: `number` = `30`
+##### interval
+
+`number` = `30`
 
 The time step of the counter.
 
-• **timestamp**: `number` = `...`
+##### timestamp
+
+`number` = `...`
 
 The timestamp now.
 
@@ -88,7 +104,9 @@ Generate a secret.
 
 #### Parameters
 
-• **length**: `number`
+##### length
+
+`number`
 
 The length of the secret to generate.
 
@@ -108,7 +126,9 @@ Convert the secret back to bytes.
 
 #### Parameters
 
-• **secretBase32**: `string`
+##### secretBase32
+
+`string`
 
 The secret encoded as base32.
 
@@ -129,15 +149,21 @@ See https://github.com/google/google-authenticator/wiki/Key-Uri-Format .
 
 #### Parameters
 
-• **issuer**: `string`
+##### issuer
+
+`string`
 
 The issuer of the totp.
 
-• **label**: `string`
+##### label
+
+`string`
 
 The label that will show in auth apps.
 
-• **secretBase32**: `string`
+##### secretBase32
+
+`string`
 
 The secret as base 32.
 

package/docs/reference/classes/X25519.md

@@ -4,13 +4,13 @@ Implementation of X25519.
 
 ## Constructors
 
-### new X25519()
+### Constructor
 
-> **new X25519**(): [`X25519`](X25519.md)
+> **new X25519**(): `X25519`
 
 #### Returns
 
-[`X25519`](X25519.md)
+`X25519`
 
 ## Methods
 
@@ -22,7 +22,9 @@ Convert Ed25519 private key to X25519 private key.
 
 #### Parameters
 
-• **ed25519PrivateKey**: `Uint8Array`
+##### ed25519PrivateKey
+
+`Uint8Array`
 
 The ed25519 private key to convert.
 
@@ -42,7 +44,9 @@ Convert Ed25519 public key to X25519 public key.
 
 #### Parameters
 
-• **ed25519PublicKey**: `Uint8Array`
+##### ed25519PublicKey
+
+`Uint8Array`
 
 The ed25519 public key to convert.
 

package/docs/reference/classes/Zip215.md

@@ -4,13 +4,13 @@ Implementation of Zip215.
 
 ## Constructors
 
-### new Zip215()
+### Constructor
 
-> **new Zip215**(): [`Zip215`](Zip215.md)
+> **new Zip215**(): `Zip215`
 
 #### Returns
 
-[`Zip215`](Zip215.md)
+`Zip215`
 
 ## Methods
 
@@ -24,15 +24,21 @@ for use in consensus-critical contexts.
 
 #### Parameters
 
-• **publicKey**: `Uint8Array`
+##### publicKey
+
+`Uint8Array`
 
 The public key for the block.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block content to validate.
 
-• **sig**: `Uint8Array`
+##### sig
+
+`Uint8Array`
 
 The signature to verify.
 

package/docs/reference/index.md

@@ -10,12 +10,14 @@
 - [X25519](classes/X25519.md)
 - [Zip215](classes/Zip215.md)
 - [Blake2b](classes/Blake2b.md)
+- [Blake3](classes/Blake3.md)
 - [HmacSha1](classes/HmacSha1.md)
 - [HmacSha256](classes/HmacSha256.md)
 - [HmacSha512](classes/HmacSha512.md)
 - [Pbkdf2](classes/Pbkdf2.md)
 - [Sha1](classes/Sha1.md)
 - [Sha256](classes/Sha256.md)
+- [Sha3](classes/Sha3.md)
 - [Sha512](classes/Sha512.md)
 - [Bip32Path](classes/Bip32Path.md)
 - [Bip39](classes/Bip39.md)

package/docs/reference/type-aliases/KeyType.md

@@ -1,5 +1,5 @@
 # Type Alias: KeyType
 
-> **KeyType**: *typeof* [`KeyType`](../variables/KeyType.md)\[keyof *typeof* [`KeyType`](../variables/KeyType.md)\]
+> **KeyType** = *typeof* [`KeyType`](../variables/KeyType.md)\[keyof *typeof* [`KeyType`](../variables/KeyType.md)\]
 
 Key types.

package/locales/en.json

@@ -31,18 +31,15 @@
 		"sha256": {
 			"bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
 		},
+		"sha3": {
+			"bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+		},
 		"hmacSha256": {
 			"bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
 		},
 		"hmacSha512": {
 			"bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
 		},
-		"base32": {
-			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
-		},
-		"base64": {
-			"length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
-		},
 		"bech32": {
 			"decodeFailed": "The address contains decoding failed for address \"{bech32}\"",
 			"invalidChecksum": "The address contains an invalid checksum in address, \"{bech32}\"",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/crypto",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "Contains helper methods and classes which implement cryptographic functions",
 	"repository": {
 		"type": "git",
@@ -14,26 +14,26 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@noble/ciphers": "1.0.0",
-		"@noble/curves": "1.6.0",
-		"@noble/hashes": "1.5.0",
-		"@scure/base": "1.1.9",
-		"@scure/bip32": "1.5.0",
-		"@scure/bip39": "1.4.0",
-		"@twin.org/core": "0.0.1-next.8",
-		"@twin.org/nameof": "next",
-		"micro-key-producer": "0.7.0"
+		"@noble/ciphers": "1.3.0",
+		"@noble/curves": "1.9.2",
+		"@noble/hashes": "1.8.0",
+		"@scure/base": "1.2.6",
+		"@scure/bip32": "1.7.0",
+		"@scure/bip39": "1.6.0",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"micro-key-producer": "0.7.6"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",