@arkade-os/sdk 0.4.26 → 0.4.28

package/dist/cjs/tree/signingSession.js

@@ -1,229 +0,0 @@
-"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 () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TreeSignerSession = exports.ErrMissingAggregateKey = exports.ErrMissingVtxoGraph = void 0;
-exports.validateTreeSigs = validateTreeSigs;
-const musig2 = __importStar(require("../musig2"));
-const script_js_1 = require("@scure/btc-signer/script.js");
-const transaction_js_1 = require("@scure/btc-signer/transaction.js");
-const base_1 = require("@scure/base");
-const secp256k1_js_1 = require("@noble/curves/secp256k1.js");
-const utils_js_1 = require("@scure/btc-signer/utils.js");
-const unknownFields_1 = require("../utils/unknownFields");
-exports.ErrMissingVtxoGraph = new Error("missing vtxo graph");
-exports.ErrMissingAggregateKey = new Error("missing aggregate key");
-class TreeSignerSession {
-    constructor(secretKey) {
-        this.secretKey = secretKey;
-        this.myNonces = null;
-        this.aggregateNonces = null;
-        this.graph = null;
-        this.scriptRoot = null;
-        this.rootSharedOutputAmount = null;
-    }
-    static random() {
-        const secretKey = (0, utils_js_1.randomPrivateKeyBytes)();
-        return new TreeSignerSession(secretKey);
-    }
-    async init(tree, scriptRoot, rootInputAmount) {
-        this.graph = tree;
-        this.scriptRoot = scriptRoot;
-        this.rootSharedOutputAmount = rootInputAmount;
-    }
-    async getPublicKey() {
-        return secp256k1_js_1.secp256k1.getPublicKey(this.secretKey);
-    }
-    async getNonces() {
-        if (!this.graph)
-            throw exports.ErrMissingVtxoGraph;
-        if (!this.myNonces) {
-            this.myNonces = this.generateNonces();
-        }
-        const publicNonces = new Map();
-        for (const [txid, nonces] of this.myNonces) {
-            publicNonces.set(txid, { pubNonce: nonces.pubNonce });
-        }
-        return publicNonces;
-    }
-    async aggregatedNonces(txid, noncesByPubkey) {
-        if (!this.graph)
-            throw exports.ErrMissingVtxoGraph;
-        if (!this.aggregateNonces) {
-            this.aggregateNonces = new Map();
-        }
-        if (!this.myNonces) {
-            await this.getNonces(); // generate nonces if not generated yet
-        }
-        if (this.aggregateNonces.has(txid)) {
-            return {
-                hasAllNonces: this.aggregateNonces.size === this.myNonces?.size,
-            };
-        }
-        const myNonce = this.myNonces.get(txid);
-        if (!myNonce)
-            throw new Error(`missing nonce for txid ${txid}`);
-        const myPublicKey = await this.getPublicKey();
-        // set my nonce to not rely on server
-        noncesByPubkey.set(base_1.hex.encode(myPublicKey.subarray(1)), myNonce);
-        const tx = this.graph.find(txid);
-        if (!tx)
-            throw new Error(`missing tx for txid ${txid}`);
-        const cosigners = (0, unknownFields_1.getArkPsbtFields)(tx.root, 0, unknownFields_1.CosignerPublicKey).map((c) => base_1.hex.encode(c.key.subarray(1)) // xonly pubkey
-        );
-        const pubNonces = [];
-        for (const cosigner of cosigners) {
-            const nonce = noncesByPubkey.get(cosigner);
-            if (!nonce) {
-                throw new Error(`missing nonce for cosigner ${cosigner}`);
-            }
-            pubNonces.push(nonce.pubNonce);
-        }
-        const aggregateNonce = musig2.aggregateNonces(pubNonces);
-        this.aggregateNonces.set(txid, { pubNonce: aggregateNonce });
-        return {
-            hasAllNonces: this.aggregateNonces.size === this.myNonces?.size,
-        };
-    }
-    async sign() {
-        if (!this.graph)
-            throw exports.ErrMissingVtxoGraph;
-        if (!this.aggregateNonces)
-            throw new Error("nonces not set");
-        if (!this.myNonces)
-            throw new Error("nonces not generated");
-        const sigs = new Map();
-        for (const g of this.graph.iterator()) {
-            const sig = this.signPartial(g);
-            sigs.set(g.txid, sig);
-        }
-        return sigs;
-    }
-    generateNonces() {
-        if (!this.graph)
-            throw exports.ErrMissingVtxoGraph;
-        const myNonces = new Map();
-        const publicKey = secp256k1_js_1.secp256k1.getPublicKey(this.secretKey);
-        for (const g of this.graph.iterator()) {
-            const nonces = musig2.generateNonces(publicKey);
-            myNonces.set(g.txid, nonces);
-        }
-        return myNonces;
-    }
-    signPartial(g) {
-        if (!this.graph || !this.scriptRoot || !this.rootSharedOutputAmount) {
-            throw TreeSignerSession.NOT_INITIALIZED;
-        }
-        if (!this.myNonces || !this.aggregateNonces) {
-            throw new Error("session not properly initialized");
-        }
-        const myNonce = this.myNonces.get(g.txid);
-        if (!myNonce)
-            throw new Error("missing private nonce");
-        const aggNonce = this.aggregateNonces.get(g.txid);
-        if (!aggNonce)
-            throw new Error("missing aggregate nonce");
-        const prevoutAmounts = [];
-        const prevoutScripts = [];
-        const cosigners = (0, unknownFields_1.getArkPsbtFields)(g.root, 0, unknownFields_1.CosignerPublicKey).map((c) => c.key);
-        const { finalKey } = musig2.aggregateKeys(cosigners, true, {
-            taprootTweak: this.scriptRoot,
-        });
-        for (let inputIndex = 0; inputIndex < g.root.inputsLength; inputIndex++) {
-            const prevout = getPrevOutput(finalKey, this.graph, this.rootSharedOutputAmount, g.root);
-            prevoutAmounts.push(prevout.amount);
-            prevoutScripts.push(prevout.script);
-        }
-        const message = g.root.preimageWitnessV1(0, // always first input
-        prevoutScripts, transaction_js_1.SigHash.DEFAULT, prevoutAmounts);
-        return musig2.sign(myNonce.secNonce, this.secretKey, aggNonce.pubNonce, cosigners, message, {
-            taprootTweak: this.scriptRoot,
-            sortKeys: true,
-        });
-    }
-}
-exports.TreeSignerSession = TreeSignerSession;
-TreeSignerSession.NOT_INITIALIZED = new Error("session not initialized, call init method");
-// Helper function to validate tree signatures
-async function validateTreeSigs(finalAggregatedKey, sharedOutputAmount, vtxoTree) {
-    // Iterate through each level of the tree
-    for (const g of vtxoTree.iterator()) {
-        // Parse the transaction
-        const input = g.root.getInput(0);
-        // Check if input has signature
-        if (!input.tapKeySig) {
-            throw new Error("unsigned tree input");
-        }
-        // Get the previous output information
-        const prevout = getPrevOutput(finalAggregatedKey, vtxoTree, sharedOutputAmount, g.root);
-        // Calculate the message that was signed
-        const message = g.root.preimageWitnessV1(0, // always first input
-        [prevout.script], transaction_js_1.SigHash.DEFAULT, [prevout.amount]);
-        // Verify the signature
-        const isValid = secp256k1_js_1.schnorr.verify(input.tapKeySig, message, finalAggregatedKey);
-        if (!isValid) {
-            throw new Error("invalid signature");
-        }
-    }
-}
-function getPrevOutput(finalKey, graph, sharedOutputAmount, tx) {
-    // generate P2TR script from musig2 final key
-    const pkScript = script_js_1.Script.encode(["OP_1", finalKey.slice(1)]);
-    // if the input is the root input, return the shared output amount
-    if (tx.id === graph.txid) {
-        return {
-            amount: sharedOutputAmount,
-            script: pkScript,
-        };
-    }
-    // find the parent transaction
-    const parentInput = tx.getInput(0);
-    if (!parentInput.txid)
-        throw new Error("missing parent input txid");
-    const parentTxid = base_1.hex.encode(parentInput.txid);
-    const parent = graph.find(parentTxid);
-    if (!parent)
-        throw new Error("parent  tx not found");
-    if (parentInput.index === undefined)
-        throw new Error("missing input index");
-    const parentOutput = parent.root.getOutput(parentInput.index);
-    if (!parentOutput)
-        throw new Error("parent output not found");
-    if (!parentOutput.amount)
-        throw new Error("parent output amount not found");
-    return {
-        amount: parentOutput.amount,
-        script: pkScript,
-    };
-}

