@arkade-os/sdk 0.1.4 → 0.2.1

package/dist/cjs/bip322/index.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BIP322 = void 0;
+exports.craftToSpendTx = craftToSpendTx;
+const btc_signer_1 = require("@scure/btc-signer");
+const errors_1 = require("./errors");
+const secp256k1_1 = require("@noble/curves/secp256k1");
+const base_1 = require("@scure/base");
+/**
+ * BIP-322 signature implementation for Bitcoin message signing.
+ *
+ * BIP-322 defines a standard for signing Bitcoin messages as well as proving
+ * ownership of coins. This namespace provides utilities for creating and
+ * validating BIP-322.
+ *
+ * @see https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki
+ *
+ * @example
+ * ```typescript
+ * // Create a BIP-322 proof
+ * const proof = BIP322.create(
+ *   "Hello Bitcoin!",
+ *   [input],
+ *   [output]
+ * );
+ *
+ * // Sign the proof
+ * const signedProof = await identity.sign(proof);
+ *
+ * // Extract the signature
+ * const signature = BIP322.signature(signedProof);
+ * ```
+ */
+var BIP322;
+(function (BIP322) {
+    /**
+     * Creates a new BIP-322 "full" proof of funds unsigned transaction.
+     *
+     * This function constructs a special transaction that can be signed to prove
+     * ownership of VTXOs and UTXOs. The proof includes the message to be
+     * signed and the inputs/outputs that demonstrate ownership.
+     *
+     * @param message - The BIP-322 message to be signed
+     * @param inputs - Array of transaction inputs to prove ownership of
+     * @param outputs - Optional array of transaction outputs
+     * @returns An unsigned BIP-322 proof transaction
+     */
+    function create(message, inputs, outputs = []) {
+        if (inputs.length == 0)
+            throw errors_1.ErrMissingInputs;
+        if (!validateInputs(inputs))
+            throw errors_1.ErrMissingData;
+        if (!validateOutputs(outputs))
+            throw errors_1.ErrMissingData;
+        // create the initial transaction to spend
+        const toSpend = craftToSpendTx(message, inputs[0].witnessUtxo.script);
+        // create the transaction to sign
+        return craftToSignTx(toSpend, inputs, outputs);
+    }
+    BIP322.create = create;
+    /**
+     * Finalizes and extracts the FullProof transaction into a BIP-322 signature.
+     *
+     * This function takes a signed proof transaction and converts it into a
+     * base64-encoded signature string. If the proof's inputs have special
+     * spending conditions, a custom finalizer can be provided.
+     *
+     * @param signedProof - The signed BIP-322 proof transaction
+     * @param finalizer - Optional custom finalizer function
+     * @returns Base64-encoded BIP-322 signature
+     */
+    function signature(signedProof, finalizer = (tx) => tx.finalize()) {
+        finalizer(signedProof);
+        return base_1.base64.encode(signedProof.extract());
+    }
+    BIP322.signature = signature;
+})(BIP322 || (exports.BIP322 = BIP322 = {}));
+const OP_RETURN_EMPTY_PKSCRIPT = new Uint8Array([btc_signer_1.OP.RETURN]);
+const ZERO_32 = new Uint8Array(32).fill(0);
+const MAX_INDEX = 0xffffffff;
+const TAG_BIP322 = "BIP0322-signed-message";
+function validateInput(input) {
+    if (input.index === undefined)
+        throw errors_1.ErrMissingData;
+    if (input.txid === undefined)
+        throw errors_1.ErrMissingData;
+    if (input.witnessUtxo === undefined)
+        throw errors_1.ErrMissingWitnessUtxo;
+    return true;
+}
+function validateInputs(inputs) {
+    inputs.forEach(validateInput);
+    return true;
+}
+function validateOutput(output) {
+    if (output.amount === undefined)
+        throw errors_1.ErrMissingData;
+    if (output.script === undefined)
+        throw errors_1.ErrMissingData;
+    return true;
+}
+function validateOutputs(outputs) {
+    outputs.forEach(validateOutput);
+    return true;
+}
+// craftToSpendTx creates the initial transaction that will be spent in the proof
+function craftToSpendTx(message, pkScript) {
+    const messageHash = hashMessage(message);
+    const tx = new btc_signer_1.Transaction({
+        version: 0,
+        allowUnknownOutputs: true,
+        allowUnknown: true,
+        allowUnknownInputs: true,
+    });
+    // add input with zero hash and max index
+    tx.addInput({
+        txid: ZERO_32, // zero hash
+        index: MAX_INDEX,
+        sequence: 0,
+    });
+    // add output with zero value and provided pkScript
+    tx.addOutput({
+        amount: 0n,
+        script: pkScript,
+    });
+    tx.updateInput(0, {
+        finalScriptSig: btc_signer_1.Script.encode(["OP_0", messageHash]),
+    });
+    return tx;
+}
+// craftToSignTx creates the transaction that will be signed for the proof
+function craftToSignTx(toSpend, inputs, outputs) {
+    const firstInput = inputs[0];
+    const tx = new btc_signer_1.Transaction({
+        version: 2,
+        allowUnknownOutputs: outputs.length === 0,
+        allowUnknown: true,
+        allowUnknownInputs: true,
+        lockTime: 0,
+    });
+    // add the first "toSpend" input
+    tx.addInput({
+        ...firstInput,
+        txid: toSpend.id,
+        index: 0,
+        witnessUtxo: {
+            script: firstInput.witnessUtxo.script,
+            amount: 0n,
+        },
+        sighashType: btc_signer_1.SigHash.ALL,
+    });
+    // add other inputs
+    for (const input of inputs) {
+        tx.addInput({
+            ...input,
+            sighashType: btc_signer_1.SigHash.ALL,
+        });
+    }
+    // add the special OP_RETURN output if no outputs are provided
+    if (outputs.length === 0) {
+        outputs = [
+            {
+                amount: 0n,
+                script: OP_RETURN_EMPTY_PKSCRIPT,
+            },
+        ];
+    }
+    for (const output of outputs) {
+        tx.addOutput({
+            amount: output.amount,
+            script: output.script,
+        });
+    }
+    return tx;
+}
+function hashMessage(message) {
+    return secp256k1_1.schnorr.utils.taggedHash(TAG_BIP322, new TextEncoder().encode(message));
+}

