@exodus/bip322-js 1.1.0-rc.0 → 1.1.0

package/dist/helpers/BIP137.js

@@ -1,7 +1,42 @@
-import secp256k1 from '@exodus/secp256k1';
-import * as bitcoinMessage from 'bitcoinjs-message';
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import dependencies
+const secp256k1_1 = require("@exodus/secp256k1");
+const bitcoinMessage = __importStar(require("bitcoinjs-message"));
+/**
+ * Class that implement BIP137-related utility functions.
+ */
 class BIP137 {
+    /**
+     * Check if a given signature satisified the format of a BIP-137 signature.
+     * @param signature Base64-encoded signature to be checked
+     * @returns True if the provided signature correspond to a valid BIP-137 signature, false if otherwise
+     */
     static isBIP137Signature(signature) {
+        // Check if the provided signature satisified the format of a BIP-137 signature
         const signatureBuffer = Buffer.from(signature, 'base64');
         if (signatureBuffer.byteLength === 65) {
             return true;
@@ -10,12 +45,27 @@ class BIP137 {
             return false;
         }
     }
+    /**
+     * Derive the public key that signed a valid BIP-137 signature.
+     * @param message Message signed by the signature
+     * @param signature Base-64 encoded signature to be decoded
+     * @returns Public key that signs the provided signature
+     */
     static derivePubKey(message, signature) {
+        // Compute the hash signed by the signer
         const messageHash = bitcoinMessage.magicHash(message);
+        // Decode the provided BIP-137 signature
         const signatureDecoded = this.decodeSignature(Buffer.from(signature, 'base64'));
-        const recoveredPublicKey = secp256k1.ecdsaRecover(signatureDecoded.signature, signatureDecoded.recovery, messageHash, signatureDecoded.compressed);
+        // Recover the public key
+        const recoveredPublicKey = (0, secp256k1_1.ecdsaRecover)(signatureDecoded.signature, signatureDecoded.recovery, messageHash, signatureDecoded.compressed);
         return Buffer.from(recoveredPublicKey);
     }
+    /**
+     * Decode a BIP-137 signature.
+     * Function copied from bitcoinjs-message library.
+     * @param signature BIP-137 signature to be decoded
+     * @returns Decoded BIP-137 signature
+     */
     static decodeSignature(signature) {
         if (signature.length !== 65)
             throw new Error('Invalid signature length');
@@ -30,5 +80,5 @@ class BIP137 {
         };
     }
 }
-export default BIP137;
+exports.default = BIP137;
 //# sourceMappingURL=BIP137.js.map

package/dist/helpers/VarInt.d.ts

@@ -1,5 +1,22 @@
+/// <reference types="node" />
+/**
+ * Class that implement variable length integer (VarInt) in Javascript.
+ * Reference: https://en.bitcoin.it/wiki/Protocol_documentation#Variable_length_integer
+ */
 declare class VarInt {
+    /**
+     * Encode an integer i as a variable length integer.
+     * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/helper.py#L180
+     * @param i Integer to be encoded
+     * @returns Encoded varint
+     */
     static encode(i: number): Buffer;
+    /**
+     * Decode a variable length integer from a Buffer into a number.
+     * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/helper.py#L160
+     * @param b Buffer which contain the varint
+     * @returns Decoded number
+     */
     static decode(b: Buffer): number;
 }
 export default VarInt;

package/dist/helpers/VarInt.js

@@ -1,4 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Class that implement variable length integer (VarInt) in Javascript.
+ * Reference: https://en.bitcoin.it/wiki/Protocol_documentation#Variable_length_integer
+ */
 class VarInt {
+    /**
+     * Encode an integer i as a variable length integer.
+     * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/helper.py#L180
+     * @param i Integer to be encoded
+     * @returns Encoded varint
+     */
     static encode(i) {
         if (i < 0xFD) {
             const buffer = Buffer.alloc(1);
@@ -20,8 +32,8 @@ class VarInt {
         else if (i < 0x1000000000000) {
             const buffer = Buffer.alloc(9);
             buffer.writeUInt8(0xff);
-            buffer.writeUIntLE(i, 1, 6);
-            buffer.writeUInt8(0x00, 7);
+            buffer.writeUIntLE(i, 1, 6); // Cannot write UInt64LE in Node JS
+            buffer.writeUInt8(0x00, 7); // Pad two extra 0x00 at the end to emulate UInt64LE
             buffer.writeUInt8(0x00, 8);
             return buffer;
         }
@@ -29,24 +41,37 @@ class VarInt {
             throw new Error(`Integer too large: ${i}`);
         }
     }
+    /**
+     * Decode a variable length integer from a Buffer into a number.
+     * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/helper.py#L160
+     * @param b Buffer which contain the varint
+     * @returns Decoded number
+     */
     static decode(b) {
+        // Check for empty buffer
         if (b.byteLength === 0) {
             throw new Error('Empty buffer provided');
         }
+        // Read first byte from the buffer
         const i = b.readUInt8();
+        // Check if i is indicating its length
         if (i === 0xfd) {
+            // 0xfd means the next two bytes are the number
             return b.readUInt16LE(1);
         }
         else if (i === 0xfe) {
+            // 0xfe means the next four bytes are the number
             return b.readUInt32LE(1);
         }
         else if (i === 0xff) {
+            // 0xff means the next eight bytes are the number, but Node JS can only read up to 6 bytes
             return b.readUIntLE(1, 6);
         }
         else {
+            // Anything else is just the integer
             return i;
         }
     }
 }
-export default VarInt;
+exports.default = VarInt;
 //# sourceMappingURL=VarInt.js.map

package/dist/helpers/VarStr.d.ts

@@ -1,5 +1,22 @@
+/// <reference types="node" />
+/**
+ * Class that implement variable length string (VarStr) in Javascript.
+ * Reference: https://en.bitcoin.it/wiki/Protocol_documentation#Variable_length_string
+ */
 declare class VarStr {
+    /**
+     * Encode a string buffer as a variable length string.
+     * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/helper.py#L203
+     * @param s String buffer to be encoded
+     * @returns Encoded varstr
+     */
     static encode(s: Buffer): Buffer;
+    /**
+     * Decode a variable length string from a Buffer into a string buffer.
+     * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/helper.py#L194
+     * @param v Varstr to be decoded
+     * @returns Decoded string buffer
+     */
     static decode(v: Buffer): Buffer;
 }
 export default VarStr;

package/dist/helpers/VarStr.js

@@ -1,14 +1,41 @@
-import VarInt from "./VarInt";
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import dependency
+const VarInt_1 = __importDefault(require("./VarInt"));
+/**
+ * Class that implement variable length string (VarStr) in Javascript.
+ * Reference: https://en.bitcoin.it/wiki/Protocol_documentation#Variable_length_string
+ */
 class VarStr {
+    /**
+     * Encode a string buffer as a variable length string.
+     * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/helper.py#L203
+     * @param s String buffer to be encoded
+     * @returns Encoded varstr
+     */
     static encode(s) {
-        const lengthBuffer = VarInt.encode(s.length);
+        // Encode the length of the string using encodeVarInt
+        const lengthBuffer = VarInt_1.default.encode(s.length);
+        // Concat the actual string right after the length of the string
         return Buffer.concat([lengthBuffer, s]);
     }
+    /**
+     * Decode a variable length string from a Buffer into a string buffer.
+     * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/helper.py#L194
+     * @param v Varstr to be decoded
+     * @returns Decoded string buffer
+     */
     static decode(v) {
-        const length = VarInt.decode(v);
-        const lengthByteLength = VarInt.encode(length).byteLength;
+        // Find the length of the string by using read_varint on the string
+        const length = VarInt_1.default.decode(v);
+        // Get the length of the VarInt used to represent the length of the string
+        const lengthByteLength = VarInt_1.default.encode(length).byteLength;
+        // Return from lengthByteLength to (length + lengthByteLength) in the buffer which contain the actual string
         return v.subarray(lengthByteLength, length + lengthByteLength);
     }
 }
-export default VarStr;
+exports.default = VarStr;
 //# sourceMappingURL=VarStr.js.map

package/dist/helpers/Witness.d.ts

@@ -1,5 +1,23 @@
+/// <reference types="node" />
+/**
+ * Class that implement witness data serialization and deserialization.
+ */
 declare class Witness {
+    /**
+     * Encode array of witness into its base-64 encoded format.
+     * Follows the encoding scheme found in buidl-python:
+     *      https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/witness.py#L35
+     * @param witnesses Array of witness data
+     * @returns Base-64 encoded witness data
+     */
     static serialize(witnesses: Uint8Array[]): string;
+    /**
+     * Decode encoded witness data, either as a base-64 encoded string or as a decoded string in a buffer, into an array of witness.
+     * Follows the decoding scheme found in buidl-python:
+     *      https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/witness.py#L62
+     * @param encodedWitness Base-64 encoded witness data, or encoded witness data that have already been decoded
+     * @returns Decoded witness data
+     */
     static deserialize(encodedWitness: string | Buffer): Buffer[];
 }
 export default Witness;

package/dist/helpers/Witness.js

@@ -1,33 +1,70 @@
-import VarInt from "./VarInt";
-import VarStr from "./VarStr";
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import dependencies
+const VarInt_1 = __importDefault(require("./VarInt"));
+const VarStr_1 = __importDefault(require("./VarStr"));
+/**
+ * Class that implement witness data serialization and deserialization.
+ */
 class Witness {
+    /**
+     * Encode array of witness into its base-64 encoded format.
+     * Follows the encoding scheme found in buidl-python:
+     *      https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/witness.py#L35
+     * @param witnesses Array of witness data
+     * @returns Base-64 encoded witness data
+     */
     static serialize(witnesses) {
-        let witnessStack = VarInt.encode(witnesses.length);
+        // The first element to be included is the length of the witness array as VarInt
+        let witnessStack = VarInt_1.default.encode(witnesses.length);
+        // Then, for each witness array,
         witnesses.forEach((witness) => {
-            witnessStack = Buffer.concat([witnessStack, VarStr.encode(Buffer.from(witness))]);
+            // Append each witness as a VarStr to the witness stack
+            witnessStack = Buffer.concat([witnessStack, VarStr_1.default.encode(Buffer.from(witness))]);
         });
+        // Return the base-64 encoded witness stack
         return witnessStack.toString('base64');
     }
+    /**
+     * Decode encoded witness data, either as a base-64 encoded string or as a decoded string in a buffer, into an array of witness.
+     * Follows the decoding scheme found in buidl-python:
+     *      https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/witness.py#L62
+     * @param encodedWitness Base-64 encoded witness data, or encoded witness data that have already been decoded
+     * @returns Decoded witness data
+     */
     static deserialize(encodedWitness) {
+        // Store the decoded witness stack
         let witnessDecoded = [];
+        // Preprocess the encodedWitness if needed
         let witnessToDecode;
         if (typeof encodedWitness === 'string') {
+            // Decode the encoded witness if it is a string (assuming it is encoded using base-64)
             witnessToDecode = Buffer.from(encodedWitness, 'base64');
         }
         else {
             witnessToDecode = encodedWitness;
         }
-        const witnessCount = VarInt.decode(witnessToDecode);
-        const varIntLength = VarInt.encode(witnessCount).byteLength;
+        // Read a VarInt which indicate the number of elements within the original witness array
+        const witnessCount = VarInt_1.default.decode(witnessToDecode);
+        // Slice the VarInt in front of the witness buffer before decoding each witness
+        const varIntLength = VarInt_1.default.encode(witnessCount).byteLength;
         witnessToDecode = witnessToDecode.subarray(varIntLength);
+        // Loop for each witness encoded
         for (let i = 0; i < witnessCount; i++) {
-            const witness = VarStr.decode(witnessToDecode);
+            // Read a VarStr from the remaining buffer
+            const witness = VarStr_1.default.decode(witnessToDecode);
+            // Append the decoded witness to witnessDecoded
             witnessDecoded.push(witness);
-            const witnessLength = VarStr.encode(witness).byteLength;
+            // Slice the read witness off witnessToDecode before next iteration
+            const witnessLength = VarStr_1.default.encode(witness).byteLength;
             witnessToDecode = witnessToDecode.subarray(witnessLength);
         }
+        // Return deserialized witness data
         return witnessDecoded;
     }
 }
-export default Witness;
+exports.default = Witness;
 //# sourceMappingURL=Witness.js.map

package/dist/helpers/index.js

@@ -1,7 +1,17 @@
-import Address from "./Address";
-import BIP137 from "./BIP137";
-import VarInt from "./VarInt";
-import VarStr from "./VarStr";
-import Witness from "./Witness";
-export { Address, BIP137, VarInt, VarStr, Witness };
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Witness = exports.VarStr = exports.VarInt = exports.BIP137 = exports.Address = void 0;
+const Address_1 = __importDefault(require("./Address"));
+exports.Address = Address_1.default;
+const BIP137_1 = __importDefault(require("./BIP137"));
+exports.BIP137 = BIP137_1.default;
+const VarInt_1 = __importDefault(require("./VarInt"));
+exports.VarInt = VarInt_1.default;
+const VarStr_1 = __importDefault(require("./VarStr"));
+exports.VarStr = VarStr_1.default;
+const Witness_1 = __importDefault(require("./Witness"));
+exports.Witness = Witness_1.default;
 //# sourceMappingURL=index.js.map

package/dist/index.js

@@ -1,6 +1,18 @@
-import BIP322 from "./BIP322";
-import Signer from "./Signer";
-import Verifier from "./Verifier";
-import { Witness, Address, BIP137 } from "./helpers";
-export { BIP322, Signer, Verifier, Witness, Address, BIP137 };
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BIP137 = exports.Address = exports.Witness = exports.Verifier = exports.Signer = exports.BIP322 = void 0;
+// Import modules to be exported
+const BIP322_1 = __importDefault(require("./BIP322"));
+exports.BIP322 = BIP322_1.default;
+const Signer_1 = __importDefault(require("./Signer"));
+exports.Signer = Signer_1.default;
+const Verifier_1 = __importDefault(require("./Verifier"));
+exports.Verifier = Verifier_1.default;
+const helpers_1 = require("./helpers");
+Object.defineProperty(exports, "Witness", { enumerable: true, get: function () { return helpers_1.Witness; } });
+Object.defineProperty(exports, "Address", { enumerable: true, get: function () { return helpers_1.Address; } });
+Object.defineProperty(exports, "BIP137", { enumerable: true, get: function () { return helpers_1.BIP137; } });
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,48 +1,46 @@
 {
-  "name": "@exodus/bip322-js",
-  "version": "1.1.0-rc.0",
-  "description": "A Javascript library that provides utility functions related to the BIP-322 signature scheme",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "type": "module",
-  "publishConfig": {
-    "access": "restricted"
-  },
-  "scripts": {
-    "build": "tsc",
-    "doc": "typedoc src/index.ts",
-    "prepack": "npm run build",
-    "test": "run -T exodus-test --jest --esbuild"
-  },
-  "keywords": [
-    "bip322",
-    "bitcoinjs",
-    "javascript",
-    "typescript",
-    "no-WASM"
-  ],
-  "author": "Ken Sze <acken2@outlook.com>",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ExodusMovement/exodus-hydra.git.git"
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "@types/create-hash": "^1",
-    "@types/node": "^20.2.5",
-    "typedoc": "^0.24.8",
-    "typescript": "^5.1.3"
-  },
-  "dependencies": {
-    "@exodus/bitcoinerlab-secp256k1": "^1.0.5-exodus.1",
-    "@exodus/bitcoinjs": "^1.1.0",
-    "@exodus/secp256k1": "4.0.2-exodus.0",
-    "bitcoinjs-message": "^2.2.0",
-    "create-hash": "^1.2.0"
-  },
-  "homepage": "https://github.com/ExodusMovement/exodus-hydra.git/tree/master/libraries/bip322-js",
-  "bugs": {
-    "url": "https://github.com/ExodusMovement/exodus-hydra.git/issues?q=is%3Aissue+is%3Aopen+label%3Abip322-js"
-  },
-  "gitHead": "81d6f87cbb318c861c654a3001f2a0cfa54ac912"
+    "name": "@exodus/bip322-js",
+    "version": "1.1.0",
+    "description": "A Javascript library that provides utility functions related to the BIP-322 signature scheme",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "publishConfig": {
+        "access": "restricted"
+    },
+    "scripts": {
+        "build": "tsc",
+        "doc": "typedoc src/index.ts",
+        "prepack": "npm run build",
+        "test": "jest",
+        "test:coverage": "nyc --reporter=text --reporter=text-summary --reporter=lcov npm test"
+    },
+    "keywords": [
+        "bip322",
+        "bitcoinjs",
+        "javascript",
+        "typescript",
+        "no-WASM"
+    ],
+    "author": "Ken Sze <acken2@outlook.com>",
+    "repository": "https://github.com/ExodusMovement/bip322-js/",
+    "license": "MIT",
+    "devDependencies": {
+        "@babel/core": "^7.22.20",
+        "@babel/preset-env": "^7.22.20",
+        "@babel/preset-flow": "^7.22.15",
+        "@babel/preset-typescript": "^7.22.15",
+        "@types/node": "^20.2.5",
+        "@types/secp256k1": "^4.0.3",
+        "babel-jest": "^29.7.0",
+        "jest": "^29.7.0",
+        "nyc": "^15.1.0",
+        "typedoc": "^0.24.8",
+        "typescript": "^5.1.3"
+    },
+    "dependencies": {
+        "@exodus/secp256k1": "4.0.2-exodus.0",
+        "@exodus/bitcoinjs-lib": "^6.1.6",
+        "bitcoinjs-message": "^2.2.0",
+        "ecpair": "^2.0.1"
+    }
 }