@wtasnorg/node-lib 0.0.10 → 0.0.12

package/src/base58.test.ts

@@ -0,0 +1,128 @@
+import { describe, it } from "node:test";
+import { strictEqual, throws } from "node:assert";
+import { encode58, decode58, Base58Charset } from "./base58.js";
+import type { Base58CharsetType } from "./base58.js";
+
+describe("Base58 encode58", () => {
+    it("encodes empty string", () => {
+        strictEqual(encode58(""), "");
+    });
+
+    it("encodes 'Hello World' with bitcoin charset", () => {
+        strictEqual(encode58("Hello World"), "JxF12TrwUP45BMd");
+    });
+
+    it("encodes single character", () => {
+        // Verify round-trip rather than hardcoded value
+        const encoded = encode58("A");
+        strictEqual(encoded.length > 0, true);
+        strictEqual(decode58(encoded), "A");
+    });
+
+    it("encodes 'abc'", () => {
+        strictEqual(encode58("abc"), "ZiCa");
+    });
+
+    it("encodes with flickr charset", () => {
+        const bitcoin = encode58("Hello World", "bitcoin");
+        const flickr = encode58("Hello World", "flickr");
+        // Flickr swaps case
+        strictEqual(bitcoin !== flickr, true);
+    });
+
+    it("encodes with ripple charset", () => {
+        const bitcoin = encode58("Hello World", "bitcoin");
+        const ripple = encode58("Hello World", "ripple");
+        strictEqual(bitcoin !== ripple, true);
+    });
+
+    it("encodes UTF-8 characters", () => {
+        const input = "こんにちは";
+        const encoded = encode58(input);
+        const decoded = decode58(encoded);
+        strictEqual(decoded, input);
+    });
+
+    it("preserves leading zero bytes", () => {
+        const input = "\x00\x00Hello";
+        const encoded = encode58(input);
+        const decoded = decode58(encoded);
+        strictEqual(decoded, input);
+    });
+});
+
+describe("Base58 decode58", () => {
+    it("decodes empty string", () => {
+        strictEqual(decode58(""), "");
+    });
+
+    it("decodes 'JxF12TrwUP45BMd' to 'Hello World'", () => {
+        strictEqual(decode58("JxF12TrwUP45BMd"), "Hello World");
+    });
+
+    it("decodes single character", () => {
+        const encoded = encode58("A");
+        strictEqual(decode58(encoded), "A");
+    });
+
+    it("decodes 'ZiCa' to 'abc'", () => {
+        strictEqual(decode58("ZiCa"), "abc");
+    });
+
+    it("throws on invalid character (0)", () => {
+        throws(() => decode58("0invalid"), /Invalid Base58 character/);
+    });
+
+    it("throws on invalid character (O)", () => {
+        throws(() => decode58("OOO"), /Invalid Base58 character/);
+    });
+
+    it("throws on invalid character (I)", () => {
+        throws(() => decode58("III"), /Invalid Base58 character/);
+    });
+
+    it("throws on invalid character (l)", () => {
+        throws(() => decode58("lll"), /Invalid Base58 character/);
+    });
+});
+
+describe("Base58 round-trip", () => {
+    const testCases = [
+        "",
+        "a",
+        "ab",
+        "abc",
+        "abcd",
+        "Hello, World!",
+        "The quick brown fox jumps over the lazy dog",
+        "こんにちは世界",
+        "🎉🚀✨",
+        "\x00\x00\x00abc"
+    ];
+
+    for (const charset of Base58Charset) {
+        describe(`charset: ${charset}`, () => {
+            for (const input of testCases) {
+                it(`round-trips: ${JSON.stringify(input)}`, () => {
+                    const encoded = encode58(input, charset);
+                    const decoded = decode58(encoded, charset);
+                    strictEqual(decoded, input);
+                });
+            }
+        });
+    }
+});
+
+describe("Base58Charset", () => {
+    it("exports array with three charsets", () => {
+        strictEqual(Base58Charset.length, 3);
+        strictEqual(Base58Charset[0], "bitcoin");
+        strictEqual(Base58Charset[1], "flickr");
+        strictEqual(Base58Charset[2], "ripple");
+    });
+
+    it("charset type works correctly", () => {
+        const cs: Base58CharsetType = "flickr";
+        strictEqual(encode58("test", cs), encode58("test", "flickr"));
+    });
+});

