@sidhujag/sysweb3-keyring 1.0.491

package/cjs/ledger/bitcoin_client/lib/merkle.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Merkle = void 0;
+exports.hashLeaf = hashLeaf;
+const bitcoinjs_lib_1 = require("bitcoinjs-lib");
+/**
+ * This class implements the merkle tree used by Ledger Bitcoin app v2+,
+ * which is documented at
+ * https://github.com/LedgerHQ/app-bitcoin-new/blob/master/doc/merkle.md
+ */
+class Merkle {
+    constructor(leaves, hasher = bitcoinjs_lib_1.crypto.sha256) {
+        this.leaves = leaves;
+        this.h = hasher;
+        const nodes = this.calculateRoot(leaves);
+        this.rootNode = nodes.root;
+        this.leafNodes = nodes.leaves;
+    }
+    getRoot() {
+        return this.rootNode.hash;
+    }
+    size() {
+        return this.leaves.length;
+    }
+    getLeaves() {
+        return this.leaves;
+    }
+    getLeafHash(index) {
+        return this.leafNodes[index].hash;
+    }
+    getProof(index) {
+        if (index >= this.leaves.length)
+            throw Error('Index out of bounds');
+        return proveNode(this.leafNodes[index]);
+    }
+    calculateRoot(leaves) {
+        const n = leaves.length;
+        if (n == 0) {
+            return {
+                root: new Node(undefined, undefined, Buffer.alloc(32, 0)),
+                leaves: [],
+            };
+        }
+        if (n == 1) {
+            const newNode = new Node(undefined, undefined, leaves[0]);
+            return { root: newNode, leaves: [newNode] };
+        }
+        const leftCount = highestPowerOf2LessThan(n);
+        const leftBranch = this.calculateRoot(leaves.slice(0, leftCount));
+        const rightBranch = this.calculateRoot(leaves.slice(leftCount));
+        const leftChild = leftBranch.root;
+        const rightChild = rightBranch.root;
+        const hash = this.hashNode(leftChild.hash, rightChild.hash);
+        const node = new Node(leftChild, rightChild, hash);
+        leftChild.parent = node;
+        rightChild.parent = node;
+        return { root: node, leaves: leftBranch.leaves.concat(rightBranch.leaves) };
+    }
+    hashNode(left, right) {
+        return this.h(Buffer.concat([Buffer.from([1]), left, right]));
+    }
+}
+exports.Merkle = Merkle;
+function hashLeaf(buf, hashFunction = bitcoinjs_lib_1.crypto.sha256) {
+    return hashConcat(Buffer.from([0]), buf, hashFunction);
+}
+function hashConcat(bufA, bufB, hashFunction) {
+    return hashFunction(Buffer.concat([bufA, bufB]));
+}
+class Node {
+    constructor(left, right, hash) {
+        this.leftChild = left;
+        this.rightChild = right;
+        this.hash = hash;
+    }
+    isLeaf() {
+        return this.leftChild == undefined;
+    }
+}
+function proveNode(node) {
+    if (!node.parent) {
+        return [];
+    }
+    if (node.parent.leftChild == node) {
+        if (!node.parent.rightChild) {
+            throw new Error('Expected right child to exist');
+        }
+        return [node.parent.rightChild.hash, ...proveNode(node.parent)];
+    }
+    else {
+        if (!node.parent.leftChild) {
+            throw new Error('Expected left child to exist');
+        }
+        return [node.parent.leftChild.hash, ...proveNode(node.parent)];
+    }
+}
+function highestPowerOf2LessThan(n) {
+    if (n < 2) {
+        throw Error('Expected n >= 2');
+    }
+    if (isPowerOf2(n)) {
+        return n / 2;
+    }
+    return 1 << Math.floor(Math.log2(n));
+}
+function isPowerOf2(n) {
+    return (n & (n - 1)) == 0;
+}
+//# sourceMappingURL=merkle.js.map