package/dist/cjs/forfeit.js

@@ -2,37 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildForfeitTx = buildForfeitTx;
 const btc_signer_1 = require("@scure/btc-signer");
-function buildForfeitTx({ connectorInput, vtxoInput, vtxoAmount, connectorAmount, feeAmount, vtxoPkScript, connectorPkScript, serverPkScript, txLocktime, }) {
+const anchor_1 = require("./utils/anchor");
+function buildForfeitTx(inputs, forfeitPkScript, txLocktime) {
     const tx = new btc_signer_1.Transaction({
-        version: 2,
+        version: 3,
         lockTime: txLocktime,
     });
-    // Add connector input
-    tx.addInput({
-        txid: connectorInput.txid,
-        index: connectorInput.vout,
-        witnessUtxo: {
-            script: connectorPkScript,
-            amount: connectorAmount,
-        },
-        sequence: 0xffffffff,
-    });
-    // Add VTXO input
-    tx.addInput({
-        txid: vtxoInput.txid,
-        index: vtxoInput.vout,
-        witnessUtxo: {
-            script: vtxoPkScript,
-            amount: vtxoAmount,
-        },
-        sequence: txLocktime ? 0xfffffffe : 0xffffffff, // MAX_SEQUENCE - 1 if locktime is set
-        sighashType: btc_signer_1.SigHash.DEFAULT,
-    });
-    const amount = BigInt(vtxoAmount) + BigInt(connectorAmount) - BigInt(feeAmount);
+    let amount = 0n;
+    for (const input of inputs) {
+        if (!input.witnessUtxo) {
+            throw new Error("input needs witness utxo");
+        }
+        amount += input.witnessUtxo.amount;
+        tx.addInput(input);
+    }
     // Add main output to server
     tx.addOutput({
-        script: serverPkScript,
+        script: forfeitPkScript,
         amount,
     });
+    // Add P2A output
+    tx.addOutput(anchor_1.P2A);
     return tx;
 }

package/dist/cjs/identity/singleKey.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SingleKey = void 0;
+const utils_1 = require("@scure/btc-signer/utils");
+const base_1 = require("@scure/base");
+const btc_signer_1 = require("@scure/btc-signer");
+const signingSession_1 = require("../tree/signingSession");
+const ZERO_32 = new Uint8Array(32).fill(0);
+const ALL_SIGHASH = Object.values(btc_signer_1.SigHash).filter((x) => typeof x === "number");
+/**
+ * In-memory single key implementation for Bitcoin transaction signing.
+ *
+ * @example
+ * ```typescript
+ * // Create from hex string
+ * const key = SingleKey.fromHex('your_private_key_hex');
+ *
+ * // Create from raw bytes
+ * const key = SingleKey.fromPrivateKey(privateKeyBytes);
+ *
+ * // Sign a transaction
+ * const signedTx = await key.sign(transaction);
+ * ```
+ */
+class SingleKey {
+    constructor(key) {
+        this.key = key || (0, utils_1.randomPrivateKeyBytes)();
+    }
+    static fromPrivateKey(privateKey) {
+        return new SingleKey(privateKey);
+    }
+    static fromHex(privateKeyHex) {
+        return new SingleKey(base_1.hex.decode(privateKeyHex));
+    }
+    async sign(tx, inputIndexes) {
+        const txCpy = tx.clone();
+        if (!inputIndexes) {
+            try {
+                if (!txCpy.sign(this.key, ALL_SIGHASH, ZERO_32)) {
+                    throw new Error("Failed to sign transaction");
+                }
+            }
+            catch (e) {
+                if (e instanceof Error &&
+                    e.message.includes("No inputs signed")) {
+                    // ignore
+                }
+                else {
+                    throw e;
+                }
+            }
+            return txCpy;
+        }
+        for (const inputIndex of inputIndexes) {
+            if (!txCpy.signIdx(this.key, inputIndex, ALL_SIGHASH, ZERO_32)) {
+                throw new Error(`Failed to sign input #${inputIndex}`);
+            }
+        }
+        return txCpy;
+    }
+    xOnlyPublicKey() {
+        return (0, utils_1.pubSchnorr)(this.key);
+    }
+    signerSession() {
+        return signingSession_1.TreeSignerSession.random();
+    }
+}
+exports.SingleKey = SingleKey;

package/dist/cjs/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndexedDBVtxoRepository = exports.networks = exports.ArkNoteData = exports.ArkNote = exports.createVirtualTx = exports.CONDITION_WITNESS_KEY_PREFIX = exports.addConditionWitness = exports.CLTVMultisigTapscript = exports.ConditionMultisigTapscript = exports.ConditionCSVMultisigTapscript = exports.CSVMultisigTapscript = exports.MultisigTapscript = exports.decodeTapscript = exports.Response = exports.Request = exports.ServiceWorkerWallet = exports.Worker = exports.setupServiceWorker = exports.TxType = exports.VHTLC = exports.VtxoScript = exports.DefaultVtxo = exports.ArkAddress = exports.RestArkProvider = exports.EsploraProvider = exports.ESPLORA_URL = exports.InMemoryKey = exports.Wallet = void 0;
-const inMemoryKey_1 = require("./identity/inMemoryKey");
-Object.defineProperty(exports, "InMemoryKey", { enumerable: true, get: function () { return inMemoryKey_1.InMemoryKey; } });
+exports.Transaction = exports.Unroll = exports.P2A = exports.TxTree = exports.BIP322 = exports.IndexedDBVtxoRepository = exports.networks = exports.ArkNote = exports.waitForIncomingFunds = exports.buildOffchainTx = exports.ConditionWitness = exports.VtxoTaprootTree = exports.VtxoTreeExpiry = exports.CosignerPublicKey = exports.getArkPsbtFields = exports.setArkPsbtField = exports.ArkPsbtFieldKeyType = exports.ArkPsbtFieldKey = exports.CLTVMultisigTapscript = exports.ConditionMultisigTapscript = exports.ConditionCSVMultisigTapscript = exports.CSVMultisigTapscript = exports.MultisigTapscript = exports.decodeTapscript = exports.Response = exports.Request = exports.ServiceWorkerWallet = exports.Worker = exports.setupServiceWorker = exports.SettlementEventType = exports.ChainTxType = exports.IndexerTxType = exports.TxType = exports.VHTLC = exports.VtxoScript = exports.DefaultVtxo = exports.ArkAddress = exports.RestIndexerProvider = exports.RestArkProvider = exports.EsploraProvider = exports.ESPLORA_URL = exports.Ramps = exports.OnchainWallet = exports.SingleKey = exports.Wallet = void 0;
+const btc_signer_1 = require("@scure/btc-signer");
+Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return btc_signer_1.Transaction; } });
+const singleKey_1 = require("./identity/singleKey");
+Object.defineProperty(exports, "SingleKey", { enumerable: true, get: function () { return singleKey_1.SingleKey; } });
 const address_1 = require("./script/address");
 Object.defineProperty(exports, "ArkAddress", { enumerable: true, get: function () { return address_1.ArkAddress; } });
 const vhtlc_1 = require("./script/vhtlc");
