@exodus/bip322-js 1.1.0 → 1.2.1

package/dist/helpers/Address.js

@@ -1,219 +1,120 @@
-"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 dependency
-const bitcoin = __importStar(require("@exodus/bitcoinjs-lib"));
-/**
- * Class that implement address-related utility functions.
- */
+import * as bitcoin from '@exodus/bitcoinjs';
 class Address {
-    /**
-     * Check if a given Bitcoin address is a pay-to-public-key-hash (p2pkh) address.
-     * @param address Bitcoin address to be checked
-     * @returns True if the provided address correspond to a valid P2PKH address, false if otherwise
-     */
     static isP2PKH(address) {
-        // Check if the provided address is a P2PKH address
         if (address[0] === '1' || address[0] === 'm' || address[0] === 'n') {
-            return true; // P2PKH address
-        }
-        else {
-            return false;
+            return true;
         }
+        return false;
     }
-    /**
-     * Check if a given Bitcoin address is a pay-to-script-hash (P2SH) address.
-     * @param address Bitcoin address to be checked
-     * @returns True if the provided address correspond to a valid P2SH address, false if otherwise
-     */
     static isP2SH(address) {
-        // Check if the provided address is a P2SH address
-        if (address[0] === '3' || address[0] === '2') {
-            return true; // P2SH address
-        }
-        else {
-            return false;
-        }
+        return address[0] === '3' || address[0] === '2';
     }
-    /**
-     * Check if a given Bitcoin address is a pay-to-witness-public-key-hash (P2WPKH) address.
-     * @param address Bitcoin address to be checked
-     * @returns True if the provided address correspond to a valid P2WPKH address, false if otherwise
-     */
     static isP2WPKH(address) {
-        // Check if the provided address is a P2WPKH/P2WSH address
         if (address.slice(0, 4) === 'bc1q' || address.slice(0, 4) === 'tb1q') {
-            // Either a P2WPKH / P2WSH address
-            // Convert the address into a scriptPubKey
             const scriptPubKey = this.convertAdressToScriptPubkey(address);
-            // Check if the scriptPubKey is exactly 22 bytes since P2WPKH scriptPubKey should be 0014<20-BYTE-PUBKEY-HASH>
             if (scriptPubKey.byteLength === 22) {
-                return true; // P2WPKH
+                return true;
             }
-            else {
-                return false; // Not P2WPKH, probably P2WSH
-            }
-        }
-        else {
             return false;
         }
+        return false;
     }
-    /**
-     * Check if a given Bitcoin address is a taproot address.
-     * @param address Bitcoin address to be checked
-     * @returns True if the provided address is a taproot address, false if otherwise
-     */
     static isP2TR(address) {
-        if (address.slice(0, 4) === 'bc1p' || address.slice(0, 4) === 'tb1p') {
-            return true; // P2TR address
-        }
-        else {
-            return false;
-        }
+        return address.slice(0, 4) === 'bc1p' || address.slice(0, 4) === 'tb1p';
     }
-    /**
-     * Check if a given witness stack corresponds to a P2WPKH address.
-     * @param witness Witness data associated with the toSign BIP-322 transaction
-     * @returns True if the provided witness stack correspond to a valid P2WPKH address, false if otherwise
-     */
     static isP2WPKHWitness(witness) {
-        // Check whether the witness stack is as expected for a P2WPKH address
-        // It should contain exactly two items, with the second item being a public key with 33 bytes, and the first byte must be either 0x02/0x03
-        if (witness.length === 2 && witness[1].byteLength === 33 && (witness[1][0] === 0x02 || witness[1][0] === 0x03)) {
-            return true;
-        }
-        else {
-            return false;
-        }
+        return (witness.length === 2 &&
+            witness[1].byteLength === 33 &&
+            (witness[1][0] === 0x02 || witness[1][0] === 0x03));
     }
-    /**
-     * Check if a given witness stack corresponds to a single-key-spend P2TR address.
-     * @param witness Witness data associated with the toSign BIP-322 transaction
-     * @returns True if the provided address and witness stack correspond to a valid single-key-spend P2TR address, false if otherwise
-     */
     static isSingleKeyP2TRWitness(witness) {
-        // Check whether the witness stack is as expected for a single-key-spend taproot address
-        // It should contain exactly one items which is the signature for the transaction
-        if (witness.length === 1) {
-            return true;
-        }
-        else {
-            return false;
-        }
+        return witness.length === 1;
     }
-    /**
-     * Convert a given Bitcoin address into its corresponding script public key.
-     * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/script.py#L607
-     * @param address Bitcoin address
-     * @returns Script public key of the given Bitcoin address
-     * @throws Error when the provided address is not a valid Bitcoin address
-     */
     static convertAdressToScriptPubkey(address) {
         if (address[0] === '1' || address[0] === 'm' || address[0] === 'n') {
-            // P2PKH address
             return bitcoin.payments.p2pkh({
-                address: address,
-                network: (address[0] === '1') ? bitcoin.networks.bitcoin : bitcoin.networks.testnet
+                address,
+                network: address[0] === '1' ? bitcoin.networks.bitcoin : bitcoin.networks.testnet,
             }).output;
         }
-        else if (address[0] === '3' || address[0] === '2') {
-            // P2SH address
+        if (address[0] === '3' || address[0] === '2') {
             return bitcoin.payments.p2sh({
-                address: address,
-                network: (address[0] === '3') ? bitcoin.networks.bitcoin : bitcoin.networks.testnet
+                address,
+                network: address[0] === '3' ? bitcoin.networks.bitcoin : bitcoin.networks.testnet,
             }).output;
         }
-        else if (address.slice(0, 4) === 'bc1q' || address.slice(0, 4) === 'tb1q') {
-            // P2WPKH or P2WSH address
+        if (address.slice(0, 4) === 'bc1q' || address.slice(0, 4) === 'tb1q') {
             if (address.length === 42) {
-                // P2WPKH address
                 return bitcoin.payments.p2wpkh({
-                    address: address,
-                    network: (address.slice(0, 4) === 'bc1q') ? bitcoin.networks.bitcoin : bitcoin.networks.testnet
+                    address,
+                    network: address.slice(0, 4) === 'bc1q' ? bitcoin.networks.bitcoin : bitcoin.networks.testnet,
                 }).output;
             }
-            else if (address.length === 62) {
-                // P2WSH address
+            if (address.length === 62) {
                 return bitcoin.payments.p2wsh({
-                    address: address,
-                    network: (address.slice(0, 4) === 'bc1q') ? bitcoin.networks.bitcoin : bitcoin.networks.testnet
+                    address,
+                    network: address.slice(0, 4) === 'bc1q' ? bitcoin.networks.bitcoin : bitcoin.networks.testnet,
                 }).output;
             }
         }
-        else if (address.slice(0, 4) === 'bc1p' || address.slice(0, 4) === 'tb1p') {
-            if (address.length === 62) {
-                // P2TR address
-                return bitcoin.payments.p2tr({
-                    address: address,
-                    network: (address.slice(0, 4) === 'bc1p') ? bitcoin.networks.bitcoin : bitcoin.networks.testnet
-                }).output;
-            }
+        else if ((address.slice(0, 4) === 'bc1p' || address.slice(0, 4) === 'tb1p') &&
+            address.length === 62) {
+            return bitcoin.payments.p2tr({
+                address,
+                network: address.slice(0, 4) === 'bc1p' ? bitcoin.networks.bitcoin : bitcoin.networks.testnet,
+            }).output;
         }
-        throw new Error("Unknown address type");
+        throw new Error('Unknown address type');
     }
-    /**
-     * Convert a given public key into a corresponding Bitcoin address.
-     * @param publicKey Public key for deriving the address, or internal public key for deriving taproot address
-     * @param addressType Bitcoin address type to be derived, must be either 'p2pkh', 'p2sh-p2wpkh', 'p2wpkh', or 'p2tr'
-     * @returns Bitcoin address that correspond to the given public key in both mainnet and testnet
-     */
     static convertPubKeyIntoAddress(publicKey, addressType) {
         switch (addressType) {
             case 'p2pkh':
                 return {
-                    mainnet: bitcoin.payments.p2pkh({ pubkey: publicKey, network: bitcoin.networks.bitcoin }).address,
-                    testnet: bitcoin.payments.p2pkh({ pubkey: publicKey, network: bitcoin.networks.testnet }).address
+                    mainnet: bitcoin.payments.p2pkh({ pubkey: publicKey, network: bitcoin.networks.bitcoin })
+                        .address,
+                    testnet: bitcoin.payments.p2pkh({ pubkey: publicKey, network: bitcoin.networks.testnet })
+                        .address,
                 };
             case 'p2sh-p2wpkh':
-                // Reference: https://github.com/bitcoinjs/bitcoinjs-lib/blob/1a9119b53bcea4b83a6aa8b948f0e6370209b1b4/test/integration/addresses.spec.ts#L70
                 return {
                     mainnet: bitcoin.payments.p2sh({
-                        redeem: bitcoin.payments.p2wpkh({ pubkey: publicKey, network: bitcoin.networks.bitcoin }),
-                        network: bitcoin.networks.bitcoin
+                        redeem: bitcoin.payments.p2wpkh({
+                            pubkey: publicKey,
+                            network: bitcoin.networks.bitcoin,
+                        }),
+                        network: bitcoin.networks.bitcoin,
                     }).address,
                     testnet: bitcoin.payments.p2sh({
-                        redeem: bitcoin.payments.p2wpkh({ pubkey: publicKey, network: bitcoin.networks.testnet }),
-                        network: bitcoin.networks.testnet
-                    }).address
+                        redeem: bitcoin.payments.p2wpkh({
+                            pubkey: publicKey,
+                            network: bitcoin.networks.testnet,
+                        }),
+                        network: bitcoin.networks.testnet,
+                    }).address,
                 };
             case 'p2wpkh':
                 return {
-                    mainnet: bitcoin.payments.p2wpkh({ pubkey: publicKey, network: bitcoin.networks.bitcoin }).address,
-                    testnet: bitcoin.payments.p2wpkh({ pubkey: publicKey, network: bitcoin.networks.testnet }).address
+                    mainnet: bitcoin.payments.p2wpkh({ pubkey: publicKey, network: bitcoin.networks.bitcoin })
+                        .address,
+                    testnet: bitcoin.payments.p2wpkh({ pubkey: publicKey, network: bitcoin.networks.testnet })
+                        .address,
                 };
             case 'p2tr':
-                // Convert full-length public key into internal public key if necessary
                 const internalPubkey = publicKey.byteLength === 33 ? publicKey.subarray(1, 33) : publicKey;
                 return {
-                    mainnet: bitcoin.payments.p2tr({ internalPubkey: internalPubkey, network: bitcoin.networks.bitcoin }).address,
-                    testnet: bitcoin.payments.p2tr({ internalPubkey: internalPubkey, network: bitcoin.networks.testnet }).address
+                    mainnet: bitcoin.payments.p2tr({
+                        internalPubkey,
+                        network: bitcoin.networks.bitcoin,
+                    }).address,
+                    testnet: bitcoin.payments.p2tr({
+                        internalPubkey,
+                        network: bitcoin.networks.testnet,
+                    }).address,
                 };
             default:
                 throw new Error('Cannot convert public key into unsupported address type.');
         }
     }
 }
-exports.default = Address;
+export default Address;
 //# sourceMappingURL=Address.js.map

package/dist/helpers/Address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Address.js","sourceRoot":"","sources":["../../src/helpers/Address.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,OAAO,MAAM,mBAAmB,CAAA;AAK5C,MAAM,OAAO;IAMJ,MAAM,CAAC,OAAO,CAAC,OAAe;QAGnC,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACnE,OAAO,IAAI,CAAA;QACb,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAOM,MAAM,CAAC,MAAM,CAAC,OAAe;QAElC,OAAO,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAA;IACjD,CAAC;IAOM,MAAM,CAAC,QAAQ,CAAC,OAAe;QAEpC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YAGrE,MAAM,YAAY,GAAG,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAA;YAG9D,IAAI,YAAY,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;gBACnC,OAAO,IAAI,CAAA;YACb,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAOM,MAAM,CAAC,MAAM,CAAC,OAAe;QAClC,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAA;IACzE,CAAC;IAOM,MAAM,CAAC,eAAe,CAAC,OAAiB;QAG7C,OAAO,CACL,OAAO,CAAC,MAAM,KAAK,CAAC;YACpB,OAAO,CAAC,CAAC,CAAE,CAAC,UAAU,KAAK,EAAE;YAC7B,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CACrD,CAAA;IACH,CAAC;IAOM,MAAM,CAAC,sBAAsB,CAAC,OAAiB;QAGpD,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAA;IAC7B,CAAC;IASM,MAAM,CAAC,2BAA2B,CAAC,OAAe;QACvD,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YAEnE,OAAO,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC5B,OAAO;gBACP,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO;aAClF,CAAC,CAAC,MAAgB,CAAA;QACrB,CAAC;QAED,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YAE7C,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC3B,OAAO;gBACP,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO;aAClF,CAAC,CAAC,MAAgB,CAAA;QACrB,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YAErE,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;gBAE1B,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAC7B,OAAO;oBACP,OAAO,EACL,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO;iBACvF,CAAC,CAAC,MAAgB,CAAA;YACrB,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;gBAE1B,OAAO,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;oBAC5B,OAAO;oBACP,OAAO,EACL,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO;iBACvF,CAAC,CAAC,MAAgB,CAAA;YACrB,CAAC;QACH,CAAC;aAAM,IACL,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC;YAClE,OAAO,CAAC,MAAM,KAAK,EAAE,EACrB,CAAC;YAED,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC3B,OAAO;gBACP,OAAO,EACL,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO;aACvF,CAAC,CAAC,MAAgB,CAAA;QACrB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;IACzC,CAAC;IAQM,MAAM,CAAC,wBAAwB,CACpC,SAAiB,EACjB,WAAwD;QAExD,QAAQ,WAAW,EAAE,CAAC;YACpB,KAAK,OAAO;gBACV,OAAO;oBACL,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;yBACtF,OAAO;oBACV,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;yBACtF,OAAO;iBACX,CAAA;YACH,KAAK,aAAa;gBAEhB,OAAO;oBACL,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;wBAC7B,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;4BAC9B,MAAM,EAAE,SAAS;4BACjB,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO;yBAClC,CAAC;wBACF,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO;qBAClC,CAAC,CAAC,OAAO;oBACV,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;wBAC7B,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;4BAC9B,MAAM,EAAE,SAAS;4BACjB,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO;yBAClC,CAAC;wBACF,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO;qBAClC,CAAC,CAAC,OAAO;iBACX,CAAA;YACH,KAAK,QAAQ;gBACX,OAAO;oBACL,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;yBACvF,OAAO;oBACV,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;yBACvF,OAAO;iBACX,CAAA;YACH,KAAK,MAAM;gBAET,MAAM,cAAc,GAAG,SAAS,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;gBAC1F,OAAO;oBACL,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;wBAC7B,cAAc;wBACd,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO;qBAClC,CAAC,CAAC,OAAO;oBACV,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;wBAC7B,cAAc;wBACd,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO;qBAClC,CAAC,CAAC,OAAO;iBACX,CAAA;YACH;gBACE,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;QAC/E,CAAC;IACH,CAAC;CACF;AAED,eAAe,OAAO,CAAA"}

package/dist/helpers/BIP137.d.ts

@@ -1,27 +1,6 @@
-/// <reference types="node" />
-/**
- * Class that implement BIP137-related utility functions.
- */
 declare 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: string): boolean;
-    /**
-     * 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: string, signature: string): Buffer;
-    /**
-     * Decode a BIP-137 signature.
-     * Function copied from bitcoinjs-message library.
-     * @param signature BIP-137 signature to be decoded
-     * @returns Decoded BIP-137 signature
-     */
     private static decodeSignature;
 }
 export default BIP137;

