@routstr/sdk 0.2.5 → 0.2.7

package/dist/store-DGeLPv9E.d.mts

@@ -0,0 +1,172 @@
+import { StoreApi } from 'zustand/vanilla';
+import { D as DiscoveryAdapter } from './interfaces-BWJJTCXO.mjs';
+import { P as ProviderRegistry, S as StorageAdapter } from './interfaces-C5fLD3jB.mjs';
+import { M as Model, P as ProviderInfo } from './types-BYj_8c5c.mjs';
+
+interface UsageTrackingEntry {
+    id: string;
+    timestamp: number;
+    modelId: string;
+    baseUrl: string;
+    requestId: string;
+    cost: number;
+    satsCost: number;
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+    client?: string;
+    sessionId?: string;
+    tags?: string[];
+}
+
+interface ListUsageTrackingOptions {
+    limit?: number;
+    before?: number;
+    after?: number;
+    modelId?: string;
+    baseUrl?: string;
+    sessionId?: string;
+    client?: string;
+}
+interface UsageTrackingDriver {
+    migrate(): Promise<void>;
+    append(entry: UsageTrackingEntry): Promise<void>;
+    appendMany(entries: UsageTrackingEntry[]): Promise<void>;
+    list(options?: ListUsageTrackingOptions): Promise<UsageTrackingEntry[]>;
+    count(options?: Omit<ListUsageTrackingOptions, "limit">): Promise<number>;
+    deleteOlderThan(timestamp: number): Promise<number>;
+    clear(): Promise<void>;
+}
+
+interface StorageDriver {
+    getItem<T>(key: string, defaultValue: T): Promise<T>;
+    setItem<T>(key: string, value: T): Promise<void>;
+    removeItem(key: string): Promise<void>;
+}
+interface SdkStorageState {
+    modelsFromAllProviders: Record<string, Model[]>;
+    lastUsedModel: string | null;
+    baseUrlsList: string[];
+    disabledProviders: string[];
+    mintsFromAllProviders: Record<string, string[]>;
+    infoFromAllProviders: Record<string, ProviderInfo>;
+    lastModelsUpdate: Record<string, number>;
+    lastBaseUrlsUpdate: number | null;
+    apiKeys: Array<{
+        baseUrl: string;
+        key: string;
+        balance: number;
+        lastUsed: number | null;
+    }>;
+    childKeys: Array<{
+        parentBaseUrl: string;
+        childKey: string;
+        balance: number;
+        balanceLimit?: number;
+        validityDate?: number;
+        createdAt: number;
+    }>;
+    xcashuTokens: Record<string, Array<{
+        baseUrl: string;
+        token: string;
+        createdAt: number;
+        tryCount: number;
+    }>>;
+    routstr21Models: string[];
+    lastRoutstr21ModelsUpdate: number | null;
+    cachedReceiveTokens: Array<{
+        token: string;
+        amount: number;
+        unit: "sat" | "msat";
+        createdAt: number;
+    }>;
+    clientIds: Array<{
+        clientId: string;
+        name: string;
+        apiKey: string;
+        createdAt: number;
+        lastUsed?: number | null;
+    }>;
+    /** Set of failed provider URLs */
+    failedProviders: string[];
+    /** Map of provider URL -> timestamp of last failure */
+    lastFailed: Record<string, number>;
+    /** Providers currently on cooldown: [baseUrl, timestamp][] */
+    providersOnCooldown: Array<{
+        baseUrl: string;
+        timestamp: number;
+    }>;
+}
+
+interface SdkStoreOptions {
+    driver: StorageDriver;
+}
+interface SdkStorageStore extends SdkStorageState {
+    setModelsFromAllProviders: (value: Record<string, Model[]>) => void;
+    setLastUsedModel: (value: string | null) => void;
+    setBaseUrlsList: (value: string[]) => void;
+    setBaseUrlsLastUpdate: (value: number | null) => void;
+    setDisabledProviders: (value: string[]) => void;
+    setMintsFromAllProviders: (value: Record<string, string[]>) => void;
+    setInfoFromAllProviders: (value: Record<string, ProviderInfo>) => void;
+    setLastModelsUpdate: (value: Record<string, number>) => void;
+    setApiKeys: (value: Array<{
+        baseUrl: string;
+        key: string;
+        balance?: number;
+        lastUsed?: number | null;
+    }> | ((current: SdkStorageStore["apiKeys"]) => SdkStorageStore["apiKeys"])) => void;
+    setChildKeys: (value: Array<{
+        parentBaseUrl: string;
+        childKey: string;
+        balance?: number;
+        balanceLimit?: number;
+        validityDate?: number;
+        createdAt?: number;
+    }>) => void;
+    setXcashuTokens: (value: Record<string, Array<{
+        baseUrl: string;
+        token: string;
+        createdAt?: number;
+        tryCount?: number;
+    }>>) => void;
+    updateXcashuTokenTryCount: (token: string, tryCount: number) => void;
+    setRoutstr21Models: (value: string[]) => void;
+    setRoutstr21ModelsLastUpdate: (value: number | null) => void;
+    setCachedReceiveTokens: (value: Array<{
+        token: string;
+        amount: number;
+        unit: "sat" | "msat";
+        createdAt?: number;
+    }>) => void;
+    setClientIds: (value: Array<{
+        clientId: string;
+        name: string;
+        apiKey: string;
+        createdAt?: number;
+        lastUsed?: number | null;
+    }> | ((current: SdkStorageStore["clientIds"]) => SdkStorageStore["clientIds"])) => void;
+    setFailedProviders: (value: string[]) => void;
+    addFailedProvider: (baseUrl: string) => void;
+    removeFailedProvider: (baseUrl: string) => void;
+    setLastFailed: (value: Record<string, number>) => void;
+    setLastFailedTimestamp: (baseUrl: string, timestamp: number) => void;
+    setProvidersOnCooldown: (value: Array<{
+        baseUrl: string;
+        timestamp: number;
+    }>) => void;
+    addProviderOnCooldown: (baseUrl: string, timestamp: number) => void;
+    removeProviderFromCooldown: (baseUrl: string) => void;
+    clearProvidersOnCooldown: () => void;
+}
+/** Store type returned after async initialization */
+type SdkStore = StoreApi<SdkStorageStore>;
+declare const createSdkStore: ({ driver, }: SdkStoreOptions) => {
+    store: SdkStore;
+    hydrate: Promise<void>;
+};
+declare const createDiscoveryAdapterFromStore: (store: SdkStore) => DiscoveryAdapter;
+declare const createStorageAdapterFromStore: (store: SdkStore) => StorageAdapter;
+declare const createProviderRegistryFromStore: (store: SdkStore) => ProviderRegistry;
+
+export { type ListUsageTrackingOptions as L, type SdkStore as S, type UsageTrackingDriver as U, type StorageDriver as a, type UsageTrackingEntry as b, createDiscoveryAdapterFromStore as c, createProviderRegistryFromStore as d, createSdkStore as e, createStorageAdapterFromStore as f };

