@arkade-os/sdk 0.4.27 → 0.4.28

package/dist/cjs/utils/transactionHistory.js

@@ -1,183 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildTransactionHistory = buildTransactionHistory;
-const wallet_1 = require("../wallet");
-const txKey = {
-    commitmentTxid: "",
-    boardingTxid: "",
-    arkTxid: "",
-};
-function collectAssets(vtxos) {
-    const map = new Map();
-    for (const vtxo of vtxos) {
-        if (vtxo.assets) {
-            for (const a of vtxo.assets) {
-                map.set(a.assetId, (map.get(a.assetId) ?? 0n) + a.amount);
-            }
-        }
-    }
-    if (map.size === 0)
-        return undefined;
-    return Array.from(map, ([assetId, amount]) => ({ assetId, amount }));
-}
-function subtractAssets(spent, change) {
-    const map = new Map();
-    for (const vtxo of change) {
-        if (vtxo.assets) {
-            for (const a of vtxo.assets) {
-                map.set(a.assetId, (map.get(a.assetId) ?? 0n) + a.amount);
-            }
-        }
-    }
-    for (const vtxo of spent) {
-        if (vtxo.assets) {
-            for (const a of vtxo.assets) {
-                const current = map.get(a.assetId) ?? 0n;
-                const remaining = current - a.amount;
-                if (remaining !== 0n) {
-                    map.set(a.assetId, remaining);
-                }
-                else {
-                    map.delete(a.assetId);
-                }
-            }
-        }
-    }
-    if (map.size === 0)
-        return undefined;
-    return Array.from(map, ([assetId, amount]) => ({ assetId, amount }));
-}
-/**
- * Builds the transaction history by analyzing virtual outputs, boarding transactions, and ignored commitments.
- * History is sorted from newest to oldest and is composed only of SENT and RECEIVED transactions.
- *
- * @param {VirtualCoin[]} vtxos - An array of virtual outputs representing the user's transactions and balances.
- * @param {ArkTransaction[]} allBoardingTxs - An array of boarding transactions to include in the history.
- * @param {Set<string>} commitmentsToIgnore - A set of commitment IDs that should be excluded from processing.
- * @return {ExtendedArkTransaction[]} A sorted array of extended Arkade transactions, representing the transaction history.
- */
-async function buildTransactionHistory(vtxos, allBoardingTxs, commitmentsToIgnore, getTxCreatedAt) {
-    const fromOldestVtxo = [...vtxos].sort((a, b) => a.createdAt.getTime() - b.createdAt.getTime());
-    const sent = [];
-    let received = [];
-    for (const vtxo of fromOldestVtxo) {
-        if (vtxo.status.isLeaf) {
-            // If this virtual output is a leaf and it's not the settlement of a boarding or there's no virtual output refreshed by it,
-            // it's translated into a received batch transaction
-            if (!commitmentsToIgnore.has(vtxo.virtualStatus.commitmentTxIds[0]) &&
-                fromOldestVtxo.filter((v) => v.settledBy === vtxo.virtualStatus.commitmentTxIds[0]).length === 0) {
-                const assets = collectAssets([vtxo]);
-                received.push({
-                    key: {
-                        ...txKey,
-                        commitmentTxid: vtxo.virtualStatus.commitmentTxIds[0],
-                    },
-                    tag: "batch",
-                    type: wallet_1.TxType.TxReceived,
-                    amount: vtxo.value,
-                    settled: vtxo.status.isLeaf || vtxo.isSpent,
-                    createdAt: vtxo.createdAt.getTime(),
-                    ...(assets && { assets }),
-                });
-            }
-        }
-        else if (fromOldestVtxo.filter((v) => v.arkTxId === vtxo.txid).length === 0) {
-            // If this virtual output is preconfirmed and does not spend any other virtual outputs,
-            // it's translated into a received offchain transaction
-            const assets = collectAssets([vtxo]);
-            received.push({
-                key: { ...txKey, arkTxid: vtxo.txid },
-                tag: "offchain",
-                type: wallet_1.TxType.TxReceived,
-                amount: vtxo.value,
-                settled: vtxo.status.isLeaf || vtxo.isSpent,
-                createdAt: vtxo.createdAt.getTime(),
-                ...(assets && { assets }),
-            });
-        }
-        // If the virtual output is spent, it's translated into a sent transaction unless:
-        // - it's been refreshed (we don't want to add any record in this case)
-        // - a sent transaction has been already added to avoid duplicates (can happen if many virtual outputs have been spent in the same tx or forfeited in the same batch)
-        if (vtxo.isSpent) {
-            // If the virtual output is spent offchain, it's translated into an offchain sent tx
-            if (vtxo.arkTxId &&
-                !sent.some((s) => s.key.arkTxid === vtxo.arkTxId)) {
-                const changes = fromOldestVtxo.filter((_) => _.txid === vtxo.arkTxId);
-                // We want to find all the other virtual outputs spent by the same transaction to
-                // calculate the full amount of the change.
-                const allSpent = fromOldestVtxo.filter((v) => v.arkTxId === vtxo.arkTxId);
-                const spentAmount = allSpent.reduce((acc, v) => acc + v.value, 0);
-                let txAmount = 0;
-                let txTime = 0;
-                if (changes.length > 0) {
-                    const changeAmount = changes.reduce((acc, v) => acc + v.value, 0);
-                    txAmount = spentAmount - changeAmount;
-                    txTime = changes[0].createdAt.getTime();
-                }
-                else {
-                    txAmount = spentAmount;
-                    // TODO: fetch the virtual output with /v1/indexer/vtxos?outpoints=<vtxo.arkTxid:0> to know when the tx was made
-                    txTime = getTxCreatedAt
-                        ? ((await getTxCreatedAt(vtxo.arkTxId)) ??
-                            vtxo.createdAt.getTime() + 1)
-                        : vtxo.createdAt.getTime() + 1;
-                }
-                const assets = subtractAssets(allSpent, changes);
-                sent.push({
-                    key: { ...txKey, arkTxid: vtxo.arkTxId },
-                    tag: "offchain",
-                    type: wallet_1.TxType.TxSent,
-                    amount: txAmount,
-                    settled: true,
-                    createdAt: txTime,
-                    ...(assets && { assets }),
-                });
-            }
-            // If the virtual output is forfeited in a batch and the total sum of forfeited virtual outputs is bigger than the sum of new virtual outputs,
-            // it's translated into an exit sent tx
-            if (vtxo.settledBy &&
-                !commitmentsToIgnore.has(vtxo.settledBy) &&
-                !sent.some((s) => s.key.commitmentTxid === vtxo.settledBy)) {
-                const changes = fromOldestVtxo.filter((v) => v.status.isLeaf &&
-                    v.virtualStatus.commitmentTxIds?.every((_) => vtxo.settledBy === _));
-                const forfeitVtxos = fromOldestVtxo.filter((v) => v.settledBy === vtxo.settledBy);
-                const forfeitAmount = forfeitVtxos.reduce((acc, v) => acc + v.value, 0);
-                if (changes.length > 0) {
-                    const settledAmount = changes.reduce((acc, v) => acc + v.value, 0);
-                    // forfeitAmount > settledAmount --> collaborative exit with offchain change
-                    // TODO: make this support fees!
-                    if (forfeitAmount > settledAmount) {
-                        const assets = subtractAssets(forfeitVtxos, changes);
-                        sent.push({
-                            key: { ...txKey, commitmentTxid: vtxo.settledBy },
-                            tag: "exit",
-                            type: wallet_1.TxType.TxSent,
-                            amount: forfeitAmount - settledAmount,
-                            settled: true,
-                            createdAt: changes[0].createdAt.getTime(),
-                            ...(assets && { assets }),
-                        });
-                    }
-                }
-                else {
-                    // forfeitAmount > 0 && settledAmount == 0 --> collaborative exit without any offchain change
-                    const assets = subtractAssets(forfeitVtxos, []);
-                    sent.push({
-                        key: { ...txKey, commitmentTxid: vtxo.settledBy },
-                        tag: "exit",
-                        type: wallet_1.TxType.TxSent,
-                        amount: forfeitAmount,
-                        settled: true,
-                        // TODO: fetch commitment tx with /v1/indexer/commitmentTx/<commitmentTxid> to know when the tx was made
-                        createdAt: vtxo.createdAt.getTime() + 1,
-                        ...(assets && { assets }),
-                    });
-                }
-            }
-        }
-    }
-    // Boardings are always inbound amounts, and we only hide the ones to ignore.
-    const boardingTx = allBoardingTxs.map((tx) => ({ ...tx, tag: "boarding" }));
-    const sorted = [...boardingTx, ...sent, ...received].sort((a, b) => b.createdAt - a.createdAt);
-    return sorted;
-}