@@ -11,12 +13,19 @@ const default_1 = require("./script/default");
 Object.defineProperty(exports, "DefaultVtxo", { enumerable: true, get: function () { return default_1.DefaultVtxo; } });
 const base_1 = require("./script/base");
 Object.defineProperty(exports, "VtxoScript", { enumerable: true, get: function () { return base_1.VtxoScript; } });
-const index_1 = require("./wallet/index");
-Object.defineProperty(exports, "TxType", { enumerable: true, get: function () { return index_1.TxType; } });
-const wallet_1 = require("./wallet/wallet");
-Object.defineProperty(exports, "Wallet", { enumerable: true, get: function () { return wallet_1.Wallet; } });
-const wallet_2 = require("./wallet/serviceWorker/wallet");
-Object.defineProperty(exports, "ServiceWorkerWallet", { enumerable: true, get: function () { return wallet_2.ServiceWorkerWallet; } });
+const wallet_1 = require("./wallet");
+Object.defineProperty(exports, "TxType", { enumerable: true, get: function () { return wallet_1.TxType; } });
+const wallet_2 = require("./wallet/wallet");
+Object.defineProperty(exports, "Wallet", { enumerable: true, get: function () { return wallet_2.Wallet; } });
+Object.defineProperty(exports, "waitForIncomingFunds", { enumerable: true, get: function () { return wallet_2.waitForIncomingFunds; } });
+const txTree_1 = require("./tree/txTree");
+Object.defineProperty(exports, "TxTree", { enumerable: true, get: function () { return txTree_1.TxTree; } });
+const ramps_1 = require("./wallet/ramps");
+Object.defineProperty(exports, "Ramps", { enumerable: true, get: function () { return ramps_1.Ramps; } });
+const wallet_3 = require("./wallet/serviceWorker/wallet");
+Object.defineProperty(exports, "ServiceWorkerWallet", { enumerable: true, get: function () { return wallet_3.ServiceWorkerWallet; } });
+const onchain_1 = require("./wallet/onchain");
+Object.defineProperty(exports, "OnchainWallet", { enumerable: true, get: function () { return onchain_1.OnchainWallet; } });
 const utils_1 = require("./wallet/serviceWorker/utils");
 Object.defineProperty(exports, "setupServiceWorker", { enumerable: true, get: function () { return utils_1.setupServiceWorker; } });
 const worker_1 = require("./wallet/serviceWorker/worker");
