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

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.
 

package/docs/reference/classes/Bip39.md

@@ -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.
 
@@ -78,11 +86,15 @@ 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

@@ -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.
 

package/docs/reference/classes/Blake2b.md

@@ -12,11 +12,15 @@ Create a new instance of Blake2b.
 
 #### Parameters
 
-• **outputLength**: `number`
+##### outputLength
+
+`number`
 
 The output length.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`
 
 Optional key for the hash.
 
@@ -58,11 +62,15 @@ Perform Sum 160 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`
 
 Optional key for the hash.
 
@@ -82,11 +90,15 @@ Perform Sum 256 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`
 
 Optional key for the hash.
 
@@ -106,11 +118,15 @@ Perform Sum 512 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`
 
 Optional key for the hash.
 
@@ -130,7 +146,9 @@ Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 

package/docs/reference/classes/Blake3.md

@@ -0,0 +1,137 @@
+# Class: Blake3
+
+Class to help with Blake3 Signature scheme.
+
+## Constructors
+
+### new Blake3()
+
+> **new Blake3**(`outputLength`, `key`?): [`Blake3`](Blake3.md)
+
+Create a new instance of Blake3.
+
+#### Parameters
+
+##### outputLength
+
+`number`
+
+The output length.
+
+##### key?
+
+`Uint8Array`
+
+Optional key for the hash.
+
+#### Returns
+
+[`Blake3`](Blake3.md)
+
+## Properties
+
+### SIZE\_256
+
+> `static` **SIZE\_256**: `number` = `32`
+
+Blake3 256.
+
+***
+
+### SIZE\_512
+
+> `static` **SIZE\_512**: `number` = `64`
+
+Blake3 512.
+
+## Methods
+
+### sum256()
+
+> `static` **sum256**(`block`, `key`?): `Uint8Array`
+
+Perform Sum 256 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+##### key?
+
+`Uint8Array`
+
+Optional key for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 256 of the block.
+
+***
+
+### sum512()
+
+> `static` **sum512**(`block`, `key`?): `Uint8Array`
+
+Perform Sum 512 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+##### key?
+
+`Uint8Array`
+
+Optional key for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 512 of the block.
+
+***
+
+### update()
+
+> **update**(`block`): [`Blake3`](Blake3.md)
+
+Update the hash with the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to update the hash with.
+
+#### Returns
+
+[`Blake3`](Blake3.md)
+
+The instance for chaining.
+
+***
+
+### digest()
+
+> **digest**(): `Uint8Array`
+
+Get the digest for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The instance for chaining.

package/docs/reference/classes/ChaCha20Poly1305.md

@@ -12,15 +12,21 @@ Create a new instance of ChaCha20Poly1305.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key.
 
-• **nonce**: `Uint8Array`
+##### nonce
+
+`Uint8Array`
 
 The nonce.
 
-• **aad?**: `Uint8Array`
+##### aad?
+
+`Uint8Array`
 
 The additional authenticated data.
 
@@ -38,7 +44,9 @@ Encrypt the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to encrypt.
 
@@ -58,7 +66,9 @@ Decrypt the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to decrypt.
 

package/docs/reference/classes/Ed25519.md

@@ -38,7 +38,9 @@ Public returns the PublicKey corresponding to private.
 
 #### Parameters
 
-• **privateKey**: `Uint8Array`
+##### privateKey
+
+`Uint8Array`
 
 The private key to get the corresponding public key.
 
@@ -62,11 +64,15 @@ Sign the block with privateKey and returns a signature.
 
 #### Parameters
 
-• **privateKey**: `Uint8Array`
+##### privateKey
+
+`Uint8Array`
 
 The private key.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to sign.
 
@@ -90,15 +96,21 @@ Verify reports whether sig is a valid signature of block by publicKey.
 
 #### Parameters
 
-• **publicKey**: `Uint8Array`
+##### publicKey
+
+`Uint8Array`
 
 The public key to verify the signature.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block for the signature.
 
-• **signature**: `Uint8Array`
+##### signature
+
+`Uint8Array`
 
 The signature.
 

package/docs/reference/classes/HmacSha1.md

@@ -12,7 +12,9 @@ Create a new instance of HmacSha1.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
@@ -30,11 +32,15 @@ Perform Sum on the block.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -54,7 +60,9 @@ Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.