@lendasat/lendaswap-sdk 0.1.3 → 0.1.6

package/wasm/lendaswap_wasm_sdk.d.ts

@@ -0,0 +1,486 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Initialize the WASM module.
+ *
+ * This sets up logging and panic hooks for better debugging.
+ * Log level can be configured via localStorage key "lendaswap_log_level".
+ * Valid values: "trace", "debug", "info", "warn", "error" (case-insensitive).
+ * Default is "warn" if not set or invalid.
+ */
+export function initialize(): void;
+/**
+ * Set the log level at runtime.
+ * This updates localStorage and reinitializes the logger.
+ *
+ * Valid values: "trace", "debug", "info", "warn", "error" (case-insensitive).
+ */
+export function setLogLevel(level: string): void;
+/**
+ * Get the current log level.
+ */
+export function getLogLevel(): string;
+/**
+ * Chain type for token information.
+ */
+export enum Chain {
+  Arkade = 0,
+  Lightning = 1,
+  Polygon = 2,
+  Ethereum = 3,
+}
+/**
+ * The `ReadableStreamType` enum.
+ *
+ * *This API requires the following crate features to be activated: `ReadableStreamType`*
+ */
+type ReadableStreamType = "bytes";
+/**
+ * Token information.
+ */
+export class AssetPair {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  source: TokenInfo;
+  target: TokenInfo;
+}
+/**
+ * Lendaswap client.
+ */
+export class Client {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new client with separate wallet and 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
+   * * `network` - The Bitcoin network ("bitcoin" or "testnet")
+   * * `arkade_url` - The Arkade server URL
+   */
+  constructor(base_url: string, wallet_storage: JsWalletStorageProvider, swap_storage: JsSwapStorageProvider, network: string, arkade_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>;
+  /**
+   * 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>;
+  /**
+   * 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>;
+  getAssetPairs(): Promise<AssetPair[]>;
+  getTokens(): Promise<TokenInfo[]>;
+  /**
+   * Get a quote.
+   */
+  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>;
+  /**
+   * Get all swaps.
+   *
+   * This function returns `[ExtendedSwapResponse[]]`. It's too complex for Wasm to handle.
+   */
+  listAll(): Promise<any>;
+  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>;
+  /**
+   * Get API version.
+   */
+  getVersion(): Promise<Version>;
+  /**
+   * Recover swaps using xpub.
+   */
+  recoverSwaps(): Promise<any>;
+  /**
+   * Get mnemonic
+   */
+  getMnemonic(): Promise<string>;
+  /**
+   * Get userIdXpub
+   */
+  getUserIdXpub(): Promise<string>;
+  /**
+   * Deletes all stored swaps
+   */
+  clearSwapStorage(): Promise<void>;
+  /**
+   * Delete specific swap
+   */
+  deleteSwap(id: string): Promise<void>;
+  /**
+   * Estimate the fee for a VTXO swap.
+   *
+   * # Arguments
+   * * `vtxos` - List of VTXO outpoints to refresh ("txid:vout" format)
+   */
+  estimateVtxoSwap(vtxos: string[]): Promise<EstimateVtxoSwapResponse>;
+  /**
+   * Create a VTXO swap for refreshing VTXOs.
+   *
+   * Returns the swap response and swap params.
+   *
+   * # Arguments
+   * * `vtxos` - List of VTXO outpoints to refresh ("txid:vout" format)
+   */
+  createVtxoSwap(vtxos: string[]): Promise<CreateVtxoSwapResult>;
+  /**
+   * Get VTXO swap details by ID.
+   */
+  getVtxoSwap(id: string): Promise<VtxoSwapResponse>;
+  /**
+   * Claim the server's VHTLC in a VTXO swap.
+   *
+   * # Arguments
+   * * `swap` - The VTXO swap response
+   * * `swap_params` - The client's swap parameters
+   * * `claim_address` - The Arkade address to receive the claimed funds
+   */
+  claimVtxoSwap(swap: VtxoSwapResponse, swap_params: SwapParams, claim_address: string): Promise<string>;
+  /**
+   * Refund the client's VHTLC in a VTXO swap.
+   *
+   * # Arguments
+   * * `swap` - The VTXO swap response
+   * * `swap_params` - The client's swap parameters
+   * * `refund_address` - The Arkade address to receive the refunded funds
+   */
+  refundVtxoSwap(swap: VtxoSwapResponse, swap_params: SwapParams, refund_address: string): Promise<string>;
+}
+/**
+ * Result from creating a VTXO swap.
+ */
+export class CreateVtxoSwapResult {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * The swap response
+   */
+  response: VtxoSwapResponse;
+  /**
+   * The swap parameters (needed for claim/refund)
+   */
+  swapParams: SwapParams;
+}
+/**
+ * Estimate response for a VTXO swap.
+ */
+export class EstimateVtxoSwapResponse {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Total fee in satoshis
+   */
+  feeSats: bigint;
+  /**
+   * Total input amount in satoshis
+   */
+  totalInputSats: bigint;
+  /**
+   * Amount user will receive (total_input_sats - fee_sats)
+   */
+  outputSats: bigint;
+  /**
+   * Number of VTXOs being refreshed
+   */
+  vtxoCount: number;
+}
+export class IntoUnderlyingByteSource {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  start(controller: ReadableByteStreamController): void;
+  pull(controller: ReadableByteStreamController): Promise<any>;
+  cancel(): void;
+  readonly type: ReadableStreamType;
+  readonly autoAllocateChunkSize: number;
+}
+export class IntoUnderlyingSink {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  write(chunk: any): Promise<any>;
+  close(): Promise<any>;
+  abort(reason: any): Promise<any>;
+}
+export class IntoUnderlyingSource {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  pull(controller: ReadableStreamDefaultController): Promise<any>;
+  cancel(): void;
+}
+/**
+ * JavaScript swap storage provider passed from TypeScript.
+ *
+ * This struct wraps JavaScript callback functions that implement
+ * typed 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({ swaps: 'id' });
+ *
+ * const swapStorage = new JsSwapStorageProvider(
+ *     async (swapId) => await db.swaps.get(swapId) ?? null,
+ *     async (swapId, data) => { await db.swaps.put({ id: swapId, ...data }); },
+ *     async (swapId) => { await db.swaps.delete(swapId); },
+ *     async () => await db.swaps.toCollection().primaryKeys()
+ * );
+ * ```
+ */
+export class JsSwapStorageProvider {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new JsSwapStorageProvider from JavaScript callbacks.
+   *
+   * # Arguments
+   * * `get_fn` - Function: `(swapId: string) => Promise<ExtendedSwapStorageData | null>`
+   * * `store_fn` - Function: `(swapId: string, data: ExtendedSwapStorageData) => Promise<void>`
+   * * `delete_fn` - Function: `(swapId: string) => Promise<void>`
+   * * `list_fn` - Function: `() => Promise<string[]>`
+   * * `get_all_fn` - Function: `() => Promise<ExtendedSwapStorageData[]>`
+   */
+  constructor(get_fn: Function, store_fn: Function, delete_fn: Function, list_fn: Function, get_all_fn: Function);
+}
+/**
+ * JavaScript wallet storage provider passed from TypeScript.
+ *
+ * This struct wraps JavaScript callback functions that implement
+ * the typed wallet storage operations. Each function should return a Promise.
+ *
+ * # Example (TypeScript)
+ *
+ * ```typescript
+ * const provider = new JsWalletStorageProvider(
+ *     async () => localStorage.getItem('mnemonic'),           // get_mnemonic
+ *     async (mnemonic) => localStorage.setItem('mnemonic', mnemonic), // set_mnemonic
+ *     async () => parseInt(localStorage.getItem('key_index') ?? '0'), // get_key_index
+ *     async (index) => localStorage.setItem('key_index', index.toString()), // set_key_index
+ * );
+ * ```
+ */
+export class JsWalletStorageProvider {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new JsWalletStorageProvider from JavaScript callbacks.
+   *
+   * # Arguments
+   * * `get_mnemonic_fn` - Function: `() => Promise<string | null>`
+   * * `set_mnemonic_fn` - Function: `(mnemonic: string) => Promise<void>`
+   * * `get_key_index_fn` - Function: `() => Promise<number>`
+   * * `set_key_index_fn` - Function: `(index: number) => Promise<void>`
+   */
+  constructor(get_mnemonic_fn: Function, set_mnemonic_fn: Function, get_key_index_fn: Function, set_key_index_fn: Function);
+}
+/**
+ * Quote response from the API.
+ */
+export class QuoteResponse {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  exchangeRate: string;
+  networkFee: bigint;
+  protocolFee: bigint;
+  protocolFeeRate: number;
+  minAmount: bigint;
+  maxAmount: bigint;
+}
+/**
+ * Parameters derived for a swap operation.
+ */
+export class SwapParams {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Secret key (hex-encoded).
+   */
+  own_sk: string;
+  /**
+   * Public key (hex-encoded).
+   */
+  own_pk: string;
+  /**
+   * Preimage for HTLC (hex-encoded).
+   */
+  preimage: string;
+  /**
+   * Hash of the preimage (hex-encoded).
+   */
+  preimage_hash: string;
+  /**
+   * User ID derived from HD wallet (hex-encoded).
+   */
+  user_id: string;
+  /**
+   * Key derivation index used.
+   */
+  key_index: number;
+}
+/**
+ * Token identifier.
+ */
+export class TokenId {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  toString(): string;
+  static fromString(s: string): TokenId;
+}
+/**
+ * Token information.
+ */
+export class TokenInfo {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  tokenId: string;
+  symbol: string;
+  chain: Chain;
+  name: string;
+  decimals: number;
+}
+/**
+ * Version information.
+ */
+export class Version {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  tag: string;
+  commitHash: string;
+}
+/**
+ * VHTLC amounts returned from Arkade.
+ */
+export class VhtlcAmounts {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Amount that can be spent (in satoshis).
+   */
+  spendable: bigint;
+  /**
+   * Amount already spent (in satoshis).
+   */
+  spent: bigint;
+  /**
+   * Amount that can be recovered via refund (in satoshis).
+   */
+  recoverable: bigint;
+}
+/**
+ * Response from creating/getting a VTXO swap.
+ */
+export class VtxoSwapResponse {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Swap ID
+   */
+  id: string;
+  /**
+   * Swap status
+   */
+  status: string;
+  /**
+   * Creation timestamp (RFC3339)
+   */
+  createdAt: string;
+  /**
+   * Client's VHTLC address
+   */
+  clientVhtlcAddress: string;
+  /**
+   * Amount client should fund in satoshis
+   */
+  clientFundAmountSats: bigint;
+  /**
+   * Client's public key
+   */
+  clientPk: string;
+  /**
+   * Client VHTLC locktime (Unix timestamp)
+   */
+  clientLocktime: bigint;
+  /**
+   * Client claim delay in seconds
+   */
+  clientUnilateralClaimDelay: bigint;
+  /**
+   * Client refund delay in seconds
+   */
+  clientUnilateralRefundDelay: bigint;
+  /**
+   * Client refund without receiver delay in seconds
+   */
+  clientUnilateralRefundWithoutReceiverDelay: bigint;
+  /**
+   * Server's VHTLC address
+   */
+  serverVhtlcAddress: string;
+  /**
+   * Amount server will fund in satoshis
+   */
+  serverFundAmountSats: bigint;
+  /**
+   * Server's public key
+   */
+  serverPk: string;
+  /**
+   * Server VHTLC locktime (Unix timestamp)
+   */
+  serverLocktime: bigint;
+  /**
+   * Server claim delay in seconds
+   */
+  serverUnilateralClaimDelay: bigint;
+  /**
+   * Server refund delay in seconds
+   */
+  serverUnilateralRefundDelay: bigint;
+  /**
+   * Server refund without receiver delay in seconds
+   */
+  serverUnilateralRefundWithoutReceiverDelay: bigint;
+  /**
+   * Arkade server's public key
+   */
+  arkadeServerPk: string;
+  /**
+   * The preimage hash (SHA256)
+   */
+  preimageHash: string;
+  /**
+   * Fee in satoshis
+   */
+  feeSats: bigint;
+  /**
+   * Bitcoin network
+   */
+  network: string;
+}

package/wasm/lendaswap_wasm_sdk.js

@@ -0,0 +1,5 @@
+import * as wasm from "./lendaswap_wasm_sdk_bg.wasm";
+export * from "./lendaswap_wasm_sdk_bg.js";
+import { __wbg_set_wasm } from "./lendaswap_wasm_sdk_bg.js";
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();