package/dist/cjs/utils/txSizeEstimator.js

@@ -1,132 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TxWeightEstimator = void 0;
-const btc_signer_1 = require("@scure/btc-signer");
-/**
- * Calculates the byte size required to store a variable-length integer (VarInt).
- * Bitcoin uses VarInts to compact integer data (like array lengths).
- *
- * @param n - The integer value to check
- * @returns The size in bytes (1, 3, 5, or 9)
- */
-const getVarIntSize = (n) => {
-    if (n < 0xfd)
-        return 1;
-    if (n <= 0xffff)
-        return 3;
-    if (n <= 0xffffffff)
-        return 5;
-    return 9;
-};
-class TxWeightEstimator {
-    constructor(hasWitness, inputCount, outputCount, inputSize, inputWitnessSize, outputSize) {
-        this.hasWitness = hasWitness;
-        this.inputCount = inputCount;
-        this.outputCount = outputCount;
-        this.inputSize = inputSize;
-        this.inputWitnessSize = inputWitnessSize;
-        this.outputSize = outputSize;
-    }
-    static create() {
-        return new TxWeightEstimator(false, 0, 0, 0, 0, 0);
-    }
-    addP2AInput() {
-        this.inputCount++;
-        this.inputSize += TxWeightEstimator.INPUT_SIZE;
-        return this;
-    }
-    addKeySpendInput(isDefault = true) {
-        this.inputCount++;
-        this.inputWitnessSize += 64 + 1 + (isDefault ? 0 : 1);
-        this.inputSize += TxWeightEstimator.INPUT_SIZE;
-        this.hasWitness = true;
-        return this;
-    }
-    addP2PKHInput() {
-        this.inputCount++;
-        this.inputWitnessSize++;
-        this.inputSize +=
-            TxWeightEstimator.INPUT_SIZE +
-                TxWeightEstimator.P2PKH_SCRIPT_SIG_SIZE;
-        return this;
-    }
-    addTapscriptInput(leafWitnessSize, leafScriptSize, leafControlBlockSize) {
-        const controlBlockWitnessSize = 1 +
-            TxWeightEstimator.BASE_CONTROL_BLOCK_SIZE +
-            1 +
-            leafScriptSize +
-            1 +
-            leafControlBlockSize;
-        this.inputCount++;
-        this.inputWitnessSize += leafWitnessSize + 1 + controlBlockWitnessSize;
-        this.inputSize += TxWeightEstimator.INPUT_SIZE;
-        this.hasWitness = true;
-        return this;
-    }
-    addP2WPKHOutput() {
-        this.outputCount++;
-        this.outputSize +=
-            TxWeightEstimator.OUTPUT_SIZE +
-                TxWeightEstimator.P2WPKH_OUTPUT_SIZE;
-        return this;
-    }
-    addP2TROutput() {
-        this.outputCount++;
-        this.outputSize +=
-            TxWeightEstimator.OUTPUT_SIZE + TxWeightEstimator.P2TR_OUTPUT_SIZE;
-        return this;
-    }
-    /**
-     * Adds an output given a raw script.
-     * Cost = 8 bytes (amount) + varint(scriptLen) + scriptLen
-     */
-    addOutputScript(script) {
-        this.outputCount++;
-        this.outputSize += 8 + getVarIntSize(script.length) + script.length;
-        return this;
-    }
-    /**
-     * Adds an output by decoding the address to get the exact script size.
-     */
-    addOutputAddress(address, network) {
-        const payment = (0, btc_signer_1.Address)(network).decode(address);
-        const script = btc_signer_1.OutScript.encode(payment);
-        return this.addOutputScript(script);
-    }
-    vsize() {
-        const inputCount = getVarIntSize(this.inputCount);
-        const outputCount = getVarIntSize(this.outputCount);
-        // Calculate the size of the transaction without witness data
-        const txSizeStripped = TxWeightEstimator.BASE_TX_SIZE +
-            inputCount +
-            this.inputSize +
-            outputCount +
-            this.outputSize;
-        // Calculate the total weight
-        let weight = txSizeStripped * TxWeightEstimator.WITNESS_SCALE_FACTOR;
-        // Add witness data if present
-        if (this.hasWitness) {
-            weight +=
-                TxWeightEstimator.WITNESS_HEADER_SIZE + this.inputWitnessSize;
-        }
-        // Convert weight to vsize (weight / 4, rounded up)
-        return vsize(weight);
-    }
-}
-exports.TxWeightEstimator = TxWeightEstimator;
-TxWeightEstimator.P2PKH_SCRIPT_SIG_SIZE = 1 + 73 + 1 + 33;
-TxWeightEstimator.INPUT_SIZE = 32 + 4 + 1 + 4;
-TxWeightEstimator.BASE_CONTROL_BLOCK_SIZE = 1 + 32;
-TxWeightEstimator.OUTPUT_SIZE = 8 + 1;
-TxWeightEstimator.P2WPKH_OUTPUT_SIZE = 1 + 1 + 20;
-TxWeightEstimator.BASE_TX_SIZE = 8 + 2; // Version + LockTime
-TxWeightEstimator.WITNESS_HEADER_SIZE = 2; // Flag + Marker
-TxWeightEstimator.WITNESS_SCALE_FACTOR = 4;
-TxWeightEstimator.P2TR_OUTPUT_SIZE = 1 + 1 + 32;
-const vsize = (weight) => {
-    const value = BigInt(Math.ceil(weight / TxWeightEstimator.WITNESS_SCALE_FACTOR));
-    return {
-        value,
-        fee: (feeRate) => feeRate * value,
-    };
-};