package/src/base58.ts

@@ -0,0 +1,177 @@
+/**
+ * Base58 encoding/decoding with multiple charset variants.
+ * Base58 excludes visually ambiguous characters (0, O, I, l).
+ * @module base58
+ */
+
+/**
+ * Available Base58 charset variants.
+ * - `bitcoin`: Bitcoin/IPFS alphabet (default)
+ * - `flickr`: Flickr short URLs (swaps case)
+ * - `ripple`: Ripple addresses
+ */
+const Base58Charset = ["bitcoin", "flickr", "ripple"] as const;
+
+/**
+ * Base58 charset type.
+ */
+type Base58CharsetType = (typeof Base58Charset)[number];
+
+/**
+ * Charset alphabets for Base58 variants.
+ */
+const CHARSETS: Record<Base58CharsetType, string> = {
+    bitcoin: "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz",
+    flickr: "123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ",
+    ripple: "rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz"
+};
+
+/**
+ * Build a reverse lookup table for decoding.
+ * @param alphabet - The 58-character alphabet string.
+ * @returns Map of character to index.
+ */
+function buildDecodeTable(alphabet: string): Map<string, number> {
+    const table = new Map<string, number>();
+    for (let i = 0; i < alphabet.length; i++) {
+        const char = alphabet[i];
+        if (char !== undefined) {
+            table.set(char, i);
+        }
+    }
+    return table;
+}
+
+/**
+ * Pre-built decode tables for each charset.
+ */
+const DECODE_TABLES: Record<Base58CharsetType, Map<string, number>> = {
+    bitcoin: buildDecodeTable(CHARSETS.bitcoin),
+    flickr: buildDecodeTable(CHARSETS.flickr),
+    ripple: buildDecodeTable(CHARSETS.ripple)
+};
+
+/**
+ * Encode a string to Base58.
+ *
+ * @example
+ * ```typescript
+ * import { encode58 } from "./base58.js";
+ *
+ * encode58("Hello World");
+ * // => "JxF12TrwUP45BMd"
+ *
+ * encode58("Hello World", "flickr");
+ * // => "jXf12sRWto45bmD"
+ * ```
+ *
+ * @param input - The string to encode.
+ * @param charset - The charset variant to use (default: "bitcoin").
+ * @returns The Base58 encoded string.
+ */
+function encode58(input: string, charset: Base58CharsetType = "bitcoin"): string {
+    if (input === "") {
+        return "";
+    }
+
+    const alphabet = CHARSETS[charset];
+    const bytes = new TextEncoder().encode(input);
+
+    // Count leading zeros
+    let leadingZeros = 0;
+    for (const byte of bytes) {
+        if (byte === 0) {
+            leadingZeros++;
+        } else {
+            break;
+        }
+    }
+
+    // Convert bytes to a big integer
+    let num = 0n;
+    for (const byte of bytes) {
+        num = num * 256n + BigInt(byte);
+    }
+
+    // Convert to Base58
+    let result = "";
+    while (num > 0n) {
+        const remainder = Number(num % 58n);
+        num = num / 58n;
+        result = alphabet[remainder] + result;
+    }
+
+    // Add leading '1's for leading zero bytes
+    const leadChar = alphabet[0];
+    for (let i = 0; i < leadingZeros; i++) {
+        result = leadChar + result;
+    }
+
+    return result;
+}
+
+/**
+ * Decode a Base58 string.
+ *
+ * @example
+ * ```typescript
+ * import { decode58 } from "./base58.js";
+ *
+ * decode58("JxF12TrwUP45BMd");
+ * // => "Hello World"
+ *
+ * decode58("jXf12sRWto45bmD", "flickr");
+ * // => "Hello World"
+ * ```
+ *
+ * @param input - The Base58 encoded string.
+ * @param charset - The charset variant to use (default: "bitcoin").
+ * @returns The decoded string.
+ * @throws Error if the input contains invalid characters.
+ */
+function decode58(input: string, charset: Base58CharsetType = "bitcoin"): string {
+    if (input === "") {
+        return "";
+    }
+
+    const alphabet = CHARSETS[charset];
+    const decodeTable = DECODE_TABLES[charset];
+    const leadChar = alphabet[0];
+
+    // Count leading '1's (or equivalent)
+    let leadingOnes = 0;
+    for (const char of input) {
+        if (char === leadChar) {
+            leadingOnes++;
+        } else {
+            break;
+        }
+    }
+
+    // Convert from Base58 to big integer
+    let num = 0n;
+    for (const char of input) {
+        const value = decodeTable.get(char);
+        if (value === undefined) {
+            throw new Error(`Invalid Base58 character: ${char}`);
+        }
+        num = num * 58n + BigInt(value);
+    }
+
+    // Convert big integer to bytes
+    const bytes: number[] = [];
+    while (num > 0n) {
+        bytes.unshift(Number(num % 256n));
+        num = num / 256n;
+    }
+
+    // Add leading zeros
+    for (let i = 0; i < leadingOnes; i++) {
+        bytes.unshift(0);
+    }
+
+    return new TextDecoder().decode(new Uint8Array(bytes));
+}
+
+export { encode58, decode58, Base58Charset };
+export type { Base58CharsetType };