package/dist/cjs/tree/txTree.js

@@ -1,192 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TxTree = void 0;
-const transaction_js_1 = require("@scure/btc-signer/transaction.js");
-const base_1 = require("@scure/base");
-const base_2 = require("@scure/base");
-/**
- * TxTree is a graph of bitcoin transactions.
- * It is used to represent batch tree created during settlement session
- */
-class TxTree {
-    constructor(root, children = new Map()) {
-        this.root = root;
-        this.children = children;
-    }
-    static create(chunks) {
-        if (chunks.length === 0) {
-            throw new Error("empty chunks");
-        }
-        // Create a map to store all chunks by their txid for easy lookup
-        const chunksByTxid = new Map();
-        for (const chunk of chunks) {
-            const decodedChunk = decodeNode(chunk);
-            const txid = decodedChunk.tx.id;
-            chunksByTxid.set(txid, decodedChunk);
-        }
-        // Find the root chunks (the ones that aren't referenced as a child)
-        const rootTxids = [];
-        for (const [txid] of chunksByTxid) {
-            let isChild = false;
-            for (const [otherTxid, otherChunk] of chunksByTxid) {
-                if (otherTxid === txid) {
-                    // skip self
-                    continue;
-                }
-                // check if the current chunk is a child of the other chunk
-                isChild = hasChild(otherChunk, txid);
-                if (isChild) {
-                    break;
-                }
-            }
-            // if the chunk is not a child of any other chunk, it is a root
-            if (!isChild) {
-                rootTxids.push(txid);
-                continue;
-            }
-        }
-        if (rootTxids.length === 0) {
-            throw new Error("no root chunk found");
-        }
-        if (rootTxids.length > 1) {
-            throw new Error(`multiple root chunks found: ${rootTxids.join(", ")}`);
-        }
-        const graph = buildGraph(rootTxids[0], chunksByTxid);
-        if (!graph) {
-            throw new Error(`chunk not found for root txid: ${rootTxids[0]}`);
-        }
-        // verify that the number of chunks is equal to the number node in the graph
-        if (graph.nbOfNodes() !== chunks.length) {
-            throw new Error(`number of chunks (${chunks.length}) is not equal to the number of nodes in the graph (${graph.nbOfNodes()})`);
-        }
-        return graph;
-    }
-    nbOfNodes() {
-        let count = 1; // count this node
-        for (const child of this.children.values()) {
-            count += child.nbOfNodes();
-        }
-        return count;
-    }
-    validate() {
-        if (!this.root) {
-            throw new Error("unexpected nil root");
-        }
-        const nbOfOutputs = this.root.outputsLength;
-        const nbOfInputs = this.root.inputsLength;
-        if (nbOfInputs !== 1) {
-            throw new Error(`unexpected number of inputs: ${nbOfInputs}, expected 1`);
-        }
-        // the children map can't be bigger than the number of outputs (excluding the P2A)
-        // a graph can be "partial" and specify only some of the outputs as children,
-        // that's why we allow len(g.Children) to be less than nbOfOutputs-1
-        if (this.children.size > nbOfOutputs - 1) {
-            throw new Error(`unexpected number of children: ${this.children.size}, expected maximum ${nbOfOutputs - 1}`);
-        }
-        // validate each child
-        for (const [outputIndex, child] of this.children) {
-            if (outputIndex >= nbOfOutputs) {
-                throw new Error(`output index ${outputIndex} is out of bounds (nb of outputs: ${nbOfOutputs})`);
-            }
-            child.validate();
-            const childInput = child.root.getInput(0);
-            const parentTxid = this.root.id;
-            // verify the input of the child is the output of the parent
-            if (!childInput.txid ||
-                base_2.hex.encode(childInput.txid) !== parentTxid ||
-                childInput.index !== outputIndex) {
-                throw new Error(`input of child ${outputIndex} is not the output of the parent`);
-            }
-            // verify the sum of the child's outputs is equal to the output of the parent
-            let childOutputsSum = 0n;
-            for (let i = 0; i < child.root.outputsLength; i++) {
-                const output = child.root.getOutput(i);
-                if (output?.amount) {
-                    childOutputsSum += output.amount;
-                }
-            }
-            const parentOutput = this.root.getOutput(outputIndex);
-            if (!parentOutput?.amount) {
-                throw new Error(`parent output ${outputIndex} has no amount`);
-            }
-            if (childOutputsSum !== parentOutput.amount) {
-                throw new Error(`sum of child's outputs is not equal to the output of the parent: ${childOutputsSum} != ${parentOutput.amount}`);
-            }
-        }
-    }
-    leaves() {
-        if (this.children.size === 0) {
-            return [this.root];
-        }
-        const leaves = [];
-        for (const child of this.children.values()) {
-            leaves.push(...child.leaves());
-        }
-        return leaves;
-    }
-    get txid() {
-        return this.root.id;
-    }
-    find(txid) {
-        if (txid === this.txid) {
-            return this;
-        }
-        for (const child of this.children.values()) {
-            const found = child.find(txid);
-            if (found) {
-                return found;
-            }
-        }
-        return null;
-    }
-    update(txid, fn) {
-        if (txid === this.txid) {
-            fn(this.root);
-            return;
-        }
-        for (const child of this.children.values()) {
-            try {
-                child.update(txid, fn);
-                return;
-            }
-            catch (error) {
-                // Continue searching in other children if not found
-                continue;
-            }
-        }
-        throw new Error(`tx not found: ${txid}`);
-    }
-    *iterator() {
-        for (const child of this.children.values()) {
-            yield* child.iterator();
-        }
-        yield this;
-    }
-}
-exports.TxTree = TxTree;
-// Helper function to check if a chunk has a specific child
-function hasChild(chunk, childTxid) {
-    return Object.values(chunk.children).includes(childTxid);
-}
-// buildGraph recursively builds the TxGraph starting from the given txid
-function buildGraph(rootTxid, chunksByTxid) {
-    const chunk = chunksByTxid.get(rootTxid);
-    if (!chunk) {
-        return null;
-    }
-    const rootTx = chunk.tx;
-    const children = new Map();
-    // Recursively build children graphs
-    for (const [outputIndexStr, childTxid] of Object.entries(chunk.children)) {
-        const outputIndex = parseInt(outputIndexStr);
-        const childGraph = buildGraph(childTxid, chunksByTxid);
-        if (childGraph) {
-            children.set(outputIndex, childGraph);
-        }
-    }
-    return new TxTree(rootTx, children);
-}
-function decodeNode(chunk) {
-    const tx = transaction_js_1.Transaction.fromPSBT(base_1.base64.decode(chunk.tx));
-    return { tx, children: chunk.children };
-}

