feat: base64, concat, fromutf8 functions

bitcoinjs · Jul 20, 2024 · 4a7c1be · 4a7c1be
1 parent c08cb3b
commit 4a7c1be
Show file tree

Hide file tree

Showing 9 changed files with 774 additions and 491 deletions.
diff --git a/package.json b/package.json
@@ -1,64 +1,66 @@
 {
-  "name": "uint8array-tools",
-  "version": "0.0.7",
-  "description": "A library for dealing with Uint8Arrays.",
-  "homepage": "https://github.com/bitcoinjs/uint8array-tools#readme",
-  "bugs": {
-    "url": "https://github.com/bitcoinjs/uint8array-tools/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/bitcoinjs/uint8array-tools.git"
-  },
-  "main": "./src/cjs/index.cjs",
-  "exports": {
-    "node": {
-      "module": "./src/mjs/index.js",
-      "require": "./src/cjs/index.cjs",
-      "import": "./src/mjs/index.js"
+    "name": "uint8array-tools",
+    "version": "0.0.7",
+    "description": "A library for dealing with Uint8Arrays.",
+    "homepage": "https://github.com/bitcoinjs/uint8array-tools#readme",
+    "bugs": {
+        "url": "https://github.com/bitcoinjs/uint8array-tools/issues"
     },
-    "browser": "./src/mjs/browser.js",
-    "default": "./src/mjs/browser.js"
-  },
-  "types": "src/cjs/index.d.ts",
-  "type": "module",
-  "scripts": {
-    "build": "npm run clean && npm run build-ts && npm run convert-cjs && rm -f ./src/cjs/browser.d.ts",
-    "build-ts": "tsc -p tsconfig.json && tsc -p tsconfig-cjs.json",
-    "clean": "rm -rf ./src/* && rm -rf ./coverage && rm -f ./package-lock.json",
-    "convert-cjs": "for f in ./src/cjs/*.js; do mv -- \"$f\" \"${f%.js}.cjs\"; done",
-    "coverage": "npm run unit -- --coverage",
-    "eslint": "eslint ts_src/*.ts",
-    "format": "npm run eslint -- --fix",
-    "gitdiff:ci": "npm run build && git diff --exit-code",
-    "lint": "npm run eslint",
-    "test": "npm run unit",
-    "unit": "jest --config=jest.json --runInBand"
-  },
-  "keywords": [
-    "uint8array",
-    "hex",
-    "tools"
-  ],
-  "files": [
-    "src"
-  ],
-  "author": "Jonathan Underwood ([email protected])",
-  "license": "MIT",
-  "devDependencies": {
-    "@types/jest": "27.0.2",
-    "@types/node": "16.11.1",
-    "@typescript-eslint/eslint-plugin": "5.0.0",
-    "@typescript-eslint/parser": "5.0.0",
-    "eslint": "8.0.1",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-prettier": "4.0.0",
-    "jest": "27.2.5",
-    "prettier": "2.4.1",
-    "ts-jest": "27.0.7",
-    "typescript": "4.4.4"
-  },
-  "engines": {
-    "node": ">=14.0.0"
-  }
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/bitcoinjs/uint8array-tools.git"
+    },
+    "main": "./src/cjs/index.cjs",
+    "exports": {
+        "node": {
+            "module": "./src/mjs/index.js",
+            "require": "./src/cjs/index.cjs",
+            "import": "./src/mjs/index.js",
+            "types": "./src/cjs/index.d.ts"
+        },
+        "browser": "./src/mjs/browser.js",
+        "default": "./src/mjs/browser.js",
+        "types": "./src/cjs/index.d.ts"
+    },
+    "types": "src/cjs/index.d.ts",
+    "type": "module",
+    "scripts": {
+        "build": "npm run clean && npm run build-ts && npm run convert-cjs && rm -f ./src/cjs/browser.d.ts",
+        "build-ts": "tsc -p tsconfig.json && tsc -p tsconfig-cjs.json",
+        "clean": "rm -rf ./src/* && rm -rf ./coverage && rm -f ./package-lock.json",
+        "convert-cjs": "for f in ./src/cjs/*.js; do mv -- \"$f\" \"${f%.js}.cjs\"; done",
+        "coverage": "npm run unit -- --coverage",
+        "eslint": "eslint ts_src/*.ts",
+        "format": "npm run eslint -- --fix",
+        "gitdiff:ci": "npm run build && git diff --exit-code",
+        "lint": "npm run eslint",
+        "test": "npm run unit",
+        "unit": "jest --config=jest.json --runInBand"
+    },
+    "keywords": [
+        "uint8array",
+        "hex",
+        "tools"
+    ],
+    "files": [
+        "src"
+    ],
+    "author": "Jonathan Underwood ([email protected])",
+    "license": "MIT",
+    "devDependencies": {
+        "@types/jest": "27.0.2",
+        "@types/node": "16.11.1",
+        "@typescript-eslint/eslint-plugin": "5.0.0",
+        "@typescript-eslint/parser": "5.0.0",
+        "eslint": "8.0.1",
+        "eslint-config-prettier": "8.3.0",
+        "eslint-plugin-prettier": "4.0.0",
+        "jest": "27.2.5",
+        "prettier": "2.4.1",
+        "ts-jest": "27.0.7",
+        "typescript": "4.4.4"
+    },
+    "engines": {
+        "node": ">=14.0.0"
+    }
 }