package/dist/cjs/utils/unknownFields.js

@@ -1,174 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VtxoTreeExpiry = exports.CosignerPublicKey = exports.ConditionWitness = exports.VtxoTaprootTree = exports.ArkPsbtFieldKeyType = exports.ArkPsbtFieldKey = void 0;
-exports.setArkPsbtField = setArkPsbtField;
-exports.getArkPsbtFields = getArkPsbtFields;
-const btc_signer_1 = require("@scure/btc-signer");
-const base_1 = require("@scure/base");
-const timelock_1 = require("./timelock");
-/**
- * ArkPsbtFieldKey are the available key names for the Arkade PSBT custom fields.
- */
-var ArkPsbtFieldKey;
-(function (ArkPsbtFieldKey) {
-    ArkPsbtFieldKey["VtxoTaprootTree"] = "taptree";
-    ArkPsbtFieldKey["VtxoTreeExpiry"] = "expiry";
-    ArkPsbtFieldKey["Cosigner"] = "cosigner";
-    ArkPsbtFieldKey["ConditionWitness"] = "condition";
-})(ArkPsbtFieldKey || (exports.ArkPsbtFieldKey = ArkPsbtFieldKey = {}));
-/**
- * ArkPsbtFieldKeyType is the key type of the Arkade PSBT custom field.
- * Every Arkade PSBT field has key type 222.
- */
-exports.ArkPsbtFieldKeyType = 222;
-/**
- * setArkPsbtField appends a new unknown field to the input at inputIndex
- *
- * @example
- * ```typescript
- * setArkPsbtField(tx, 0, VtxoTaprootTree, myTaprootTree);
- * setArkPsbtField(tx, 0, VtxoTreeExpiry, myVtxoTreeExpiry);
- * ```
- */
-function setArkPsbtField(tx, inputIndex, coder, value) {
-    tx.updateInput(inputIndex, {
-        unknown: [
-            ...(tx.getInput(inputIndex)?.unknown ?? []),
-            coder.encode(value),
-        ],
-    });
-}
-/**
- * getArkPsbtFields returns all the values of the given coder for the input at inputIndex
- * Multiple fields of the same type can exist in a single input.
- *
- * @example
- * ```typescript
- * const vtxoTaprootTreeFields = getArkPsbtFields(tx, 0, VtxoTaprootTree);
- * console.log(`input has ${vtxoTaprootTreeFields.length} vtxoTaprootTree fields`);
- */
-function getArkPsbtFields(tx, inputIndex, coder) {
-    const unknown = tx.getInput(inputIndex)?.unknown ?? [];
-    const fields = [];
-    for (const u of unknown) {
-        const v = coder.decode(u);
-        if (v)
-            fields.push(v);
-    }
-    return fields;
-}
-/**
- * VtxoTaprootTree is set to pass all spending leaves of the vtxo input
- *
- * @example
- * ```typescript
- * const vtxoTaprootTree = VtxoTaprootTree.encode(myTaprootTree);
- */
-exports.VtxoTaprootTree = {
-    key: ArkPsbtFieldKey.VtxoTaprootTree,
-    encode: (value) => [
-        {
-            type: exports.ArkPsbtFieldKeyType,
-            key: encodedPsbtFieldKey[ArkPsbtFieldKey.VtxoTaprootTree],
-        },
-        value,
-    ],
-    decode: (value) => nullIfCatch(() => {
-        if (!checkKeyIncludes(value[0], ArkPsbtFieldKey.VtxoTaprootTree))
-            return null;
-        return value[1];
-    }),
-};
-/**
- * ConditionWitness is set to pass the witness data used to finalize the conditionMultisigClosure
- *
- * @example
- * ```typescript
- * const conditionWitness = ConditionWitness.encode(myConditionWitness);
- */
-exports.ConditionWitness = {
-    key: ArkPsbtFieldKey.ConditionWitness,
-    encode: (value) => [
-        {
-            type: exports.ArkPsbtFieldKeyType,
-            key: encodedPsbtFieldKey[ArkPsbtFieldKey.ConditionWitness],
-        },
-        btc_signer_1.RawWitness.encode(value),
-    ],
-    decode: (value) => nullIfCatch(() => {
-        if (!checkKeyIncludes(value[0], ArkPsbtFieldKey.ConditionWitness))
-            return null;
-        return btc_signer_1.RawWitness.decode(value[1]);
-    }),
-};
-/**
- * CosignerPublicKey is set on every TxGraph transactions to identify the musig2 public keys
- *
- * @example
- * ```typescript
- * const cosignerPublicKey = CosignerPublicKey.encode(myCosignerPublicKey);
- */
-exports.CosignerPublicKey = {
-    key: ArkPsbtFieldKey.Cosigner,
-    encode: (value) => [
-        {
-            type: exports.ArkPsbtFieldKeyType,
-            key: new Uint8Array([
-                ...encodedPsbtFieldKey[ArkPsbtFieldKey.Cosigner],
-                value.index,
-            ]),
-        },
-        value.key,
-    ],
-    decode: (unknown) => nullIfCatch(() => {
-        if (!checkKeyIncludes(unknown[0], ArkPsbtFieldKey.Cosigner))
-            return null;
-        return {
-            index: unknown[0].key[unknown[0].key.length - 1],
-            key: unknown[1],
-        };
-    }),
-};
-/**
- * VtxoTreeExpiry is set to pass the expiry time of the input
- *
- * @example
- * ```typescript
- * const vtxoTreeExpiry = VtxoTreeExpiry.encode(myVtxoTreeExpiry);
- */
-exports.VtxoTreeExpiry = {
-    key: ArkPsbtFieldKey.VtxoTreeExpiry,
-    encode: (value) => [
-        {
-            type: exports.ArkPsbtFieldKeyType,
-            key: encodedPsbtFieldKey[ArkPsbtFieldKey.VtxoTreeExpiry],
-        },
-        (0, btc_signer_1.ScriptNum)(6, true).encode(value.value === 0n ? 0n : value.value),
-    ],
-    decode: (unknown) => nullIfCatch(() => {
-        if (!checkKeyIncludes(unknown[0], ArkPsbtFieldKey.VtxoTreeExpiry))
-            return null;
-        const v = (0, btc_signer_1.ScriptNum)(6, true).decode(unknown[1]);
-        if (!v)
-            return null;
-        return (0, timelock_1.sequenceToTimelock)(Number(v));
-    }),
-};
-const encodedPsbtFieldKey = Object.fromEntries(Object.values(ArkPsbtFieldKey).map((key) => [
-    key,
-    new TextEncoder().encode(key),
-]));
-const nullIfCatch = (fn) => {
-    try {
-        return fn();
-    }
-    catch (err) {
-        return null;
-    }
-};
-function checkKeyIncludes(key, arkPsbtFieldKey) {
-    const expected = base_1.hex.encode(encodedPsbtFieldKey[arkPsbtFieldKey]);
-    return base_1.hex
-        .encode(new Uint8Array([key.type, ...key.key]))
-        .includes(expected);
-}