package/dist/cjs/tree/validation.js

@@ -1,107 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrMissingCosignersPublicKeys = exports.ErrWrongCommitmentTxid = exports.ErrInvalidRoundTxOutputs = exports.ErrInvalidTaprootScript = exports.ErrNoLeaves = exports.ErrInvalidAmount = exports.ErrWrongSettlementTxid = exports.ErrNumberOfInputs = exports.ErrEmptyTree = exports.ErrInvalidSettlementTxOutputs = exports.ErrInvalidSettlementTx = void 0;
-exports.validateConnectorsTxGraph = validateConnectorsTxGraph;
-exports.validateVtxoTxGraph = validateVtxoTxGraph;
-const base_1 = require("@scure/base");
-const transaction_js_1 = require("@scure/btc-signer/transaction.js");
-const base_2 = require("@scure/base");
-const musig2_1 = require("../musig2");
-const unknownFields_1 = require("../utils/unknownFields");
-const ErrInvalidSettlementTx = (tx) => new Error(`invalid settlement transaction: ${tx}`);
-exports.ErrInvalidSettlementTx = ErrInvalidSettlementTx;
-exports.ErrInvalidSettlementTxOutputs = new Error("invalid settlement transaction outputs");
-exports.ErrEmptyTree = new Error("empty tree");
-exports.ErrNumberOfInputs = new Error("invalid number of inputs");
-exports.ErrWrongSettlementTxid = new Error("wrong settlement txid");
-exports.ErrInvalidAmount = new Error("invalid amount");
-exports.ErrNoLeaves = new Error("no leaves");
-exports.ErrInvalidTaprootScript = new Error("invalid taproot script");
-exports.ErrInvalidRoundTxOutputs = new Error("invalid round transaction outputs");
-exports.ErrWrongCommitmentTxid = new Error("wrong commitment txid");
-exports.ErrMissingCosignersPublicKeys = new Error("missing cosigners public keys");
-const BATCH_OUTPUT_VTXO_INDEX = 0;
-const BATCH_OUTPUT_CONNECTORS_INDEX = 1;
-function validateConnectorsTxGraph(settlementTxB64, connectorsGraph) {
-    connectorsGraph.validate();
-    if (connectorsGraph.root.inputsLength !== 1)
-        throw exports.ErrNumberOfInputs;
-    const rootInput = connectorsGraph.root.getInput(0);
-    const settlementTx = transaction_js_1.Transaction.fromPSBT(base_2.base64.decode(settlementTxB64));
-    if (settlementTx.outputsLength <= BATCH_OUTPUT_CONNECTORS_INDEX)
-        throw exports.ErrInvalidSettlementTxOutputs;
-    const expectedRootTxid = settlementTx.id;
-    if (!rootInput.txid)
-        throw exports.ErrWrongSettlementTxid;
-    if (base_1.hex.encode(rootInput.txid) !== expectedRootTxid)
-        throw exports.ErrWrongSettlementTxid;
-    if (rootInput.index !== BATCH_OUTPUT_CONNECTORS_INDEX)
-        throw exports.ErrWrongSettlementTxid;
-}
-// ValidateVtxoTxGraph checks if the given virtual output tx graph is valid.
-// The function validates:
-// - the number of nodes
-// - the number of leaves
-// - children coherence with parent.
-// - every control block and taproot output scripts.
-// - input and output amounts.
-function validateVtxoTxGraph(graph, roundTransaction, sweepTapTreeRoot) {
-    if (roundTransaction.outputsLength < BATCH_OUTPUT_VTXO_INDEX + 1) {
-        throw exports.ErrInvalidRoundTxOutputs;
-    }
-    const batchOutputAmount = roundTransaction.getOutput(BATCH_OUTPUT_VTXO_INDEX)?.amount;
-    if (!batchOutputAmount) {
-        throw exports.ErrInvalidRoundTxOutputs;
-    }
-    if (!graph.root) {
-        throw exports.ErrEmptyTree;
-    }
-    const rootInput = graph.root.getInput(0);
-    const commitmentTxid = roundTransaction.id;
-    if (!rootInput.txid ||
-        base_1.hex.encode(rootInput.txid) !== commitmentTxid ||
-        rootInput.index !== BATCH_OUTPUT_VTXO_INDEX) {
-        throw exports.ErrWrongCommitmentTxid;
-    }
-    let sumRootValue = 0n;
-    for (let i = 0; i < graph.root.outputsLength; i++) {
-        const output = graph.root.getOutput(i);
-        if (output?.amount) {
-            sumRootValue += output.amount;
-        }
-    }
-    if (sumRootValue !== batchOutputAmount) {
-        throw exports.ErrInvalidAmount;
-    }
-    const leaves = graph.leaves();
-    if (leaves.length === 0) {
-        throw exports.ErrNoLeaves;
-    }
-    // validate the graph structure
-    graph.validate();
-    // iterates over all the nodes of the graph to verify that cosigners public keys are corresponding to the parent output
-    for (const g of graph.iterator()) {
-        for (const [childIndex, child] of g.children) {
-            const parentOutput = g.root.getOutput(childIndex);
-            if (!parentOutput?.script) {
-                throw new Error(`parent output ${childIndex} not found`);
-            }
-            const previousScriptKey = parentOutput.script.slice(2);
-            if (previousScriptKey.length !== 32) {
-                throw new Error(`parent output ${childIndex} has invalid script`);
-            }
-            const cosigners = (0, unknownFields_1.getArkPsbtFields)(child.root, 0, unknownFields_1.CosignerPublicKey);
-            if (cosigners.length === 0) {
-                throw exports.ErrMissingCosignersPublicKeys;
-            }
-            const cosignerKeys = cosigners.map((c) => c.key);
-            const { finalKey } = (0, musig2_1.aggregateKeys)(cosignerKeys, true, {
-                taprootTweak: sweepTapTreeRoot,
-            });
-            if (!finalKey ||
-                base_1.hex.encode(finalKey.slice(1)) !== base_1.hex.encode(previousScriptKey)) {
-                throw exports.ErrInvalidTaprootScript;
-            }
-        }
-    }
-}

