@coinbase/cdp-core 0.0.124 → 0.0.125

package/dist/native-types/mfa/state.d.ts

@@ -5,6 +5,12 @@ import { MfaMethod } from '@coinbase/cdp-api-client';
 export type MfaVerificationContext = {
     /** The MFA methods the user has enrolled in. */
     methods: MfaMethod[];
+    /**
+     * Opaque challenge handle from the `X-Mfa-Challenge-Id` response header,
+     * present when the project's `verificationScope` is `request`. Passed through
+     * unexamined to `initiateMfaVerification`/`submitMfaVerification`.
+     */
+    challengeId?: string;
 };
 /**
  * Listener function called when MFA verification is required.
@@ -96,10 +102,15 @@ export declare const hasRegisteredMfaListeners: () => boolean;
  *
  * @param {MfaMethod[]} methods - The MFA methods available for verification.
  * @param {unknown} [trigger] - Optional opaque trigger value used by listener predicates.
+ * @param {object} [context] - Optional opaque request-scope context
+ *   merged into the listener's {@link MfaVerificationContext}. Passed through unexamined.
+ * @param {string} [context.challengeId] - Opaque challenge handle, passed through unexamined.
  * @returns {Promise<void>} A Promise that resolves when MFA is complete.
  * @internal
  */
-export declare const triggerMfaVerification: (methods: MfaMethod[], trigger?: unknown) => Promise<void>;
+export declare const triggerMfaVerification: (methods: MfaMethod[], trigger?: unknown, context?: {
+    challengeId?: string;
+}) => Promise<void>;
 /**
  * Resolves the pending MFA verification Promise.
  * Called internally after successful MFA submission.
@@ -115,6 +126,15 @@ export declare const resolvePendingMfaVerification: () => void;
  * @internal
  */
 export declare const rejectPendingMfaVerification: (error: Error) => void;
+/**
+ * Returns the challenge handle for the pending verification, if the server
+ * minted one. MFA actions default to this so request-scope projects work
+ * without every UI having to thread the handle back from its listener.
+ *
+ * @returns {string | undefined} The pending challenge ID, or undefined under session scope.
+ * @internal
+ */
+export declare const getPendingMfaChallengeId: () => string | undefined;
 /**
  * Checks if there's a pending MFA verification.
  *

package/dist/native-types/mfa/withMfa.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Whether the project verifies MFA per request rather than per session.
+ *
+ * @returns True when the project's verification scope is `request`.
+ * @internal
+ */
+export declare const isRequestScope: () => boolean;
 /**
  * Wraps an async operation to handle MFA verification automatically.
  *
@@ -8,6 +15,13 @@
  * If the operation fails with an `mfa_required` error from the API, it will also
  * trigger the MFA handler and retry the operation after successful verification.
  *
+ * The operation must issue exactly one protected request and must build it from values
+ * computed before the thunk runs. A request-scope approval is bound to a digest of the
+ * request that earned it and is spent once, so the retry is only allowed through as a
+ * byte-identical replay. A salt, timestamp or WebAuthn credential generated inside the
+ * thunk changes that digest and the server rejects the retry too. Two protected requests
+ * therefore need two wrappers, one each, not one wrapper around both.
+ *
  * @param operation - The async operation to wrap.
  * @returns The result of the operation.
  * @internal
@@ -21,6 +35,12 @@ export declare function withMfa<T>(operation: () => Promise<T>): Promise<T>;
  * MFA-protected action will trigger the registered MFA verification handler.
  *
  * Use this to pre-warn users or show UI hints before they start a sensitive flow.
+ * Do not use it to verify ahead of the action: MFA-protected actions prompt and
+ * retry on their own, and under `request` scope the challenge only exists once
+ * the action has been attempted.
+ *
+ * Under `request` scope this returns true for any enrolled user, because every
+ * protected call is verified individually.
  *
  * @returns True if MFA verification will be required for the next sensitive action.
  *
@@ -28,11 +48,10 @@ export declare function withMfa<T>(operation: () => Promise<T>): Promise<T>;
  * ```typescript
  * import { isMfaRequired, signEvmHash } from '@coinbase/cdp-core';
  * async function handleSign() {
- *   // prompt mfa before calling the sign hash function
  *   if (isMfaRequired()) {
- *     await ensureMfaVerified(); // User will be prompted
+ *     showHint("You'll be asked to verify before signing.");
  *   }
- *   await signEvmHash({ ... }); // MFA handled automatically by withMfa
+ *   await signEvmHash({ ... }); // Prompts for MFA and retries automatically
  * }
  * ```
  */

