@exodus/bip322-js 1.1.0 → 1.2.1

package/dist/helpers/Witness.js

@@ -1,70 +1,33 @@
-"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.
- */
+import VarInt from './VarInt.js';
+import VarStr from './VarStr.js';
 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) {
-        // 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,
+        let witnessStack = VarInt.encode(witnesses.length);
         witnesses.forEach((witness) => {
-            // Append each witness as a VarStr to the witness stack
-            witnessStack = Buffer.concat([witnessStack, VarStr_1.default.encode(Buffer.from(witness))]);
+            witnessStack = Buffer.concat([witnessStack, VarStr.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
+        const witnessDecoded = [];
         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;
         }
-        // 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;
+        const witnessCount = VarInt.decode(witnessToDecode);
+        const varIntLength = VarInt.encode(witnessCount).byteLength;
         witnessToDecode = witnessToDecode.subarray(varIntLength);
-        // Loop for each witness encoded
         for (let i = 0; i < witnessCount; i++) {
-            // Read a VarStr from the remaining buffer
-            const witness = VarStr_1.default.decode(witnessToDecode);
-            // Append the decoded witness to witnessDecoded
+            const witness = VarStr.decode(witnessToDecode);
             witnessDecoded.push(witness);
-            // Slice the read witness off witnessToDecode before next iteration
-            const witnessLength = VarStr_1.default.encode(witness).byteLength;
+            const witnessLength = VarStr.encode(witness).byteLength;
             witnessToDecode = witnessToDecode.subarray(witnessLength);
         }
-        // Return deserialized witness data
         return witnessDecoded;
     }
 }
-exports.default = Witness;
+export default Witness;
 //# sourceMappingURL=Witness.js.map

package/dist/helpers/Witness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../src/helpers/Witness.ts"],"names":[],"mappings":"AACA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,MAAM,MAAM,aAAa,CAAA;AAKhC,MAAM,OAAO;IAQJ,MAAM,CAAC,SAAS,CAAC,SAAuB;QAE7C,IAAI,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;QAElD,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAE5B,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;QACnF,CAAC,CAAC,CAAA;QAEF,OAAO,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACxC,CAAC;IASM,MAAM,CAAC,WAAW,CAAC,cAA+B;QAEvD,MAAM,cAAc,GAAa,EAAE,CAAA;QAEnC,IAAI,eAAuB,CAAA;QAC3B,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YAEvC,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;QACzD,CAAC;aAAM,CAAC;YACN,eAAe,GAAG,cAAc,CAAA;QAClC,CAAC;QAGD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;QAEnD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,UAAU,CAAA;QAC3D,eAAe,GAAG,eAAe,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;QAExD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,CAAC,EAAE,EAAE,CAAC;YAEtC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;YAE9C,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAE5B,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,UAAU,CAAA;YACvD,eAAe,GAAG,eAAe,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAA;QAC3D,CAAC;QAGD,OAAO,cAAc,CAAA;IACvB,CAAC;CACF;AAED,eAAe,OAAO,CAAA"}

package/dist/helpers/index.d.ts

@@ -1,6 +1,5 @@
-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 };
+export { default as Address } from './Address.js';
+export { default as VarInt } from './VarInt.js';
+export { default as BIP137 } from './BIP137.js';
+export { default as Witness } from './Witness.js';
+export { default as VarStr } from './VarStr.js';

package/dist/helpers/index.js

@@ -1,17 +1,6 @@
-"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;
+export { default as Address } from './Address.js';
+export { default as VarInt } from './VarInt.js';
+export { default as BIP137 } from './BIP137.js';
+export { default as Witness } from './Witness.js';
+export { default as VarStr } from './VarStr.js';
 //# sourceMappingURL=index.js.map

package/dist/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAA"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-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 };
+export { default as BIP322 } from './BIP322.js';
+export { default as Signer } from './Signer.js';
+export { Witness, Address } from './helpers/index.js';
+export { default as Verifier } from './Verifier.js';
+export { BIP137 } from './helpers/index.js';

package/dist/index.js

@@ -1,18 +1,6 @@
-"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; } });
+export { default as BIP322 } from './BIP322.js';
+export { default as Signer } from './Signer.js';
+export { Witness, Address } from './helpers/index.js';
+export { default as Verifier } from './Verifier.js';
+export { BIP137 } from './helpers/index.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAA;AAEnD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA"}

package/package.json

@@ -1,46 +1,55 @@
 {
-    "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"
-    }
+  "name": "@exodus/bip322-js",
+  "version": "1.2.1",
+  "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"
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint",
+    "lint:fix": "run lint --fix",
+    "doc": "typedoc src/index.ts",
+    "prepack": "npm run build",
+    "test": "run -T exodus-test --jest --esbuild",
+    "prepublishOnly": "yarn run -T build --scope @exodus/bip322-js"
+  },
+  "keywords": [
+    "bip322",
+    "bitcoinjs",
+    "javascript",
+    "typescript",
+    "no-WASM"
+  ],
+  "author": "Exodus Movement, Inc.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/exodus-hydra.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/tree/master/libraries/bip322-js",
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Abip322-js"
+  },
+  "gitHead": "6a40d50082582568d68206d8926737eea560fa50"
 }