@arkade-os/sdk 0.4.26 → 0.4.28

package/dist/types/wallet/onchain.d.ts

@@ -1,109 +0,0 @@
-import { P2TR } from "@scure/btc-signer/payment.js";
-import { Coin, SendBitcoinParams } from "./index.js";
-import { Identity } from "../identity/index.js";
-import { Network, NetworkName } from "../networks.js";
-import { OnchainProvider } from "../providers/onchain.js";
-import { AnchorBumper } from "../utils/anchor.js";
-import { Transaction } from "../utils/transaction.js";
-/**
- * Onchain Bitcoin wallet implementation for traditional Bitcoin transactions.
- *
- * This wallet handles regular Bitcoin transactions on the blockchain without
- * using the Arkade protocol. It supports P2TR (Pay-to-Taproot) addresses and
- * provides basic Bitcoin wallet functionality.
- *
- * @example
- * ```typescript
- * const wallet = await OnchainWallet.create(identity, 'mainnet');
- * const balance = await wallet.getBalance();
- * const txid = await wallet.send({
- *   address: 'bc1...',
- *   amount: 50000
- * });
- * ```
- */
-export declare class OnchainWallet implements AnchorBumper {
-    private identity;
-    static MIN_FEE_RATE: number;
-    readonly onchainP2TR: P2TR;
-    readonly provider: OnchainProvider;
-    readonly network: Network;
-    private constructor();
-    /**
-     * Create an onchain wallet for the given identity and Bitcoin network.
-     *
-     * @param identity - Identity used to derive the Taproot key and sign transactions
-     * @param networkName - Bitcoin network name, @see NetworkName
-     * @param provider - Optional onchain provider override, @see OnchainProvider
-     * @returns Configured onchain wallet
-     * @defaultValue `provider = new EsploraProvider('https://mempool.space/api')`
-     * @throws Error if the configured identity cannot produce a valid x-only public key
-     */
-    static create(identity: Identity, networkName?: NetworkName, provider?: OnchainProvider): Promise<OnchainWallet>;
-    get address(): string;
-    /**
-     * Fetch spendable onchain outputs for the wallet address.
-     *
-     * @returns Spendable onchain outputs for the wallet address
-     * @see getBalance
-     */
-    getCoins(): Promise<Coin[]>;
-    /**
-     * Return the wallet's total onchain balance in satoshis.
-     *
-     * @returns Confirmed plus unconfirmed onchain balance
-     * @see getCoins
-     */
-    getBalance(): Promise<number>;
-    /**
-     * Iteratively selects coins and estimates transaction fees until convergence.
-     *
-     * This method handles the circular dependency between output selection and fee
-     * estimation: the fee depends on transaction size, which depends on the number
-     * of inputs (selected outputs) and whether a change output is needed.
-     *
-     * The algorithm iterates up to 10 times, refining the fee estimate based on
-     * the actual transaction structure. It resolves dust oscillation loops that
-     * occur when the change amount hovers near the dust threshold—adding/removing
-     * the change output causes the fee to fluctuate, preventing convergence.
-     * When a lower fee is computed (indicating the change output was dropped),
-     * the function accepts this state to guarantee termination.
-     *
-     * @param coins - Available onchain outputs to select from
-     * @param amount - Target send amount in satoshis
-     * @param feeRate - Fee rate in sat/vbyte
-     * @param recipientAddress - Destination address for size estimation
-     * @returns Selected inputs, change amount, and calculated fee
-     * @throws Error if fee estimation fails to converge within max iterations
-     */
-    private estimateFeesAndSelectCoins;
-    /**
-     * Send bitcoin to a single onchain address.
-     *
-     * @param params - destination `address`, `amount` (in satoshis), and optional `feeRate` override (other fields ignored)
-     * @returns Broadcast transaction id
-     * @throws Error if the amount is non-positive, below dust, or cannot be funded
-     * @see SendBitcoinParams
-     */
-    send(params: SendBitcoinParams): Promise<string>;
-    /**
-     * CPFP-bump a parent transaction that contains a pay-to-anchor output.
-     *
-     * @param parent - Parent transaction containing a pay-to-anchor output
-     * @returns Tuple of parent transaction id and child transaction id
-     * @throws Error if the parent transaction has no pay-to-anchor output or bumping cannot be funded
-     * @see send
-     */
-    bumpP2A(parent: Transaction): Promise<[string, string]>;
-}
-/**
- * Select coins to reach a target amount, prioritizing those closer to expiry
- * @param coins List of coins to select from
- * @param targetAmount Target amount to reach in satoshis
- * @param forceChange If true, ensure the coin selection will require a change output
- * @returns Selected coins and change amount, or null if insufficient funds
- */
-export declare function selectCoins(coins: Coin[], targetAmount: number, forceChange?: boolean): {
-    inputs: Coin[];
-    changeAmount: bigint;
-};

package/dist/types/wallet/ramps.d.ts

@@ -1,64 +0,0 @@
-import { ExtendedCoin, IWallet } from "./index.js";
-import { FeeInfo, SettlementEvent } from "../providers/ark.js";
-/**
- * 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
- * ```
- */
-export declare class Ramps {
-    readonly wallet: IWallet;
-    /**
-     * Create convenience wrappers for onboarding and offboarding flows.
-     *
-     * @param wallet - Wallet used to query funds and execute settlement transactions
-     */
-    constructor(wallet: IWallet);
-    /**
-     * 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);
-     * ```
-     */
-    onboard(feeInfo: FeeInfo, boardingUtxos?: ExtendedCoin[], amount?: bigint, eventCallback?: (event: SettlementEvent) => void): ReturnType<IWallet["settle"]>;
-    /**
-     * 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);
-     * ```
-     */
-    offboard(destinationAddress: string, feeInfo: FeeInfo, amount?: bigint, eventCallback?: (event: SettlementEvent) => void): ReturnType<IWallet["settle"]>;
-}