@twin.org/crypto 0.0.1-next.1

package/dist/types/address/bech32.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Bech32 encoding and decoding.
+ */
+export declare class Bech32 {
+    /**
+     * Encode the buffer.
+     * @param humanReadablePart The header.
+     * @param data The data to encode.
+     * @returns The encoded data.
+     */
+    static encode(humanReadablePart: string, data: Uint8Array): string;
+    /**
+     * Decode a bech32 string.
+     * @param bech The text to decode.
+     * @returns The decoded data or undefined if it could not be decoded.
+     * @throws An error if the decoding fails.
+     */
+    static decode(bech: string): {
+        humanReadablePart: string;
+        data: Uint8Array;
+    };
+    /**
+     * Is the input a bech 32 address.
+     * @param bech The value to test.
+     * @returns True if this is potentially a match.
+     */
+    static isBech32(bech: unknown): bech is string;
+}

package/dist/types/address/bip44.d.ts

@@ -0,0 +1,53 @@
+import { Bip32Path } from "../keys/bip32Path";
+import { KeyType } from "../models/keyType";
+/**
+ * Implementation of Bip44 for address generation.
+ */
+export declare class Bip44 {
+    /**
+     * Generate a bip44 key pair from the seed and parts.
+     * @param seed The account seed.
+     * @param keyType The key type.
+     * @param coinType The coin type.
+     * @param accountIndex The account index.
+     * @param isInternal Is this an internal address.
+     * @param addressIndex The address index.
+     * @returns The key pair.
+     * @throws Error if the address type is not supported.
+     */
+    static keyPair(seed: Uint8Array, keyType: KeyType, coinType: number, accountIndex: number, isInternal: boolean, addressIndex: number): {
+        privateKey: Uint8Array;
+        publicKey: Uint8Array;
+    };
+    /**
+     * Generate a bip44 path based on all its parts.
+     * @param coinType The coin type.
+     * @param accountIndex The account index.
+     * @param isInternal Is this an internal address.
+     * @param addressIndex The address index.
+     * @returns The generated path.
+     */
+    static path(coinType: number, accountIndex: number, isInternal: boolean, addressIndex: number): Bip32Path;
+    /**
+     * Create a bip44 base path for the provided coin type.
+     * @param coinType The coin type.
+     * @returns The bip44 address base path.
+     */
+    static basePath(coinType: number): string;
+    /**
+     * Generate a bech32 address from the seed and parts.
+     * @param seed The account seed.
+     * @param keyType The key type.
+     * @param hrp The human readable part of the address.
+     * @param coinType The coin type.
+     * @param accountIndex The account index.
+     * @param isInternal Is this an internal address.
+     * @param addressIndex The address index.
+     * @returns The generated path and the associated keypair.
+     */
+    static addressBech32(seed: Uint8Array, keyType: KeyType, hrp: string, coinType: number, accountIndex: number, isInternal: boolean, addressIndex: number): {
+        address: string;
+        privateKey: Uint8Array;
+        publicKey: Uint8Array;
+    };
+}

package/dist/types/ciphers/chaCha20Poly1305.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Implementation of the ChaCha20Poly1305 cipher.
+ */
+export declare class ChaCha20Poly1305 {
+    /**
+     * Create a new instance of ChaCha20Poly1305.
+     * @param key The key.
+     * @param nonce The nonce.
+     * @param aad The additional authenticated data.
+     */
+    constructor(key: Uint8Array, nonce: Uint8Array, aad?: Uint8Array);
+    /**
+     * Encrypt the block.
+     * @param block The block to encrypt.
+     * @returns The block encrypted.
+     */
+    encrypt(block: Uint8Array): Uint8Array;
+    /**
+     * Decrypt the block.
+     * @param block The block to decrypt.
+     * @returns The block decrypted.
+     */
+    decrypt(block: Uint8Array): Uint8Array;
+}

package/dist/types/curves/ed25519.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Implementation of Ed25519.
+ */
+export declare class Ed25519 {
+    /**
+     * Private Key Size is the size, in bytes, of private keys as used in this package.
+     */
+    static PRIVATE_KEY_SIZE: number;
+    /**
+     * Public Key Size is the size, in bytes, of public keys as used in this package.
+     */
+    static PUBLIC_KEY_SIZE: number;
+    /**
+     * Public returns the PublicKey corresponding to private.
+     * @param privateKey The private key to get the corresponding public key.
+     * @returns The public key.
+     * @throws Error if the private key is not the correct length.
+     */
+    static publicKeyFromPrivateKey(privateKey: Uint8Array): Uint8Array;
+    /**
+     * Sign the block with privateKey and returns a signature.
+     * @param privateKey The private key.
+     * @param block The block to sign.
+     * @returns The signature.
+     * @throws Error if the private key is not the correct length.
+     */
+    static sign(privateKey: Uint8Array, block: Uint8Array): Uint8Array;
+    /**
+     * Verify reports whether sig is a valid signature of block by publicKey.
+     * @param publicKey The public key to verify the signature.
+     * @param block The block for the signature.
+     * @param signature The signature.
+     * @returns True if the signature matches.
+     * @throws Error if the public key is not the correct length.
+     */
+    static verify(publicKey: Uint8Array, block: Uint8Array, signature: Uint8Array): boolean;
+}