package/dist/store-h7m23ffq.d.ts

@@ -0,0 +1,172 @@
+import { StoreApi } from 'zustand/vanilla';
+import { D as DiscoveryAdapter } from './interfaces-BxDEka72.js';
+import { P as ProviderRegistry, S as StorageAdapter } from './interfaces-B62Rw-dd.js';
+import { M as Model, P as ProviderInfo } from './types-BYj_8c5c.js';
+
+interface UsageTrackingEntry {
+    id: string;
+    timestamp: number;
+    modelId: string;
+    baseUrl: string;
+    requestId: string;
+    cost: number;
+    satsCost: number;
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+    client?: string;
+    sessionId?: string;
+    tags?: string[];
+}
+
+interface ListUsageTrackingOptions {
+    limit?: number;
+    before?: number;
+    after?: number;
+    modelId?: string;
+    baseUrl?: string;
+    sessionId?: string;
+    client?: string;
+}
+interface UsageTrackingDriver {
+    migrate(): Promise<void>;
+    append(entry: UsageTrackingEntry): Promise<void>;
+    appendMany(entries: UsageTrackingEntry[]): Promise<void>;
+    list(options?: ListUsageTrackingOptions): Promise<UsageTrackingEntry[]>;
+    count(options?: Omit<ListUsageTrackingOptions, "limit">): Promise<number>;
+    deleteOlderThan(timestamp: number): Promise<number>;
+    clear(): Promise<void>;
+}
+
+interface StorageDriver {
+    getItem<T>(key: string, defaultValue: T): Promise<T>;
+    setItem<T>(key: string, value: T): Promise<void>;
+    removeItem(key: string): Promise<void>;
+}
+interface SdkStorageState {
+    modelsFromAllProviders: Record<string, Model[]>;
+    lastUsedModel: string | null;
+    baseUrlsList: string[];
+    disabledProviders: string[];
+    mintsFromAllProviders: Record<string, string[]>;
+    infoFromAllProviders: Record<string, ProviderInfo>;
+    lastModelsUpdate: Record<string, number>;
+    lastBaseUrlsUpdate: number | null;
+    apiKeys: Array<{
+        baseUrl: string;
+        key: string;
+        balance: number;
+        lastUsed: number | null;
+    }>;
+    childKeys: Array<{
+        parentBaseUrl: string;
+        childKey: string;
+        balance: number;
+        balanceLimit?: number;
+        validityDate?: number;
+        createdAt: number;
+    }>;
+    xcashuTokens: Record<string, Array<{
+        baseUrl: string;
+        token: string;
+        createdAt: number;
+        tryCount: number;
+    }>>;
+    routstr21Models: string[];
+    lastRoutstr21ModelsUpdate: number | null;
+    cachedReceiveTokens: Array<{
+        token: string;
+        amount: number;
+        unit: "sat" | "msat";
+        createdAt: number;
+    }>;
+    clientIds: Array<{
+        clientId: string;
+        name: string;
+        apiKey: string;
+        createdAt: number;
+        lastUsed?: number | null;
+    }>;
+    /** Set of failed provider URLs */
+    failedProviders: string[];
+    /** Map of provider URL -> timestamp of last failure */
+    lastFailed: Record<string, number>;
+    /** Providers currently on cooldown: [baseUrl, timestamp][] */
+    providersOnCooldown: Array<{
+        baseUrl: string;
+        timestamp: number;
+    }>;
+}
+
+interface SdkStoreOptions {
+    driver: StorageDriver;
+}
+interface SdkStorageStore extends SdkStorageState {
+    setModelsFromAllProviders: (value: Record<string, Model[]>) => void;
+    setLastUsedModel: (value: string | null) => void;
+    setBaseUrlsList: (value: string[]) => void;
+    setBaseUrlsLastUpdate: (value: number | null) => void;
+    setDisabledProviders: (value: string[]) => void;
+    setMintsFromAllProviders: (value: Record<string, string[]>) => void;
+    setInfoFromAllProviders: (value: Record<string, ProviderInfo>) => void;
+    setLastModelsUpdate: (value: Record<string, number>) => void;
+    setApiKeys: (value: Array<{
+        baseUrl: string;
+        key: string;
+        balance?: number;
+        lastUsed?: number | null;
+    }> | ((current: SdkStorageStore["apiKeys"]) => SdkStorageStore["apiKeys"])) => void;
+    setChildKeys: (value: Array<{
+        parentBaseUrl: string;
+        childKey: string;
+        balance?: number;
+        balanceLimit?: number;
+        validityDate?: number;
+        createdAt?: number;
+    }>) => void;
+    setXcashuTokens: (value: Record<string, Array<{
+        baseUrl: string;
+        token: string;
+        createdAt?: number;
+        tryCount?: number;
+    }>>) => void;
+    updateXcashuTokenTryCount: (token: string, tryCount: number) => void;
+    setRoutstr21Models: (value: string[]) => void;
+    setRoutstr21ModelsLastUpdate: (value: number | null) => void;
+    setCachedReceiveTokens: (value: Array<{
+        token: string;
+        amount: number;
+        unit: "sat" | "msat";
+        createdAt?: number;
+    }>) => void;
+    setClientIds: (value: Array<{
+        clientId: string;
+        name: string;
+        apiKey: string;
+        createdAt?: number;
+        lastUsed?: number | null;
+    }> | ((current: SdkStorageStore["clientIds"]) => SdkStorageStore["clientIds"])) => void;
+    setFailedProviders: (value: string[]) => void;
+    addFailedProvider: (baseUrl: string) => void;
+    removeFailedProvider: (baseUrl: string) => void;
+    setLastFailed: (value: Record<string, number>) => void;
+    setLastFailedTimestamp: (baseUrl: string, timestamp: number) => void;
+    setProvidersOnCooldown: (value: Array<{
+        baseUrl: string;
+        timestamp: number;
+    }>) => void;
+    addProviderOnCooldown: (baseUrl: string, timestamp: number) => void;
+    removeProviderFromCooldown: (baseUrl: string) => void;
+    clearProvidersOnCooldown: () => void;
+}
+/** Store type returned after async initialization */
+type SdkStore = StoreApi<SdkStorageStore>;
+declare const createSdkStore: ({ driver, }: SdkStoreOptions) => {
+    store: SdkStore;
+    hydrate: Promise<void>;
+};
+declare const createDiscoveryAdapterFromStore: (store: SdkStore) => DiscoveryAdapter;
+declare const createStorageAdapterFromStore: (store: SdkStore) => StorageAdapter;
+declare const createProviderRegistryFromStore: (store: SdkStore) => ProviderRegistry;
+
+export { type ListUsageTrackingOptions as L, type SdkStore as S, type UsageTrackingDriver as U, type StorageDriver as a, type UsageTrackingEntry as b, createDiscoveryAdapterFromStore as c, createProviderRegistryFromStore as d, createSdkStore as e, createStorageAdapterFromStore as f };