diff --git a/src/cjs/browser.cjs b/src/cjs/browser.cjs
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readUInt64 = exports.readUInt32 = exports.readUInt16 = exports.readUInt8 = exports.writeUInt64 = exports.writeUInt32 = exports.writeUInt16 = exports.writeUInt8 = exports.compare = exports.fromHex = exports.toHex = exports.toUtf8 = void 0;
+exports.readUInt64 = exports.readUInt32 = exports.readUInt16 = exports.readUInt8 = exports.writeUInt64 = exports.writeUInt32 = exports.writeUInt16 = exports.writeUInt8 = exports.compare = exports.fromBase64 = exports.toBase64 = exports.fromHex = exports.toHex = exports.concat = exports.fromUtf8 = exports.toUtf8 = void 0;
 const HEX_STRINGS = "0123456789abcdefABCDEF";
 const HEX_CODES = HEX_STRINGS.split("").map((c) => c.codePointAt(0));
 const HEX_CODEPOINTS = Array(256)
@@ -17,6 +17,21 @@ function toUtf8(bytes) {
     return DECODER.decode(bytes);
 }
 exports.toUtf8 = toUtf8;
+function fromUtf8(s) {
+    return ENCODER.encode(s);
+}
+exports.fromUtf8 = fromUtf8;
+function concat(arrays) {
+    const totalLength = arrays.reduce((a, b) => a + b.length, 0);
+    const result = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const array of arrays) {
+        result.set(array, offset);
+        offset += array.length;
+    }
+    return result;
+}
+exports.concat = concat;
 // There are two implementations.
 // One optimizes for length of the bytes, and uses TextDecoder.
 // One optimizes for iteration count, and appends strings.
@@ -60,6 +75,19 @@ function fromHex(hexString) {
     return i === resultBytes.length ? resultBytes : resultBytes.slice(0, i);
 }
 exports.fromHex = fromHex;
+function toBase64(bytes) {
+    return btoa(String.fromCharCode(...bytes));
+}
+exports.toBase64 = toBase64;
+function fromBase64(base64) {
+    const binaryString = atob(base64);
+    const bytes = new Uint8Array(binaryString.length);
+    for (let i = 0; i < binaryString.length; i++) {
+        bytes[i] = binaryString.charCodeAt(i);
+    }
+    return bytes;
+}
+exports.fromBase64 = fromBase64;
 // Same behavior as Buffer.compare()
 function compare(v1, v2) {
     const minLength = Math.min(v1.length, v2.length);

diff --git a/src/cjs/index.cjs b/src/cjs/index.cjs
@@ -1,10 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readUInt64 = exports.readUInt32 = exports.readUInt16 = exports.readUInt8 = exports.writeUInt64 = exports.writeUInt32 = exports.writeUInt16 = exports.writeUInt8 = exports.compare = exports.fromHex = exports.toHex = exports.toUtf8 = void 0;
+exports.readUInt64 = exports.readUInt32 = exports.readUInt16 = exports.readUInt8 = exports.writeUInt64 = exports.writeUInt32 = exports.writeUInt16 = exports.writeUInt8 = exports.compare = exports.fromBase64 = exports.toBase64 = exports.fromHex = exports.toHex = exports.concat = exports.fromUtf8 = exports.toUtf8 = void 0;
 function toUtf8(bytes) {
     return Buffer.from(bytes || []).toString();
 }
 exports.toUtf8 = toUtf8;
+function fromUtf8(s) {
+    return Uint8Array.from(Buffer.from(s || "", "utf8"));
+}
+exports.fromUtf8 = fromUtf8;
+function concat(arrays) {
+    return Uint8Array.from(Buffer.concat(arrays));
+}
+exports.concat = concat;
 function toHex(bytes) {
     return Buffer.from(bytes || []).toString("hex");
 }
@@ -13,6 +21,14 @@ function fromHex(hexString) {
     return Uint8Array.from(Buffer.from(hexString || "", "hex"));
 }
 exports.fromHex = fromHex;
+function toBase64(bytes) {
+    return Buffer.from(bytes).toString("base64");
+}
+exports.toBase64 = toBase64;
+function fromBase64(base64) {
+    return Uint8Array.from(Buffer.from(base64 || "", "base64"));
+}
+exports.fromBase64 = fromBase64;
 function compare(v1, v2) {
     return Buffer.from(v1).compare(Buffer.from(v2));
 }

diff --git a/src/cjs/index.d.ts b/src/cjs/index.d.ts
@@ -1,6 +1,10 @@
 export declare function toUtf8(bytes: Uint8Array): string;
+export declare function fromUtf8(s: string): Uint8Array;
+export declare function concat(arrays: Uint8Array[]): Uint8Array;
 export declare function toHex(bytes: Uint8Array): string;
 export declare function fromHex(hexString: string): Uint8Array;
+export declare function toBase64(bytes: Uint8Array): string;
+export declare function fromBase64(base64: string): Uint8Array;
 export declare type CompareResult = -1 | 0 | 1;
 export declare function compare(v1: Uint8Array, v2: Uint8Array): CompareResult;
 export declare type endian = "LE" | "BE" | "le" | "be";

diff --git a/src/mjs/browser.js b/src/mjs/browser.js
@@ -13,6 +13,19 @@ const DECODER = new TextDecoder();
 export function toUtf8(bytes) {
     return DECODER.decode(bytes);
 }
+export function fromUtf8(s) {
+    return ENCODER.encode(s);
+}
+export function concat(arrays) {
+    const totalLength = arrays.reduce((a, b) => a + b.length, 0);
+    const result = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const array of arrays) {
+        result.set(array, offset);
+        offset += array.length;
+    }
+    return result;
+}
 // There are two implementations.
 // One optimizes for length of the bytes, and uses TextDecoder.
 // One optimizes for iteration count, and appends strings.