package/dist/native-types/version.d.ts

@@ -2,4 +2,4 @@
  * Current version of @coinbase/cdp-core package.
  * This file is auto-generated by scripts/sync-versions.js
  */
-export declare const VERSION = "0.0.124";
+export declare const VERSION = "0.0.125";

package/dist/types/actions/fetchWithX402.d.ts

@@ -1,19 +1,52 @@
-import { EvmAddress } from '../types.js';
-import { PaymentRequirementsSelector, X402Config, wrapFetchWithPayment } from 'x402-fetch';
+import { EvmAddress, SolanaAddress } from '../types.js';
+import { PaymentPolicy, x402Client } from '@x402/core/client';
+import { wrapFetchWithPayment } from '@x402/fetch';
+/**
+ * Opt-in/out per x402 payment scheme. `exact`, `upto`, and `authCapture` all
+ * default on.
+ *
+ * `authCapture` only applies to EVM (Base) — it's skipped for a Solana
+ * account regardless of this setting, matching `@x402/svm`'s current scheme
+ * coverage.
+ */
+export type X402SchemesConfig = {
+    /** Registers `ExactEvmScheme` / `ExactSvmScheme`. Defaults to `true`. */
+    exact?: boolean;
+    /** Registers `UptoEvmScheme` / `UptoSvmScheme` (usage-based billing). Defaults to `true`. */
+    upto?: boolean;
+    /** Registers `AuthCaptureEvmScheme` for EVM accounts. Defaults to `true`. */
+    authCapture?: boolean;
+};
 /**
  * Options for the fetchWithX402 function.
  */
 export type FetchWithX402Options = {
-    /** The address of the account to use for the fetch function. */
-    address?: EvmAddress | string;
-    /** The fetch function to use for the fetch function. */
+    /**
+     * The address of the account to use for the fetch function. Pins the
+     * network family — no fallback to the other network is attempted.
+     *
+     * Defaults to the signed-in user's smart account, then EOA, then Solana
+     * account: auto-detection falls back to the Solana account if no EVM
+     * account resolves.
+     */
+    address?: EvmAddress | SolanaAddress | string;
+    /** Custom `fetch` implementation to wrap. Defaults to `globalThis.fetch`. */
     fetch?: typeof globalThis.fetch;
-    /** The maximum allowed payment amount in base units (defaults to 0.1 USDC) */
-    maxValue?: bigint;
-    /** A function that selects the payment requirements from the response */
-    paymentRequirementsSelector?: PaymentRequirementsSelector;
-    /** Optional configuration for X402 operations (e.g., custom RPC URLs) */
-    config?: X402Config;
+    /**
+     * CAIP-2 network id -> RPC URL overrides, e.g.
+     * `{ "eip155:84532": "https://sepolia.base.org" }`. Also registers payment
+     * schemes on any additional `eip155:*` / `solana:*` network supplied here,
+     * on top of the Base mainnet + Solana mainnet baseline that's always
+     * registered.
+     */
+    rpcUrls?: Record<string, string>;
+    /**
+     * Policies registered on the underlying `x402Client`, e.g. to cap spend or
+     * restrict networks/assets.
+     */
+    policies?: PaymentPolicy[];
+    /** Opt-in/out per payment scheme. See {@link X402SchemesConfig}. */
+    schemes?: X402SchemesConfig;
 };
 /**
  * Return type for the fetchWithX402 function.
@@ -21,13 +54,38 @@ export type FetchWithX402Options = {
 export type FetchWithX402ReturnType = {
     /** The wrapped fetch function with payment handling. */
     fetchWithPayment: ReturnType<typeof wrapFetchWithPayment>;