package/cjs/ledger/bitcoin_client/lib/merkle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merkle.js","sourceRoot":"","sources":["../../../../../src/ledger/bitcoin_client/lib/merkle.ts"],"names":[],"mappings":";;;AAuEA,4BAKC;AA5ED,iDAAuC;AAEvC;;;;GAIG;AACH,MAAa,MAAM;IAKjB,YACE,MAAgB,EAChB,SAAkC,sBAAM,CAAC,MAAM;QAE/C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC;IAChC,CAAC;IACD,OAAO;QACL,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IACD,IAAI;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IACD,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,WAAW,CAAC,KAAa;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;IACpC,CAAC;IACD,QAAQ,CAAC,KAAa;QACpB,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACpE,OAAO,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,aAAa,CAAC,MAAgB;QAI5B,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;QACxB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACX,OAAO;gBACL,IAAI,EAAE,IAAI,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;gBACzD,MAAM,EAAE,EAAE;aACX,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACX,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1D,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9C,CAAC;QACD,MAAM,SAAS,GAAG,uBAAuB,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;QAClE,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QAChE,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC;QAClC,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QACnD,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC;QACxB,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;QACzB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,KAAa;QAClC,OAAO,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC;CACF;AA9DD,wBA8DC;AAED,SAAgB,QAAQ,CACtB,GAAW,EACX,eAAwC,sBAAM,CAAC,MAAM;IAErD,OAAO,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,UAAU,CACjB,IAAY,EACZ,IAAY,EACZ,YAAqC;IAErC,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,IAAI;IAKR,YAAY,IAAsB,EAAE,KAAuB,EAAE,IAAY;QACvE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IACD,MAAM;QACJ,OAAO,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;IACrC,CAAC;CACF;AAED,SAAS,SAAS,CAAC,IAAU;IAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAClE,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACjE,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,CAAS;IACxC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACV,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAClB,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IACD,OAAO,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,UAAU,CAAC,CAAS;IAC3B,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC"}

package/cjs/ledger/bitcoin_client/lib/merkleMap.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MerkleMap = void 0;
+const merkle_1 = require("./merkle");
+const varint_1 = require("./varint");
+/**
+ * This implements "Merkelized Maps", documented at
+ * https://github.com/LedgerHQ/app-bitcoin-new/blob/master/doc/merkle.md#merkleized-maps
+ *
+ * A merkelized map consist of two merkle trees, one for the keys of
+ * a map and one for the values of the same map, thus the two merkle
+ * trees have the same shape. The commitment is the number elements
+ * in the map followed by the keys' merkle root followed by the
+ * values' merkle root.
+ */
+class MerkleMap {
+    /**
+     * @param keys Sorted list of (unhashed) keys
+     * @param values values, in corresponding order as the keys, and of equal length
+     */
+    constructor(keys, values) {
+        if (keys.length != values.length) {
+            throw new Error('keys and values should have the same length');
+        }
+        // Sanity check: verify that keys are actually sorted and with no duplicates
+        for (let i = 0; i < keys.length - 1; i++) {
+            if (keys[i].toString('hex') >= keys[i + 1].toString('hex')) {
+                throw new Error('keys must be in strictly increasing order');
+            }
+        }
+        this.keys = keys;
+        this.keysTree = new merkle_1.Merkle(keys.map((k) => (0, merkle_1.hashLeaf)(k)));
+        this.values = values;
+        this.valuesTree = new merkle_1.Merkle(values.map((v) => (0, merkle_1.hashLeaf)(v)));
+    }
+    commitment() {
+        // returns a buffer between 65 and 73 (included) bytes long
+        return Buffer.concat([
+            (0, varint_1.createVarint)(this.keys.length),
+            this.keysTree.getRoot(),
+            this.valuesTree.getRoot(),
+        ]);
+    }
+}
+exports.MerkleMap = MerkleMap;
+//# sourceMappingURL=merkleMap.js.map

package/cjs/ledger/bitcoin_client/lib/merkleMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merkleMap.js","sourceRoot":"","sources":["../../../../../src/ledger/bitcoin_client/lib/merkleMap.ts"],"names":[],"mappings":";;;AAAA,qCAA4C;AAC5C,qCAAwC;AAExC;;;;;;;;;GASG;AACH,MAAa,SAAS;IAKpB;;;OAGG;IACH,YAAY,IAAuB,EAAE,MAAyB;QAC5D,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,4EAA4E;QAC5E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3D,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,iBAAQ,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,iBAAQ,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,UAAU;QACR,2DAA2D;QAC3D,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,IAAA,qBAAY,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YAC9B,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YACvB,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;SAC1B,CAAC,CAAC;IACL,CAAC;CACF;AAnCD,8BAmCC"}