package/dist/wallet/index.d.mts

@@ -1,5 +1,5 @@
-import { W as WalletAdapter, S as StorageAdapter, P as ProviderRegistry } from '../interfaces-C6Dr6hKy.mjs';
-export { A as ApiKeyEntry, C as ChildKeyEntry, R as RoutstrClientOptions, a as StreamingCallbacks } from '../interfaces-C6Dr6hKy.mjs';
+import { W as WalletAdapter, S as StorageAdapter, P as ProviderRegistry } from '../interfaces-C5fLD3jB.mjs';
+export { A as ApiKeyEntry, C as ChildKeyEntry, R as RoutstrClientOptions, a as StreamingCallbacks, X as XCashuTokenEntry } from '../interfaces-C5fLD3jB.mjs';
 import { R as RefundResult, m as TopUpResult, S as SpendResult } from '../types-BYj_8c5c.mjs';
 export { P as ProviderInfo } from '../types-BYj_8c5c.mjs';
 
@@ -15,17 +15,6 @@ export { P as ProviderInfo } from '../types-BYj_8c5c.mjs';
  * Extracted from utils/cashuUtils.ts
  */
 
-/**
- * Options for refunding tokens
- */
-interface RefundOptions {
-    /** The mint URL (for NIP-60 wallet operations) */
-    mintUrl: string;
-    /** The provider base URL */
-    baseUrl: string;
-    /** Optional specific token to refund (if not provided, uses stored token) */
-    token?: string;
-}
 /**
  * Options for refunding API key balance
  */