+    /** The lazily initialized `x402Client` for advanced configuration. */
+    client: Promise<x402Client>;
 };
 /**
- * Hook that provides a wrapped fetch function with payment handling.
+ * Imports an x402 peer dependency, adding installation guidance when the
+ * module can't be resolved. Runtime errors thrown by an already-installed
+ * module (e.g. a bug surfaced while evaluating it) are re-thrown as-is,
+ * since installation guidance would be misleading there.
+ *
+ * Exported (but not part of the public SDK surface — not re-exported from
+ * any index) so this classification can be unit tested directly without
+ * fighting test-mocking frameworks' own module-loading error handling.
+ *
+ * @param specifier - The module specifier being imported, for the error message.
+ * @param loader - Thunk performing the dynamic `import()`, so callers keep accurate typing.
+ * @returns The imported module's exports.
+ */
+export declare function importX402Dependency<T>(specifier: string, loader: () => Promise<T>): Promise<T>;
+/**
+ * Provides a wrapped fetch function with x402 (v2) payment handling, backed
+ * by the current CDP embedded wallet user's EVM or Solana account.
+ *
+ * Builds an `x402Client` and registers payment schemes on it: for an EVM
+ * account, `exact`/`upto`/`authCapture` on Base; for a Solana account,
+ * `exact`/`upto` on Solana. See {@link X402SchemesConfig}.
  *
  * @param options - Configuration object for the fetch function
  * @param options.address - The address to use for the fetch function
- * @returns A wrapped fetch function with payment handling
+ * @param options.rpcUrls - CAIP-2 network id -> RPC URL overrides
+ * @param options.policies - Policies to register on the underlying `x402Client`
+ * @param options.schemes - Opt-in/out per payment scheme
+ * @returns A wrapped fetch function with payment handling, and the underlying `x402Client`
  *
  * @example
  * ```tsx lines
@@ -36,5 +94,14 @@ export type FetchWithX402ReturnType = {
  *   method: "GET",
  * });
  * ```
+ *
+ * @example
+ * ```tsx lines
+ * // Also register Base Sepolia (e.g. for local testing) and disable authCapture.
+ * const { fetchWithPayment } = fetchWithX402({
+ *   rpcUrls: { "eip155:84532": "https://sepolia.base.org" },
+ *   schemes: { authCapture: false },
+ * });
+ * ```
  */
 export declare function fetchWithX402(options?: FetchWithX402Options): FetchWithX402ReturnType;

package/dist/types/actions/initiateMfaVerification.d.ts

@@ -1,4 +1,4 @@
-import { MfaMethod } from '@coinbase/cdp-api-client';
+import { InitiateMfaVerificationResponseWrapper, MfaMethod } from '@coinbase/cdp-api-client';
 /**
  * Request parameters for initiating MFA verification.
  */
@@ -7,6 +7,12 @@ export type InitiateMfaVerificationOptions = {
     mfaMethod: MfaMethod;
     /** Optional idempotency key for safe retries. */
     idempotencyKey?: string;
+    /**
+     * Opaque challenge handle from the MFA listener's context, required when the
+     * project's `verificationScope` is `request`; ignored under `session`. Never
+     * inspected — pass through the value received from the listener unchanged.
+     */
+    challengeId?: string;
 };
 /**
  * Initiates an MFA verification flow for operations requiring MFA.
@@ -28,6 +34,7 @@ export type InitiateMfaVerificationOptions = {
  * await initiateMfaVerification({ mfaMethod: "sms" });
  * // SMS sent to user's phone - prompt for code
  * ```
- * @returns A promise that resolves if MFA initiation is successful.
+ * @returns A promise that resolves with the initiate response (opaque under `session`
+ *   scope, where it resolves to `{}`) once MFA initiation is successful.
  */
-export declare const initiateMfaVerification: (options: InitiateMfaVerificationOptions) => Promise<void>;
+export declare const initiateMfaVerification: (options: InitiateMfaVerificationOptions) => Promise<InitiateMfaVerificationResponseWrapper | void>;

package/dist/types/actions/submitMfaVerification.d.ts

@@ -8,6 +8,12 @@ export type SubmitMfaVerificationOptions = {
     mfaCode: string;
     /** Optional idempotency key for safe retries. */
     idempotencyKey?: string;
+    /**
+     * Opaque challenge handle from the MFA listener's context, required when the
+     * project's `verificationScope` is `request`; ignored under `session`. Never
+     * inspected — pass through the value received from the listener unchanged.
+     */
+    challengeId?: string;
 };
 /**
  * Submits an MFA code to complete the verification process.

package/dist/types/actions/verifyPasskey.d.ts

@@ -4,6 +4,12 @@
 export type VerifyPasskeyOptions = {
     /** Optional idempotency key for safe retries. */
     idempotencyKey?: string;