package/dist/helpers/BIP137.js

@@ -1,71 +1,16 @@
-"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.
- */
+import secp256k1 from '@exodus/secp256k1';
+import * as bitcoinMessage from 'bitcoinjs-message';
 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;
-        }
-        else {
-            return false;
-        }
+        return signatureBuffer.byteLength === 65;
     }
-    /**
-     * 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'));
-        // Recover the public key
-        const recoveredPublicKey = (0, secp256k1_1.ecdsaRecover)(signatureDecoded.signature, signatureDecoded.recovery, messageHash, signatureDecoded.compressed);
+        const recoveredPublicKey = secp256k1.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');
@@ -76,9 +21,9 @@ class BIP137 {
         return {
             compressed: !!(flagByte & 12),
             recovery: flagByte & 3,
-            signature: signature.subarray(1)
+            signature: signature.subarray(1),
         };
     }
 }
-exports.default = BIP137;
+export default BIP137;
 //# sourceMappingURL=BIP137.js.map

package/dist/helpers/BIP137.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BIP137.js","sourceRoot":"","sources":["../../src/helpers/BIP137.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,mBAAmB,CAAA;AACzC,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAA;AAKnD,MAAM,MAAM;IAMH,MAAM,CAAC,iBAAiB,CAAC,SAAiB;QAE/C,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;QACxD,OAAO,eAAe,CAAC,UAAU,KAAK,EAAE,CAAA;IAC1C,CAAC;IAQM,MAAM,CAAC,YAAY,CAAC,OAAe,EAAE,SAAiB;QAE3D,MAAM,WAAW,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QAErD,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAA;QAE/E,MAAM,kBAAkB,GAAG,SAAS,CAAC,YAAY,CAC/C,gBAAgB,CAAC,SAAS,EAC1B,gBAAgB,CAAC,QAAQ,EACzB,WAAW,EACX,gBAAgB,CAAC,UAAU,CAC5B,CAAA;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;IACxC,CAAC;IAQO,MAAM,CAAC,eAAe,CAAC,SAAiB;QAC9C,IAAI,SAAS,CAAC,MAAM,KAAK,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QACxE,MAAM,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QAC5C,IAAI,QAAQ,GAAG,EAAE,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAChD,CAAC;QAED,OAAO;YACL,UAAU,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,EAAE,CAAC;YAC7B,QAAQ,EAAE,QAAQ,GAAG,CAAC;YACtB,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;SACjC,CAAA;IACH,CAAC;CACF;AAED,eAAe,MAAM,CAAA"}

package/dist/helpers/VarInt.d.ts

@@ -1,22 +1,5 @@
-/// <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,77 +1,48 @@
-"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) {
+        if (i < 0xfd) {
             const buffer = Buffer.alloc(1);
             buffer.writeUInt8(i);
             return buffer;
         }
-        else if (i < 0x10000) {
+        if (i < 0x1_00_00) {
             const buffer = Buffer.alloc(3);
             buffer.writeUInt8(0xfd);
             buffer.writeUInt16LE(i, 1);
             return buffer;
         }
-        else if (i < 0x100000000) {
+        if (i < 0x1_00_00_00_00) {
             const buffer = Buffer.alloc(5);
             buffer.writeUInt8(0xfe);
             buffer.writeUInt32LE(i, 1);
             return buffer;
         }
-        else if (i < 0x1000000000000) {
+        if (i < 0x1_00_00_00_00_00_00) {
             const buffer = Buffer.alloc(9);
             buffer.writeUInt8(0xff);
-            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.writeUIntLE(i, 1, 6);
+            buffer.writeUInt8(0x00, 7);
             buffer.writeUInt8(0x00, 8);
             return buffer;
         }
-        else {
-            throw new Error(`Integer too large: ${i}`);
-        }
+        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
+        if (i === 0xfe) {
             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
+        if (i === 0xff) {
             return b.readUIntLE(1, 6);
         }
-        else {
-            // Anything else is just the integer
-            return i;
-        }
+        return i;
     }
 }
-exports.default = VarInt;
+export default VarInt;
 //# sourceMappingURL=VarInt.js.map

package/dist/helpers/VarInt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VarInt.js","sourceRoot":"","sources":["../../src/helpers/VarInt.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM;IAOH,MAAM,CAAC,MAAM,CAAC,CAAS;QAC5B,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;YACb,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC9B,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;YACpB,OAAO,MAAM,CAAA;QACf,CAAC;QAED,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC;YAClB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC9B,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YACvB,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAC1B,OAAO,MAAM,CAAA;QACf,CAAC;QAED,IAAI,CAAC,GAAG,eAAe,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC9B,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YACvB,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAC1B,OAAO,MAAM,CAAA;QACf,CAAC;QAED,IAAI,CAAC,GAAG,qBAAqB,EAAE,CAAC;YAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC9B,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YACvB,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;YAC3B,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;YAC1B,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;YAC1B,OAAO,MAAM,CAAA;QACf,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAA;IAC5C,CAAC;IAQM,MAAM,CAAC,MAAM,CAAC,CAAS;QAE5B,IAAI,CAAC,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;QAC1C,CAAC;QAGD,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,CAAA;QAEvB,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAEf,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAC1B,CAAC;QAED,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAEf,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAC1B,CAAC;QAED,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAEf,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC3B,CAAC;QAGD,OAAO,CAAC,CAAA;IACV,CAAC;CACF;AAED,eAAe,MAAM,CAAA"}

package/dist/helpers/VarStr.d.ts

@@ -1,22 +1,5 @@
-/// <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,41 +1,14 @@
-"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
- */
+import VarInt from './VarInt.js';
 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) {
-        // 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
+        const lengthBuffer = VarInt.encode(s.length);
         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) {
-        // 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
+        const length = VarInt.decode(v);
+        const lengthByteLength = VarInt.encode(length).byteLength;
         return v.subarray(lengthByteLength, length + lengthByteLength);
     }
 }
-exports.default = VarStr;
+export default VarStr;
 //# sourceMappingURL=VarStr.js.map

package/dist/helpers/VarStr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VarStr.js","sourceRoot":"","sources":["../../src/helpers/VarStr.ts"],"names":[],"mappings":"AACA,OAAO,MAAM,MAAM,aAAa,CAAA;AAMhC,MAAM,MAAM;IAOH,MAAM,CAAC,MAAM,CAAC,CAAS;QAE5B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;QAE5C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAA;IACzC,CAAC;IAQM,MAAM,CAAC,MAAM,CAAC,CAAS;QAE5B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QAE/B,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,CAAA;QAEzD,OAAO,CAAC,CAAC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAA;IAChE,CAAC;CACF;AAED,eAAe,MAAM,CAAA"}

package/dist/helpers/Witness.d.ts

@@ -1,23 +1,5 @@
-/// <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;