@@ -25,11 +34,12 @@ const request_1 = require("./wallet/serviceWorker/request");
 Object.defineProperty(exports, "Request", { enumerable: true, get: function () { return request_1.Request; } });
 const response_1 = require("./wallet/serviceWorker/response");
 Object.defineProperty(exports, "Response", { enumerable: true, get: function () { return response_1.Response; } });
-const onchain_1 = require("./providers/onchain");
-Object.defineProperty(exports, "ESPLORA_URL", { enumerable: true, get: function () { return onchain_1.ESPLORA_URL; } });
-Object.defineProperty(exports, "EsploraProvider", { enumerable: true, get: function () { return onchain_1.EsploraProvider; } });
+const onchain_2 = require("./providers/onchain");
+Object.defineProperty(exports, "ESPLORA_URL", { enumerable: true, get: function () { return onchain_2.ESPLORA_URL; } });
+Object.defineProperty(exports, "EsploraProvider", { enumerable: true, get: function () { return onchain_2.EsploraProvider; } });
 const ark_1 = require("./providers/ark");
 Object.defineProperty(exports, "RestArkProvider", { enumerable: true, get: function () { return ark_1.RestArkProvider; } });
+Object.defineProperty(exports, "SettlementEventType", { enumerable: true, get: function () { return ark_1.SettlementEventType; } });
 const tapscript_1 = require("./script/tapscript");
 Object.defineProperty(exports, "CLTVMultisigTapscript", { enumerable: true, get: function () { return tapscript_1.CLTVMultisigTapscript; } });
 Object.defineProperty(exports, "ConditionCSVMultisigTapscript", { enumerable: true, get: function () { return tapscript_1.ConditionCSVMultisigTapscript; } });