+    /**
+     * Opaque challenge handle from the MFA listener's context, required when the
+     * project's `verificationScope` is `request`; ignored under `session`. Never
+     * inspected — pass through the value received from the listener unchanged.
+     */
+    challengeId?: string;
 };
 /**
  * Completes an MFA verification using an enrolled passkey (WebAuthn).
@@ -23,7 +29,7 @@ export type VerifyPasskeyOptions = {
  * ```typescript
  * await verifyPasskey();
  * ```
- * @returns A promise that resolves if passkey verification is successful.
+ * @returns A promise that resolves once MFA verification is complete.
  * @throws {MfaError} With code `PASSKEY_NOT_SUPPORTED` when passkeys are not available in the current environment.
  * @throws {MfaError} With code `CANCELLED` when the user dismisses the passkey prompt or it times out.
  */

package/dist/types/auth/oAuthManager.d.ts

@@ -1,5 +1,5 @@
-import { OAuthFlowState, OnOAuthStateChangeFn } from '../types.js';
 import { IOAuthManager } from './types.js';
+import { OAuthFlowState, OnOAuthStateChangeFn } from '../types.js';
 /**
  * Manages the OAuth flow state and related callbacks.
  */

package/dist/types/errors.d.ts

@@ -67,7 +67,9 @@ export type MfaErrorCode =
 /** Passkeys (WebAuthn) are not supported in the current environment. */
  | "PASSKEY_NOT_SUPPORTED"
 /** This device already holds a passkey for this account, so it cannot enroll another. */
- | "PASSKEY_ALREADY_ENROLLED";
+ | "PASSKEY_ALREADY_ENROLLED"
+/** MFA cannot be verified ahead of time because the project verifies per request. */
+ | "REQUEST_SCOPE_UNSUPPORTED";
 /**
  * Error thrown when an MFA operation fails.
  */

package/dist/types/index.d.ts

@@ -5,7 +5,7 @@ export { type SpendPermissionNetwork } from '@coinbase/cdp-api-client';
 export { revokeSpendPermission, type RevokeSpendPermissionOptions, type RevokeSpendPermissionResult, } from './actions/revokeSpendPermission.js';
 export { enableSpendPermissions, type EnableSpendPermissionsOptions, type EnableSpendPermissionsResult, type EnableSpendPermissionsNetwork, } from './actions/enableSpendPermissions.js';
 export { getCurrentUserSync } from './actions/getCurrentUserSync.js';
-export { fetchWithX402, type FetchWithX402Options, type FetchWithX402ReturnType, } from './actions/fetchWithX402.js';
+export { fetchWithX402, type FetchWithX402Options, type FetchWithX402ReturnType, type X402SchemesConfig, } from './actions/fetchWithX402.js';
 export { linkGoogle } from './actions/linkGoogle.js';
 export { linkSms } from './actions/linkSms.js';
 export { linkEmail } from './actions/linkEmail.js';
@@ -50,6 +50,7 @@ export { getMfaConfigState, getProjectConfigState } from './state.js';
 export { recordMfaEnrollmentPrompted, type RecordMfaEnrollmentPromptedResult, } from './actions/recordMfaEnrollmentPrompted.js';
 export { initiateMfaEnrollment, type InitiateMfaEnrollmentResult, type InitiateMfaOptions, type InitiateTotpMfaOptions, type InitiateSmsMfaOptions, type InitiateTotpMfaResult, type InitiateSmsMfaResult, } from './actions/initiateMfaEnrollment.js';
 export { submitMfaEnrollment, type SubmitMfaEnrollmentOptions, type SubmitMfaEnrollmentResult, } from './actions/submitMfaEnrollment.js';
+export { enrollPasskey, type EnrollPasskeyOptions, type EnrollPasskeyResult, } from './actions/enrollPasskey.js';
 export { initiateMfaVerification, type InitiateMfaVerificationOptions, } from './actions/initiateMfaVerification.js';
 export { submitMfaVerification, type SubmitMfaVerificationOptions, } from './actions/submitMfaVerification.js';
 export { cancelMfaVerification } from './actions/cancelMfaVerification.js';

package/dist/types/index.native.d.ts

