@lendasat/lendaswap-sdk-pure 0.0.1 → 0.0.3

package/README.md

@@ -11,24 +11,39 @@ npm install @lendasat/lendaswap-sdk-pure
 
 ## Supported Swaps
 
-This SDK currently supports the following swap directions:
-
-| Source       | Target                | Status    |
-| ------------ | --------------------- | --------- |
-| Lightning    | Polygon (USDC, USDT)  | Supported |
-| Lightning    | Arbitrum (USDC, USDT) | Supported |
-| Arkade       | Polygon (USDC, USDT)  | Supported |
-| Arkade       | Arbitrum (USDC, USDT) | Supported |
-| On-chain BTC | Polygon (USDC, USDT)  | Supported |
-| On-chain BTC | Arbitrum (USDC, USDT) | Supported |
+This SDK supports the following swap directions:
+
+### BTC to EVM
+
+| Source       | Target                      | Status    |
+| ------------ | --------------------------- | --------- |
+| Lightning    | Polygon (USDC, USDT)        | Supported |
+| Lightning    | Arbitrum (USDC, USDT)       | Supported |
+| Lightning    | Ethereum (USDC, USDT, WBTC) | Supported |
+| Arkade       | Polygon (USDC, USDT)        | Supported |
+| Arkade       | Arbitrum (USDC, USDT)       | Supported |
+| Arkade       | Ethereum (USDC, USDT, WBTC) | Supported |
+| On-chain BTC | Polygon (USDC, USDT)        | Supported |
+| On-chain BTC | Arbitrum (USDC, USDT)       | Supported |
+| On-chain BTC | Ethereum (USDC, USDT, WBTC) | Supported |
+
+### EVM to BTC
+
+| Source                      | Target    | Status    |
+| --------------------------- | --------- | --------- |
+| Polygon (USDC, USDT)        | Arkade    | Supported |
+| Polygon (USDC, USDT)        | Lightning | Supported |
+| Arbitrum (USDC, USDT)       | Arkade    | Supported |
+| Arbitrum (USDC, USDT)       | Lightning | Supported |
+| Ethereum (USDC, USDT, WBTC) | Arkade    | Supported |
+| Ethereum (USDC, USDT, WBTC) | Lightning | Supported |
 
 **Refund support:**
 
 - Lightning swaps: Auto-expire, no refund needed
 - Arkade swaps: Off-chain refund via Arkade protocol
 - On-chain BTC swaps: On-chain refund transaction after timelock
-
-> More swap directions (e.g., EVM to BTC) will be added in future versions.
+- EVM swaps: On-chain refund after timelock expires
 
 ## Usage
 
@@ -86,16 +101,30 @@ console.log(`Swap ID: ${result.response.id}`);
 #### Arkade to EVM
 
 ```typescript
-const result = await client.createArkadeToEvmSwap({
+// Create an Arkade-to-EVM swap (any ERC-20 token via 1inch)
+const result = await client.createArkadeToEvmSwapGeneric({
   targetAddress: "0x1234567890abcdef1234567890abcdef12345678",
-  targetToken: "usdc_arb",
-  targetChain: "arbitrum",
-  sourceAmount: 100000,
+  tokenAddress: "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359", // USDC on Polygon
+  evmChainId: 137,
+  sourceAmount: 100000, // sats
 });
 
 // Send BTC to the Arkade VHTLC address
-console.log(`Send BTC to: ${result.response.htlc_address_arkade}`);
+console.log(`Send BTC to: ${result.response.btc_vhtlc_address}`);
 console.log(`Swap ID: ${result.response.id}`);
+
+// Once the server has funded the EVM HTLC (status: "serverfunded"),
+// claim gaslessly — the server submits the tx on your behalf:
+const claimResult = await client.claimViaGasless(
+  result.response.id,
+  async (digest) => {
+    // Sign the EIP-712 digest with your EVM wallet
+    // e.g. using ethers.js: wallet.signMessage(ethers.getBytes(digest))
+    return { v: 27, r: "0x...", s: "0x..." };
+  },
+  "0x1234567890abcdef1234567890abcdef12345678", // destination
+);
+console.log(`Claimed! TX: ${claimResult.txHash}`);
 ```
 
 #### On-chain BTC to EVM
