@kaleidorg/wallet-engine 1.0.0-beta.31 → 1.0.0-beta.32

package/dist/adapters/ArkadeAdapter.d.ts

@@ -1,49 +1,112 @@
 /**
  * Arkade Protocol Adapter
- * Implements IProtocolAdapter using @arkade-os/sdk.
- * Ported from rate-extension, adapted for React Native with Expo providers.
+ * Implements IProtocolAdapter using @arkade-os/sdk v0.4.x.
+ *
+ * SDK API facts for v0.4.x:
+ *  - `wallet.getBalance()` includes `assets: { assetId, amount }[]`
+ *  - `wallet.assetManager.getAssetDetails(assetId)` resolves supply + metadata
+ *  - `wallet.send({ address, assets: [...] })` sends Arkade-native assets
+ *  - `wallet.sendBitcoin({ address, amount })` still sends BTC
+ *  - `wallet.getTransactionHistory()` → ArkTransaction[]
+ *    where ArkTransaction = { key, type: TxType, amount: number, settled: boolean, createdAt: number }
+ *  - `TxType.TxSent = "SENT"`, `TxType.TxReceived = "RECEIVED"`
+ *  - `WalletBalance.boarding.total` (number), `.settled`, `.preconfirmed`, `.available`, `.recoverable`, `.total`
  */
-import { IProtocolAdapter, BaseProtocolConfig } from './IProtocolAdapter.js';
-import { ProtocolType, Layer, UnifiedAsset, UnifiedTransaction, InvoiceRequest, Invoice, DecodedInvoice, PaymentRequest, PaymentResult, PaymentStatus, Address, ConnectionInfo, TransactionFilter } from '../types/base.js';
+import { IProtocolAdapter, type ProtocolConfig } from "./IProtocolAdapter.js";
+import { ProtocolType, Layer, NodeInfo, UnifiedAsset, UnifiedTransaction, InvoiceRequest, Invoice, DecodedInvoice, PaymentRequest, PaymentResult, PaymentStatus, Address, ConnectionInfo, TransactionFilter, QuoteRequest, Quote, SwapResult } from "../types/base.js";
 export declare class ArkadeAdapter implements IProtocolAdapter {
     readonly protocolName: ProtocolType;
-    readonly capabilities: readonly import("..").ProtocolCapability[];
     readonly supportedLayers: Layer[];
     readonly version = "1.0.0";
+    readonly capabilities: readonly import("..").ProtocolCapability[];
     private config;
-    connect(config: BaseProtocolConfig): Promise<void>;
+    private assetDetailsCache;
+    connect(config: ProtocolConfig): Promise<void>;
     disconnect(): Promise<void>;
     isConnected(): boolean;
     getConnectionInfo(): Promise<ConnectionInfo>;
     listAssets(): Promise<UnifiedAsset[]>;
     getAsset(assetId: string): Promise<UnifiedAsset>;
-    getAssetBalance(assetId: string): Promise<UnifiedAsset['balance']>;
+    getAssetBalance(assetId: string): Promise<UnifiedAsset["balance"]>;
     refreshBalances(): Promise<void>;
     listTransactions(filter?: TransactionFilter): Promise<UnifiedTransaction[]>;
     getTransaction(txId: string): Promise<UnifiedTransaction>;
     createInvoice(request: InvoiceRequest): Promise<Invoice>;
+    /**
+     * Generate a Boltz reverse-swap Lightning invoice that, when paid, lands
+     * the funds in this Arkade wallet as a VTXO. Requires amount > 0 — Boltz
+     * can't issue an amountless invoice. The embedded `SwapManager` claims
+     * the VHTLC automatically once the LN payment settles.
+     */
+    createArkadeLightningInvoice(request: InvoiceRequest): Promise<Invoice>;
     decodeInvoice(invoice: string): Promise<DecodedInvoice>;
     sendPayment(request: PaymentRequest): Promise<PaymentResult>;
+    /**
+     * Resolve a payment's terminal state from the SDK's transaction history.
+     * `paymentHash` is the txid returned by `sendBitcoin` / `sendLightningPayment`
+     * (Boltz returns a preimage as a fallback if there's no on-chain txid yet —
+     * in that case we don't have a history row and the payment stays pending).
+     */
     getPaymentStatus(paymentHash: string): Promise<PaymentStatus>;
     getReceiveAddress(assetId?: string): Promise<Address>;
-    getNodeInfo(): Promise<any>;
+    getNodeInfo(): Promise<NodeInfo>;
     getBtcBalance(): Promise<{
         confirmed: number;
         unconfirmed: number;
         total: number;
     }>;
     listChannels(): Promise<[]>;
-    listPayments(): Promise<any>;
+    listPayments(): Promise<{
+        payments?: unknown[];
+    }>;
+    /**
+     * Get all VTXOs, sorted by batchExpiry ascending (expiry-first).
+     * This ensures UI consumers see soon-to-expire VTXOs first, and any
+     * manual coin selection naturally picks the shortest-lived coins.
+     */
+    getVtxos(): Promise<Record<string, unknown>[]>;
+    getBoardingUtxos(): Promise<Record<string, unknown>[]>;
+    /**
+     * Onboard — settle boarding UTXOs into VTXOs via a Commitment Transaction.
+     * Requires at least one confirmed boarding UTXO.
+     * Returns the commitment txid.
+     */
+    onboard(): Promise<{
+        txid: string;
+    }>;
+    /**
+     * Offboard — collaborative exit: convert VTXOs back to an on-chain Bitcoin UTXO.
+     * @param address  Bitcoin on-chain destination (bc1/tb1)
+     * @param amount   Optional sats to offboard; undefined = exit all
+     */
+    offboard(address: string, amount?: number): Promise<{
+        txid: string;
+    }>;
     listTransfers(_options?: {
         asset_id?: string;
-    }): Promise<any>;
-    supportsSwaps(): boolean;
+    }): Promise<{
+        transfers: [];
+    }>;
+    sendAsset(params: Record<string, unknown>): Promise<Record<string, unknown>>;
     sendBtcOnchain(params: {
         address: string;
         amount: number;
-    }): Promise<any>;
-    private convertArkTx;
-    private toNumber;
-    private formatSats;
+    }): Promise<Record<string, unknown>>;
+    supportsSwaps(): boolean;
+    getSwapQuote(_request: QuoteRequest): Promise<Quote>;
+    executeSwap(_quote: Quote): Promise<SwapResult>;
+    getSwapStatus(_swapId: string): Promise<SwapResult>;
+    signMessage(message: string): Promise<string>;
+    verifyMessage(message: string, signature: string): Promise<string>;
+    /**
+     * Pre-select spendable BTC VTXOs for a sendBitcoin call using the
+     * expiry-first policy. Returns `undefined` (not an empty array) when no
+     * override should be applied — that lets the SDK fall back to its own
+     * selection when the fetch fails, the spendable set can't cover the target,
+     * or the target is non-positive. Mixed-asset VTXOs are filtered out.
+     */
+    private selectSpendableBtcVtxos;
+    private getWalletBalanceSummary;
+    private getCachedAssetDetails;
 }
 //# sourceMappingURL=ArkadeAdapter.d.ts.map