@@ -82,10 +71,6 @@ declare class BalanceManager {
     private cashuSpender;
     constructor(walletAdapter: WalletAdapter, storageAdapter: StorageAdapter, providerRegistry?: ProviderRegistry | undefined, cashuSpender?: CashuSpender);
     getBalanceState(): Promise<BalanceState>;
-    /**
-     * Unified refund - handles both NIP-60 and legacy wallet refunds
-     */
-    refund(options: RefundOptions): Promise<RefundResult>;
     /**
      * Refund API key balance - convert remaining API key balance to cashu token
      * @param options - Refund options including forceRefund flag
@@ -93,9 +78,14 @@ declare class BalanceManager {
      */
     refundApiKey(options: RefundApiKeyOptions): Promise<RefundResult>;
     /**
-     * Fetch refund token from provider API using API key authentication
+     * Fetch refund token from provider API using API key (or xcashu token) authentication
      */
-    private _fetchRefundTokenWithApiKey;
+    fetchRefundToken(baseUrl: string, apiKeyOrToken: string, xCashu?: boolean): Promise<{
+        success: boolean;
+        token?: string;
+        requestId?: string;
+        error?: string;
+    }>;
     /**
      * Top up API key balance with a cashu token
      */
@@ -103,10 +93,6 @@ declare class BalanceManager {
     createProviderToken(options: CreateProviderTokenOptions): Promise<ProviderTokenResult>;
     private _selectCandidateMints;
     private _refundOtherProvidersForTopUp;
-    /**
-     * Fetch refund token from provider API
-     */
-    private _fetchRefundToken;
     /**
      * Post topup request to provider API
      */
@@ -209,13 +195,27 @@ declare class CashuSpender {
      */
     private _spendInternal;
     /**
-     * Try to reuse an existing token
+     * Try to reuse an existing API key
      */
     private _tryReuseToken;
+    /**
+     * Refund all xcashu tokens from storage by calling the provider's refund endpoint.
+     * The xcashu token acts as an API key to claim the refund, and the response contains
+     * the actual refunded Cashu token which is then received into the wallet.
+     * @param mintUrl - The mint URL for receiving tokens
+     * @param excludeBaseUrls - Base URLs to exclude from refund (optional)
+     * @returns Results for each xcashu token refund attempt
+     */
+    refundXcashuTokens(mintUrl: string, excludeBaseUrls?: string[]): Promise<{
+        baseUrl: string;
+        token: string;
+        success: boolean;
+        error?: string;
+    }[]>;
     /**
      * Refund specific providers without retrying spend
      */
-    refundProviders(baseUrls: string[], mintUrl: string, refundApiKeys?: boolean, forceRefund?: boolean): Promise<{
+    refundProviders(mintUrl: string, forceRefund?: boolean): Promise<{
         baseUrl: string;
         success: boolean;
     }[]>;
@@ -226,4 +226,4 @@ declare class CashuSpender {
     private _getProviderTokenBalance;
 }
 
-export { BalanceManager, type BalanceState, CashuSpender, type CreateProviderTokenOptions, ProviderRegistry, type ProviderTokenResult, type RefundApiKeyOptions, type RefundOptions, type SpendOptions, StorageAdapter, type TopUpOptions, WalletAdapter };
+export { BalanceManager, type BalanceState, CashuSpender, type CreateProviderTokenOptions, ProviderRegistry, type ProviderTokenResult, type RefundApiKeyOptions, type SpendOptions, StorageAdapter, type TopUpOptions, WalletAdapter };

package/dist/wallet/index.d.ts

@@ -1,5 +1,5 @@
-import { W as WalletAdapter, S as StorageAdapter, P as ProviderRegistry } from '../interfaces-CluftN4z.js';
-export { A as ApiKeyEntry, C as ChildKeyEntry, R as RoutstrClientOptions, a as StreamingCallbacks } from '../interfaces-CluftN4z.js';
+import { W as WalletAdapter, S as StorageAdapter, P as ProviderRegistry } from '../interfaces-B62Rw-dd.js';
+export { A as ApiKeyEntry, C as ChildKeyEntry, R as RoutstrClientOptions, a as StreamingCallbacks, X as XCashuTokenEntry } from '../interfaces-B62Rw-dd.js';
 import { R as RefundResult, m as TopUpResult, S as SpendResult } from '../types-BYj_8c5c.js';
 export { P as ProviderInfo } from '../types-BYj_8c5c.js';
 
@@ -15,17 +15,6 @@ export { P as ProviderInfo } from '../types-BYj_8c5c.js';
  * Extracted from utils/cashuUtils.ts
  */
 
-/**
- * Options for refunding tokens
- */
-interface RefundOptions {
-    /** The mint URL (for NIP-60 wallet operations) */
-    mintUrl: string;
-    /** The provider base URL */
-    baseUrl: string;
-    /** Optional specific token to refund (if not provided, uses stored token) */
-    token?: string;
-}
 /**
  * Options for refunding API key balance
  */
@@ -82,10 +71,6 @@ declare class BalanceManager {
     private cashuSpender;
     constructor(walletAdapter: WalletAdapter, storageAdapter: StorageAdapter, providerRegistry?: ProviderRegistry | undefined, cashuSpender?: CashuSpender);
     getBalanceState(): Promise<BalanceState>;
-    /**
-     * Unified refund - handles both NIP-60 and legacy wallet refunds
-     */
-    refund(options: RefundOptions): Promise<RefundResult>;
     /**
      * Refund API key balance - convert remaining API key balance to cashu token
      * @param options - Refund options including forceRefund flag
@@ -93,9 +78,14 @@ declare class BalanceManager {
      */
     refundApiKey(options: RefundApiKeyOptions): Promise<RefundResult>;
     /**
-     * Fetch refund token from provider API using API key authentication
+     * Fetch refund token from provider API using API key (or xcashu token) authentication
      */
-    private _fetchRefundTokenWithApiKey;
+    fetchRefundToken(baseUrl: string, apiKeyOrToken: string, xCashu?: boolean): Promise<{
+        success: boolean;
+        token?: string;
+        requestId?: string;
+        error?: string;
+    }>;
     /**
      * Top up API key balance with a cashu token
      */
@@ -103,10 +93,6 @@ declare class BalanceManager {
     createProviderToken(options: CreateProviderTokenOptions): Promise<ProviderTokenResult>;
     private _selectCandidateMints;
     private _refundOtherProvidersForTopUp;
-    /**
-     * Fetch refund token from provider API
-     */
-    private _fetchRefundToken;
     /**
      * Post topup request to provider API
      */
@@ -209,13 +195,27 @@ declare class CashuSpender {
      */
     private _spendInternal;
     /**
-     * Try to reuse an existing token
+     * Try to reuse an existing API key
      */
     private _tryReuseToken;
+    /**
+     * Refund all xcashu tokens from storage by calling the provider's refund endpoint.
+     * The xcashu token acts as an API key to claim the refund, and the response contains
+     * the actual refunded Cashu token which is then received into the wallet.
+     * @param mintUrl - The mint URL for receiving tokens
+     * @param excludeBaseUrls - Base URLs to exclude from refund (optional)
+     * @returns Results for each xcashu token refund attempt
+     */
+    refundXcashuTokens(mintUrl: string, excludeBaseUrls?: string[]): Promise<{
+        baseUrl: string;
+        token: string;
+        success: boolean;
+        error?: string;
+    }[]>;
     /**
      * Refund specific providers without retrying spend
      */
-    refundProviders(baseUrls: string[], mintUrl: string, refundApiKeys?: boolean, forceRefund?: boolean): Promise<{
+    refundProviders(mintUrl: string, forceRefund?: boolean): Promise<{
         baseUrl: string;
         success: boolean;
     }[]>;
@@ -226,4 +226,4 @@ declare class CashuSpender {
     private _getProviderTokenBalance;
 }
 
-export { BalanceManager, type BalanceState, CashuSpender, type CreateProviderTokenOptions, ProviderRegistry, type ProviderTokenResult, type RefundApiKeyOptions, type RefundOptions, type SpendOptions, StorageAdapter, type TopUpOptions, WalletAdapter };
+export { BalanceManager, type BalanceState, CashuSpender, type CreateProviderTokenOptions, ProviderRegistry, type ProviderTokenResult, type RefundApiKeyOptions, type SpendOptions, StorageAdapter, type TopUpOptions, WalletAdapter };