package/dist/cjs/utils/anchor.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.P2A = exports.ANCHOR_PKSCRIPT = exports.ANCHOR_VALUE = void 0;
-exports.findP2AOutput = findP2AOutput;
-const base_1 = require("@scure/base");
-exports.ANCHOR_VALUE = 0n;
-exports.ANCHOR_PKSCRIPT = new Uint8Array([0x51, 0x02, 0x4e, 0x73]);
-/**
- * A zero-value anchor output.
- */
-exports.P2A = {
-    script: exports.ANCHOR_PKSCRIPT,
-    amount: exports.ANCHOR_VALUE,
-};
-const hexP2Ascript = base_1.hex.encode(exports.P2A.script);
-/**
- * search for anchor in the given transaction.
- * @throws {Error} if the anchor is not found or has the wrong amount
- */
-function findP2AOutput(tx) {
-    for (let i = 0; i < tx.outputsLength; i++) {
-        const output = tx.getOutput(i);
-        if (output.script && base_1.hex.encode(output.script) === hexP2Ascript) {
-            if (output.amount !== exports.P2A.amount) {
-                throw new Error(`P2A output has wrong amount, expected ${exports.P2A.amount} got ${output.amount}`);
-            }
-            return {
-                txid: tx.id,
-                index: i,
-                witnessUtxo: exports.P2A,
-            };
-        }
-    }
-    throw new Error("P2A output not found");
-}