@@ -113,6 +142,38 @@ console.log(`Send BTC to: ${result.response.btc_htlc_address}`);
 console.log(`Swap ID: ${result.response.id}`);
 ```
 
+#### EVM to Arkade
+
+```typescript
+const result = await client.createEvmToArkadeSwap({
+  sourceToken: "usdc_pol",       // or "usdc_arb", "usdc_eth", "usdt_*", "wbtc_eth"
+  sourceChain: "polygon",        // or "arbitrum", "ethereum"
+  sourceAmount: 100000000n,      // Amount in token's smallest unit (e.g., 6 decimals for USDC)
+  targetAddress: "ark1...",      // Your Arkade address
+  evmAddress: "0x...",           // Your EVM address (for funding the HTLC)
+});
+
+// Fund the EVM HTLC (approve + createSwap)
+console.log(`HTLC Address: ${result.response.htlc_address}`);
+console.log(`Swap ID: ${result.response.id}`);
+```
+
+#### EVM to Lightning
+
+```typescript
+const result = await client.createEvmToLightningSwap({
+  sourceToken: "usdc_pol",
+  sourceChain: "polygon",
+  sourceAmount: 100000000n,
+  targetAddress: "lnbc...",       // Lightning invoice
+  evmAddress: "0x...",
+});
+
+// Fund the EVM HTLC
+console.log(`HTLC Address: ${result.response.htlc_address}`);
+console.log(`Swap ID: ${result.response.id}`);
+```
+
 ### Monitor Swap Status
 
 ```typescript
@@ -128,8 +189,19 @@ console.log(`Status: ${swap.status}`);
 Once the server has funded the EVM HTLC (`serverfunded` status), claim your tokens:
 
 ```typescript
-const claimResult = await client.claimEvmSwap("swap-uuid");
-console.log(`Claim tx: ${claimResult.tx_hash}`);
+// Gasless claim for Arkade-to-EVM swaps — the server submits the tx
+const claimResult = await client.claimViaGasless(
+  "swap-uuid",
+  async (digest) => {
+    // Sign the EIP-712 digest with your EVM wallet
+    return { v: 27, r: "0x...", s: "0x..." };
+  },
+  "0xYourDestinationAddress",
+);
+console.log(`Claim tx: ${claimResult.txHash}`);
+
+// For other swap types (Lightning/On-chain to EVM), use the existing claim:
+const result = await client.claim("swap-uuid");
 ```
 
 ### Refund (if swap times out)

package/dist/api/client.d.ts

@@ -4,28 +4,25 @@ export type ApiClient = ReturnType<typeof createClient<paths>>;
 export type { paths, components };
 export type TokenId = components["schemas"]["TokenId"];
 export type TokenInfo = components["schemas"]["TokenInfo"];
-export type AssetPair = components["schemas"]["AssetPair"];
+export type TokenInfos = components["schemas"]["TokenInfos"];
 export type SwapStatus = components["schemas"]["SwapStatus"];
 export type QuoteResponse = components["schemas"]["QuoteResponse"];
+export type Chain = components["schemas"]["Chain"];
 export type GetSwapResponse = components["schemas"]["GetSwapResponse"];
-export type BtcToEvmSwapResponse = components["schemas"]["BtcToEvmSwapResponse"];
-export type OnchainToEvmSwapResponse = components["schemas"]["OnchainToEvmSwapResponse"];
-export type EvmToBtcSwapResponse = components["schemas"]["EvmToBtcSwapResponse"];
 export type BtcToArkadeSwapResponse = components["schemas"]["BtcToArkadeSwapResponse"];