package/cjs/ledger/bitcoin_client/lib/policy.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultWalletPolicy = exports.WalletPolicy = void 0;
+const bitcoinjs_lib_1 = require("bitcoinjs-lib");
+const buffertools_1 = require("./buffertools");
+const merkle_1 = require("./merkle");
+const WALLET_POLICY_V2 = 2;
+/**
+ * The Bitcon hardware app uses a descriptors-like thing to describe
+ * how to construct output scripts from keys. A "Wallet Policy" consists
+ * of a "Descriptor Template" and a list of "keys". A key is basically
+ * a serialized BIP32 extended public key with some added derivation path
+ * information. This is documented at
+ * https://github.com/LedgerHQ/app-bitcoin-new/blob/master/doc/wallet.md
+ */
+class WalletPolicy {
+    /**
+     * Creates and instance of a wallet policy.
+     * @param name an ascii string, up to 16 bytes long; it must be an empty string for default wallet policies
+     * @param descriptorTemplate the wallet policy template
+     * @param keys and array of the keys, with the key derivation information
+     */
+    constructor(name, descriptorTemplate, keys) {
+        this.name = name;
+        this.descriptorTemplate = descriptorTemplate;
+        this.keys = keys;
+    }
+    /**
+     * Returns the unique 32-bytes id of this wallet policy.
+     */
+    getId() {
+        return bitcoinjs_lib_1.crypto.sha256(this.serialize());
+    }
+    /**
+     * Serializes the wallet policy for transmission via the hardware wallet protocol.
+     * @returns the serialized wallet policy
+     */
+    serialize() {
+        const keyBuffers = this.keys.map((k) => Buffer.from(k, 'ascii'));
+        const m = new merkle_1.Merkle(keyBuffers.map((k) => (0, merkle_1.hashLeaf)(k)));
+        const buf = new buffertools_1.BufferWriter();
+        buf.writeUInt8(WALLET_POLICY_V2); // wallet version
+        // length of wallet name, and wallet name
+        buf.writeVarSlice(Buffer.from(this.name, 'ascii'));
+        // length of descriptor template
+        buf.writeVarInt(this.descriptorTemplate.length);
+        // sha256 hash of descriptor template
+        buf.writeSlice(bitcoinjs_lib_1.crypto.sha256(Buffer.from(this.descriptorTemplate)));
+        // number of keys
+        buf.writeVarInt(this.keys.length);
+        // root of Merkle tree of keys
+        buf.writeSlice(m.getRoot());
+        return buf.buffer();
+    }
+}
+exports.WalletPolicy = WalletPolicy;
+/**
+ * Simplified class to handle default wallet policies that can be used without policy registration.
+ */
+class DefaultWalletPolicy extends WalletPolicy {
+    constructor(descriptorTemplate, key) {
+        super('', descriptorTemplate, [key]);
+    }
+}
+exports.DefaultWalletPolicy = DefaultWalletPolicy;
+//# sourceMappingURL=policy.js.map

package/cjs/ledger/bitcoin_client/lib/policy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"policy.js","sourceRoot":"","sources":["../../../../../src/ledger/bitcoin_client/lib/policy.ts"],"names":[],"mappings":";;;AAAA,iDAAuC;AAEvC,+CAA6C;AAC7C,qCAA4C;AAE5C,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B;;;;;;;GAOG;AACH,MAAa,YAAY;IAIvB;;;;;OAKG;IACH,YACE,IAAY,EACZ,kBAA0B,EAC1B,IAAuB;QAEvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,sBAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,GAAG,IAAI,eAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,iBAAQ,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEzD,MAAM,GAAG,GAAG,IAAI,0BAAY,EAAE,CAAC;QAC/B,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,iBAAiB;QAEnD,yCAAyC;QACzC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAEnD,gCAAgC;QAChC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAChD,qCAAqC;QACrC,GAAG,CAAC,UAAU,CAAC,sBAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAEpE,iBAAiB;QACjB,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClC,8BAA8B;QAC9B,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC5B,OAAO,GAAG,CAAC,MAAM,EAAE,CAAC;IACtB,CAAC;CACF;AApDD,oCAoDC;AAQD;;GAEG;AACH,MAAa,mBAAoB,SAAQ,YAAY;IACnD,YAAY,kBAA6C,EAAE,GAAW;QACpE,KAAK,CAAC,EAAE,EAAE,kBAAkB,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,CAAC;CACF;AAJD,kDAIC"}