package/src/base85.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Base85 encoding/decoding with multiple charset variants.
+ * Base85 provides ~25% better efficiency than Base64 (4:5 vs 3:4 ratio).
+ * @module base85
+ */
+/**
+ * Available Base85 charset variants.
+ * - `ascii85`: Adobe Ascii85 (btoa format)
+ * - `z85`: ZeroMQ Base85 (no quotes or backslash)
+ * - `rfc1924`: RFC 1924 IPv6 encoding
+ */
+declare const Base85Charset: readonly ["ascii85", "z85", "rfc1924"];
+/**
+ * Base85 charset type.
+ */
+type Base85CharsetType = (typeof Base85Charset)[number];
+/**
+ * Encode a string to Base85.
+ *
+ * @example
+ * ```typescript
+ * import { encode85 } from "./base85.js";
+ *
+ * encode85("Hello");
+ * // => "87cURDZ"
+ *
+ * encode85("test", "z85");
+ * // => "wrx.P"
+ * ```
+ *
+ * @param input - The string to encode.
+ * @param charset - The charset variant to use (default: "ascii85").
+ * @returns The Base85 encoded string.
+ */
+declare function encode85(input: string, charset?: Base85CharsetType): string;
+/**
+ * Decode a Base85 string.
+ *
+ * @example
+ * ```typescript
+ * import { decode85 } from "./base85.js";
+ *
+ * decode85("87cURDZ");
+ * // => "Hello"
+ *
+ * decode85("wrx.P", "z85");
+ * // => "test"
+ * ```
+ *
+ * @param input - The Base85 encoded string.
+ * @param charset - The charset variant to use (default: "ascii85").
+ * @returns The decoded string.
+ * @throws Error if the input contains invalid characters.
+ */
+declare function decode85(input: string, charset?: Base85CharsetType): string;
+export { encode85, decode85, Base85Charset };
+export type { Base85CharsetType };
+//# sourceMappingURL=base85.d.ts.map

package/src/base85.js