-export type ArkadeToPolygonSwapRequest = components["schemas"]["ArkadeToPolygonSwapRequest"];
-export type ArkadeToEthereumSwapRequest = components["schemas"]["ArkadeToEthereumSwapRequest"];
-export type ArkadeToArbitrumSwapRequest = components["schemas"]["ArkadeToArbitrumSwapRequest"];
-export type LightningToPolygonSwapRequest = components["schemas"]["LightningToPolygonSwapRequest"];
-export type LightningToEthereumSwapRequest = components["schemas"]["LightningToEthereumSwapRequest"];
-export type LightningToArbitrumSwapRequest = components["schemas"]["LightningToArbitrumSwapRequest"];
-export type BitcoinToPolygonSwapRequest = components["schemas"]["BitcoinToPolygonSwapRequest"];
-export type BitcoinToEthereumSwapRequest = components["schemas"]["BitcoinToEthereumSwapRequest"];
-export type BitcoinToArbitrumSwapRequest = components["schemas"]["BitcoinToArbitrumSwapRequest"];
-export type PolygonToArkadeSwapRequest = components["schemas"]["PolygonToArkadeSwapRequest"];
-export type ArbitrumToArkadeSwapRequest = components["schemas"]["ArbitrumToArkadeSwapRequest"];
-export type EthereumToArkadeSwapRequest = components["schemas"]["EthereumToArkadeSwapRequest"];
-export type ClaimGelatoRequest = components["schemas"]["ClaimGelatoRequest"];
-export type ClaimGelatoResponse = components["schemas"]["ClaimGelatoResponse"];
+export type EvmToArkadeSwapResponse = components["schemas"]["EvmToArkadeSwapResponse"];
+export type ClaimGaslessRequest = components["schemas"]["ClaimGaslessRequest"];
+export type ClaimGaslessResponse = components["schemas"]["ClaimGaslessResponse"];
+export type ArkadeToEvmSwapRequest = components["schemas"]["ArkadeToEvmSwapRequest"];
+export type ArkadeToEvmSwapResponse = components["schemas"]["ArkadeToEvmSwapResponse"];
+export type DexCallData = components["schemas"]["DexCallData"];
+export type BitcoinToEvmSwapRequest = components["schemas"]["BitcoinToEvmSwapRequest"];
+export type BitcoinToEvmSwapResponse = components["schemas"]["BitcoinToEvmSwapResponse"];
+export type EvmToArkadeGenericSwapRequest = components["schemas"]["EvmToArkadeGenericSwapRequest"];
+export type EvmToBitcoinSwapRequest = components["schemas"]["EvmToBitcoinSwapRequest"];
+export type EvmToBitcoinSwapResponse = components["schemas"]["EvmToBitcoinSwapResponse"];
+export type EvmToLightningSwapResponse = components["schemas"]["EvmToLightningSwapResponse"];
+export type LightningToEvmSwapResponse = components["schemas"]["LightningToEvmSwapResponse"];
 export interface ApiClientOptions {
     baseUrl: string;
     apiKey?: string;

package/dist/api/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AAE/D,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AAGlC,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AACvD,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAC3D,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAC3D,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AAC7D,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AACnE,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,CAAC;AACvE,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;AAChD,MAAM,MAAM,wBAAwB,GAClC,UAAU,CAAC,SAAS,CAAC,CAAC,0BAA0B,CAAC,CAAC;AACpD,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;AAChD,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AAGnD,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,4BAA4B,CAAC,CAAC;AACtD,MAAM,MAAM,2BAA2B,GACrC,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,CAAC;AACvD,MAAM,MAAM,2BAA2B,GACrC,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,CAAC;AACvD,MAAM,MAAM,6BAA6B,GACvC,UAAU,CAAC,SAAS,CAAC,CAAC,+BAA+B,CAAC,CAAC;AACzD,MAAM,MAAM,8BAA8B,GACxC,UAAU,CAAC,SAAS,CAAC,CAAC,gCAAgC,CAAC,CAAC;AAC1D,MAAM,MAAM,8BAA8B,GACxC,UAAU,CAAC,SAAS,CAAC,CAAC,gCAAgC,CAAC,CAAC;AAC1D,MAAM,MAAM,2BAA2B,GACrC,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,CAAC;AACvD,MAAM,MAAM,4BAA4B,GACtC,UAAU,CAAC,SAAS,CAAC,CAAC,8BAA8B,CAAC,CAAC;AACxD,MAAM,MAAM,4BAA4B,GACtC,UAAU,CAAC,SAAS,CAAC,CAAC,8BAA8B,CAAC,CAAC;AAGxD,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,4BAA4B,CAAC,CAAC;AACtD,MAAM,MAAM,2BAA2B,GACrC,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,CAAC;AACvD,MAAM,MAAM,2BAA2B,GACrC,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,CAAC;AAEvD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAC7E,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC;AAE/E,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,SAAS,CAUpE"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AAE/D,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AAGlC,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AACvD,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAC3D,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AAC7D,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AAC7D,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AACnE,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AACnD,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,CAAC;AACvE,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AACnD,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AAGnD,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC;AAC/E,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;AAGhD,MAAM,MAAM,sBAAsB,GAChC,UAAU,CAAC,SAAS,CAAC,CAAC,wBAAwB,CAAC,CAAC;AAClD,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AACnD,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AAG/D,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AACnD,MAAM,MAAM,wBAAwB,GAClC,UAAU,CAAC,SAAS,CAAC,CAAC,0BAA0B,CAAC,CAAC;AAGpD,MAAM,MAAM,6BAA6B,GACvC,UAAU,CAAC,SAAS,CAAC,CAAC,+BAA+B,CAAC,CAAC;AAGzD,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AACnD,MAAM,MAAM,wBAAwB,GAClC,UAAU,CAAC,SAAS,CAAC,CAAC,0BAA0B,CAAC,CAAC;AAGpD,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,4BAA4B,CAAC,CAAC;AAGtD,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,4BAA4B,CAAC,CAAC;AAEtD,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,SAAS,CAUpE"}

