@lendasat/lendaswap-sdk 0.1.8 → 0.1.65

package/wasm/lendaswap_wasm_sdk.d.ts

@@ -1,5 +1,9 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * Returns a human-readable string representation of the swap status.
+ */
+export function swapStatusToString(status: SwapStatus): string;
 /**
  * Initialize the WASM module.
  *
@@ -26,8 +30,46 @@ export function getLogLevel(): string;
 export enum Chain {
   Arkade = 0,
   Lightning = 1,
-  Polygon = 2,
-  Ethereum = 3,
+  Bitcoin = 2,
+  Polygon = 3,
+  Ethereum = 4,
+}
+/**
+ * Bitcoin network type.
+ */
+export enum Network {
+  Bitcoin = 0,
+  Testnet = 1,
+  Regtest = 2,
+  Mutinynet = 3,
+}
+/**
+ * Swap status for BTC/EVM swaps.
+ */
+export enum SwapStatus {
+  Pending = 0,
+  ClientFundingSeen = 1,
+  ClientFunded = 2,
+  ClientRefunded = 3,
+  ServerFunded = 4,
+  ClientRedeeming = 5,
+  ClientRedeemed = 6,
+  ServerRedeemed = 7,
+  ClientFundedServerRefunded = 8,
+  ClientRefundedServerFunded = 9,
+  ClientRefundedServerRefunded = 10,
+  Expired = 11,
+  ClientInvalidFunded = 12,
+  ClientFundedTooLate = 13,
+  ClientRedeemedAndClientRefunded = 14,
+}
+/**
+ * Swap type discriminator.
+ */
+export enum SwapType {
+  BtcToEvm = 0,
+  EvmToBtc = 1,
+  BtcToArkade = 2,
 }
 /**
  * The `ReadableStreamType` enum.
@@ -45,6 +87,80 @@ export class AssetPair {
   source: TokenInfo;
   target: TokenInfo;
 }
+/**
+ * Fields from SwapCommonFields are flattened.
+ */
+export class BtcToArkadeSwapResponse {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  id: string;
+  status: SwapStatus;
+  btc_htlc_address: string;
+  asset_amount: bigint;
+  sats_receive: bigint;
+  fee_sats: bigint;
+  hash_lock: string;
+  btc_refund_locktime: bigint;
+  arkade_vhtlc_address: string;
+  target_arkade_address: string;
+  get btc_fund_txid(): string | undefined;
+  set btc_fund_txid(value: string | null | undefined);
+  get btc_claim_txid(): string | undefined;
+  set btc_claim_txid(value: string | null | undefined);
+  get arkade_fund_txid(): string | undefined;
+  set arkade_fund_txid(value: string | null | undefined);
+  get arkade_claim_txid(): string | undefined;
+  set arkade_claim_txid(value: string | null | undefined);
+  network: string;
+  created_at: string;
+  server_vhtlc_pk: string;
+  arkade_server_pk: string;
+  vhtlc_refund_locktime: bigint;
+  unilateral_claim_delay: bigint;
+  unilateral_refund_delay: bigint;
+  unilateral_refund_without_receiver_delay: bigint;
+  source_token: TokenId;
+  target_token: TokenId;
+}
+/**
+ * BTC to EVM swap response.
+ * Fields from SwapCommonFields are flattened.
+ */
+export class BtcToEvmSwapResponse {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  id: string;
+  status: SwapStatus;
+  hash_lock: string;
+  fee_sats: bigint;
+  asset_amount: number;
+  sender_pk: string;
+  receiver_pk: string;
+  server_pk: string;
+  refund_locktime: number;
+  unilateral_claim_delay: bigint;
+  unilateral_refund_delay: bigint;
+  unilateral_refund_without_receiver_delay: bigint;
+  network: Network;
+  created_at: string;
+  htlc_address_evm: string;
+  htlc_address_arkade: string;
+  user_address_evm: string;
+  ln_invoice: string;
+  sats_receive: bigint;
+  source_token: TokenId;
+  target_token: TokenId;
+  get bitcoin_htlc_claim_txid(): string | undefined;
+  set bitcoin_htlc_claim_txid(value: string | null | undefined);
+  get bitcoin_htlc_fund_txid(): string | undefined;
+  set bitcoin_htlc_fund_txid(value: string | null | undefined);
+  get evm_htlc_claim_txid(): string | undefined;
+  set evm_htlc_claim_txid(value: string | null | undefined);
+  get evm_htlc_fund_txid(): string | undefined;
+  set evm_htlc_fund_txid(value: string | null | undefined);
+}
 /**
  * Lendaswap client.
  */