@@ -10,7 +10,7 @@ export { type SpendPermissionNetwork } from '@coinbase/cdp-api-client';
 export { revokeSpendPermission, type RevokeSpendPermissionOptions, type RevokeSpendPermissionResult, } from './actions/revokeSpendPermission.js';
 export { enableSpendPermissions, type EnableSpendPermissionsOptions, type EnableSpendPermissionsResult, type EnableSpendPermissionsNetwork, } from './actions/enableSpendPermissions.js';
 export { getCurrentUserSync } from './actions/getCurrentUserSync.js';
-export { fetchWithX402, type FetchWithX402Options, type FetchWithX402ReturnType, } from './actions/fetchWithX402.js';
+export { fetchWithX402, type FetchWithX402Options, type FetchWithX402ReturnType, type X402SchemesConfig, } from './actions/fetchWithX402.js';
 export { linkGoogle } from './actions/linkGoogle.js';
 export { linkSms } from './actions/linkSms.js';
 export { linkEmail } from './actions/linkEmail.js';

package/dist/types/index.web.d.ts

@@ -10,7 +10,7 @@ export { type SpendPermissionNetwork } from '@coinbase/cdp-api-client';
 export { revokeSpendPermission, type RevokeSpendPermissionOptions, type RevokeSpendPermissionResult, } from './actions/revokeSpendPermission.js';
 export { enableSpendPermissions, type EnableSpendPermissionsOptions, type EnableSpendPermissionsResult, type EnableSpendPermissionsNetwork, } from './actions/enableSpendPermissions.js';
 export { getCurrentUserSync } from './actions/getCurrentUserSync.js';
-export { fetchWithX402, type FetchWithX402Options, type FetchWithX402ReturnType, } from './actions/fetchWithX402.js';
+export { fetchWithX402, type FetchWithX402Options, type FetchWithX402ReturnType, type X402SchemesConfig, } from './actions/fetchWithX402.js';
 export { linkGoogle } from './actions/linkGoogle.js';
 export { linkSms } from './actions/linkSms.js';
 export { linkEmail } from './actions/linkEmail.js';

package/dist/types/mfa/index.d.ts

@@ -1,4 +1,4 @@
 export { hasPendingMfaVerification, resolvePendingMfaVerification, rejectPendingMfaVerification, triggerMfaVerification, type MfaListener, type MfaVerificationContext, } from './state.js';
 export { getEnabledMfaMethods, getEnrolledMfaMethods, isEnrolledInMfa } from './utils.js';
-export { withMfa, ensureMfaVerified, isMfaRequired } from './withMfa.js';
+export { withMfa, ensureMfaVerified, isMfaRequired, isRequestScope } from './withMfa.js';
 export { MFA_PROTECTED_ACTIONS, MFA_PROTECTED_FUNCTIONS, isMfaProtectedAction, type MfaProtectedAction, } from './protectedActions.js';

package/dist/types/mfa/protectedActions.d.ts

@@ -1,6 +1,23 @@
+import { createDelegation } from '../actions/createDelegation.js';
+import { createDelegationForAccount } from '../actions/createDelegationForAccount.js';
 import { createEvmKeyExportIframe, createSolanaKeyExportIframe } from '../actions/createKeyExportIframe.js';
+import { revokeDelegation } from '../actions/revokeDelegation.js';
+import { revokeDelegationForAccount } from '../actions/revokeDelegationForAccount.js';
 import { SignEvmHashOptions, SignEvmHashResult, SignEvmTransactionOptions, SignEvmTransactionResult, SignSolanaTransactionOptions, SignSolanaTransactionResult, SendEvmTransactionOptions, SendEvmTransactionResult, SendSolanaTransactionOptions, SendSolanaTransactionResult, SignEvmMessageOptions, SignSolanaMessageOptions, SignSolanaMessageResult, SignEvmTypedDataOptions, SignEvmTypedDataResult, SendUserOperationOptions, SendUserOperationResult, ExportEvmAccountOptions, ExportEvmAccountResult, ExportSolanaAccountOptions, ExportSolanaAccountResult } from '../types.js';
 import { SignBitcoinHashOptions, SignBitcoinHashResult } from '../actions/signBitcoinHash.js';