package/dist/adapters/ArkadeAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ArkadeAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/ArkadeAdapter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAGzE,OAAO,EACL,YAAY,EACZ,KAAK,EACL,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,OAAO,EACP,cAAc,EACd,cAAc,EACd,aAAa,EACb,aAAa,EACb,OAAO,EACP,cAAc,EACd,iBAAiB,EAOlB,MAAM,eAAe,CAAA;AAGtB,qBAAa,aAAc,YAAW,gBAAgB;IACpD,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAW;IAC9C,QAAQ,CAAC,YAAY,6CAA6B;IAClD,QAAQ,CAAC,eAAe,EAAE,KAAK,EAAE,CAA4C;IAC7E,QAAQ,CAAC,OAAO,WAAU;IAE1B,OAAO,CAAC,MAAM,CAA4B;IAMpC,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBlD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAMjC,WAAW,IAAI,OAAO;IAIhB,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC;IAgB5C,UAAU,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IA8CrC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAShD,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAKlE,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAMhC,gBAAgB,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAwB3E,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAazD,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAexD,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIvD,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IA0B5D,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAQ7D,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBrD,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB3B,aAAa,IAAI,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAWnF,YAAY,IAAI,OAAO,CAAC,EAAE,CAAC;IAC3B,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC;IAC5B,aAAa,CAAC,QAAQ,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAMnE,aAAa,IAAI,OAAO;IAElB,cAAc,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAa/E,OAAO,CAAC,YAAY;IAkCpB,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,UAAU;CAGnB"}
+{"version":3,"file":"ArkadeAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/ArkadeAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,gBAAgB,EAAE,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAiC3E,OAAO,EACL,YAAY,EACZ,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,OAAO,EACP,cAAc,EACd,cAAc,EACd,aAAa,EACb,aAAa,EACb,OAAO,EACP,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,KAAK,EACL,UAAU,EAIX,MAAM,eAAe,CAAC;AAsBvB,qBAAa,aAAc,YAAW,gBAAgB;IACpD,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAY;IAC/C,QAAQ,CAAC,eAAe,EAAE,KAAK,EAAE,CAA6C;IAC9E,QAAQ,CAAC,OAAO,WAAW;IAC3B,QAAQ,CAAC,YAAY,6CAA8B;IAEnD,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,iBAAiB,CAAqD;IAMxE,OAAO,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IA4B9C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAUjC,WAAW,IAAI,OAAO;IAIhB,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC;IAgB5C,UAAU,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAuGrC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAShD,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAUlE,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAQhC,gBAAgB,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAwC3E,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAazD,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAoB9D;;;;;OAKG;IACG,4BAA4B,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAyCvE,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IASvD,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAoFlE;;;;;OAKG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAuC7D,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAkCrD,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;IAwBhC,aAAa,IAAI,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAmBnF,YAAY,IAAI,OAAO,CAAC,EAAE,CAAC;IAI3B,YAAY,IAAI,OAAO,CAAC;QAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;KAAE,CAAC;IAKvD;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAwB9C,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAuB5D;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAgB1C;;;;OAIG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAiCrE,aAAa,CAAC,QAAQ,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,EAAE,CAAA;KAAE,CAAC;IAQ3E,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAsC5E,cAAc,CAAC,MAAM,EAAE;QAC3B,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAuBpC,aAAa,IAAI,OAAO;IAIlB,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;IAIpD,WAAW,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAI/C,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAQnD,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAgB7C,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQxE;;;;;;OAMG;YACW,uBAAuB;YA+BvB,uBAAuB;YA2EvB,qBAAqB;CAoBpC"}