@@ -52,29 +168,31 @@ export class Client {
   free(): void;
   [Symbol.dispose](): void;
   /**
-   * Create a new client with separate wallet and swap storage.
+   * Create a new client with separate wallet, swap, and VTXO swap storage.
    *
    * # Arguments
    * * `base_url` - The Lendaswap API URL
    * * `wallet_storage` - Storage provider for wallet data (mnemonic, key index)
    * * `swap_storage` - Storage provider for swap data
+   * * `vtxo_swap_storage` - Storage provider for VTXO swap data
    * * `network` - The Bitcoin network ("bitcoin" or "testnet")
    * * `arkade_url` - The Arkade server URL
+   * * `esplora_url` - The Esplora API URL for on-chain Bitcoin operations
    */
-  constructor(base_url: string, wallet_storage: JsWalletStorageProvider, swap_storage: JsSwapStorageProvider, network: string, arkade_url: string);
+  constructor(base_url: string, wallet_storage: JsWalletStorageProvider, swap_storage: JsSwapStorageProvider, vtxo_swap_storage: JsVtxoSwapStorageProvider, network: string, arkade_url: string, esplora_url: string);
   init(mnemonic?: string | null): Promise<void>;
   /**
    * Create an Arkade to EVM swap.
    */
-  createArkadeToEvmSwap(target_address: string, target_amount: number, target_token: string, target_chain: string, referral_code?: string | null): Promise<any>;
+  createArkadeToEvmSwap(target_address: string, target_amount: number, target_token: string, target_chain: string, referral_code?: string | null): Promise<BtcToEvmSwapResponse>;
   /**
    * Create an EVM to Arkade swap.
    */
-  createEvmToArkadeSwap(target_address: string, user_address: string, source_amount: number, source_token: string, source_chain: string, referral_code?: string | null): Promise<any>;
+  createEvmToArkadeSwap(target_address: string, user_address: string, source_amount: number, source_token: string, source_chain: string, referral_code?: string | null): Promise<EvmToBtcSwapResponse>;
   /**
    * Create an EVM to Lightning swap.
    */
-  createEvmToLightningSwap(bolt11_invoice: string, user_address: string, source_token: string, source_chain: string, referral_code?: string | null): Promise<any>;
+  createEvmToLightningSwap(bolt11_invoice: string, user_address: string, source_token: string, source_chain: string, referral_code?: string | null): Promise<EvmToBtcSwapResponse>;
   getAssetPairs(): Promise<AssetPair[]>;
   getTokens(): Promise<TokenInfo[]>;
   /**
@@ -83,20 +201,28 @@ export class Client {
   getQuote(from: string, to: string, base_amount: bigint): Promise<QuoteResponse>;
   /**
    * Get swap by ID.
-   *
-   * This function returns `[ExtendedSwapResponse]`. It's too complex for Wasm to handle.
    */
-  getSwap(id: string): Promise<any>;
+  getSwap(id: string): Promise<ExtendedSwapStorageData>;
   /**
    * Get all swaps.
-   *
-   * This function returns `[ExtendedSwapResponse[]]`. It's too complex for Wasm to handle.
    */
-  listAll(): Promise<any>;
+  listAll(): Promise<ExtendedSwapStorageData[]>;
   claimGelato(swap_id: string, secret?: string | null): Promise<void>;
   amountsForSwap(swap_id: string): Promise<any>;
   claimVhtlc(swap_id: string): Promise<void>;
   refundVhtlc(swap_id: string, refund_address: string): Promise<string>;
+  /**
+   * Create an on-chain Bitcoin to Arkade swap.
+   */
+  createBitcoinToArkadeSwap(target_arkade_address: string, sats_receive: bigint, referral_code?: string | null): Promise<BtcToArkadeSwapResponse>;
+  /**
+   * Claim the Arkade VHTLC for a BTC-to-Arkade swap.
+   */
+  claimBtcToArkadeVhtlc(swap_id: string): Promise<string>;
+  /**
+   * Refund from the on-chain Bitcoin HTLC after timeout.
+   */
+  refundOnchainHtlc(swap_id: string, refund_address: string): Promise<string>;
   /**
    * Get API version.
    */
@@ -104,7 +230,7 @@ export class Client {
   /**
    * Recover swaps using xpub.
    */
-  recoverSwaps(): Promise<any>;
+  recoverSwaps(): Promise<ExtendedSwapStorageData[]>;
   /**
    * Get mnemonic
    */
@@ -121,6 +247,16 @@ export class Client {
    * Delete specific swap
    */
   deleteSwap(id: string): Promise<void>;
+  /**
+   * Get the list of swap IDs that failed to deserialize during the last listAll() call.
+   * These are "corrupted" entries that couldn't be loaded.
+   */
+  getCorruptedSwapIds(): string[];
+  /**
+   * Delete all corrupted swap entries from storage.
+   * Returns the number of entries deleted.
+   */
+  deleteCorruptedSwaps(): Promise<number>;
   /**
    * Estimate the fee for a VTXO swap.
    *
@@ -140,7 +276,7 @@ export class Client {
   /**
    * Get VTXO swap details by ID.
    */
-  getVtxoSwap(id: string): Promise<VtxoSwapResponse>;
+  getVtxoSwap(id: string): Promise<ExtendedVtxoSwapStorageData>;
   /**
    * Claim the server's VHTLC in a VTXO swap.
    *
@@ -154,11 +290,16 @@ export class Client {
    * Refund the client's VHTLC in a VTXO swap.
    *
    * # Arguments
-   * * `swap` - The VTXO swap response
-   * * `swap_params` - The client's swap parameters
+   * * `swap_id` - The swap ID
    * * `refund_address` - The Arkade address to receive the refunded funds
    */
-  refundVtxoSwap(swap: VtxoSwapResponse, swap_params: SwapParams, refund_address: string): Promise<string>;
+  refundVtxoSwap(swap_id: string, refund_address: string): Promise<string>;
+  /**
+   * List all VTXO swaps from local storage.
+   *
+   * Returns all stored VTXO swaps without fetching from the API.
+   */
+  listAllVtxoSwaps(): Promise<ExtendedVtxoSwapStorageData[]>;
 }
 /**
  * Result from creating a VTXO swap.
@@ -174,7 +315,7 @@ export class CreateVtxoSwapResult {
   /**
    * The swap parameters (needed for claim/refund)
    */
-  swapParams: SwapParams;
+  swap_params: SwapParams;
 }
 /**
  * Estimate response for a VTXO swap.
@@ -186,23 +327,126 @@ export class EstimateVtxoSwapResponse {
   /**
    * Total fee in satoshis
    */
-  feeSats: bigint;
+  fee_sats: bigint;
   /**
    * Total input amount in satoshis
    */
-  totalInputSats: bigint;
+  total_input_sats: bigint;
   /**
    * Amount user will receive (total_input_sats - fee_sats)
    */
-  outputSats: bigint;
+  output_sats: bigint;
   /**
    * Number of VTXOs being refreshed
    */
-  vtxoCount: number;
+  vtxo_count: number;
   /**
    * Expected expiry timestamp (Unix) of the resulting VTXOs
    */
-  expectedVtxoExpiry: bigint;
+  expected_vtxo_expiry: bigint;
+}
+/**
+ * EVM to BTC swap response.
+ * Fields from SwapCommonFields are flattened.
+ */
+export class EvmToBtcSwapResponse {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  id: string;
+  status: SwapStatus;
+  hash_lock: string;
+  fee_sats: bigint;
+  asset_amount: number;
+  sender_pk: string;
+  receiver_pk: string;
+  server_pk: string;
+  refund_locktime: number;
+  unilateral_claim_delay: bigint;
+  unilateral_refund_delay: bigint;
+  unilateral_refund_without_receiver_delay: bigint;
+  network: Network;
+  created_at: string;
+  htlc_address_evm: string;
+  htlc_address_arkade: string;
+  user_address_evm: string;
+  get user_address_arkade(): string | undefined;
+  set user_address_arkade(value: string | null | undefined);
+  ln_invoice: string;
+  source_token: TokenId;
+  target_token: TokenId;
+  sats_receive: bigint;
+  get bitcoin_htlc_fund_txid(): string | undefined;
+  set bitcoin_htlc_fund_txid(value: string | null | undefined);
+  get bitcoin_htlc_claim_txid(): string | undefined;
+  set bitcoin_htlc_claim_txid(value: string | null | undefined);
+  get evm_htlc_claim_txid(): string | undefined;
+  set evm_htlc_claim_txid(value: string | null | undefined);
+  get evm_htlc_fund_txid(): string | undefined;
+  set evm_htlc_fund_txid(value: string | null | undefined);
+  get create_swap_tx(): string | undefined;
+  set create_swap_tx(value: string | null | undefined);
+  get approve_tx(): string | undefined;
+  set approve_tx(value: string | null | undefined);
+  get gelato_forwarder_address(): string | undefined;
+  set gelato_forwarder_address(value: string | null | undefined);
+  get gelato_user_nonce(): string | undefined;
+  set gelato_user_nonce(value: string | null | undefined);
+  get gelato_user_deadline(): string | undefined;
+  set gelato_user_deadline(value: string | null | undefined);
+  source_token_address: string;
+}
+/**
+ * Extended swap storage data that combines the API response with client-side swap parameters.
+ * This is the data structure stored for each swap.
+ *
+ * Note: The `response` field contains a `GetSwapResponse` enum which cannot be directly
+ * exposed via wasm-bindgen. It is serialized to a plain JS object via serde.
+ */
+export class ExtendedSwapStorageData {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Get the swap type.
+   */
+  readonly swapType: SwapType;
+  /**
+   * Get the BTC to EVM swap response, if this is a BTC to EVM swap.
+   * Returns undefined if this is an EVM to BTC swap.
+   */
+  readonly btcToEvmResponse: BtcToEvmSwapResponse | undefined;
+  /**
+   * Get the EVM to BTC swap response, if this is an EVM to BTC swap.
+   * Returns undefined if this is a BTC to EVM swap.
+   */
+  readonly evmToBtcResponse: EvmToBtcSwapResponse | undefined;
+  /**
+   * Get the Onchain to Arkade swap response, if this is an Onchian to Arkade swap.
+   * Returns undefined if not.
+   */
+  readonly btcToArkadeResponse: BtcToArkadeSwapResponse | undefined;
+  /**
+   * Get the swap parameters.
+   */
+  readonly swapParams: SwapParams;
+}
+/**
+ * Extended VTXO swap data that combines the API response with client-side swap parameters.
+ * This is the data structure stored for each VTXO swap.
+ */
+export class ExtendedVtxoSwapStorageData {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * The VTXO swap response from the API
+   */
+  response: VtxoSwapResponse;
+  /**
+   * The client-side swap parameters (keys, preimage, etc.)
+   */
+  swap_params: SwapParams;
 }
 export class IntoUnderlyingByteSource {
   private constructor();
@@ -266,6 +510,44 @@ export class JsSwapStorageProvider {
    */
   constructor(get_fn: Function, store_fn: Function, delete_fn: Function, list_fn: Function, get_all_fn: Function);
 }
+/**
+ * JavaScript VTXO swap storage provider passed from TypeScript.
+ *
+ * This struct wraps JavaScript callback functions that implement
+ * typed VTXO swap storage operations. Each function should return a Promise.
+ *
+ * # Example (TypeScript with Dexie)
+ *
+ * ```typescript
+ * import Dexie from 'dexie';
+ *
+ * const db = new Dexie('lendaswap');
+ * db.version(1).stores({ vtxoSwaps: 'id' });
+ *
+ * const vtxoSwapStorage = new JsVtxoSwapStorageProvider(
+ *     async (swapId) => await db.vtxoSwaps.get(swapId) ?? null,
+ *     async (swapId, data) => { await db.vtxoSwaps.put({ id: swapId, ...data }); },
+ *     async (swapId) => { await db.vtxoSwaps.delete(swapId); },
+ *     async () => await db.vtxoSwaps.toCollection().primaryKeys(),
+ *     async () => await db.vtxoSwaps.toArray()
+ * );
+ * ```
+ */
+export class JsVtxoSwapStorageProvider {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new JsVtxoSwapStorageProvider from JavaScript callbacks.
+   *
+   * # Arguments
+   * * `get_fn` - Function: `(swapId: string) => Promise<ExtendedVtxoSwapStorageData | null>`
+   * * `store_fn` - Function: `(swapId: string, data: ExtendedVtxoSwapStorageData) => Promise<void>`
+   * * `delete_fn` - Function: `(swapId: string) => Promise<void>`
+   * * `list_fn` - Function: `() => Promise<string[]>`
+   * * `get_all_fn` - Function: `() => Promise<ExtendedVtxoSwapStorageData[]>`
+   */
+  constructor(get_fn: Function, store_fn: Function, delete_fn: Function, list_fn: Function, get_all_fn: Function);
+}
 /**
  * JavaScript wallet storage provider passed from TypeScript.
  *
@@ -350,8 +632,44 @@ export class TokenId {
   private constructor();
   free(): void;
   [Symbol.dispose](): void;
+  /**
+   * Static constructor for BTC Lightning token
+   */
+  static btcLightning(): TokenId;
+  /**
+   * Static constructor for BTC onchain token
+   */
+  static btcOnchain(): TokenId;
+  /**
+   * Static constructor for BTC Arkade token
+   */
+  static btcArkade(): TokenId;
   toString(): string;
   static fromString(s: string): TokenId;
+  /**
+   * Returns true if this token equals another token
+   */
+  equals(other: TokenId): boolean;
+  /**
+   * Returns true if the token is Arkade
+   */
+  isArkade(): boolean;
+  /**
+   * Returns true if the token is Lightning
+   */
+  isLightning(): boolean;
+  /**
+   * Returns true if the token is onchain btc
+   */
+  isBtcOnchain(): boolean;
+  /**
+   * Returns true if the token is either Arkade or Lightning
+   */
+  isBtc(): boolean;
+  /**
+   * Returns true if the token is not BTC on Arkade and not BTC on Lightning
+   */
+  isEvmToken(): boolean;
 }
 /**
  * Token information.
@@ -360,7 +678,7 @@ export class TokenInfo {
   private constructor();
   free(): void;
   [Symbol.dispose](): void;
-  tokenId: string;
+  token_id: TokenId;
   symbol: string;
   chain: Chain;
   name: string;
@@ -414,75 +732,75 @@ export class VtxoSwapResponse {
   /**
    * Creation timestamp (RFC3339)
    */