+import { AdjustBorrowPositionOptions, AdjustBorrowPositionResult } from '../actions/adjustBorrowPosition.js';
+import { CloseBorrowPositionOptions, CloseBorrowPositionResult } from '../actions/closeBorrowPosition.js';
+import { CreateBorrowPositionOptions, CreateBorrowPositionResult } from '../actions/createBorrowPosition.js';
+import { CreateSpendPermissionOptions, CreateSpendPermissionResult } from '../actions/createSpendPermission.js';
+import { EnableSpendPermissionsOptions, EnableSpendPermissionsResult } from '../actions/enableSpendPermissions.js';
+import { ExecuteSwapOptions, ExecuteSwapResult } from '../actions/executeSwap.js';
+import { RevokeSpendPermissionOptions, RevokeSpendPermissionResult } from '../actions/revokeSpendPermission.js';
+import { SendEvmEoaUsdcOptions, SendEvmEoaUsdcResult } from '../actions/sendEvmEoaUsdc.js';
+import { SendEvmSmartAccountUsdcOptions, SendEvmSmartAccountUsdcResult } from '../actions/sendEvmSmartAccountUsdc.js';
+import { SendSolanaUsdcOptions, SendSolanaUsdcResult } from '../actions/sendSolanaUsdc.js';
+import { EnrollPasskeyOptions, EnrollPasskeyResult } from '../actions/enrollPasskey.js';
+import { InitiateMfaOptions, InitiateMfaEnrollmentResult } from '../actions/initiateMfaEnrollment.js';
+import { SubmitMfaEnrollmentOptions, SubmitMfaEnrollmentResult } from '../actions/submitMfaEnrollment.js';
 /**
  * Map of MFA-protected functions to ensure type safety.
  * If a function is renamed, the import will fail and this file won't compile.
@@ -22,6 +39,23 @@ export declare const MFA_PROTECTED_FUNCTIONS: {
     readonly signBitcoinHash: (options: SignBitcoinHashOptions) => Promise< SignBitcoinHashResult>;
     readonly createEvmKeyExportIframe: typeof createEvmKeyExportIframe;
     readonly createSolanaKeyExportIframe: typeof createSolanaKeyExportIframe;
+    readonly adjustBorrowPosition: (options: AdjustBorrowPositionOptions) => Promise< AdjustBorrowPositionResult>;
+    readonly closeBorrowPosition: (options: CloseBorrowPositionOptions) => Promise< CloseBorrowPositionResult>;
+    readonly createBorrowPosition: (options: CreateBorrowPositionOptions) => Promise< CreateBorrowPositionResult>;
+    readonly createDelegation: typeof createDelegation;
+    readonly createDelegationForAccount: typeof createDelegationForAccount;
+    readonly createSpendPermission: (options: CreateSpendPermissionOptions) => Promise< CreateSpendPermissionResult>;
+    readonly enableSpendPermissions: (options: EnableSpendPermissionsOptions) => Promise< EnableSpendPermissionsResult>;
+    readonly executeSwap: (options: ExecuteSwapOptions) => Promise< ExecuteSwapResult>;
+    readonly revokeDelegation: typeof revokeDelegation;
+    readonly revokeDelegationForAccount: typeof revokeDelegationForAccount;
+    readonly revokeSpendPermission: (options: RevokeSpendPermissionOptions) => Promise< RevokeSpendPermissionResult>;
+    readonly sendEvmEoaUsdc: (options: SendEvmEoaUsdcOptions) => Promise< SendEvmEoaUsdcResult>;
+    readonly sendEvmSmartAccountUsdc: (options: SendEvmSmartAccountUsdcOptions) => Promise< SendEvmSmartAccountUsdcResult>;
+    readonly sendSolanaUsdc: (options: SendSolanaUsdcOptions) => Promise< SendSolanaUsdcResult>;
+    readonly enrollPasskey: (options?: EnrollPasskeyOptions) => Promise< EnrollPasskeyResult>;
+    readonly initiateMfaEnrollment: (options: InitiateMfaOptions) => Promise< InitiateMfaEnrollmentResult>;
+    readonly submitMfaEnrollment: (options: SubmitMfaEnrollmentOptions) => Promise< SubmitMfaEnrollmentResult>;
 };
 /**
  * List of action names that require MFA verification when the user is enrolled.

package/dist/types/mfa/state.d.ts

@@ -5,6 +5,12 @@ import { MfaMethod } from '@coinbase/cdp-api-client';
 export type MfaVerificationContext = {
     /** The MFA methods the user has enrolled in. */
     methods: MfaMethod[];
