@arkade-os/sdk 0.4.26 → 0.4.28

package/dist/cjs/wallet/ramps.js

@@ -1,216 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Ramps = void 0;
-const arkfee_1 = require("../arkfee");
-const btc_signer_1 = require("@scure/btc-signer");
-const base_1 = require("@scure/base");
-const networks_1 = require("../networks");
-const address_1 = require("../script/address");
-/**
- * Ramps is a class wrapping `settle` method to provide a more convenient interface for onboarding and offboarding operations.
- *
- * @see IWallet.settle
- * @see onboard
- * @see offboard
- *
- * @example
- * ```typescript
- * const ramps = new Ramps(wallet);
- * const feeInfo = { intentFee: {}, txFeeRate: '1' };
- * await ramps.onboard(feeInfo); // onboard all boarding inputs
- * await ramps.offboard('bc1q...', feeInfo); // collaboratively exit all virtual outputs to an onchain address
- * ```
- */
-class Ramps {
-    /**
-     * Create convenience wrappers for onboarding and offboarding flows.
-     *
-     * @param wallet - Wallet used to query funds and execute settlement transactions
-     */
-    constructor(wallet) {
-        this.wallet = wallet;
-    }
-    /**
-     * Onboard boarding inputs.
-     *
-     * @param feeInfo - The fee info to deduct from the onboard amount.
-     * @param boardingUtxos - Specific boarding inputs to onboard. If not provided, all boarding inputs will be used.
-     * @param amount - Amount to onboard. If not provided, the total amount of boarding inputs will be onboarded.
-     * @param eventCallback - Optional callback that receives settlement events
-     * @returns The Arkade transaction id created by settlement
-     * @throws Error if no boarding inputs remain after fee deduction or if `amount` exceeds available value
-     * @see IWallet.getBoardingUtxos
-     * @see IWallet.settle
-     * @example
-     * ```typescript
-     * const feeInfo = { intentFee: {}, txFeeRate: '1' };
-     * const ramps = new Ramps(wallet);
-     * await ramps.onboard(feeInfo);
-     * ```
-     */
-    async onboard(feeInfo, boardingUtxos, amount, eventCallback) {
-        boardingUtxos = boardingUtxos ?? (await this.wallet.getBoardingUtxos());
-        // Calculate input fees and filter out boarding inputs where fee >= value.
-        const estimator = new arkfee_1.Estimator(feeInfo?.intentFee ?? {});
-        const filteredBoardingUtxos = [];
-        let totalAmount = 0n;
-        for (const utxo of boardingUtxos) {
-            const inputFee = estimator.evalOnchainInput({
-                amount: BigInt(utxo.value),
-            });
-            if (inputFee.satoshis >= utxo.value) {
-                // Skip boarding inputs where spending fees are greater than or equal to the input value.
-                continue;
-            }
-            filteredBoardingUtxos.push(utxo);
-            totalAmount += BigInt(utxo.value) - BigInt(inputFee.satoshis);
-        }
-        if (filteredBoardingUtxos.length === 0) {
-            throw new Error("No boarding utxos available after deducting fees");
-        }
-        let change = 0n;
-        if (amount) {
-            if (amount > totalAmount) {
-                throw new Error("Amount is greater than total amount of boarding utxos after fees");
-            }
-            change = totalAmount - amount;
-        }
-        amount = amount ?? totalAmount;
-        // Calculate offchain output fee using Estimator
-        const offchainAddress = await this.wallet.getAddress();
-        const offchainAddr = address_1.ArkAddress.decode(offchainAddress);
-        const offchainScript = base_1.hex.encode(offchainAddr.pkScript);
-        const outputFee = estimator.evalOffchainOutput({
-            amount,
-            script: offchainScript,
-        });
-        if (BigInt(outputFee.satoshis) > amount) {
-            throw new Error(`can't deduct fees from onboard amount (${outputFee.satoshis} > ${amount})`);
-        }
-        amount -= BigInt(outputFee.satoshis);
-        const outputs = [
-            {
-                address: offchainAddress,
-                amount,
-            },
-        ];
-        if (change > 0n) {
-            const boardingAddress = await this.wallet.getBoardingAddress();
-            outputs.push({
-                address: boardingAddress,
-                amount: change,
-            });
-        }
-        return this.wallet.settle({
-            inputs: filteredBoardingUtxos,
-            outputs,
-        }, eventCallback);
-    }
-    /**
-     * Offboard virtual outputs, or collaboratively exit them to an onchain address.
-     *
-     * @param destinationAddress - The destination address to offboard to.
-     * @param feeInfo - The fee info to deduct from the offboard amount.
-     * @param amount - The amount to offboard. If not provided, the total amount of virtual outputs will be offboarded.
-     * @param eventCallback - Optional callback that receives settlement events
-     * @returns The Arkade transaction id created by settlement
-     * @throws Error if no virtual outputs remain after fee deduction or the destination address cannot be decoded
-     * @see IWallet.getVtxos
-     * @see IWallet.settle
-     * @example
-     * ```typescript
-     * const feeInfo = { intentFee: {}, txFeeRate: '1' };
-     * const ramps = new Ramps(wallet);
-     * await ramps.offboard('bc1q...', feeInfo);
-     * ```
-     */
-    async offboard(destinationAddress, feeInfo, amount, eventCallback) {
-        const vtxos = await this.wallet.getVtxos({
-            withRecoverable: true,
-            withUnrolled: false,
-        });
-        // Calculate input fees and filter out virtual outputs where fee >= value.
-        const estimator = new arkfee_1.Estimator(feeInfo?.intentFee ?? {});
-        const filteredVtxos = [];
-        let totalAmount = 0n;
-        for (const vtxo of vtxos) {
-            const inputFee = estimator.evalOffchainInput({
-                amount: BigInt(vtxo.value),
-                type: vtxo.virtualStatus.state === "swept"
-                    ? "recoverable"
-                    : "vtxo",
-                weight: 0,
-                birth: vtxo.createdAt,
-                expiry: vtxo.virtualStatus.batchExpiry
-                    ? new Date(vtxo.virtualStatus.batchExpiry)
-                    : undefined,
-            });
-            if (inputFee.satoshis >= vtxo.value) {
-                // Skip virtual outputs where spending fees are greater than or equal to the output value.
-                continue;
-            }
-            filteredVtxos.push(vtxo);
-            totalAmount += BigInt(vtxo.value) - BigInt(inputFee.satoshis);
-        }
-        if (filteredVtxos.length === 0) {
-            throw new Error("No vtxos available after deducting fees");
-        }
-        let change = 0n;
-        if (amount) {
-            if (amount > totalAmount) {
-                throw new Error("Amount is greater than total amount of vtxos after fees");
-            }
-            change = totalAmount - amount;
-        }
-        amount = amount ?? totalAmount;
-        const networkNames = [
-            "bitcoin",
-            "regtest",
-            "testnet",
-            "signet",
-            "mutinynet",
-        ];
-        let destinationScript;
-        for (const networkName of networkNames) {
-            try {
-                const network = networks_1.networks[networkName];
-                const addr = (0, btc_signer_1.Address)(network).decode(destinationAddress);
-                destinationScript = btc_signer_1.OutScript.encode(addr);
-                break;
-            }
-            catch {
-                // Try next network
-                continue;
-            }
-        }
-        if (!destinationScript) {
-            throw new Error(`Failed to decode destination address: ${destinationAddress}`);
-        }
-        const outputFee = estimator.evalOnchainOutput({
-            amount,
-            script: base_1.hex.encode(destinationScript),
-        });
-        if (BigInt(outputFee.satoshis) > amount) {
-            throw new Error(`can't deduct fees from offboard amount (${outputFee.satoshis} > ${amount})`);
-        }
-        amount -= BigInt(outputFee.satoshis);
-        const outputs = [
-            {
-                address: destinationAddress,
-                amount,
-            },
-        ];
-        if (change > 0n) {
-            const offchainAddress = await this.wallet.getAddress();
-            outputs.push({
-                address: offchainAddress,
-                amount: change,
-            });
-        }
-        return this.wallet.settle({
-            inputs: filteredVtxos,
-            outputs,
-        }, eventCallback);
-    }
-}
-exports.Ramps = Ramps;