package/dist/types/curves/secp256k1.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Implementation of secp256k1.
+ */
+export declare class Secp256k1 {
+    /**
+     * Private Key Size is the size, in bytes, of private keys as used in this package.
+     */
+    static PRIVATE_KEY_SIZE: number;
+    /**
+     * Public Key Size is the size, in bytes, of public keys as used in this package.
+     */
+    static PUBLIC_KEY_SIZE: number;
+    /**
+     * Public returns the PublicKey corresponding to private.
+     * @param privateKey The private key to get the corresponding public key.
+     * @returns The public key.
+     * @throws Error if the private key is not the correct length.
+     */
+    static publicKeyFromPrivateKey(privateKey: Uint8Array): Uint8Array;
+    /**
+     * Sign the block with privateKey and returns a signature.
+     * @param privateKey The private key.
+     * @param block The block to sign.
+     * @returns The signature.
+     * @throws Error if the private key is not the correct length.
+     */
+    static sign(privateKey: Uint8Array, block: Uint8Array): Uint8Array;
+    /**
+     * Verify reports whether sig is a valid signature of block by publicKey.
+     * @param publicKey The public key to verify the signature.
+     * @param block The block for the signature.
+     * @param signature The signature.
+     * @returns True if the signature matches.
+     * @throws Error if the public key is not the correct length.
+     */
+    static verify(publicKey: Uint8Array, block: Uint8Array, signature: Uint8Array): boolean;
+}

package/dist/types/curves/x25519.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Implementation of X25519.
+ */
+export declare class X25519 {
+    /**
+     * Convert Ed25519 private key to X25519 private key.
+     * @param ed25519PrivateKey The ed25519 private key to convert.
+     * @returns The x25519 private key.
+     */
+    static convertPrivateKeyToX25519(ed25519PrivateKey: Uint8Array): Uint8Array;
+    /**
+     * Convert Ed25519 public key to X25519 public key.
+     * @param ed25519PublicKey The ed25519 public key to convert.
+     * @returns The x25519 public key.
+     * @throws GeneralError On invalid public key.
+     */
+    static convertPublicKeyToX25519(ed25519PublicKey: Uint8Array): Uint8Array;
+}

package/dist/types/curves/zip215.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Implementation of Zip215.
+ */
+export declare class Zip215 {
+    /**
+     * Verify reports whether sig is a valid signature of block by
+     * publicKey, using precisely-specified validation criteria (ZIP 215) suitable
+     * for use in consensus-critical contexts.
+     * @param publicKey The public key for the block.
+     * @param block The block content to validate.
+     * @param sig The signature to verify.
+     * @returns True if the signature is valid.
+     */
+    static verify(publicKey: Uint8Array, block: Uint8Array, sig: Uint8Array): boolean;
+}

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

@@ -0,0 +1,55 @@
+/**
+ * Class to help with Blake2B Signature scheme.
+ */
+export declare class Blake2b {
+    /**
+     * Blake2b 160.
+     */
+    static SIZE_160: number;
+    /**
+     * Blake2b 256.
+     */
+    static SIZE_256: number;
+    /**
+     * Blake2b 512.
+     */
+    static SIZE_512: number;
+    /**
+     * Create a new instance of Blake2b.
+     * @param outputLength The output length.
+     * @param key Optional key for the hash.
+     */
+    constructor(outputLength: number, key?: Uint8Array);
+    /**
+     * Perform Sum 160 on the block.
+     * @param block The block to operate on.
+     * @param key Optional key for the hash.
+     * @returns The sum 160 of the block.
+     */
+    static sum160(block: Uint8Array, key?: Uint8Array): 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): Blake2b;
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest(): Uint8Array;
+}

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

@@ -0,0 +1,28 @@
+/**
+ * Class to help with HmacSha1 scheme.
+ */
+export declare class HmacSha1 {
+    /**
+     * Create a new instance of HmacSha1.
+     * @param key The key for the hmac.
+     */
+    constructor(key: Uint8Array);
+    /**
+     * Perform Sum on the block.
+     * @param key The key for the hmac.
+     * @param block The block to operate on.
+     * @returns The sum of the block.
+     */
+    static sum(key: Uint8Array, 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): HmacSha1;
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest(): Uint8Array;
+}

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