@@ -0,0 +1,173 @@
+/**
+ * Base85 encoding/decoding with multiple charset variants.
+ * Base85 provides ~25% better efficiency than Base64 (4:5 vs 3:4 ratio).
+ * @module base85
+ */
+/**
+ * Available Base85 charset variants.
+ * - `ascii85`: Adobe Ascii85 (btoa format)
+ * - `z85`: ZeroMQ Base85 (no quotes or backslash)
+ * - `rfc1924`: RFC 1924 IPv6 encoding
+ */
+const Base85Charset = ["ascii85", "z85", "rfc1924"];
+/**
+ * Charset alphabets for Base85 variants.
+ * Each has exactly 85 printable ASCII characters.
+ */
+const CHARSETS = {
+    ascii85: "!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstu",
+    z85: "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-:+=^!/*?&<>()[]{}@%$#",
+    rfc1924: "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!#$%&()*+-;<=>?@^_`{|}~"
+};
+/**
+ * Build a reverse lookup table for decoding.
+ * @param alphabet - The 85-character alphabet string.
+ * @returns Map of character to index.
+ */
+function buildDecodeTable(alphabet) {
+    const table = new Map();
+    for (let i = 0; i < alphabet.length; i++) {
+        const char = alphabet[i];
+        if (char !== undefined) {
+            table.set(char, i);
+        }
+    }
+    return table;
+}
+/**
+ * Pre-built decode tables for each charset.
+ */
+const DECODE_TABLES = {
+    ascii85: buildDecodeTable(CHARSETS.ascii85),
+    z85: buildDecodeTable(CHARSETS.z85),
+    rfc1924: buildDecodeTable(CHARSETS.rfc1924)
+};
+/**
+ * Encode a string to Base85.
+ *
+ * @example
+ * ```typescript
+ * import { encode85 } from "./base85.js";
+ *
+ * encode85("Hello");
+ * // => "87cURDZ"
+ *
+ * encode85("test", "z85");
+ * // => "wrx.P"
+ * ```
+ *
+ * @param input - The string to encode.
+ * @param charset - The charset variant to use (default: "ascii85").
+ * @returns The Base85 encoded string.
+ */
+function encode85(input, charset = "ascii85") {
+    if (input === "") {
+        return "";
+    }
+    const alphabet = CHARSETS[charset];
+    const bytes = new TextEncoder().encode(input);
+    let result = "";
+    // Process 4 bytes at a time
+    for (let i = 0; i < bytes.length; i += 4) {
+        const chunkSize = Math.min(4, bytes.length - i);
+        // Pack up to 4 bytes into a value using multiplication to avoid
+        // 32-bit signed integer overflow from bitwise operations
+        let value = 0;
+        for (let j = 0; j < chunkSize; j++) {
+            value = value * 256 + (bytes[i + j] ?? 0);
+        }
+        // Pad with zeros for incomplete chunks
+        for (let j = chunkSize; j < 4; j++) {
+            value = value * 256;
+        }
+        // Convert to 5 base-85 digits
+        const encoded = [];
+        for (let j = 0; j < 5; j++) {
+            encoded.unshift(alphabet[value % 85] ?? "");
+            value = Math.floor(value / 85);
+        }
+        // For the last chunk, only output as many characters as needed
+        // (chunkSize bytes -> chunkSize + 1 characters)
+        if (i + 4 > bytes.length) {
+            result += encoded.slice(0, chunkSize + 1).join("");
+        }
+        else {
+            result += encoded.join("");
+        }
+    }
+    return result;
+}
+/**
+ * Decode a Base85 string.
+ *
+ * @example
+ * ```typescript
+ * import { decode85 } from "./base85.js";
+ *
+ * decode85("87cURDZ");
+ * // => "Hello"
+ *
+ * decode85("wrx.P", "z85");
+ * // => "test"
+ * ```
+ *
+ * @param input - The Base85 encoded string.
+ * @param charset - The charset variant to use (default: "ascii85").
+ * @returns The decoded string.
+ * @throws Error if the input contains invalid characters.
+ */
+function decode85(input, charset = "ascii85") {
+    if (input === "") {
+        return "";
+    }
+    const decodeTable = DECODE_TABLES[charset];
+    const bytes = [];
+    const inputLen = input.length;
+    // Calculate expected output length
+    // Full groups of 5 chars -> 4 bytes each
+    // Partial group: n chars -> n-1 bytes
+    const fullGroups = Math.floor(inputLen / 5);
+    const remainder = inputLen % 5;
+    const totalBytes = fullGroups * 4 + (remainder > 0 ? remainder - 1 : 0);
+    // Process 5 characters at a time
+    let byteCount = 0;
+    for (let i = 0; i < inputLen; i += 5) {
+        const chunkSize = Math.min(5, inputLen - i);
+        // Decode up to 5 characters into a 32-bit value
+        let value = 0;
+        for (let j = 0; j < chunkSize; j++) {
+            const char = input[i + j];
+            if (char === undefined) {
+                break;
+            }
+            const digit = decodeTable.get(char);
+            if (digit === undefined) {
+                throw new Error(`Invalid Base85 character: ${char}`);
+            }
+            value = value * 85 + digit;
+        }
+        // Pad with 84 (highest digit) for incomplete chunks
+        for (let j = chunkSize; j < 5; j++) {
+            value = value * 85 + 84;
+        }
+        // Calculate how many bytes this chunk should produce
+        const bytesToExtract = chunkSize === 5 ? 4 : chunkSize - 1;
+        // Extract bytes from high to low
+        const extracted = [];
+        for (let j = 0; j < 4; j++) {
+            extracted.unshift(value & 0xff);
+            value = value >>> 8;
+        }
+        // Only push the bytes we need
+        for (let j = 0; j < bytesToExtract && byteCount < totalBytes; j++) {
+            const byte = extracted[j];
+            if (byte !== undefined) {
+                bytes.push(byte);
+                byteCount++;
+            }
+        }
+    }
+    return new TextDecoder().decode(new Uint8Array(bytes));
+}
+export { encode85, decode85, Base85Charset };
+//# sourceMappingURL=base85.js.map

