@volr/react 0.1.92 → 0.1.93

package/dist/index.d.cts

@@ -730,6 +730,156 @@ declare function uploadBlobViaPresign(params: {
  */
 declare function useInternalAuth(): InternalAuthContextType;
 
+/**
+ * Payment types for SDK
+ */
+type PaymentStatus = 'PENDING' | 'PROCESSING' | 'CONFIRMED' | 'FAILED' | 'CANCELLED' | 'EXPIRED';
+interface PaymentItem {
+    /** Item name displayed in payment modal */
+    name: string;
+    /** Item description (optional) */
+    description?: string;
+    /** Item image URL (optional) */
+    image?: string;
+}
+interface PayOptions {
+    /** Amount in token units (before decimals applied) */
+    amount: number;
+    /** Item information to display in payment modal */
+    item?: PaymentItem;
+    /** Client-side order/reference ID */
+    referenceId?: string;
+    /** Custom metadata (max 50 keys) */
+    metadata?: Record<string, string>;
+    /** Idempotency key to prevent duplicate payments */
+    idempotencyKey?: string;
+    /** Payment expiration time in seconds (default: 900 = 15 minutes) */
+    expiresInSec?: number;
+    /** Callback handlers */
+    handlers?: PaymentHandlers;
+}
+interface PaymentHandlers {
+    /** Called when payment is created with ID */
+    onCreated?: (payment: {
+        id: string;
+    }) => void;
+    /** Called when transaction is broadcasted with txHash */
+    onProcessing?: (payment: {
+        id: string;
+        txHash: string;
+    }) => void;
+    /** Called when payment is confirmed on-chain */
+    onSuccess?: (result: PaymentResult) => void;
+    /** Called when payment fails */
+    onError?: (error: PaymentError) => void;
+    /** Called when user cancels the payment */
+    onCancel?: () => void;
+}
+interface PaymentToken {
+    id: string;
+    symbol: string;
+    chainId: number;
+    decimals: number;
+}
+interface PaymentResult {
+    id: string;
+    status: PaymentStatus;
+    txHash: string | null;
+    amount: string;
+    totalUsd: string | null;
+    tokenPriceUsd: string | null;
+    token: PaymentToken;
+    itemName: string | null;
+    itemDescription: string | null;
+    itemImage: string | null;
+    referenceId: string | null;
+    metadata: Record<string, string> | null;
+    createdAt: string;
+    confirmedAt: string | null;
+}
+interface PaymentError {
+    code: string;
+    message: string;
+}
+interface PaymentHistoryResult {
+    payments: PaymentResult[];
+    total: number;
+}
+interface PaymentHistoryOptions {
+    take?: number;
+    skip?: number;
+    status?: PaymentStatus;
+}
+/**
+ * Payment handle returned from pay() function
+ */
+interface PaymentHandle {
+    /** Payment ID */
+    id: string;
+    /** Current payment status */
+    status: PaymentStatus;
+    /** Wait for payment to complete (CONFIRMED/FAILED/CANCELLED) */
+    wait: () => Promise<PaymentResult>;
+    /** Cancel the payment (only works for PENDING status) */
+    cancel: () => Promise<void>;
+}
+/**
+ * Internal payment context for PaymentModal
+ */
+interface PaymentContext {
+    payment: PaymentResult | null;
+    options: PayOptions;
+    isOpen: boolean;
+    close: () => void;
+    onPaymentCreated: (payment: PaymentResult) => void;
+    onPaymentProcessing: (payment: PaymentResult & {
+        txHash: string;
+    }) => void;
+    onPaymentComplete: (result: PaymentResult) => void;
+    onPaymentError: (error: PaymentError) => void;
+    onPaymentCancel: () => void;
+}
+
+/**
+ * useVolrPay hook - Payment functionality for Volr SDK
+ *
+ * This hook provides the core payment API methods.
+ * For UI integration (PaymentModal), use useVolrPayUI from @volr/react-ui
+ */
+
+interface UseVolrPayReturn {
+    /**
+     * Create a payment (without UI)
+     * For UI integration, use useVolrPayUI from @volr/react-ui
+     */
+    createPayment: (options: PayOptions) => Promise<PaymentResult>;
+    /**
+     * Check payment status by ID
+     */
+    checkPayment: (paymentId: string) => Promise<PaymentResult>;
+    /**
+     * Get payment history for current user
+     */
+    getPaymentHistory: (options?: PaymentHistoryOptions) => Promise<PaymentHistoryResult>;
+    /**
+     * Update payment to PROCESSING status (link transaction)
+     */
+    updatePaymentToProcessing: (paymentId: string, transactionId: string) => Promise<PaymentResult>;
+    /**
+     * Cancel a pending payment
+     */
+    cancelPayment: (paymentId: string) => Promise<PaymentResult>;
+    /**
+     * Poll payment status until completion
+     */
+    pollPaymentStatus: (paymentId: string) => Promise<PaymentResult>;
+    /**
+     * Whether a payment operation is loading
+     */
+    isLoading: boolean;
+}
+declare function useVolrPay(): UseVolrPayReturn;
+
 /**
  * Passkey adapter for WebAuthn
  * Implements PasskeyProviderPort interface
@@ -1141,4 +1291,4 @@ declare function getUserCredentials(client: APIClient): Promise<Array<{
     createdAt: string;
 }>>;
 
-export { type ApiResponse, type AuthRefreshResponseDto, type AuthResult, type BuildCallOptions, type ContractAnalysisResult, DEFAULT_EXPIRES_IN_SEC, DEFAULT_MODE, type DepositAsset$1 as DepositAsset, type DepositConfig, type ERC20BalanceComparison, type Erc20Token$1 as Erc20Token, type EvmClient, type KeyStorageType, type MigrationCompleteParams, type MigrationCompleteResult, type MigrationError, type MigrationMessage, type MigrationRequestParams, type MigrationRequestResult, type MigrationSeedRequest, type MigrationSeedResponse, type MpcConnectionStep, type NetworkDto, type NetworkInfo, type PasskeyAdapterOptions, type PasskeyEnrollmentStep, PasskeyNotFoundError, type PlatformCheckResult, type PrfInputDto, PrfNotSupportedError, type SendBatchOverloads, type SendTxOptions, type SignerType, type SiweSession, type SiweSessionStatus, type SocialProvider, type TransactionDto, type TransactionStatus, type UseMpcConnectionReturn, type UsePasskeyEnrollmentReturn, type UseVolrAuthCallbackOptions, type UseVolrAuthCallbackReturn, type UseVolrLoginReturn, UserCancelledError, type UserDto, type VolrClient, type VolrConfig, type VolrContextValue, VolrProvider, type VolrUser, type WalletStateComparison, analyzeContractForEIP7702, buildCall, buildCalls, checkPrfExtensionAvailable, checkPrfSupport, compareERC20Balances, compareWalletStates, completeMigration, createGetNetworkInfo, createPasskeyAdapter, debugTransactionFailure, defaultIdempotencyKey, diagnoseTransactionFailure, getERC20Balance, getPasskeyAuthGuidance, getUserCredentials, getWalletState, isEIP7702Delegated, isUserCancelledError, listenForSeedRequests, normalizeHex, normalizeHexArray, openMigrationPopup, requestMigration, requestSeedFromOpener, sendSeedToPopup, uploadBlobViaPresign, useDepositListener, useInternalAuth, useMpcConnection, usePasskeyEnrollment, useVolr, useVolrAuthCallback, useVolrContext, useVolrLogin };
+export { type ApiResponse, type AuthRefreshResponseDto, type AuthResult, type BuildCallOptions, type ContractAnalysisResult, DEFAULT_EXPIRES_IN_SEC, DEFAULT_MODE, type DepositAsset$1 as DepositAsset, type DepositConfig, type ERC20BalanceComparison, type Erc20Token$1 as Erc20Token, type EvmClient, type KeyStorageType, type MigrationCompleteParams, type MigrationCompleteResult, type MigrationError, type MigrationMessage, type MigrationRequestParams, type MigrationRequestResult, type MigrationSeedRequest, type MigrationSeedResponse, type MpcConnectionStep, type NetworkDto, type NetworkInfo, type PasskeyAdapterOptions, type PasskeyEnrollmentStep, PasskeyNotFoundError, type PayOptions, type PaymentContext, type PaymentError, type PaymentHandle, type PaymentHandlers, type PaymentHistoryOptions, type PaymentHistoryResult, type PaymentItem, type PaymentResult, type PaymentStatus, type PaymentToken, type PlatformCheckResult, type PrfInputDto, PrfNotSupportedError, type SendBatchOverloads, type SendTxOptions, type SignerType, type SiweSession, type SiweSessionStatus, type SocialProvider, type TransactionDto, type TransactionStatus, type UseMpcConnectionReturn, type UsePasskeyEnrollmentReturn, type UseVolrAuthCallbackOptions, type UseVolrAuthCallbackReturn, type UseVolrLoginReturn, type UseVolrPayReturn, UserCancelledError, type UserDto, type VolrClient, type VolrConfig, type VolrContextValue, VolrProvider, type VolrUser, type WalletStateComparison, analyzeContractForEIP7702, buildCall, buildCalls, checkPrfExtensionAvailable, checkPrfSupport, compareERC20Balances, compareWalletStates, completeMigration, createGetNetworkInfo, createPasskeyAdapter, debugTransactionFailure, defaultIdempotencyKey, diagnoseTransactionFailure, getERC20Balance, getPasskeyAuthGuidance, getUserCredentials, getWalletState, isEIP7702Delegated, isUserCancelledError, listenForSeedRequests, normalizeHex, normalizeHexArray, openMigrationPopup, requestMigration, requestSeedFromOpener, sendSeedToPopup, uploadBlobViaPresign, useDepositListener, useInternalAuth, useMpcConnection, usePasskeyEnrollment, useVolr, useVolrAuthCallback, useVolrContext, useVolrLogin, useVolrPay };

package/dist/index.d.ts

@@ -730,6 +730,156 @@ declare function uploadBlobViaPresign(params: {
  */
 declare function useInternalAuth(): InternalAuthContextType;
 
+/**
+ * Payment types for SDK
+ */
+type PaymentStatus = 'PENDING' | 'PROCESSING' | 'CONFIRMED' | 'FAILED' | 'CANCELLED' | 'EXPIRED';
+interface PaymentItem {
+    /** Item name displayed in payment modal */
+    name: string;
+    /** Item description (optional) */
+    description?: string;
+    /** Item image URL (optional) */
+    image?: string;
+}
+interface PayOptions {
+    /** Amount in token units (before decimals applied) */
+    amount: number;
+    /** Item information to display in payment modal */
+    item?: PaymentItem;
+    /** Client-side order/reference ID */
+    referenceId?: string;
+    /** Custom metadata (max 50 keys) */
+    metadata?: Record<string, string>;
+    /** Idempotency key to prevent duplicate payments */
+    idempotencyKey?: string;
+    /** Payment expiration time in seconds (default: 900 = 15 minutes) */
+    expiresInSec?: number;
+    /** Callback handlers */
+    handlers?: PaymentHandlers;
+}
+interface PaymentHandlers {
+    /** Called when payment is created with ID */
+    onCreated?: (payment: {
+        id: string;
+    }) => void;
+    /** Called when transaction is broadcasted with txHash */
+    onProcessing?: (payment: {
+        id: string;
+        txHash: string;
+    }) => void;
+    /** Called when payment is confirmed on-chain */
+    onSuccess?: (result: PaymentResult) => void;
+    /** Called when payment fails */
+    onError?: (error: PaymentError) => void;
+    /** Called when user cancels the payment */
+    onCancel?: () => void;
+}
+interface PaymentToken {
+    id: string;
+    symbol: string;
+    chainId: number;
+    decimals: number;
+}
+interface PaymentResult {
+    id: string;
+    status: PaymentStatus;
+    txHash: string | null;
+    amount: string;
+    totalUsd: string | null;
+    tokenPriceUsd: string | null;
+    token: PaymentToken;
+    itemName: string | null;
+    itemDescription: string | null;
+    itemImage: string | null;
+    referenceId: string | null;
+    metadata: Record<string, string> | null;
+    createdAt: string;
+    confirmedAt: string | null;
+}
+interface PaymentError {
+    code: string;
+    message: string;
+}
+interface PaymentHistoryResult {
+    payments: PaymentResult[];
+    total: number;
+}
+interface PaymentHistoryOptions {
+    take?: number;
+    skip?: number;
+    status?: PaymentStatus;
+}
+/**
+ * Payment handle returned from pay() function
+ */
+interface PaymentHandle {
+    /** Payment ID */
+    id: string;
+    /** Current payment status */
+    status: PaymentStatus;
+    /** Wait for payment to complete (CONFIRMED/FAILED/CANCELLED) */
+    wait: () => Promise<PaymentResult>;
+    /** Cancel the payment (only works for PENDING status) */
+    cancel: () => Promise<void>;
+}
+/**
+ * Internal payment context for PaymentModal
+ */
+interface PaymentContext {
+    payment: PaymentResult | null;
+    options: PayOptions;
+    isOpen: boolean;
+    close: () => void;
+    onPaymentCreated: (payment: PaymentResult) => void;
+    onPaymentProcessing: (payment: PaymentResult & {
+        txHash: string;
+    }) => void;
+    onPaymentComplete: (result: PaymentResult) => void;
+    onPaymentError: (error: PaymentError) => void;
+    onPaymentCancel: () => void;
+}
+
+/**
+ * useVolrPay hook - Payment functionality for Volr SDK
+ *
+ * This hook provides the core payment API methods.
+ * For UI integration (PaymentModal), use useVolrPayUI from @volr/react-ui
+ */
+
+interface UseVolrPayReturn {
+    /**
+     * Create a payment (without UI)
+     * For UI integration, use useVolrPayUI from @volr/react-ui
+     */
+    createPayment: (options: PayOptions) => Promise<PaymentResult>;
+    /**
+     * Check payment status by ID
+     */
+    checkPayment: (paymentId: string) => Promise<PaymentResult>;
+    /**
+     * Get payment history for current user
+     */
+    getPaymentHistory: (options?: PaymentHistoryOptions) => Promise<PaymentHistoryResult>;
+    /**
+     * Update payment to PROCESSING status (link transaction)
+     */
+    updatePaymentToProcessing: (paymentId: string, transactionId: string) => Promise<PaymentResult>;
+    /**
+     * Cancel a pending payment
+     */
+    cancelPayment: (paymentId: string) => Promise<PaymentResult>;
+    /**
+     * Poll payment status until completion
+     */
+    pollPaymentStatus: (paymentId: string) => Promise<PaymentResult>;
+    /**
+     * Whether a payment operation is loading
+     */
+    isLoading: boolean;
+}
+declare function useVolrPay(): UseVolrPayReturn;
+
 /**
  * Passkey adapter for WebAuthn
  * Implements PasskeyProviderPort interface
@@ -1141,4 +1291,4 @@ declare function getUserCredentials(client: APIClient): Promise<Array<{
     createdAt: string;
 }>>;
 
-export { type ApiResponse, type AuthRefreshResponseDto, type AuthResult, type BuildCallOptions, type ContractAnalysisResult, DEFAULT_EXPIRES_IN_SEC, DEFAULT_MODE, type DepositAsset$1 as DepositAsset, type DepositConfig, type ERC20BalanceComparison, type Erc20Token$1 as Erc20Token, type EvmClient, type KeyStorageType, type MigrationCompleteParams, type MigrationCompleteResult, type MigrationError, type MigrationMessage, type MigrationRequestParams, type MigrationRequestResult, type MigrationSeedRequest, type MigrationSeedResponse, type MpcConnectionStep, type NetworkDto, type NetworkInfo, type PasskeyAdapterOptions, type PasskeyEnrollmentStep, PasskeyNotFoundError, type PlatformCheckResult, type PrfInputDto, PrfNotSupportedError, type SendBatchOverloads, type SendTxOptions, type SignerType, type SiweSession, type SiweSessionStatus, type SocialProvider, type TransactionDto, type TransactionStatus, type UseMpcConnectionReturn, type UsePasskeyEnrollmentReturn, type UseVolrAuthCallbackOptions, type UseVolrAuthCallbackReturn, type UseVolrLoginReturn, UserCancelledError, type UserDto, type VolrClient, type VolrConfig, type VolrContextValue, VolrProvider, type VolrUser, type WalletStateComparison, analyzeContractForEIP7702, buildCall, buildCalls, checkPrfExtensionAvailable, checkPrfSupport, compareERC20Balances, compareWalletStates, completeMigration, createGetNetworkInfo, createPasskeyAdapter, debugTransactionFailure, defaultIdempotencyKey, diagnoseTransactionFailure, getERC20Balance, getPasskeyAuthGuidance, getUserCredentials, getWalletState, isEIP7702Delegated, isUserCancelledError, listenForSeedRequests, normalizeHex, normalizeHexArray, openMigrationPopup, requestMigration, requestSeedFromOpener, sendSeedToPopup, uploadBlobViaPresign, useDepositListener, useInternalAuth, useMpcConnection, usePasskeyEnrollment, useVolr, useVolrAuthCallback, useVolrContext, useVolrLogin };
+export { type ApiResponse, type AuthRefreshResponseDto, type AuthResult, type BuildCallOptions, type ContractAnalysisResult, DEFAULT_EXPIRES_IN_SEC, DEFAULT_MODE, type DepositAsset$1 as DepositAsset, type DepositConfig, type ERC20BalanceComparison, type Erc20Token$1 as Erc20Token, type EvmClient, type KeyStorageType, type MigrationCompleteParams, type MigrationCompleteResult, type MigrationError, type MigrationMessage, type MigrationRequestParams, type MigrationRequestResult, type MigrationSeedRequest, type MigrationSeedResponse, type MpcConnectionStep, type NetworkDto, type NetworkInfo, type PasskeyAdapterOptions, type PasskeyEnrollmentStep, PasskeyNotFoundError, type PayOptions, type PaymentContext, type PaymentError, type PaymentHandle, type PaymentHandlers, type PaymentHistoryOptions, type PaymentHistoryResult, type PaymentItem, type PaymentResult, type PaymentStatus, type PaymentToken, type PlatformCheckResult, type PrfInputDto, PrfNotSupportedError, type SendBatchOverloads, type SendTxOptions, type SignerType, type SiweSession, type SiweSessionStatus, type SocialProvider, type TransactionDto, type TransactionStatus, type UseMpcConnectionReturn, type UsePasskeyEnrollmentReturn, type UseVolrAuthCallbackOptions, type UseVolrAuthCallbackReturn, type UseVolrLoginReturn, type UseVolrPayReturn, UserCancelledError, type UserDto, type VolrClient, type VolrConfig, type VolrContextValue, VolrProvider, type VolrUser, type WalletStateComparison, analyzeContractForEIP7702, buildCall, buildCalls, checkPrfExtensionAvailable, checkPrfSupport, compareERC20Balances, compareWalletStates, completeMigration, createGetNetworkInfo, createPasskeyAdapter, debugTransactionFailure, defaultIdempotencyKey, diagnoseTransactionFailure, getERC20Balance, getPasskeyAuthGuidance, getUserCredentials, getWalletState, isEIP7702Delegated, isUserCancelledError, listenForSeedRequests, normalizeHex, normalizeHexArray, openMigrationPopup, requestMigration, requestSeedFromOpener, sendSeedToPopup, uploadBlobViaPresign, useDepositListener, useInternalAuth, useMpcConnection, usePasskeyEnrollment, useVolr, useVolrAuthCallback, useVolrContext, useVolrLogin, useVolrPay };

package/dist/index.js

@@ -19596,6 +19596,87 @@ async function uploadBlobViaPresign(params) {
   }
   return { s3Key };
 }
+var POLL_INTERVAL_MS = 2e3;
+var MAX_POLL_ATTEMPTS = 180;
+function useVolrPay() {
+  const { client } = useInternalAuth();
+  const [isLoading, setIsLoading] = useState(false);
+  const createPayment = useCallback(
+    async (options) => {
+      setIsLoading(true);
+      try {
+        const response = await client.post("/payments", {
+          amount: options.amount,
+          item: options.item,
+          referenceId: options.referenceId,
+          metadata: options.metadata,
+          idempotencyKey: options.idempotencyKey,
+          expiresInSec: options.expiresInSec
+        });
+        return response;
+      } finally {
+        setIsLoading(false);
+      }
+    },
+    [client]
+  );
+  const checkPayment = useCallback(
+    async (paymentId) => {
+      return client.get(`/payments/${paymentId}`);
+    },
+    [client]
+  );
+  const getPaymentHistory = useCallback(
+    async (options = {}) => {
+      const params = new URLSearchParams();
+      if (options.take) params.append("take", String(options.take));
+      if (options.skip) params.append("skip", String(options.skip));
+      if (options.status) params.append("status", options.status);
+      const queryString = params.toString();
+      const url = queryString ? `/payments?${queryString}` : "/payments";
+      return client.get(url);
+    },
+    [client]
+  );
+  const updatePaymentToProcessing = useCallback(
+    async (paymentId, transactionId) => {
+      return client.post(`/payments/${paymentId}/processing`, {
+        transactionId
+      });
+    },
+    [client]
+  );
+  const cancelPayment = useCallback(
+    async (paymentId) => {
+      return client.post(`/payments/${paymentId}/cancel`, {});
+    },
+    [client]
+  );
+  const pollPaymentStatus = useCallback(
+    async (paymentId) => {
+      let attempts = 0;
+      while (attempts < MAX_POLL_ATTEMPTS) {
+        const payment = await checkPayment(paymentId);
+        if (payment.status === "CONFIRMED" || payment.status === "FAILED" || payment.status === "CANCELLED" || payment.status === "EXPIRED") {
+          return payment;
+        }
+        await new Promise((resolve) => setTimeout(resolve, POLL_INTERVAL_MS));
+        attempts++;
+      }
+      throw new Error("Payment polling timeout");
+    },
+    [checkPayment]
+  );
+  return {
+    createPayment,
+    checkPayment,
+    getPaymentHistory,
+    updatePaymentToProcessing,
+    cancelPayment,
+    pollPaymentStatus,
+    isLoading
+  };
+}
 
 // src/utils/contract-analysis.ts
 var EIP7702_PREFIX = "0xef0100";
@@ -20202,6 +20283,6 @@ async function getUserCredentials(client) {
   (*! noble-curves - MIT License (c) 2022 Paul Miller (paulmillr.com) *)
 */
 
-export { DEFAULT_EXPIRES_IN_SEC, DEFAULT_MODE, PasskeyNotFoundError, PrfNotSupportedError, UserCancelledError, VolrProvider, analyzeContractForEIP7702, buildCall, buildCalls, checkPrfExtensionAvailable, checkPrfSupport, compareERC20Balances, compareWalletStates, completeMigration, createGetNetworkInfo, createPasskeyAdapter, debugTransactionFailure, defaultIdempotencyKey, diagnoseTransactionFailure, getERC20Balance, getPasskeyAuthGuidance, getUserCredentials, getWalletState, isEIP7702Delegated, isUserCancelledError, listenForSeedRequests, normalizeHex, normalizeHexArray, openMigrationPopup, requestMigration, requestSeedFromOpener, sendSeedToPopup, uploadBlobViaPresign, useDepositListener, useInternalAuth, useMpcConnection, usePasskeyEnrollment, useVolr, useVolrAuthCallback, useVolrContext, useVolrLogin };
+export { DEFAULT_EXPIRES_IN_SEC, DEFAULT_MODE, PasskeyNotFoundError, PrfNotSupportedError, UserCancelledError, VolrProvider, analyzeContractForEIP7702, buildCall, buildCalls, checkPrfExtensionAvailable, checkPrfSupport, compareERC20Balances, compareWalletStates, completeMigration, createGetNetworkInfo, createPasskeyAdapter, debugTransactionFailure, defaultIdempotencyKey, diagnoseTransactionFailure, getERC20Balance, getPasskeyAuthGuidance, getUserCredentials, getWalletState, isEIP7702Delegated, isUserCancelledError, listenForSeedRequests, normalizeHex, normalizeHexArray, openMigrationPopup, requestMigration, requestSeedFromOpener, sendSeedToPopup, uploadBlobViaPresign, useDepositListener, useInternalAuth, useMpcConnection, usePasskeyEnrollment, useVolr, useVolrAuthCallback, useVolrContext, useVolrLogin, useVolrPay };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map