@@ -0,0 +1,44 @@
+/**
+ * Class to help with HmacSha256 scheme.
+ */
+export declare class HmacSha256 {
+    /**
+     * Sha256 256.
+     */
+    static readonly SIZE_256: number;
+    /**
+     * Sha256 224.
+     */
+    static readonly SIZE_224: number;
+    /**
+     * Create a new instance of HmacSha256.
+     * @param key The key for the hmac.
+     * @param bits The number of bits.
+     */
+    constructor(key: Uint8Array, bits?: number);
+    /**
+     * Perform Sum 224 on the block.
+     * @param key The key for the hmac.
+     * @param block The block to operate on.
+     * @returns The sum 224 of the block.
+     */
+    static sum224(key: Uint8Array, block: Uint8Array): Uint8Array;
+    /**
+     * Perform Sum 256 on the block.
+     * @param key The key for the hmac.
+     * @param block The block to operate on.
+     * @returns The sum 256 of the block.
+     */
+    static sum256(key: Uint8Array, 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): HmacSha256;
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest(): Uint8Array;
+}

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

@@ -0,0 +1,66 @@
+/**
+ * Class to help with HmacSha512 scheme.
+ */
+export declare class HmacSha512 {
+    /**
+     * Sha512 224.
+     */
+    static SIZE_224: number;
+    /**
+     * Sha512 256.
+     */
+    static SIZE_256: number;
+    /**
+     * Sha512 384.
+     */
+    static SIZE_384: number;
+    /**
+     * Sha512 512.
+     */
+    static SIZE_512: number;
+    /**
+     * Create a new instance of HmacSha512.
+     * @param key The key for the hmac.
+     * @param bits The number of bits.
+     */
+    constructor(key: Uint8Array, bits?: number);
+    /**
+     * Perform Sum 512 on the block.
+     * @param key The key for the hmac.
+     * @param block The block to operate on.
+     * @returns The sum 512 of the block.
+     */
+    static sum512(key: Uint8Array, block: Uint8Array): Uint8Array;
+    /**
+     * Perform Sum 384 on the block.
+     * @param key The key for the hmac.
+     * @param block The block to operate on.
+     * @returns The sum 384 of the block.
+     */
+    static sum384(key: Uint8Array, block: Uint8Array): Uint8Array;
+    /**
+     * Perform Sum 256 on the block.
+     * @param key The key for the hmac.
+     * @param block The block to operate on.
+     * @returns The sum 256 of the block.
+     */
+    static sum256(key: Uint8Array, block: Uint8Array): Uint8Array;
+    /**
+     * Perform Sum 224 on the block.
+     * @param key The key for the hmac.
+     * @param block The block to operate on.
+     * @returns The sum 224 of the block.
+     */
+    static sum224(key: Uint8Array, 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): HmacSha512;
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest(): Uint8Array;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * Implementation of the password based key derivation function 2.
+ */
+export declare class Pbkdf2 {
+    /**
+     * Derive a key from the parameters using Sha256.
+     * @param password The password to derive the key from.
+     * @param salt The salt for the derivation.
+     * @param iterations Number of iterations to perform.
+     * @param keyLength The length of the key to derive.
+     * @returns The derived key.
+     */
+    static sha256(password: Uint8Array, salt: Uint8Array, iterations: number, keyLength: number): Uint8Array;
+    /**
+     * Derive a key from the parameters using Sha512.
+     * @param password The password to derive the key from.
+     * @param salt The salt for the derivation.
+     * @param iterations Number of iterations to perform.
+     * @param keyLength The length of the key to derive.
+     * @returns The derived key.
+     */
+    static sha512(password: Uint8Array, salt: Uint8Array, iterations: number, keyLength: number): Uint8Array;
+}

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

@@ -0,0 +1,26 @@
+/**
+ * Perform a SHA-1 hash on the block.
+ */
+export declare class Sha1 {
+    /**
+     * Create a new instance of Sha1.
+     */
+    constructor();
+    /**
+     * Perform Sum on the block.
+     * @param block The block to operate on.
+     * @returns The sum of the block.
+     */
+    static sum(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): Sha1;
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest(): Uint8Array;
+}

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

@@ -0,0 +1,41 @@
+/**
+ * Perform a SHA-256 hash on the block.
+ */
+export declare class Sha256 {
+    /**
+     * Sha256 256.
+     */
+    static readonly SIZE_256: number;
+    /**
+     * Sha256 224.
+     */
+    static readonly SIZE_224: number;
+    /**
+     * Create a new instance of Sha256.
+     * @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;
+    /**
+     * Update the hash with the block.
+     * @param block The block to update the hash with.
+     * @returns The instance for chaining.
+     */
+    update(block: Uint8Array): Sha256;
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest(): Uint8Array;
+}

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

@@ -0,0 +1,61 @@
+/**
+ * Perform a SHA-512 hash on the block.
+ */
+export declare class Sha512 {
+    /**
+     * Sha512 224.
+     */
+    static SIZE_224: number;
+    /**
+     * Sha512 256.
+     */
+    static SIZE_256: number;
+    /**
+     * Sha512 384.
+     */
+    static SIZE_384: number;
+    /**
+     * Sha512 512.
+     */
+    static SIZE_512: number;
+    /**
+     * Create a new instance of Sha512.
+     * @param bits The number of bits.
+     */
+    constructor(bits?: number);
+    /**
+     * 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;
+    /**
+     * 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 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;
+    /**
+     * Update the hash with the block.
+     * @param block The block to update the hash with.
+     * @returns The instance for chaining.
+     */
+    update(block: Uint8Array): Sha512;
+    /**
+     * Get the digest for the hash.
+     * @returns The instance for chaining.
+     */
+    digest(): Uint8Array;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,23 @@
+export * from "./address/bech32";
+export * from "./address/bip44";
+export * from "./ciphers/chaCha20Poly1305";
+export * from "./curves/ed25519";
+export * from "./curves/secp256k1";
+export * from "./curves/x25519";
+export * from "./curves/zip215";
+export * from "./hashes/blake2b";
+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/sha512";
+export * from "./keys/bip32Path";
+export * from "./keys/bip39";
+export * from "./keys/slip0010";
+export * from "./models/keyType";
+export * from "./otp/hotp";
+export * from "./otp/totp";
+export * from "./passwords/passwordGenerator";
+export * from "./passwords/passwordValidator";

package/dist/types/keys/bip32Path.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Class to help with bip32 paths.
+ */
+export declare class Bip32Path {
+    /**
+     * Create a new instance of Bip32Path.
+     * @param initialPath Initial path to create.
+     */
+    constructor(initialPath?: string);
+    /**
+     * Construct a new path by cloning an existing one.
+     * @param bip32Path The path to clone.
+     * @returns A new instance of Bip32Path.
+     */
+    static fromPath(bip32Path: Bip32Path): Bip32Path;
+    /**
+     * Converts the path to a string.
+     * @returns The path as a string.
+     */
+    toString(): string;
+    /**
+     * Push a new index on to the path.
+     * @param index The index to add to the path.
+     */
+    push(index: number): void;
+    /**
+     * Push a new hardened index on to the path.
+     * @param index The index to add to the path.
+     */
+    pushHardened(index: number): void;
+    /**
+     * Pop an index from the path.
+     */
+    pop(): void;
+    /**
+     * Get the segments.
+     * @returns The segments as numbers.
+     */
+    numberSegments(): number[];
+}

package/dist/types/keys/bip39.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Implementation of Bip39 for mnemonic generation.
+ */
+export declare class Bip39 {
+    /**
+     * Generate a random mnemonic.
+     * @param strength The strength of the mnemonic to generate, defaults to 256.
+     * @param words The wordlist to use, defaults to the English wordlist.
+     * @returns The random mnemonic.
+     * @throws Error if the length is not a multiple of 32.
+     */
+    static randomMnemonic(strength?: number, words?: string[]): string;
+    /**
+     * Generate a mnemonic from the entropy.
+     * @param entropy The entropy to generate.
+     * @param words The wordlist to use, defaults to the English wordlist.
+     * @returns The mnemonic.
+     * @throws Error if the length of the entropy is not a multiple of 4, or is less than 16 or greater than 32.
+     */
+    static entropyToMnemonic(entropy: Uint8Array, words?: string[]): string;
+    /**
+     * Convert a mnemonic to a seed.
+     * @param mnemonic The mnemonic to convert.
+     * @param password The password to apply to the seed generation.
+     * @returns The seed.
+     */
+    static mnemonicToSeed(mnemonic: string, password?: string): Uint8Array;
+    /**
+     * Convert the mnemonic back to entropy.
+     * @param mnemonic The mnemonic to convert.
+     * @param words The wordlist to use, defaults to the English wordlist.
+     * @returns The entropy.
+     * @throws Error if the number of words is not a multiple of 3.
+     */
+    static mnemonicToEntropy(mnemonic: string, words?: string[]): Uint8Array;
+}