@@ -37,14 +47,30 @@ Object.defineProperty(exports, "ConditionMultisigTapscript", { enumerable: true,
 Object.defineProperty(exports, "CSVMultisigTapscript", { enumerable: true, get: function () { return tapscript_1.CSVMultisigTapscript; } });
 Object.defineProperty(exports, "decodeTapscript", { enumerable: true, get: function () { return tapscript_1.decodeTapscript; } });
 Object.defineProperty(exports, "MultisigTapscript", { enumerable: true, get: function () { return tapscript_1.MultisigTapscript; } });
-const psbt_1 = require("./utils/psbt");
-Object.defineProperty(exports, "addConditionWitness", { enumerable: true, get: function () { return psbt_1.addConditionWitness; } });
-Object.defineProperty(exports, "CONDITION_WITNESS_KEY_PREFIX", { enumerable: true, get: function () { return psbt_1.CONDITION_WITNESS_KEY_PREFIX; } });
-Object.defineProperty(exports, "createVirtualTx", { enumerable: true, get: function () { return psbt_1.createVirtualTx; } });
+const arkTransaction_1 = require("./utils/arkTransaction");
+Object.defineProperty(exports, "buildOffchainTx", { enumerable: true, get: function () { return arkTransaction_1.buildOffchainTx; } });
+const unknownFields_1 = require("./utils/unknownFields");
+Object.defineProperty(exports, "VtxoTaprootTree", { enumerable: true, get: function () { return unknownFields_1.VtxoTaprootTree; } });
+Object.defineProperty(exports, "ConditionWitness", { enumerable: true, get: function () { return unknownFields_1.ConditionWitness; } });
+Object.defineProperty(exports, "getArkPsbtFields", { enumerable: true, get: function () { return unknownFields_1.getArkPsbtFields; } });
+Object.defineProperty(exports, "setArkPsbtField", { enumerable: true, get: function () { return unknownFields_1.setArkPsbtField; } });
+Object.defineProperty(exports, "ArkPsbtFieldKey", { enumerable: true, get: function () { return unknownFields_1.ArkPsbtFieldKey; } });
+Object.defineProperty(exports, "ArkPsbtFieldKeyType", { enumerable: true, get: function () { return unknownFields_1.ArkPsbtFieldKeyType; } });
+Object.defineProperty(exports, "CosignerPublicKey", { enumerable: true, get: function () { return unknownFields_1.CosignerPublicKey; } });
+Object.defineProperty(exports, "VtxoTreeExpiry", { enumerable: true, get: function () { return unknownFields_1.VtxoTreeExpiry; } });
+const bip322_1 = require("./bip322");
+Object.defineProperty(exports, "BIP322", { enumerable: true, get: function () { return bip322_1.BIP322; } });
 const arknote_1 = require("./arknote");
 Object.defineProperty(exports, "ArkNote", { enumerable: true, get: function () { return arknote_1.ArkNote; } });
-Object.defineProperty(exports, "ArkNoteData", { enumerable: true, get: function () { return arknote_1.ArkNoteData; } });
 const idb_1 = require("./wallet/serviceWorker/db/vtxo/idb");
 Object.defineProperty(exports, "IndexedDBVtxoRepository", { enumerable: true, get: function () { return idb_1.IndexedDBVtxoRepository; } });
 const networks_1 = require("./networks");
 Object.defineProperty(exports, "networks", { enumerable: true, get: function () { return networks_1.networks; } });
+const indexer_1 = require("./providers/indexer");
+Object.defineProperty(exports, "RestIndexerProvider", { enumerable: true, get: function () { return indexer_1.RestIndexerProvider; } });
+Object.defineProperty(exports, "IndexerTxType", { enumerable: true, get: function () { return indexer_1.IndexerTxType; } });
+Object.defineProperty(exports, "ChainTxType", { enumerable: true, get: function () { return indexer_1.ChainTxType; } });
+const anchor_1 = require("./utils/anchor");
+Object.defineProperty(exports, "P2A", { enumerable: true, get: function () { return anchor_1.P2A; } });
+const unroll_1 = require("./wallet/unroll");
+Object.defineProperty(exports, "Unroll", { enumerable: true, get: function () { return unroll_1.Unroll; } });