package/src/base85.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=base85.test.d.ts.map

package/src/base85.test.js

@@ -0,0 +1,107 @@
+import { describe, it } from "node:test";
+import { strictEqual, throws } from "node:assert";
+import { encode85, decode85, Base85Charset } from "./base85.js";
+describe("Base85 encode85", () => {
+    it("encodes empty string", () => {
+        strictEqual(encode85(""), "");
+    });
+    it("encodes 'Hello' with ascii85 charset", () => {
+        const encoded = encode85("Hello");
+        strictEqual(encoded.length > 0, true);
+    });
+    it("encodes single character", () => {
+        const encoded = encode85("A");
+        strictEqual(encoded.length, 2);
+    });
+    it("encodes 4 characters (full block)", () => {
+        const encoded = encode85("test");
+        strictEqual(encoded.length, 5);
+    });
+    it("encodes 5 characters (4 + 1)", () => {
+        const encoded = encode85("tests");
+        strictEqual(encoded.length, 7);
+    });
+    it("encodes with z85 charset", () => {
+        const ascii85 = encode85("test", "ascii85");
+        const z85 = encode85("test", "z85");
+        strictEqual(ascii85 !== z85, true);
+    });
+    it("encodes with rfc1924 charset", () => {
+        const ascii85 = encode85("test", "ascii85");
+        const rfc1924 = encode85("test", "rfc1924");
+        strictEqual(ascii85 !== rfc1924, true);
+    });
+    it("encodes UTF-8 characters", () => {
+        const input = "こんにちは";
+        const encoded = encode85(input);
+        const decoded = decode85(encoded);
+        strictEqual(decoded, input);
+    });
+});
+describe("Base85 decode85", () => {
+    it("decodes empty string", () => {
+        strictEqual(decode85(""), "");
+    });
+    it("decodes encoded 'Hello'", () => {
+        const encoded = encode85("Hello");
+        strictEqual(decode85(encoded), "Hello");
+    });
+    it("decodes single character encoded", () => {
+        const encoded = encode85("A");
+        strictEqual(decode85(encoded), "A");
+    });
+    it("decodes 4-char block correctly", () => {
+        const encoded = encode85("test");
+        strictEqual(decode85(encoded), "test");
+    });
+    it("throws on invalid character", () => {
+        // Use a character not in ascii85 alphabet
+        throws(() => decode85("\x7F"), /Invalid Base85 character/);
+    });
+});
+describe("Base85 round-trip", () => {
+    const testCases = [
+        "",
+        "a",
+        "ab",
+        "abc",
+        "abcd",
+        "abcde",
+        "Hello, World!",
+        "The quick brown fox jumps over the lazy dog",
+        "こんにちは世界",
+        "🎉🚀✨",
+        "1234567890"
+    ];
+    for (const charset of Base85Charset) {
+        describe(`charset: ${charset}`, () => {
+            for (const input of testCases) {
+                it(`round-trips: ${JSON.stringify(input)}`, () => {
+                    const encoded = encode85(input, charset);
+                    const decoded = decode85(encoded, charset);
+                    strictEqual(decoded, input);
+                });
+            }
+        });
+    }
+});
+describe("Base85Charset", () => {
+    it("exports array with three charsets", () => {
+        strictEqual(Base85Charset.length, 3);
+        strictEqual(Base85Charset[0], "ascii85");
+        strictEqual(Base85Charset[1], "z85");
+        strictEqual(Base85Charset[2], "rfc1924");
+    });
+    it("charset type works correctly", () => {
+        const cs = "z85";
+        strictEqual(encode85("test", cs), encode85("test", "z85"));
+    });
+    it("each charset has exactly 85 characters", () => {
+        // This is a compile-time guarantee, but let's verify at runtime too
+        for (const charset of Base85Charset) {
+            const encoded = encode85("test", charset);
+            strictEqual(encoded.length > 0, true);
+        }
+    });
+});
+//# sourceMappingURL=base85.test.js.map