@twin.org/crypto 0.0.1-next.9 → 0.0.2-next.3

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.
 

package/docs/reference/classes/Blake2b.md

@@ -4,25 +4,29 @@ Class to help with Blake2B Signature scheme.
 
 ## Constructors
 
-### new Blake2b()
+### Constructor
 
-> **new Blake2b**(`outputLength`, `key`?): [`Blake2b`](Blake2b.md)
+> **new Blake2b**(`outputLength`, `key?`): `Blake2b`
 
 Create a new instance of Blake2b.
 
 #### Parameters
 
-• **outputLength**: `number`
+##### outputLength
+
+`number`
 
 The output length.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`\<`ArrayBufferLike`\>
 
 Optional key for the hash.
 
 #### Returns
 
-[`Blake2b`](Blake2b.md)
+`Blake2b`
 
 ## Properties
 
@@ -52,17 +56,21 @@ Blake2b 512.
 
 ### sum160()
 
-> `static` **sum160**(`block`, `key`?): `Uint8Array`
+> `static` **sum160**(`block`, `key?`): `Uint8Array`
 
 Perform Sum 160 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`\<`ArrayBufferLike`\>
 
 Optional key for the hash.
 
@@ -76,17 +84,21 @@ The sum 160 of the block.
 
 ### sum256()
 
-> `static` **sum256**(`block`, `key`?): `Uint8Array`
+> `static` **sum256**(`block`, `key?`): `Uint8Array`
 
 Perform Sum 256 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`\<`ArrayBufferLike`\>
 
 Optional key for the hash.
 
@@ -100,17 +112,21 @@ The sum 256 of the block.
 
 ### sum512()
 
-> `static` **sum512**(`block`, `key`?): `Uint8Array`
+> `static` **sum512**(`block`, `key?`): `Uint8Array`
 
 Perform Sum 512 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`\<`ArrayBufferLike`\>
 
 Optional key for the hash.
 
@@ -124,19 +140,21 @@ The sum 512 of the block.
 
 ### update()
 
-> **update**(`block`): [`Blake2b`](Blake2b.md)
+> **update**(`block`): `Blake2b`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`Blake2b`](Blake2b.md)
+`Blake2b`
 
 The instance for chaining.
 

package/docs/reference/classes/Blake3.md

@@ -4,25 +4,29 @@ Class to help with Blake3 Signature scheme.
 
 ## Constructors
 
-### new Blake3()
+### Constructor
 
-> **new Blake3**(`outputLength`, `key`?): [`Blake3`](Blake3.md)
+> **new Blake3**(`outputLength`, `key?`): `Blake3`
 
 Create a new instance of Blake3.
 
 #### Parameters
 
-• **outputLength**: `number`
+##### outputLength
+
+`number`
 
 The output length.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`\<`ArrayBufferLike`\>
 
 Optional key for the hash.
 
 #### Returns
 
-[`Blake3`](Blake3.md)
+`Blake3`
 
 ## Properties
 
@@ -44,17 +48,21 @@ Blake3 512.
 
 ### sum256()
 
-> `static` **sum256**(`block`, `key`?): `Uint8Array`
+> `static` **sum256**(`block`, `key?`): `Uint8Array`
 
 Perform Sum 256 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`\<`ArrayBufferLike`\>
 
 Optional key for the hash.
 
@@ -68,17 +76,21 @@ The sum 256 of the block.
 
 ### sum512()
 
-> `static` **sum512**(`block`, `key`?): `Uint8Array`
+> `static` **sum512**(`block`, `key?`): `Uint8Array`
 
 Perform Sum 512 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`\<`ArrayBufferLike`\>
 
 Optional key for the hash.
 
@@ -92,19 +104,21 @@ The sum 512 of the block.
 
 ### update()
 
-> **update**(`block`): [`Blake3`](Blake3.md)
+> **update**(`block`): `Blake3`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`Blake3`](Blake3.md)
+`Blake3`
 
 The instance for chaining.
 

package/docs/reference/classes/ChaCha20Poly1305.md

@@ -4,29 +4,35 @@ Implementation of the ChaCha20Poly1305 cipher.
 
 ## Constructors
 
-### new ChaCha20Poly1305()
+### Constructor
 
-> **new ChaCha20Poly1305**(`key`, `nonce`, `aad`?): [`ChaCha20Poly1305`](ChaCha20Poly1305.md)
+> **new ChaCha20Poly1305**(`key`, `nonce`, `aad?`): `ChaCha20Poly1305`
 
 Create a new instance of ChaCha20Poly1305.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key.
 
-• **nonce**: `Uint8Array`
+##### nonce
+
+`Uint8Array`
 
 The nonce.
 
-• **aad?**: `Uint8Array`
+##### aad?
+
+`Uint8Array`\<`ArrayBufferLike`\>
 
 The additional authenticated data.
 
 #### Returns
 
-[`ChaCha20Poly1305`](ChaCha20Poly1305.md)
+`ChaCha20Poly1305`
 
 ## Methods
 
@@ -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.