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

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

@@ -34,6 +34,21 @@ export declare class Bip44 {
      * @returns The bip44 address base path.
      */
     static basePath(coinType: number): string;
+    /**
+     * Generate an address 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 generated path and the associated keypair.
+     */
+    static address(seed: Uint8Array, keyType: KeyType, coinType: number, accountIndex: number, isInternal: boolean, addressIndex: number): {
+        address: string;
+        privateKey: Uint8Array;
+        publicKey: Uint8Array;
+    };
     /**
      * Generate a bech32 address from the seed and parts.
      * @param seed The account seed.

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

@@ -0,0 +1,63 @@
+/**
+ * Implementation of the RSA cipher.
+ */
+export declare class RSA {
+    /**
+     * Create a new instance of RSA.
+     * @param publicKey The public key for encryption (DER format as Uint8Array).
+     * @param privateKey The private key for decryption (DER format as Uint8Array).
+     */
+    constructor(publicKey: Uint8Array, privateKey?: Uint8Array);
+    /**
+     * Generate a new RSA key pair in PKCS8 format.
+     * @param modulusLength The key size in bits (default: 2048).
+     * @returns The public and private keys as Uint8Array.
+     */
+    static generateKeyPair(modulusLength?: number): {
+        publicKey: Uint8Array;
+        privateKey: Uint8Array;
+    };
+    /**
+     * Convert a PKCS1 key to a PKCS8 key.
+     * @param pkcs1Key The PKCS1 key as Uint8Array.
+     * @returns The PKCS8 key as Uint8Array.
+     */
+    static convertPkcs1ToPkcs8(pkcs1Key: Uint8Array): Uint8Array;
+    /**
+     * Break the private key down in to its components.
+     * @param pkcs8Key The PKCS8 key as Uint8Array.
+     * @returns The key components.
+     */
+    static getPrivateKeyComponents(pkcs8Key: Uint8Array): {
+        n: bigint;
+        e: bigint;
+        d: bigint;
+        p: bigint;
+        q: bigint;
+        dp: bigint;
+        dq: bigint;
+        qi: bigint;
+    };
+    /**
+     * Break the public key down in to its components.
+     * @param spkiKey The SPKI key as Uint8Array.
+     * @returns The key components.
+     */
+    static getPublicKeyComponents(spkiKey: Uint8Array): {
+        n: bigint;
+        e: bigint;
+    };
+    /**
+     * Encrypt the data.
+     * @param data The data to encrypt.
+     * @returns The data encrypted.
+     */
+    encrypt(data: Uint8Array): Uint8Array;
+    /**
+     * Decrypt the data.
+     * @param data The data to decrypt.
+     * @returns The data decrypted.
+     * @throws GeneralError If no private key is provided.
+     */
+    decrypt(data: Uint8Array): Uint8Array;
+}

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

@@ -34,4 +34,16 @@ export declare class Ed25519 {
      * @throws Error if the public key is not the correct length.
      */
     static verify(publicKey: Uint8Array, block: Uint8Array, signature: Uint8Array): boolean;
+    /**
+     * Convert a private key in PKCS8 format.
+     * @param privateKey The private key to convert.
+     * @returns The private key in PKCS8 format.
+     */
+    static privateKeyToPkcs8(privateKey: Uint8Array): Promise<CryptoKey>;
+    /**
+     * Convert a crypto key to raw private key.
+     * @param cryptoKey The crypto key to convert.
+     * @returns The raw private key.
+     */
+    static pkcs8ToPrivateKey(cryptoKey: CryptoKey): Promise<Uint8Array>;
 }

package/dist/types/helpers/pemHelper.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Helper class for working with PEM (Privacy-Enhanced Mail) formatted data.
+ */
+export declare class PemHelper {
+    /**
+     * Strip the PEM content of its headers, footers, and newlines.
+     * @param pemContent The PEM content to strip.
+     * @returns The stripped PEM content in bas64 format.
+     */
+    static stripPemMarkers(pemContent: string): string;
+    /**
+     * Format the PEM content to have a specific line length.
+     * @param marker The marker for the PEM content, e.g. RSA PRIVATE KEY
+     * @param base64Content The base64 content to format.
+     * @param lineLength The length of each line in the PEM content, default is 64 characters.
+     * @returns The formatted PEM content.
+     */
+    static formatPem(marker: string, base64Content: string, lineLength?: number): string;
+}

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./address/bech32";
 export * from "./address/bip44";
 export * from "./ciphers/chaCha20Poly1305";
+export * from "./ciphers/rsa";
 export * from "./curves/ed25519";
 export * from "./curves/secp256k1";
 export * from "./curves/x25519";
@@ -15,6 +16,7 @@ export * from "./hashes/sha1";
 export * from "./hashes/sha256";
 export * from "./hashes/sha3";
 export * from "./hashes/sha512";
+export * from "./helpers/pemHelper";
 export * from "./keys/bip32Path";
 export * from "./keys/bip39";
 export * from "./keys/slip0010";

package/docs/changelog.md

@@ -1,5 +1,404 @@
 # @twin.org/crypto - Changelog
 
-## 0.0.1-next.9
+## [0.0.2-next.3](https://github.com/twinfoundation/framework/compare/crypto-v0.0.2-next.2...crypto-v0.0.2-next.3) (2025-08-06)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* add rsa cipher support ([7af6cc6](https://github.com/twinfoundation/framework/commit/7af6cc67512d3363bd4a2f2e87bd7733c2800147))
+* add RSA support for public key components ([7126259](https://github.com/twinfoundation/framework/commit/7126259103b758c291e52a8a03818eb822d1aad1))
+* change method accessibility ([c1b77fc](https://github.com/twinfoundation/framework/commit/c1b77fcfb61c092a01c97aebb2fe2dc2bbaa221b))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* update dependencies ([f3bd015](https://github.com/twinfoundation/framework/commit/f3bd015efd169196b7e0335f5cab876ba6ca1d75))
+* 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.2-next.2 to 0.0.2-next.3
+    * @twin.org/nameof bumped from 0.0.2-next.2 to 0.0.2-next.3
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/framework/compare/crypto-v0.0.2-next.1...crypto-v0.0.2-next.2) (2025-08-06)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* add rsa cipher support ([7af6cc6](https://github.com/twinfoundation/framework/commit/7af6cc67512d3363bd4a2f2e87bd7733c2800147))
+* change method accessibility ([c1b77fc](https://github.com/twinfoundation/framework/commit/c1b77fcfb61c092a01c97aebb2fe2dc2bbaa221b))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* update dependencies ([f3bd015](https://github.com/twinfoundation/framework/commit/f3bd015efd169196b7e0335f5cab876ba6ca1d75))
+* 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.2-next.1 to 0.0.2-next.2
+    * @twin.org/nameof bumped from 0.0.2-next.1 to 0.0.2-next.2
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.1 to 0.0.2-next.2
+
+## [0.0.2-next.1](https://github.com/twinfoundation/framework/compare/crypto-v0.0.2-next.0...crypto-v0.0.2-next.1) (2025-08-06)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* add rsa cipher support ([7af6cc6](https://github.com/twinfoundation/framework/commit/7af6cc67512d3363bd4a2f2e87bd7733c2800147))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* update dependencies ([f3bd015](https://github.com/twinfoundation/framework/commit/f3bd015efd169196b7e0335f5cab876ba6ca1d75))
+* 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.2-next.0 to 0.0.2-next.1
+    * @twin.org/nameof bumped from 0.0.2-next.0 to 0.0.2-next.1
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.0 to 0.0.2-next.1
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.0 to 0.0.2-next.1
+
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* release to production ([829d53d](https://github.com/twinfoundation/framework/commit/829d53d3953b1e1b40b0243c04cfdfd3842aac7b))
+* release to production ([5cf3a76](https://github.com/twinfoundation/framework/commit/5cf3a76a09eff2e6414d0cba846c7c37400a11d6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from ^0.0.0 to ^0.0.1
+    * @twin.org/nameof bumped from ^0.0.0 to ^0.0.1
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from ^0.0.0 to ^0.0.1
+    * @twin.org/nameof-vitest-plugin bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.70](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.69...crypto-v0.0.1-next.70) (2025-07-02)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* 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.69 to 0.0.1-next.70
+    * @twin.org/nameof bumped from 0.0.1-next.69 to 0.0.1-next.70
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.69 to 0.0.1-next.70
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.69 to 0.0.1-next.70
+
+## [0.0.1-next.69](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.68...crypto-v0.0.1-next.69) (2025-07-02)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* 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.68 to 0.0.1-next.69
+    * @twin.org/nameof bumped from 0.0.1-next.68 to 0.0.1-next.69
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.68 to 0.0.1-next.69
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.68 to 0.0.1-next.69
+
+## [0.0.1-next.68](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.67...crypto-v0.0.1-next.68) (2025-07-02)
+
+
+### Features
+
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.67 to 0.0.1-next.68
+    * @twin.org/nameof bumped from 0.0.1-next.67 to 0.0.1-next.68
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.67 to 0.0.1-next.68
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.67 to 0.0.1-next.68
+
+## [0.0.1-next.67](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.66...crypto-v0.0.1-next.67) (2025-06-26)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.66 to 0.0.1-next.67
+
+## [0.0.1-next.66](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.65...crypto-v0.0.1-next.66) (2025-06-26)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.65 to 0.0.1-next.66
+
+## [0.0.1-next.65](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.64...crypto-v0.0.1-next.65) (2025-06-19)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.64 to 0.0.1-next.65
+
+## [0.0.1-next.64](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.63...crypto-v0.0.1-next.64) (2025-06-19)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.63 to 0.0.1-next.64
+
+## [0.0.1-next.63](https://github.com/twinfoundation/framework/compare/crypto-v0.0.1-next.62...crypto-v0.0.1-next.63) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **crypto:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.62 to 0.0.1-next.63
+
+## [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.