@@ -54,6 +67,17 @@ export function fromHex(hexString) {
     }
     return i === resultBytes.length ? resultBytes : resultBytes.slice(0, i);
 }
+export function toBase64(bytes) {
+    return btoa(String.fromCharCode(...bytes));
+}
+export function fromBase64(base64) {
+    const binaryString = atob(base64);
+    const bytes = new Uint8Array(binaryString.length);
+    for (let i = 0; i < binaryString.length; i++) {
+        bytes[i] = binaryString.charCodeAt(i);
+    }
+    return bytes;
+}
 // Same behavior as Buffer.compare()
 export function compare(v1, v2) {
     const minLength = Math.min(v1.length, v2.length);

diff --git a/src/mjs/index.js b/src/mjs/index.js
@@ -1,12 +1,24 @@
 export function toUtf8(bytes) {
     return Buffer.from(bytes || []).toString();
 }
+export function fromUtf8(s) {
+    return Uint8Array.from(Buffer.from(s || "", "utf8"));
+}
+export function concat(arrays) {
+    return Uint8Array.from(Buffer.concat(arrays));
+}
 export function toHex(bytes) {
     return Buffer.from(bytes || []).toString("hex");
 }
 export function fromHex(hexString) {
     return Uint8Array.from(Buffer.from(hexString || "", "hex"));
 }
+export function toBase64(bytes) {
+    return Buffer.from(bytes).toString("base64");
+}
+export function fromBase64(base64) {
+    return Uint8Array.from(Buffer.from(base64 || "", "base64"));
+}
 export function compare(v1, v2) {
     return Buffer.from(v1).compare(Buffer.from(v2));
 }

diff --git a/ts_src/browser.ts b/ts_src/browser.ts
@@ -15,6 +15,21 @@ export function toUtf8(bytes: Uint8Array): string {
   return DECODER.decode(bytes);
 }
 
+export function fromUtf8(s: string): Uint8Array {
+  return ENCODER.encode(s);
+}
+
+export function concat(arrays: Uint8Array[]): Uint8Array {
+  const totalLength = arrays.reduce((a, b) => a + b.length, 0);
+  const result = new Uint8Array(totalLength);
+  let offset = 0;
+  for (const array of arrays) {
+    result.set(array, offset);
+    offset += array.length;
+  }
+  return result;
+}
+
 // There are two implementations.
 // One optimizes for length of the bytes, and uses TextDecoder.
 // One optimizes for iteration count, and appends strings.
@@ -58,6 +73,19 @@ export function fromHex(hexString: string): Uint8Array {
   return i === resultBytes.length ? resultBytes : resultBytes.slice(0, i);
 }
 
+export function toBase64(bytes: Uint8Array): string {
+  return btoa(String.fromCharCode(...bytes));
+}
+
+export function fromBase64(base64: string): Uint8Array {
+  const binaryString = atob(base64);
+  const bytes = new Uint8Array(binaryString.length);
+  for (let i = 0; i < binaryString.length; i++) {
+    bytes[i] = binaryString.charCodeAt(i);
+  }
+  return bytes;
+}
+
 export type CompareResult = -1 | 0 | 1;
 // Same behavior as Buffer.compare()
 export function compare(v1: Uint8Array, v2: Uint8Array): CompareResult {