@twin.org/core 0.0.1-next.8 → 0.0.1-next.9

package/dist/cjs/index.cjs

@@ -900,6 +900,127 @@ class Base32 {
     }
 }
 
+/**
+ * Class to help with base58 Encoding/Decoding.
+ */
+class Base58 {
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "Base58";
+    /**
+     * Alphabet table for encoding.
+     * @internal
+     */
+    static _ALPHABET = 
+    // cspell:disable-next-line
+    "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
+    /**
+     * Reverse map for decoding.
+     * @internal
+     */
+    static _ALPHABET_REVERSE = [
+        -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+        -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+        -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, -1, -1, -1, -1, 9, 10, 11, 12, 13, 14, 15, 16, -1,
+        17, 18, 19, 20, 21, -1, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, -1, -1, -1, -1, -1, -1, 33,
+        34, 35, 36, 37, 38, 39, 40, 41, 42, 43, -1, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56,
+        57, -1, -1, -1, -1, -1
+    ];
+    /**
+     * Convert the base 58 string to a byte array.
+     * @param base58 The base58 string to convert.
+     * @returns The byte array.
+     * @throws If the input string contains a character not in the Base58 alphabet.
+     */
+    static decode(base58) {
+        let zeroes = 0;
+        for (let i = 0; i < base58.length; i++) {
+            if (base58[i] !== "1") {
+                break;
+            }
+            zeroes += 1;
+        }
+        const size = Math.trunc((base58.length * 733) / 1000) + 1;
+        const b256 = new Uint8Array(size).fill(0);
+        let length = 0;
+        for (let i = zeroes; i < base58.length; i++) {
+            const ch = base58.charCodeAt(i);
+            if (ch & 0xff80) {
+                throw new GeneralError(Base58._CLASS_NAME, "invalidCharacter", { invalidCharacter: ch });
+            }
+            const val = Base58._ALPHABET_REVERSE[ch];
+            if (val === -1) {
+                throw new GeneralError(Base58._CLASS_NAME, "invalidCharacter", { invalidCharacter: ch });
+            }
+            let carry = val;
+            let j = 0;
+            for (let k = size - 1; k >= 0; k--, j++) {
+                if (carry === 0 && j >= length) {
+                    break;
+                }
+                carry += b256[k] * 58;
+                b256[k] = carry;
+                carry >>>= 8;
+            }
+            length = j;
+        }
+        const out = new Uint8Array(zeroes + length);
+        let j;
+        for (j = 0; j < zeroes; j++) {
+            out[j] = 0;
+        }
+        let i = size - length;
+        while (i < size) {
+            out[j++] = b256[i++];
+        }
+        return out;
+    }
+    /**
+     * Convert a byte array to base 58.
+     * @param bytes The byte array to encode.
+     * @returns The data as base58 string.
+     */
+    static encode(bytes) {
+        let zeroes = 0;
+        for (let i = 0; i < bytes.length; i++) {
+            if (bytes[i] !== 0) {
+                break;
+            }
+            zeroes += 1;
+        }
+        const size = Math.trunc(((bytes.length - zeroes) * 138) / 100) + 1;
+        const b58 = new Uint8Array(size).fill(0);
+        let length = 0;
+        for (let i = zeroes; i < bytes.length; i++) {
+            let carry = bytes[i];
+            let j = 0;
+            for (let k = size - 1; k >= 0; k--, j++) {
+                if (carry === 0 && j >= length) {
+                    break;
+                }
+                carry += b58[k] * 256;
+                b58[k] = carry % 58;
+                carry = Math.trunc(carry / 58);
+            }
+            length = j;
+        }
+        let i = size - length;
+        while (i < size && b58[i] === 0) {
+            i += 1;
+        }
+        let str = "";
+        for (let j = 0; j < zeroes; j++) {
+            str += "1";
+        }
+        while (i < size) {
+            str += Base58._ALPHABET[b58[i++]];
+        }
+        return str;
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /* eslint-disable no-bitwise */
@@ -2661,6 +2782,22 @@ class Converter {
     static base64UrlToBytes(base64Url) {
         return Base64Url.decode(base64Url);
     }
+    /**
+     * Convert bytes to base58 string.
+     * @param bytes The bytes to convert.
+     * @returns A base58 string of the bytes.
+     */
+    static bytesToBase58(bytes) {
+        return Base58.encode(bytes);
+    }
+    /**
+     * Convert a base58 string to bytes.
+     * @param base58 The base58 string.
+     * @returns The bytes.
+     */
+    static base58ToBytes(base58) {
+        return Base58.decode(base58);
+    }
     /**
      * Build the static lookup tables.
      * @internal
@@ -4207,6 +4344,7 @@ exports.AlreadyExistsError = AlreadyExistsError;
 exports.ArrayHelper = ArrayHelper;
 exports.AsyncCache = AsyncCache;
 exports.Base32 = Base32;
+exports.Base58 = Base58;
 exports.Base64 = Base64;
 exports.Base64Url = Base64Url;
 exports.BaseError = BaseError;

package/dist/esm/index.mjs

@@ -898,6 +898,127 @@ class Base32 {
     }
 }
 
+/**
+ * Class to help with base58 Encoding/Decoding.
+ */
+class Base58 {
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "Base58";
+    /**
+     * Alphabet table for encoding.
+     * @internal
+     */
+    static _ALPHABET = 
+    // cspell:disable-next-line
+    "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
+    /**
+     * Reverse map for decoding.
+     * @internal
+     */
+    static _ALPHABET_REVERSE = [
+        -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+        -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+        -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, -1, -1, -1, -1, 9, 10, 11, 12, 13, 14, 15, 16, -1,
+        17, 18, 19, 20, 21, -1, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, -1, -1, -1, -1, -1, -1, 33,
+        34, 35, 36, 37, 38, 39, 40, 41, 42, 43, -1, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56,
+        57, -1, -1, -1, -1, -1
+    ];
+    /**
+     * Convert the base 58 string to a byte array.
+     * @param base58 The base58 string to convert.
+     * @returns The byte array.
+     * @throws If the input string contains a character not in the Base58 alphabet.
+     */
+    static decode(base58) {
+        let zeroes = 0;
+        for (let i = 0; i < base58.length; i++) {
+            if (base58[i] !== "1") {
+                break;
+            }
+            zeroes += 1;
+        }
+        const size = Math.trunc((base58.length * 733) / 1000) + 1;
+        const b256 = new Uint8Array(size).fill(0);
+        let length = 0;
+        for (let i = zeroes; i < base58.length; i++) {
+            const ch = base58.charCodeAt(i);
+            if (ch & 0xff80) {
+                throw new GeneralError(Base58._CLASS_NAME, "invalidCharacter", { invalidCharacter: ch });
+            }
+            const val = Base58._ALPHABET_REVERSE[ch];
+            if (val === -1) {
+                throw new GeneralError(Base58._CLASS_NAME, "invalidCharacter", { invalidCharacter: ch });
+            }
+            let carry = val;
+            let j = 0;
+            for (let k = size - 1; k >= 0; k--, j++) {
+                if (carry === 0 && j >= length) {
+                    break;
+                }
+                carry += b256[k] * 58;
+                b256[k] = carry;
+                carry >>>= 8;
+            }
+            length = j;
+        }
+        const out = new Uint8Array(zeroes + length);
+        let j;
+        for (j = 0; j < zeroes; j++) {
+            out[j] = 0;
+        }
+        let i = size - length;
+        while (i < size) {
+            out[j++] = b256[i++];
+        }
+        return out;
+    }
+    /**
+     * Convert a byte array to base 58.
+     * @param bytes The byte array to encode.
+     * @returns The data as base58 string.
+     */
+    static encode(bytes) {
+        let zeroes = 0;
+        for (let i = 0; i < bytes.length; i++) {
+            if (bytes[i] !== 0) {
+                break;
+            }
+            zeroes += 1;
+        }
+        const size = Math.trunc(((bytes.length - zeroes) * 138) / 100) + 1;
+        const b58 = new Uint8Array(size).fill(0);
+        let length = 0;
+        for (let i = zeroes; i < bytes.length; i++) {
+            let carry = bytes[i];
+            let j = 0;
+            for (let k = size - 1; k >= 0; k--, j++) {
+                if (carry === 0 && j >= length) {
+                    break;
+                }
+                carry += b58[k] * 256;
+                b58[k] = carry % 58;
+                carry = Math.trunc(carry / 58);
+            }
+            length = j;
+        }
+        let i = size - length;
+        while (i < size && b58[i] === 0) {
+            i += 1;
+        }
+        let str = "";
+        for (let j = 0; j < zeroes; j++) {
+            str += "1";
+        }
+        while (i < size) {
+            str += Base58._ALPHABET[b58[i++]];
+        }
+        return str;
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /* eslint-disable no-bitwise */
@@ -2659,6 +2780,22 @@ class Converter {
     static base64UrlToBytes(base64Url) {
         return Base64Url.decode(base64Url);
     }
+    /**
+     * Convert bytes to base58 string.
+     * @param bytes The bytes to convert.
+     * @returns A base58 string of the bytes.
+     */
+    static bytesToBase58(bytes) {
+        return Base58.encode(bytes);
+    }
+    /**
+     * Convert a base58 string to bytes.
+     * @param base58 The base58 string.
+     * @returns The bytes.
+     */
+    static base58ToBytes(base58) {
+        return Base58.decode(base58);
+    }
     /**
      * Build the static lookup tables.
      * @internal
@@ -4201,4 +4338,4 @@ class Validation {
     }
 }
 
-export { AlreadyExistsError, ArrayHelper, AsyncCache, Base32, Base64, Base64Url, BaseError, BitString, Coerce, ComponentFactory, Compression, CompressionType, ConflictError, Converter, ErrorHelper, Factory, FilenameHelper, GeneralError, GuardError, Guards, HexHelper, I18n, Is, JsonHelper, NotFoundError, NotImplementedError, NotSupportedError, ObjectHelper, RandomHelper, StringHelper, UnauthorizedError, UnprocessableError, Url, Urn, Validation, ValidationError };
+export { AlreadyExistsError, ArrayHelper, AsyncCache, Base32, Base58, Base64, Base64Url, BaseError, BitString, Coerce, ComponentFactory, Compression, CompressionType, ConflictError, Converter, ErrorHelper, Factory, FilenameHelper, GeneralError, GuardError, Guards, HexHelper, I18n, Is, JsonHelper, NotFoundError, NotImplementedError, NotSupportedError, ObjectHelper, RandomHelper, StringHelper, UnauthorizedError, UnprocessableError, Url, Urn, Validation, ValidationError };

package/dist/types/encoding/base58.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Class to help with base58 Encoding/Decoding.
+ */
+export declare class Base58 {
+    /**
+     * Convert the base 58 string to a byte array.
+     * @param base58 The base58 string to convert.
+     * @returns The byte array.
+     * @throws If the input string contains a character not in the Base58 alphabet.
+     */
+    static decode(base58: string): Uint8Array;
+    /**
+     * Convert a byte array to base 58.
+     * @param bytes The byte array to encode.
+     * @returns The data as base58 string.
+     */
+    static encode(bytes: Uint8Array): string;
+}

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./encoding/base32";
+export * from "./encoding/base58";
 export * from "./encoding/base64";
 export * from "./encoding/base64Url";
 export * from "./errors/alreadyExistsError";

package/dist/types/utils/converter.d.ts

@@ -82,4 +82,16 @@ export declare class Converter {
      * @returns The bytes.
      */
     static base64UrlToBytes(base64Url: string): Uint8Array;
+    /**
+     * Convert bytes to base58 string.
+     * @param bytes The bytes to convert.
+     * @returns A base58 string of the bytes.
+     */
+    static bytesToBase58(bytes: Uint8Array): string;
+    /**
+     * Convert a base58 string to bytes.
+     * @param base58 The base58 string.
+     * @returns The bytes.
+     */
+    static base58ToBytes(base58: string): Uint8Array;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/core - Changelog
 
-## 0.0.1-next.8
+## 0.0.1-next.9
 
 - Initial Release

package/docs/reference/classes/Base58.md

@@ -0,0 +1,57 @@
+# Class: Base58
+
+Class to help with base58 Encoding/Decoding.
+
+## Constructors
+
+### new Base58()
+
+> **new Base58**(): [`Base58`](Base58.md)
+
+#### Returns
+
+[`Base58`](Base58.md)
+
+## Methods
+
+### decode()
+
+> `static` **decode**(`base58`): `Uint8Array`
+
+Convert the base 58 string to a byte array.
+
+#### Parameters
+
+• **base58**: `string`
+
+The base58 string to convert.
+
+#### Returns
+
+`Uint8Array`
+
+The byte array.
+
+#### Throws
+
+If the input string contains a character not in the Base58 alphabet.
+
+***
+
+### encode()
+
+> `static` **encode**(`bytes`): `string`
+
+Convert a byte array to base 58.
+
+#### Parameters
+
+• **bytes**: `Uint8Array`
+
+The byte array to encode.
+
+#### Returns
+
+`string`
+
+The data as base58 string.

package/docs/reference/classes/Converter.md

@@ -283,3 +283,43 @@ The base64 url string.
 `Uint8Array`
 
 The bytes.
+
+***
+
+### bytesToBase58()
+
+> `static` **bytesToBase58**(`bytes`): `string`
+
+Convert bytes to base58 string.
+
+#### Parameters
+
+• **bytes**: `Uint8Array`
+
+The bytes to convert.
+
+#### Returns
+
+`string`
+
+A base58 string of the bytes.
+
+***
+
+### base58ToBytes()
+
+> `static` **base58ToBytes**(`base58`): `Uint8Array`
+
+Convert a base58 string to bytes.
+
+#### Parameters
+
+• **base58**: `string`
+
+The base58 string.
+
+#### Returns
+
+`Uint8Array`
+
+The bytes.

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Classes
 
 - [Base32](classes/Base32.md)
+- [Base58](classes/Base58.md)
 - [Base64](classes/Base64.md)
 - [Base64Url](classes/Base64Url.md)
 - [AlreadyExistsError](classes/AlreadyExistsError.md)

package/locales/en.json

@@ -78,6 +78,15 @@
 		},
 		"bitString": {
 			"outOfRange": "The index should be >= 0 and less than the length of the bit string"
+		},
+		"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}\""
+		},
+		"base58": {
+			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
 		}
 	},
 	"errorNames": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1-next.9",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",