@swype-org/react-sdk 0.1.2 → 0.1.4

package/dist/index.d.cts

@@ -27,11 +27,6 @@ interface WalletSource {
     token: WalletToken;
     balance: TokenBalance;
 }
-/** Token + chain most recently authorized via Permit2 for a wallet */
-interface LastAuthorizedToken {
-    symbol: string;
-    chainName: string;
-}
 /** Full wallet with chain, balance, and token sources */
 interface Wallet {
     id: string;
@@ -43,8 +38,8 @@ interface Wallet {
         id: string;
         name: string;
     };
-    /** The token+chain most recently authorized via Permit2, if any. */
-    lastAuthorizedToken?: LastAuthorizedToken | null;
+    /** The smart account type (e.g. 'metamask'), if a smart account has been created. */
+    smartAccountType?: string | null;
     createDate: string;
     updateDate: string;
     authorizationSessions?: AuthorizationSession[];
@@ -94,6 +89,17 @@ interface TransferDestination {
     };
     amount: Amount;
 }
+/** Sign payload containing the unsigned UserOp and bridge/relay metadata */
+interface TransferSignPayload {
+    userOp: Record<string, unknown>;
+    /** ERC-4337 UserOp hash — used as the WebAuthn challenge for on-chain verification. */
+    userOpHash: string;
+    bridgeRelayAddress: string;
+    tokenSymbol: string;
+    chainName: string;
+    amount: string;
+    estimatedFeeUsd: string;
+}
 /** Transfer object returned by the API */
 interface Transfer {
     id: string;
@@ -109,6 +115,7 @@ interface Transfer {
     createDate: string;
     updateDate: string;
     authorizationSessions: AuthorizationSession[];
+    signPayload?: TransferSignPayload | null;
 }
 /** Standard API error shape */
 interface ErrorResponse {
@@ -162,11 +169,6 @@ interface AdvancedSettings {
     /** Override chain name (e.g. 'Base', 'Ethereum'). Null = let backend decide. */
     chain: string | null;
 }
-/** User's top-up allowance selection for the SIGN_PERMIT2 action. */
-interface AllowanceSelection {
-    /** Extra amount (in human-readable units, e.g. 100 = $100) to add on top of the transfer amount. */
-    topUpAmount: number;
-}
 
 interface ThemeTokens {
     bg: string;
@@ -281,21 +283,30 @@ interface UseAuthorizationExecutorResult {
     executing: boolean;
     results: ActionExecutionResult[];
     error: string | null;
+    /** The current action being executed (for UI display). */
+    currentAction: AuthorizationAction | null;
     /** The SELECT_SOURCE action when paused for user selection, null otherwise. */
     pendingSelectSource: AuthorizationAction | null;
     /** Call this from the UI to provide the user's chain+token choice. */
     resolveSelectSource: (selection: SourceSelection) => void;
-    /** The SIGN_PERMIT2 action when paused for allowance selection, null otherwise. */
-    pendingAllowanceSelection: AuthorizationAction | null;
-    /** Call this from the UI to provide the user's top-up allowance choice. */
-    resolveAllowanceSelection: (selection: AllowanceSelection) => void;
     executeSession: (transfer: Transfer) => Promise<void>;
 }
 /**
  * Executes the full authorization flow for a transfer's first session:
- * fetches the session, walks through PENDING actions (OPEN_PROVIDER,
- * SELECT_SOURCE, SWITCH_CHAIN, APPROVE_PERMIT_2, SIGN_PERMIT2), reports
- * each completion to the server, and chains new actions that appear.
+ * fetches the session, walks through PENDING actions, reports each
+ * completion to the server, and chains new actions that appear.
+ *
+ * Supported action types:
+ *   - OPEN_PROVIDER — connect the user's wallet
+ *   - SELECT_SOURCE — pause for user chain+token selection
+ *   - SWITCH_CHAIN — switch the wallet to the required chain
+ *   - REGISTER_PASSKEY — create a WebAuthn passkey credential
+ *   - CREATE_SMART_ACCOUNT — server-side smart account deployment
+ *   - APPROVE_PERMIT2 — ERC-20 approve(permit2, maxUint256) from EOA
+ *   - SIGN_PERMIT2 — EIP-712 Permit2 allowance signature from EOA
+ *
+ * Transfer signing (passkey) is handled separately via
+ * `useTransferSigning()` after the authorization flow completes.
  *
  * When a SELECT_SOURCE action is encountered, the executor pauses and
  * exposes the action via `pendingSelectSource`. The UI should display
@@ -316,6 +327,11 @@ interface CreateTransferParams {
 }
 declare function createTransfer(apiBaseUrl: string, token: string, params: CreateTransferParams): Promise<Transfer>;
 declare function fetchTransfer(apiBaseUrl: string, token: string, transferId: string): Promise<Transfer>;
+/**
+ * Submit a passkey-signed UserOperation for a transfer.
+ * PATCH /v1/transfers/{transferId}
+ */
+declare function signTransfer(apiBaseUrl: string, token: string, transferId: string, signedUserOp: Record<string, unknown>): Promise<Transfer>;
 declare function fetchAuthorizationSession(apiBaseUrl: string, sessionId: string): Promise<AuthorizationSessionDetail>;
 declare function updateUserConfig(apiBaseUrl: string, token: string, config: {
     defaultAllowance: number;
@@ -340,10 +356,11 @@ declare const api_fetchChains: typeof fetchChains;
 declare const api_fetchProviders: typeof fetchProviders;
 declare const api_fetchTransfer: typeof fetchTransfer;
 declare const api_reportActionCompletion: typeof reportActionCompletion;
+declare const api_signTransfer: typeof signTransfer;
 declare const api_updateUserConfig: typeof updateUserConfig;
 declare const api_updateUserConfigBySession: typeof updateUserConfigBySession;
 declare namespace api {
-  export { type api_CreateTransferParams as CreateTransferParams, api_createTransfer as createTransfer, api_fetchAccounts as fetchAccounts, api_fetchAuthorizationSession as fetchAuthorizationSession, api_fetchChains as fetchChains, api_fetchProviders as fetchProviders, api_fetchTransfer as fetchTransfer, api_reportActionCompletion as reportActionCompletion, api_updateUserConfig as updateUserConfig, api_updateUserConfigBySession as updateUserConfigBySession };
+  export { type api_CreateTransferParams as CreateTransferParams, api_createTransfer as createTransfer, api_fetchAccounts as fetchAccounts, api_fetchAuthorizationSession as fetchAuthorizationSession, api_fetchChains as fetchChains, api_fetchProviders as fetchProviders, api_fetchTransfer as fetchTransfer, api_reportActionCompletion as reportActionCompletion, api_signTransfer as signTransfer, api_updateUserConfig as updateUserConfig, api_updateUserConfigBySession as updateUserConfigBySession };
 }
 
 export { type Account, type ActionExecutionResult, type AdvancedSettings, type Amount, type AuthorizationAction, type AuthorizationSession, type AuthorizationSessionDetail, type Chain, type Destination, type ErrorResponse, type ListResponse, type PaymentStep, type Provider, type SourceType, SwypePayment, type SwypePaymentProps, SwypeProvider, type SwypeProviderProps, type ThemeMode, type ThemeTokens, type TokenBalance, type Transfer, type TransferDestination, type UserConfig, type Wallet, type WalletSource, type WalletToken, darkTheme, getTheme, lightTheme, api as swypeApi, useAuthorizationExecutor, useSwypeConfig, useSwypeDepositAmount, useTransferPolling };

package/dist/index.d.ts

@@ -27,11 +27,6 @@ interface WalletSource {
     token: WalletToken;
     balance: TokenBalance;
 }
-/** Token + chain most recently authorized via Permit2 for a wallet */
-interface LastAuthorizedToken {
-    symbol: string;
-    chainName: string;
-}
 /** Full wallet with chain, balance, and token sources */
 interface Wallet {
     id: string;
@@ -43,8 +38,8 @@ interface Wallet {
         id: string;
         name: string;
     };
-    /** The token+chain most recently authorized via Permit2, if any. */
-    lastAuthorizedToken?: LastAuthorizedToken | null;
+    /** The smart account type (e.g. 'metamask'), if a smart account has been created. */
+    smartAccountType?: string | null;
     createDate: string;
     updateDate: string;
     authorizationSessions?: AuthorizationSession[];
@@ -94,6 +89,17 @@ interface TransferDestination {
     };
     amount: Amount;
 }
+/** Sign payload containing the unsigned UserOp and bridge/relay metadata */
+interface TransferSignPayload {
+    userOp: Record<string, unknown>;
+    /** ERC-4337 UserOp hash — used as the WebAuthn challenge for on-chain verification. */
+    userOpHash: string;
+    bridgeRelayAddress: string;
+    tokenSymbol: string;
+    chainName: string;
+    amount: string;
+    estimatedFeeUsd: string;
+}
 /** Transfer object returned by the API */
 interface Transfer {
     id: string;
@@ -109,6 +115,7 @@ interface Transfer {
     createDate: string;
     updateDate: string;
     authorizationSessions: AuthorizationSession[];
+    signPayload?: TransferSignPayload | null;
 }
 /** Standard API error shape */
 interface ErrorResponse {
@@ -162,11 +169,6 @@ interface AdvancedSettings {
     /** Override chain name (e.g. 'Base', 'Ethereum'). Null = let backend decide. */
     chain: string | null;
 }
-/** User's top-up allowance selection for the SIGN_PERMIT2 action. */
-interface AllowanceSelection {
-    /** Extra amount (in human-readable units, e.g. 100 = $100) to add on top of the transfer amount. */
-    topUpAmount: number;
-}
 
 interface ThemeTokens {
     bg: string;
@@ -281,21 +283,30 @@ interface UseAuthorizationExecutorResult {
     executing: boolean;
     results: ActionExecutionResult[];
     error: string | null;
+    /** The current action being executed (for UI display). */
+    currentAction: AuthorizationAction | null;
     /** The SELECT_SOURCE action when paused for user selection, null otherwise. */
     pendingSelectSource: AuthorizationAction | null;
     /** Call this from the UI to provide the user's chain+token choice. */
     resolveSelectSource: (selection: SourceSelection) => void;
-    /** The SIGN_PERMIT2 action when paused for allowance selection, null otherwise. */
-    pendingAllowanceSelection: AuthorizationAction | null;
-    /** Call this from the UI to provide the user's top-up allowance choice. */
-    resolveAllowanceSelection: (selection: AllowanceSelection) => void;
     executeSession: (transfer: Transfer) => Promise<void>;
 }
 /**
  * Executes the full authorization flow for a transfer's first session:
- * fetches the session, walks through PENDING actions (OPEN_PROVIDER,
- * SELECT_SOURCE, SWITCH_CHAIN, APPROVE_PERMIT_2, SIGN_PERMIT2), reports
- * each completion to the server, and chains new actions that appear.
+ * fetches the session, walks through PENDING actions, reports each
+ * completion to the server, and chains new actions that appear.
+ *
+ * Supported action types:
+ *   - OPEN_PROVIDER — connect the user's wallet
+ *   - SELECT_SOURCE — pause for user chain+token selection
+ *   - SWITCH_CHAIN — switch the wallet to the required chain
+ *   - REGISTER_PASSKEY — create a WebAuthn passkey credential
+ *   - CREATE_SMART_ACCOUNT — server-side smart account deployment
+ *   - APPROVE_PERMIT2 — ERC-20 approve(permit2, maxUint256) from EOA
+ *   - SIGN_PERMIT2 — EIP-712 Permit2 allowance signature from EOA
+ *
+ * Transfer signing (passkey) is handled separately via
+ * `useTransferSigning()` after the authorization flow completes.
  *
  * When a SELECT_SOURCE action is encountered, the executor pauses and
  * exposes the action via `pendingSelectSource`. The UI should display
@@ -316,6 +327,11 @@ interface CreateTransferParams {
 }
 declare function createTransfer(apiBaseUrl: string, token: string, params: CreateTransferParams): Promise<Transfer>;
 declare function fetchTransfer(apiBaseUrl: string, token: string, transferId: string): Promise<Transfer>;
+/**
+ * Submit a passkey-signed UserOperation for a transfer.
+ * PATCH /v1/transfers/{transferId}
+ */
+declare function signTransfer(apiBaseUrl: string, token: string, transferId: string, signedUserOp: Record<string, unknown>): Promise<Transfer>;
 declare function fetchAuthorizationSession(apiBaseUrl: string, sessionId: string): Promise<AuthorizationSessionDetail>;
 declare function updateUserConfig(apiBaseUrl: string, token: string, config: {
     defaultAllowance: number;
@@ -340,10 +356,11 @@ declare const api_fetchChains: typeof fetchChains;
 declare const api_fetchProviders: typeof fetchProviders;
 declare const api_fetchTransfer: typeof fetchTransfer;
 declare const api_reportActionCompletion: typeof reportActionCompletion;
+declare const api_signTransfer: typeof signTransfer;
 declare const api_updateUserConfig: typeof updateUserConfig;
 declare const api_updateUserConfigBySession: typeof updateUserConfigBySession;
 declare namespace api {
-  export { type api_CreateTransferParams as CreateTransferParams, api_createTransfer as createTransfer, api_fetchAccounts as fetchAccounts, api_fetchAuthorizationSession as fetchAuthorizationSession, api_fetchChains as fetchChains, api_fetchProviders as fetchProviders, api_fetchTransfer as fetchTransfer, api_reportActionCompletion as reportActionCompletion, api_updateUserConfig as updateUserConfig, api_updateUserConfigBySession as updateUserConfigBySession };
+  export { type api_CreateTransferParams as CreateTransferParams, api_createTransfer as createTransfer, api_fetchAccounts as fetchAccounts, api_fetchAuthorizationSession as fetchAuthorizationSession, api_fetchChains as fetchChains, api_fetchProviders as fetchProviders, api_fetchTransfer as fetchTransfer, api_reportActionCompletion as reportActionCompletion, api_signTransfer as signTransfer, api_updateUserConfig as updateUserConfig, api_updateUserConfigBySession as updateUserConfigBySession };
 }
 
 export { type Account, type ActionExecutionResult, type AdvancedSettings, type Amount, type AuthorizationAction, type AuthorizationSession, type AuthorizationSessionDetail, type Chain, type Destination, type ErrorResponse, type ListResponse, type PaymentStep, type Provider, type SourceType, SwypePayment, type SwypePaymentProps, SwypeProvider, type SwypeProviderProps, type ThemeMode, type ThemeTokens, type TokenBalance, type Transfer, type TransferDestination, type UserConfig, type Wallet, type WalletSource, type WalletToken, darkTheme, getTheme, lightTheme, api as swypeApi, useAuthorizationExecutor, useSwypeConfig, useSwypeDepositAmount, useTransferPolling };