+    /**
+     * Opaque challenge handle from the `X-Mfa-Challenge-Id` response header,
+     * present when the project's `verificationScope` is `request`. Passed through
+     * unexamined to `initiateMfaVerification`/`submitMfaVerification`.
+     */
+    challengeId?: string;
 };
 /**
  * Listener function called when MFA verification is required.
@@ -96,10 +102,15 @@ export declare const hasRegisteredMfaListeners: () => boolean;
  *
  * @param {MfaMethod[]} methods - The MFA methods available for verification.
  * @param {unknown} [trigger] - Optional opaque trigger value used by listener predicates.
+ * @param {object} [context] - Optional opaque request-scope context
+ *   merged into the listener's {@link MfaVerificationContext}. Passed through unexamined.
+ * @param {string} [context.challengeId] - Opaque challenge handle, passed through unexamined.
  * @returns {Promise<void>} A Promise that resolves when MFA is complete.
  * @internal
  */
-export declare const triggerMfaVerification: (methods: MfaMethod[], trigger?: unknown) => Promise<void>;
+export declare const triggerMfaVerification: (methods: MfaMethod[], trigger?: unknown, context?: {
+    challengeId?: string;
+}) => Promise<void>;
 /**
  * Resolves the pending MFA verification Promise.
  * Called internally after successful MFA submission.
@@ -115,6 +126,15 @@ export declare const resolvePendingMfaVerification: () => void;
  * @internal
  */
 export declare const rejectPendingMfaVerification: (error: Error) => void;
+/**
+ * Returns the challenge handle for the pending verification, if the server
+ * minted one. MFA actions default to this so request-scope projects work
+ * without every UI having to thread the handle back from its listener.
+ *
+ * @returns {string | undefined} The pending challenge ID, or undefined under session scope.
+ * @internal
+ */
+export declare const getPendingMfaChallengeId: () => string | undefined;
 /**
  * Checks if there's a pending MFA verification.
  *

package/dist/types/mfa/withMfa.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Whether the project verifies MFA per request rather than per session.
+ *
+ * @returns True when the project's verification scope is `request`.
+ * @internal
+ */
+export declare const isRequestScope: () => boolean;
 /**
  * Wraps an async operation to handle MFA verification automatically.
  *
@@ -8,6 +15,13 @@
  * If the operation fails with an `mfa_required` error from the API, it will also
  * trigger the MFA handler and retry the operation after successful verification.
  *
+ * The operation must issue exactly one protected request and must build it from values
+ * computed before the thunk runs. A request-scope approval is bound to a digest of the
+ * request that earned it and is spent once, so the retry is only allowed through as a
+ * byte-identical replay. A salt, timestamp or WebAuthn credential generated inside the
+ * thunk changes that digest and the server rejects the retry too. Two protected requests
+ * therefore need two wrappers, one each, not one wrapper around both.
+ *
  * @param operation - The async operation to wrap.
  * @returns The result of the operation.
  * @internal
@@ -21,6 +35,12 @@ export declare function withMfa<T>(operation: () => Promise<T>): Promise<T>;
  * MFA-protected action will trigger the registered MFA verification handler.
  *
  * Use this to pre-warn users or show UI hints before they start a sensitive flow.
+ * Do not use it to verify ahead of the action: MFA-protected actions prompt and
+ * retry on their own, and under `request` scope the challenge only exists once
+ * the action has been attempted.
+ *
+ * Under `request` scope this returns true for any enrolled user, because every
+ * protected call is verified individually.
  *
  * @returns True if MFA verification will be required for the next sensitive action.
  *
@@ -28,11 +48,10 @@ export declare function withMfa<T>(operation: () => Promise<T>): Promise<T>;
  * ```typescript
  * import { isMfaRequired, signEvmHash } from '@coinbase/cdp-core';
  * async function handleSign() {
- *   // prompt mfa before calling the sign hash function
  *   if (isMfaRequired()) {
- *     await ensureMfaVerified(); // User will be prompted
+ *     showHint("You'll be asked to verify before signing.");
  *   }
- *   await signEvmHash({ ... }); // MFA handled automatically by withMfa
+ *   await signEvmHash({ ... }); // Prompts for MFA and retries automatically
  * }
  * ```
  */

package/dist/types/version.d.ts

@@ -2,4 +2,4 @@
  * Current version of @coinbase/cdp-core package.
  * This file is auto-generated by scripts/sync-versions.js
  */
-export declare const VERSION = "0.0.124";
+export declare const VERSION = "0.0.125";