@swype-org/react-sdk 0.2.173 → 0.2.185

package/dist/index.d.cts

@@ -1,7 +1,8 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ReactNode, MouseEvent } from 'react';
+import { ReactNode, MouseEvent, HTMLAttributeAnchorTarget } from 'react';
 
-/** Wallet provider (e.g. MetaMask) */
+type ChainFamily = 'evm' | 'svm';
+/** Wallet provider (e.g. MetaMask or Phantom) */
 interface Provider {
     id: string;
     name: string;
@@ -10,12 +11,15 @@ interface Provider {
     isDesktopCompatible: boolean;
     /** Whether this provider is available on mobile platforms. */
     isMobileCompatible: boolean;
+    /** Chain family this provider can connect to. */
+    chainFamily: ChainFamily;
 }
 /** Blockchain chain */
 interface Chain {
     id: string;
     name: string;
     commonId: number | null;
+    chainFamily: ChainFamily;
 }
 /** Token balance within a wallet source */
 interface TokenBalance {
@@ -30,7 +34,7 @@ interface WalletToken {
 /** A token source within a wallet (e.g. USDC on a specific chain) */
 interface WalletSource {
     id: string;
-    /** On-chain ERC-20 contract address (e.g. 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913) */
+    /** On-chain token address: ERC-20 contract for EVM, mint address for SVM. */
     address: string;
     token: WalletToken;
     balance: TokenBalance;
@@ -126,8 +130,9 @@ interface TransferDestination {
     };
     amount: Amount;
 }
-/** Sign payload containing the unsigned UserOp and bridge/relay metadata */
-interface TransferSignPayload {
+/** EVM sign payload containing the unsigned UserOp and bridge/relay metadata */
+interface EvmTransferSignPayload {
+    chainFamily?: 'evm';
     userOp: Record<string, unknown>;
     /** ERC-4337 UserOp hash -- used as the WebAuthn challenge for on-chain verification. */
     userOpHash: string;
@@ -139,6 +144,23 @@ interface TransferSignPayload {
     amount: string;
     estimatedFeeUsd: string;
 }
+/** SVM sign payload containing the raw Swig message to sign. */
+interface SvmTransferSignPayload {
+    chainFamily: 'svm';
+    /** Base64-encoded Swig canonical message used directly as the WebAuthn challenge. */
+    message: string;
+    /** WebAuthn credential ID bound to the Swig root authority. */
+    passkeyCredentialId: string;
+    swigMetadataPda: string;
+    swigWalletPubkey: string;
+    bridgeRequestId: string;
+    bridgeProvider: string;
+    tokenSymbol: string;
+    chainName: string;
+    amount: string;
+    estimatedFeeUsd: string;
+}
+type TransferSignPayload = EvmTransferSignPayload | SvmTransferSignPayload;
 /** Transfer object returned by the API */
 interface Transfer {
     id: string;
@@ -445,7 +467,7 @@ declare function fetchTransfer(apiBaseUrl: string, token: string, transferId: st
  * 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>, authorizationSessionToken?: string): Promise<Transfer>;
+declare function signTransfer(apiBaseUrl: string, token: string, transferId: string, signedTransfer: Record<string, unknown>, authorizationSessionToken?: string): Promise<Transfer>;
 declare function fetchAuthorizationSession(apiBaseUrl: string, sessionId: string): Promise<AuthorizationSessionDetail>;
 declare function fetchAuthorizationSessionByToken(apiBaseUrl: string, token: string): Promise<AuthorizationSessionDetail>;
 /**
@@ -518,7 +540,8 @@ type ProbeActionCompletionResult = {
  *   action as done.
  * - `detected: false, reason: 'not-found'` — scan completed with no match
  *   (`DEPOSIT_TX_NOT_FOUND` for bridges, `APPROVE_NOT_DETECTED` for
- *   approves); safe to prompt the wallet.
+ *   EVM approves, `APPROVE_SPL_NOT_DETECTED` for Solana approves); safe to
+ *   prompt the wallet.
  * - `detected: false, reason: 'invalid-state'` — transfer already advanced
  *   past CREATED (race); the next orchestrator loop will observe it.
  * - `detected: false, reason: 'error'` — unexpected failure (network, 5xx);
@@ -588,7 +611,7 @@ interface SelectSourceChainChoice {
     }[];
 }
 
-type ScreenName = 'loading' | 'login' | 'success' | 'processing' | 'confirm-sign' | 'select-source' | 'setup' | 'open-wallet' | 'setup-deposit' | 'passkey-ready' | 'wallet-picker' | 'token-picker' | 'guest-source-picker' | 'deposit';
+type ScreenName = 'loading' | 'login' | 'success' | 'processing' | 'confirm-sign' | 'select-source' | 'setup' | 'open-wallet' | 'setup-deposit' | 'passkey-ready' | 'wallet-picker' | 'token-picker' | 'guest-source-picker' | 'amount-too-low' | 'deposit';
 interface MobileFlowState {
     deeplinkUri: string;
     providerId: string | null;
@@ -634,6 +657,9 @@ type PaymentPhase = {
     step: 'failed';
     transfer: Transfer;
     error: string;
+} | {
+    step: 'amount-too-low';
+    minAmountUsd: number;
 };
 declare function screenForPhase(phase: PaymentPhase): ScreenName;
 
@@ -701,6 +727,15 @@ declare function isUserDismissedAuthorizationError(err: unknown): boolean;
 /** True when the error represents any expected user-initiated cancellation of an authorization flow. */
 declare function isExpectedAuthorizationCancellation(err: unknown): boolean;
 
+interface ExecuteSvmCombinedFirstTransferOptions {
+    /**
+     * Invoked once after Phantom's `signAllTransactions` returns and we
+     * begin polling Solana RPC for the SPL approval to confirm. UI uses
+     * this to swap "Confirm in Phantom" copy for a settlement spinner —
+     * mirroring `executeApproveSplSolana.onConfirming`.
+     */
+    onApproveSplConfirming?: (action: AuthorizationAction) => void;
+}
 interface BatchedWalletCallsResult {
     txHash: string | undefined;
     actionResults: Array<{
@@ -719,12 +754,32 @@ type ExecutionResult = {
     status: 'cancelled';
 };
 
+interface ExecuteActionOptions {
+    /** Forwarded to actions that may need server polling (e.g. SIGN_PERMIT2 typedData). */
+    sessionId?: string;
+    /**
+     * Forwarded to APPROVE_SPL: invoked once after the Phantom signature is
+     * returned and before client-side on-chain confirmation begins. The
+     * orchestrator can use this to render a "Confirming on Solana…" UI
+     * cue while the SDK polls for `confirmed`.
+     */
+    onApproveSplConfirming?: (action: AuthorizationAction) => void;
+}
 interface UseAuthorizationExecutorResult {
     executing: boolean;
     results: ActionExecutionResult[];
     error: string | null;
     /** The current action being executed (for UI display). */
     currentAction: AuthorizationAction | null;
+    /**
+     * Set to the active APPROVE_SPL action while the SDK is awaiting
+     * client-side on-chain confirmation (after the Phantom signature has
+     * been returned but before `reportActionCompletion`). Cleared when
+     * the action settles or fails. UI surfaces use this to swap "confirm
+     * in Phantom" copy for "confirming on Solana…" — mirroring EVM's
+     * `waitForTransactionSettled` window.
+     */
+    approveSplConfirming: 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. */
@@ -737,9 +792,7 @@ interface UseAuthorizationExecutorResult {
      * Execute a single authorization action. Sets `currentAction` for UI display.
      * Pass `sessionId` when the action may need server polling (e.g. SIGN_PERMIT2 typedData).
      */
-    executeAction: (action: AuthorizationAction, options?: {
-        sessionId?: string;
-    }) => Promise<ActionExecutionResult>;
+    executeAction: (action: AuthorizationAction, options?: ExecuteActionOptions) => Promise<ActionExecutionResult>;
     /**
      * Execute batchable actions via EIP-5792 wallet_sendCalls.
      * Sets `batchTxHash` on success. The caller is responsible for reporting
@@ -751,6 +804,26 @@ interface UseAuthorizationExecutorResult {
     executeBatch: (actions: BatchedActionExecutionInput[], options?: {
         paymasterUrl?: string;
     }) => Promise<BatchedWalletCallsResult>;
+    /**
+     * SVM first-transfer combined path: signs the leading APPROVE_SPL +
+     * SVM EXECUTE_BRIDGE pair in a single Phantom prompt via
+     * `signAllTransactions`, submits the SPL approve via the configured
+     * client RPC, polls for confirmation, and returns the signed bridge
+     * tx for the orchestrator to forward to the server. The orchestrator
+     * iterates `actionResults` exactly as it does for `executeBatch`.
+     *
+     * Caller must pre-validate the pair via `isSvmCombinedFirstTransferPair`.
+     */
+    executeSvmCombinedFirstTransfer: (actions: BatchedActionExecutionInput[], options?: ExecuteSvmCombinedFirstTransferOptions) => Promise<BatchedWalletCallsResult>;
+    /**
+     * Probe whether the connected SVM wallet supports the
+     * `signAllTransactions` API used by `executeSvmCombinedFirstTransfer`.
+     * Pass the leading APPROVE_SPL action so we resolve the same
+     * `providerName` the combined path will use. Returns false on any
+     * connect/probe error so the orchestrator falls back to per-action
+     * SVM signing instead of throwing.
+     */
+    canSignAllSolanaTransactions: (action: AuthorizationAction) => Promise<boolean>;
     /** Refresh wallet capabilities and return whether atomicBatch is supported. */
     canBatch: () => Promise<boolean>;
     /** Check whether the connected wallet supports ERC-7677 paymasterService on the current chain. */
@@ -798,6 +871,7 @@ interface UseAuthorizationExecutorOptions {
  *   - DEPLOY_SMART_ACCOUNT — server-side on-chain deployment via no-op UserOp
  *   - APPROVE_PERMIT2 — ERC-20 approve(permit2, maxUint256) from EOA
  *   - SIGN_PERMIT2 — EIP-712 Permit2 allowance signature from EOA
+ *   - APPROVE_SPL — sign a server-built SPL delegate approval transaction
  *   - EXECUTE_BRIDGE — on-chain bridge call(s)
  */
 declare function useAuthorizationExecutor(options?: UseAuthorizationExecutorOptions): UseAuthorizationExecutorResult;
@@ -809,8 +883,8 @@ type OrchestratorResult = {
 };
 interface OrchestratorRunOptions {
     /**
-     * Called when the orchestrator encounters a SIGN_PERMIT2 action with
-     * `awaitingLimit`. The callback should show the one-tap setup UI
+     * Called when the orchestrator encounters a SIGN_PERMIT2 or APPROVE_SPL
+     * action with `awaitingLimit`. The callback should show the one-tap setup UI
      * and return a Promise that resolves when the user completes (or
      * auto-resolves if the limit was already saved).
      *
@@ -835,7 +909,7 @@ interface OrchestratorRunOptions {
     alwaysPauseForOneTap?: boolean;
     /**
      * When true (default), before presenting the wallet for any of
-     * APPROVE_PERMIT2 / SIGN_PERMIT2 / EXECUTE_BRIDGE on this run, probe
+     * APPROVE_PERMIT2 / SIGN_PERMIT2 / APPROVE_SPL / EXECUTE_BRIDGE on this run, probe
      * the server to see if the action is already satisfied on-chain (e.g.
      * user confirmed pre-reload but the PATCH never landed, signed in
      * another tab, or the wallet returned a stale error after broadcasting).
@@ -844,6 +918,7 @@ interface OrchestratorRunOptions {
      *   - APPROVE_PERMIT2: backend re-checks ERC-20 allowance for Permit2.
      *   - SIGN_PERMIT2:    backend re-checks Permit2 allowance (single &
      *                      batched paths).
+     *   - APPROVE_SPL:     backend re-checks SPL delegate authority.
      *   - EXECUTE_BRIDGE:  backend scans for the deposit tx hash on-chain.
      *
      * Applied at most once per action.id within a run; on a not-detected
@@ -853,6 +928,19 @@ interface OrchestratorRunOptions {
      * run.
      */
     probeBeforePrompt?: boolean;
+    /**
+     * Fires once during APPROVE_SPL after Phantom returns the signed
+     * transaction, while the SDK polls a Solana RPC for on-chain
+     * confirmation. Mirrors EVM's "tx sent, awaiting settlement" window
+     * — useful for swapping wallet-prompt copy ("Confirm in Phantom") for
+     * a settlement spinner ("Confirming on Solana…") so the UI doesn't
+     * look frozen during the 5–30 second confirm phase.
+     *
+     * The `authExecutor.approveSplConfirming` state exposes the same
+     * signal for first-party SDK UI; this callback is the orchestrator
+     * surface for SDK consumers that drive their own UI.
+     */
+    onApproveSplConfirming?: (action: AuthorizationAction) => void;
 }
 interface UseAuthorizationOrchestratorResult {
     /**
@@ -893,7 +981,7 @@ interface UseAuthorizationOrchestratorResult {
      * the user completes one-tap setup.
      */
     resolveOneTapPause: () => void;
-    /** The SIGN_PERMIT2 awaiting-limit action currently waiting on one-tap setup. */
+    /** The awaiting-limit action currently waiting on one-tap setup. */
     pendingOneTapAction: AuthorizationAction | null;
     /** Cancel any paused setup flow and reject the current orchestrator run. */
     cancelPendingFlow: () => void;
@@ -1006,6 +1094,14 @@ interface PaymentState {
      */
     guestWalletPrepared: PreparedSession | null;
     guestWalletDeeplinksPreparing: boolean;
+    /**
+     * When set, the host requested a transfer with `amount < minTransferAmountUsd`.
+     * Routes the flow to a dedicated full-screen error via `resolveTerminalPhase`.
+     * Cleared on `NEW_PAYMENT` (Try Again) and `LOGOUT`.
+     */
+    amountTooLow: {
+        minAmountUsd: number;
+    } | null;
 }
 interface InitialStateConfig {
     depositAmount: number | null;
@@ -1190,12 +1286,22 @@ interface UseTransferPollingResult {
     stopPolling: () => void;
 }
 /**
- * Polls GET /v1/transfers/{id} every `intervalMs` until status is
- * COMPLETED or FAILED.
+ * Polls GET /v1/transfers/{id} until status is COMPLETED or FAILED. Uses an
+ * adaptive interval (see FAST_POLL_COUNT/FAST_POLL_INTERVAL_MS) so the early
+ * polls — when the bridge is most likely to settle — fire quickly while
+ * later polls back off to `intervalMs` to limit API load.
  */
 declare function useTransferPolling(intervalMs?: number, overrideGetAccessToken?: () => Promise<string | null>): UseTransferPollingResult;
 
 type AccessTokenGetter = () => Promise<string | null | undefined>;
+interface SignTransferOptions {
+    /**
+     * Win 2 hint: when the caller already has a fresh `signPayload` (e.g. from
+     * the POST /v1/transfers response), pass it here to skip the GET poll loop
+     * and proceed directly to the WebAuthn ceremony.
+     */
+    knownSignPayload?: TransferSignPayload | null;
+}
 interface UseTransferSigningResult {
     signing: boolean;
     signPayload: TransferSignPayload | null;
@@ -1204,10 +1310,11 @@ interface UseTransferSigningResult {
     /**
      * Starts the signing flow:
      * 1. Polls GET /v1/transfers/{id} until signPayload is present
+     *    (skipped when `opts.knownSignPayload` is provided).
      * 2. Triggers WebAuthn passkey prompt
      * 3. Submits signed UserOp via PATCH /v1/transfers/{id}
      */
-    signTransfer: (transferId: string) => Promise<Transfer>;
+    signTransfer: (transferId: string, opts?: SignTransferOptions) => Promise<Transfer>;
 }
 interface UseTransferSigningOptions {
     /** Optional API base URL override when used outside BlinkProvider. */
@@ -1271,6 +1378,8 @@ interface PrimaryButtonProps {
     children: ReactNode;
     onClick?: (event: MouseEvent<HTMLButtonElement | HTMLAnchorElement>) => void;
     href?: string;
+    target?: HTMLAttributeAnchorTarget;
+    rel?: string;
     disabled?: boolean;
     loading?: boolean;
     /** Override the default "Please wait..." text shown while loading. */
@@ -1284,7 +1393,7 @@ interface PrimaryButtonProps {
     /** When true, the fill bar pulses to signal the user needs to take action (e.g. confirm in wallet). */
     progressPaused?: boolean;
 }
-declare function PrimaryButton({ children, onClick, href, disabled, loading, loadingText, icon, progress, progressText, progressPaused, }: PrimaryButtonProps): react_jsx_runtime.JSX.Element;
+declare function PrimaryButton({ children, onClick, href, target, rel, disabled, loading, loadingText, icon, progress, progressText, progressPaused, }: PrimaryButtonProps): react_jsx_runtime.JSX.Element;
 
 interface OutlineButtonProps {
     children: ReactNode;
@@ -1775,6 +1884,7 @@ declare function OpenWalletScreen({ walletName, deeplinkUri, loading, useDeeplin
 
 interface ConfirmSignScreenProps {
     walletName: string | null;
+    chainFamily?: 'evm' | 'svm' | null;
     signing: boolean;
     error: string | null;
     onSign: () => void;
@@ -1784,7 +1894,7 @@ interface ConfirmSignScreenProps {
  * Shown after the user returns from wallet authorization. Requires an explicit
  * button tap to initiate passkey signing (FaceID) rather than auto-triggering.
  */
-declare function ConfirmSignScreen({ walletName, signing, error, onSign, onLogout, }: ConfirmSignScreenProps): react_jsx_runtime.JSX.Element;
+declare function ConfirmSignScreen({ walletName, chainFamily, signing, error, onSign, onLogout, }: ConfirmSignScreenProps): react_jsx_runtime.JSX.Element;
 
 interface TokenPickerScreenProps {
     /**