package/dist/api/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AA2DzC,MAAM,UAAU,eAAe,CAAC,OAAyB;IACvD,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IACxC,CAAC;IAED,OAAO,YAAY,CAAQ;QACzB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO;KACR,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AA6DzC,MAAM,UAAU,eAAe,CAAC,OAAyB;IACvD,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IACxC,CAAC;IAED,OAAO,YAAY,CAAQ;QACzB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO;KACR,CAAC,CAAC;AACL,CAAC"}

package/dist/arkade.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Arkade VHTLC query utilities.
+ *
+ * Provides functions for querying VHTLC state from the Arkade indexer.
+ */
+/** Overall VTXO lifecycle status */
+export type VtxoStatus = "not_funded" | "spendable" | "recoverable" | "spent" | "mixed";
+/** VHTLC amounts breakdown */
+export interface VhtlcAmounts {
+    /** Amount that can be spent (in satoshis) */
+    spendable: number;
+    /** Amount already spent (in satoshis) */
+    spent: number;
+    /** Amount that can be recovered via refund (in satoshis) */
+    recoverable: number;
+    /** Overall status derived from VTXO states */
+    vtxoStatus: VtxoStatus;
+}
+/** Parameters for querying VHTLC amounts */
+export interface GetVhtlcAmountsParams {
+    /** The Arkade VHTLC address */
+    vhtlcAddress: string;
+    /** The Bitcoin network (e.g. "bitcoin", "signet") */
+    network: string;
+    /** Optional Arkade server URL override. Falls back to network-based defaults. */
+    arkadeServerUrl?: string;
+}
+/**
+ * Queries the Arkade indexer for spendable, spent, and recoverable balances
+ * at a VHTLC address.
+ *
+ * @param params - The VHTLC address and network to query.
+ * @returns The VHTLC amounts in satoshis.
+ */
+export declare function getVhtlcAmounts(params: GetVhtlcAmountsParams): Promise<VhtlcAmounts>;
+//# sourceMappingURL=arkade.d.ts.map

package/dist/arkade.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arkade.d.ts","sourceRoot":"","sources":["../src/arkade.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAeH,oCAAoC;AACpC,MAAM,MAAM,UAAU,GAClB,YAAY,GACZ,WAAW,GACX,aAAa,GACb,OAAO,GACP,OAAO,CAAC;AAEZ,8BAA8B;AAC9B,MAAM,WAAW,YAAY;IAC3B,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,WAAW,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,4CAA4C;AAC5C,MAAM,WAAW,qBAAqB;IACpC,+BAA+B;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,iFAAiF;IACjF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,YAAY,CAAC,CAyDvB"}

package/dist/arkade.js