-  createdAt: string;
+  created_at: string;
   /**
    * Client's VHTLC address
    */
-  clientVhtlcAddress: string;
+  client_vhtlc_address: string;
   /**
    * Amount client should fund in satoshis
    */
-  clientFundAmountSats: bigint;
+  client_fund_amount_sats: bigint;
   /**
    * Client's public key
    */
-  clientPk: string;
+  client_pk: string;
   /**
    * Client VHTLC locktime (Unix timestamp)
    */
-  clientLocktime: bigint;
+  client_locktime: bigint;
   /**
    * Client claim delay in seconds
    */
-  clientUnilateralClaimDelay: bigint;
+  client_unilateral_claim_delay: bigint;
   /**
    * Client refund delay in seconds
    */
-  clientUnilateralRefundDelay: bigint;
+  client_unilateral_refund_delay: bigint;
   /**
    * Client refund without receiver delay in seconds
    */
-  clientUnilateralRefundWithoutReceiverDelay: bigint;
+  client_unilateral_refund_without_receiver_delay: bigint;
   /**
    * Server's VHTLC address
    */
-  serverVhtlcAddress: string;
+  server_vhtlc_address: string;
   /**
    * Amount server will fund in satoshis
    */
-  serverFundAmountSats: bigint;
+  server_fund_amount_sats: bigint;
   /**
    * Server's public key
    */
-  serverPk: string;
+  server_pk: string;
   /**
    * Server VHTLC locktime (Unix timestamp)
    */
-  serverLocktime: bigint;
+  server_locktime: bigint;
   /**
    * Server claim delay in seconds
    */
-  serverUnilateralClaimDelay: bigint;
+  server_unilateral_claim_delay: bigint;
   /**
    * Server refund delay in seconds
    */
-  serverUnilateralRefundDelay: bigint;
+  server_unilateral_refund_delay: bigint;
   /**
    * Server refund without receiver delay in seconds
    */
-  serverUnilateralRefundWithoutReceiverDelay: bigint;
+  server_unilateral_refund_without_receiver_delay: bigint;
   /**
    * Arkade server's public key
    */
-  arkadeServerPk: string;
+  arkade_server_pk: string;
   /**
    * The preimage hash (SHA256)
    */
-  preimageHash: string;
+  preimage_hash: string;
   /**
    * Fee in satoshis
    */
-  feeSats: bigint;
+  fee_sats: bigint;
   /**
    * Bitcoin network
    */