@@ -0,0 +1,68 @@
+/**
+ * Arkade VHTLC query utilities.
+ *
+ * Provides functions for querying VHTLC state from the Arkade indexer.
+ */
+import { ArkAddress, RestIndexerProvider, } from "@arkade-os/sdk";
+import { hex } from "@scure/base";
+/** Default Arkade server URLs by network */
+const DEFAULT_ARKADE_URLS = {
+    bitcoin: "https://arkade.computer",
+    signet: "https://signet.arkade.computer",
+};
+/**
+ * Queries the Arkade indexer for spendable, spent, and recoverable balances
+ * at a VHTLC address.
+ *
+ * @param params - The VHTLC address and network to query.
+ * @returns The VHTLC amounts in satoshis.
+ */
+export async function getVhtlcAmounts(params) {
+    const { vhtlcAddress, network, arkadeServerUrl } = params;
+    // Decode the Arkade address to get the pkScript for indexer queries
+    const decoded = ArkAddress.decode(vhtlcAddress);
+    const pkScript = hex.encode(decoded.pkScript);
+    // Determine Arkade server URL: explicit override > network default
+    const serverUrl = arkadeServerUrl ?? DEFAULT_ARKADE_URLS[network];
+    if (!serverUrl) {
+        throw new Error(`Unknown network for Arkade: ${network}`);
+    }
+    const indexerProvider = new RestIndexerProvider(serverUrl);
+    // Query each category separately
+    const [spendableResult, spentResult, recoverableResult] = await Promise.all([
+        indexerProvider.getVtxos({ scripts: [pkScript], spendableOnly: true }),
+        indexerProvider.getVtxos({ scripts: [pkScript], spentOnly: true }),
+        indexerProvider.getVtxos({ scripts: [pkScript], recoverableOnly: true }),
+    ]);
+    const sum = (vtxos) => vtxos.reduce((acc, v) => acc + v.value, 0);
+    // The indexer's spendableOnly filter doesn't account for expired batches.
+    // A preconfirmed VTXO with batchExpiry in the past is effectively expired
+    // and can only be spent via delegated settlement, not offchain spend.
+    // Reclassify such VTXOs from spendable to recoverable.
+    const now = Date.now();
+    let actualSpendable = 0;
+    let expiredSpendable = 0;
+    for (const v of spendableResult.vtxos) {
+        const expiry = v.virtualStatus?.batchExpiry;
+        if (expiry && expiry <= now) {
+            expiredSpendable += v.value;
+        }
+        else {
+            actualSpendable += v.value;
+        }
+    }
+    const spendable = actualSpendable;
+    const spent = sum(spentResult.vtxos);
+    const recoverable = sum(recoverableResult.vtxos) + expiredSpendable;
+    const vtxoStatus = spendable === 0 && spent === 0 && recoverable === 0
+        ? "not_funded"
+        : spendable > 0 && recoverable > 0
+            ? "mixed"
+            : spendable > 0
+                ? "spendable"
+                : recoverable > 0
+                    ? "recoverable"
+                    : "spent";
+    return { spendable, spent, recoverable, vtxoStatus };
+}
+//# sourceMappingURL=arkade.js.map

package/dist/arkade.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arkade.js","sourceRoot":"","sources":["../src/arkade.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,UAAU,EAEV,mBAAmB,GACpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAElC,4CAA4C;AAC5C,MAAM,mBAAmB,GAA2B;IAClD,OAAO,EAAE,yBAAyB;IAClC,MAAM,EAAE,gCAAgC;CACzC,CAAC;AAgCF;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAA6B;IAE7B,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;IAE1D,oEAAoE;IACpE,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAChD,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE9C,mEAAmE;IACnE,MAAM,SAAS,GAAG,eAAe,IAAI,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAClE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,eAAe,GAAoB,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAE5E,iCAAiC;IACjC,MAAM,CAAC,eAAe,EAAE,WAAW,EAAE,iBAAiB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC1E,eAAe,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;QACtE,eAAe,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QAClE,eAAe,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;KACzE,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,CAAC,KAA0B,EAAE,EAAE,CACzC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAE7C,0EAA0E;IAC1E,0EAA0E;IAC1E,sEAAsE;IACtE,uDAAuD;IACvD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,IAAI,eAAe,GAAG,CAAC,CAAC;IACxB,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,KAAK,MAAM,CAAC,IAAI,eAAe,CAAC,KAAK,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,CAAC,CAAC,aAAa,EAAE,WAAW,CAAC;QAC5C,IAAI,MAAM,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;YAC5B,gBAAgB,IAAI,CAAC,CAAC,KAAK,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,eAAe,IAAI,CAAC,CAAC,KAAK,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,eAAe,CAAC;IAClC,MAAM,KAAK,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACrC,MAAM,WAAW,GAAG,GAAG,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC;IAEpE,MAAM,UAAU,GACd,SAAS,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,WAAW,KAAK,CAAC;QACjD,CAAC,CAAC,YAAY;QACd,CAAC,CAAC,SAAS,GAAG,CAAC,IAAI,WAAW,GAAG,CAAC;YAChC,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,SAAS,GAAG,CAAC;gBACb,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,WAAW,GAAG,CAAC;oBACf,CAAC,CAAC,aAAa;oBACf,CAAC,CAAC,OAAO,CAAC;IAEpB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;AACvD,CAAC"}