@coinbase/cdp-api-client 0.0.124 → 0.0.125

package/dist/types/index.d.ts

@@ -3,17 +3,17 @@ import { AxiosRequestConfig } from 'axios';
 /**
  * A request to adjust an existing borrow position for an end user's smart account on the specified borrow product.
  The request can supply collateral, withdraw collateral, repay debt, and/or borrow more of the loan asset, broadcasting a user operation to apply the changes onchain.
- A single request cannot combine supplying and withdrawing collateral,  or repaying debt and borrowing more debt.
+ A single request must not combine `addCollateralAmount` with `removeCollateralAmount` or `repayLoanAmount`, and must not combine `borrowLoanAmount` with `repayLoanAmount` or `removeCollateralAmount`. Otherwise any subset of the four amount fields may be supplied; at least one is required.
  */
 export declare interface AdjustBorrowPositionRequest {
     borrowProductId: BorrowProductId;
-    /** The amount of collateral to add to the position, as a decimal string in standard unit denomination (i.e. "1" for 1 cbBTC). Must not be combined with `removeCollateralAmount`. */
+    /** The amount of collateral to add to the position, as a decimal string in standard unit denomination of the collateral token (i.e. "1" for 1 cbBTC). Must not be combined with `removeCollateralAmount` or `repayLoanAmount`. */
     addCollateralAmount?: PositiveDecimal;
-    /** The amount of collateral to withdraw from the position, as a decimal string in standard unit denomination (i.e. "1" for 1 cbBTC).  Must not be combined with `addCollateralAmount`. */
+    /** The amount of collateral to withdraw from the position, as a decimal string in standard unit denomination of the collateral token (i.e. "1" for 1 cbBTC).  Must not be combined with `addCollateralAmount` or `borrowLoanAmount`. */
     removeCollateralAmount?: PositiveDecimal;
-    /** The amount of the loan token to repay, as a decimal string in standard unit denomination of the loan token (i.e. "100" for 100 USDC).  Must not be combined with `borrowLoanAmount`. */
+    /** The amount of the loan token to repay, as a decimal string in standard unit denomination of the loan token (i.e. "100" for 100 USDC).  Must not be combined with `borrowLoanAmount` or `addCollateralAmount`. */
     repayLoanAmount?: PositiveDecimal;
-    /** The amount of the loan token to borrow, as a decimal string in standard unit denomination of the loan token (i.e. "100" for 100 USDC).  Must not be combined with `repayLoanAmount`. */
+    /** The amount of the loan token to borrow, as a decimal string in standard unit denomination of the loan token (i.e. "100" for 100 USDC).  Must not be combined with `repayLoanAmount` or `removeCollateralAmount`. */
     borrowLoanAmount?: PositiveDecimal;
     /**
      * The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth header.
@@ -32,7 +32,7 @@ export declare interface AdjustBorrowPositionRequest {
 /**
  * Adjusts an existing borrow position for a specific borrow product by supplying collateral, withdrawing collateral, repaying debt, and/or borrowing more of the loan asset from an end user smart account.
  The `borrowProductId` identifies the product whose position to adjust, and the `addCollateralAmount`, `removeCollateralAmount`, `repayLoanAmount`, and `borrowLoanAmount` fields specify the changes to apply, each expressed as a decimal string in standard unit denomination of the respective token.
- A single request cannot combine supplying and withdrawing collateral, or repaying debt and borrowing more debt.
+ A single request must not combine `addCollateralAmount` with `removeCollateralAmount` or `repayLoanAmount`, and must not combine `borrowLoanAmount` with `repayLoanAmount` or `removeCollateralAmount`. Otherwise any subset of the four amount fields may be supplied; at least one is required.
  A user operation is broadcast to adjust the position onchain. Poll `getUserOperationWithEndUserAccount` with the returned `userOpHash` until it reaches a terminal state. Once the user operation succeeds onchain, use the borrow positions list endpoint to view the user's adjusted positions.
  * @summary Adjust a borrow position for an end user smart account
  */
@@ -80,6 +80,12 @@ export declare class APIError extends Error {
     errorMessage: string;
     correlationId?: string;
     errorLink?: string;
+    /**
+     * Response headers, lowercase-keyed (e.g. `x-mfa-challenge-id`). Never included in
+     * {@link toJSON}. Multi-value headers (e.g. `set-cookie`) come back as arrays; callers
+     * must guard with `Array.isArray` before treating a value as a string.
+     */
+    headers?: Record<string, string | string[]>;
     /**
      * Constructor for the APIError class
      *
@@ -89,8 +95,9 @@ export declare class APIError extends Error {
      * @param correlationId - The correlation ID
      * @param errorLink - URL to documentation about this error
      * @param cause - The cause of the error
+     * @param headers - The response headers, lowercase-keyed
      */
-    constructor(statusCode: number, errorType: APIErrorType, errorMessage: string, correlationId?: string, errorLink?: string, cause?: Error);
+    constructor(statusCode: number, errorType: APIErrorType, errorMessage: string, correlationId?: string, errorLink?: string, cause?: Error, headers?: Record<string, string | string[]>);
     /**
      * Convert the error to a JSON object, excluding undefined properties
      *
@@ -420,14 +427,14 @@ export declare interface BorrowProductVenue {
 export declare type CapabilityName = (typeof CapabilityName)[keyof typeof CapabilityName];
 
 export declare const CapabilityName: {
-    readonly custodyCrypto: "custodyCrypto";
-    readonly custodyFiat: "custodyFiat";
-    readonly custodyStablecoin: "custodyStablecoin";
-    readonly tradeCrypto: "tradeCrypto";
-    readonly tradeStablecoin: "tradeStablecoin";
-    readonly transferCrypto: "transferCrypto";
-    readonly transferFiat: "transferFiat";
-    readonly transferStablecoin: "transferStablecoin";
+    readonly CustodyCrypto: "custodyCrypto";
+    readonly CustodyFiat: "custodyFiat";
+    readonly CustodyStablecoin: "custodyStablecoin";
+    readonly TradeCrypto: "tradeCrypto";
+    readonly TradeStablecoin: "tradeStablecoin";
+    readonly TransferCrypto: "transferCrypto";
+    readonly TransferFiat: "transferFiat";
+    readonly TransferStablecoin: "transferStablecoin";
 };
 
 /**
@@ -435,11 +442,26 @@ export declare const CapabilityName: {
  * to the request headers.
  *
  * @param {AxiosRequestConfig} config - The Axios request configuration.
- * @param idempotencyKey - The idempotency key.
+ * @param options - Per-request options, or a bare idempotency key string (legacy form).
  * @returns {Promise<T>} A promise that resolves to the response data.
  * @throws {APIError} If the request fails.
  */
-declare const cdpApiClient: <T>(config: AxiosRequestConfig, idempotencyKey?: string) => Promise<T>;
+declare const cdpApiClient: <T>(config: AxiosRequestConfig, options?: CdpApiClientOptions | string) => Promise<T>;
+
+/**
+ * Per-request options accepted as the second parameter of {@link cdpApiClient}
+ * (the `options` argument of every generated operation).
+ */
+export declare type CdpApiClientOptions = {
+    /** Idempotency key for safe retries, sent as the X-Idempotency-Key header. */
+    idempotencyKey?: string;
+    /**
+     * Opaque per-request MFA challenge handle, sent as the X-Mfa-Challenge-Id
+     * header on the MFA initiate and submit endpoints when the project's
+     * `verificationScope` is `request`.
+     */
+    mfaChallengeId?: string;
+};
 
 /**
  * The options for the CDP API Client.
@@ -1298,7 +1320,7 @@ export declare interface EndUserBtcAccount {
     addressType: EndUserBtcAccountAddressType;
     /** The Bitcoin network this account is associated with. */
     network: EndUserBtcAccountNetwork;
-    /** The BIP-32 extended public key (xpub) at the account derivation path, base58check encoded, used to derive child addresses. Present only when the response includes it explicitly (the `createEndUserBtcAccount` response, or `getAuthenticatedEndUser` with `includeBtcXpubs=true`); otherwise omitted. */
+    /** The BIP-32 extended public key (xpub) at the account derivation path, base58check encoded, used to derive child addresses. Present only when the response includes it explicitly (the `createEndUserBtcAccount` or `addEndUserBtcAccount` response, or `getAuthenticatedEndUser` with `includeBtcXpubs=true`); otherwise omitted. */
     xpub?: string;
     /**
      * The lowercase hex-encoded SHA-256 of the UTF-8 bytes of the `xpub` string (the base58check-encoded form exactly as returned, not the decoded key bytes). Used as a stable identifier to select the proper account during signing. This is intentionally not the BIP-32 key fingerprint: hashing the full string form avoids the fingerprint's 4-byte collision risk and yields an identifier that can be recomputed consistently without decoding the key.
@@ -1615,6 +1637,7 @@ export declare const ErrorType: {
     readonly asset_mismatch: "asset_mismatch";
     readonly mfa_already_enrolled: "mfa_already_enrolled";
     readonly mfa_invalid_code: "mfa_invalid_code";
+    readonly mfa_challenge_not_found: "mfa_challenge_not_found";
     readonly mfa_flow_expired: "mfa_flow_expired";
     readonly mfa_required: "mfa_required";
     readonly mfa_not_enrolled: "mfa_not_enrolled";
@@ -1726,6 +1749,9 @@ export declare const EvmSwapsNetwork: {
     readonly polygon: "polygon";
 };
 
+/**
+ * A smart account operation response.
+ */
 export declare interface EvmUserOperation {
     network: EvmUserOperationNetwork;
     /**
@@ -1780,6 +1806,46 @@ export declare const EvmUserOperationStatus: {
     readonly failed: "failed";
 };
 
+/**
+ * Export an existing Bitcoin HD (Hierarchical Deterministic) account's master seed as encrypted BIP39 entropy. The 32-byte entropy is encrypted in transport to the provided RSA public key and can be encoded into a BIP39 mnemonic (seed phrase) client-side to import the account into a compatible wallet. It is important to store the exported seed phrase in a secure place after it's exported.
+ * @summary Export end user Bitcoin account
+ */
+export declare const exportEndUserBtcAccount: (userId: string, exportEndUserBtcAccountBody: ExportEndUserBtcAccountBody, params?: ExportEndUserBtcAccountParams, options?: SecondParameter<typeof cdpApiClient<ExportEndUserBtcAccount200>>) => Promise<ExportEndUserBtcAccount200>;
+
+export declare type ExportEndUserBtcAccount200 = {
+    /** The base64-encoded, encrypted 32-byte BIP39 entropy of the Bitcoin HD account. This is the initial entropy (not a PBKDF2-derived BIP39 seed): it is encrypted in transport using the exportEncryptionKey in the request and is encoded into a 24-word BIP39 mnemonic (seed phrase) client-side. */
+    encryptedEntropy: string;
+};
+
+export declare type ExportEndUserBtcAccountBody = {
+    /**
+     * The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
+     * @pattern ^[a-zA-Z0-9-]{1,100}$
+     */
+    walletSecretId: string;
+    /**
+     * The lowercase hex-encoded SHA-256 of the UTF-8 bytes of the `xpub` string (the base58check-encoded form exactly as returned, not the decoded key bytes). Selects which of the end user's Bitcoin accounts to export. Use the `xpubHash` returned with the account when it is created or retrieved.
+     * @pattern ^[0-9a-f]{64}$
+     */
+    xpubHash: string;
+    /** The base64-encoded, public part of the RSA key in DER format used to encrypt the account entropy. */
+    exportEncryptionKey: string;
+    /** The origin of the parent site that opened the secure iframe. This origin will be validated against the project's configured allowed origins. Must be a valid origin in the format <scheme>://<host>(:<port>) (e.g., https://example.com, http://localhost:3000). */
+    parentOrigin?: Url;
+    /** If true, the account is ejected after the master seed is exported. Ejection immediately blocks all signing and sending operations on this account. The master seed can still be re-exported during the server-controlled grace period. Setting eject to false or omitting it does not cancel ejection, and re-exporting does not extend or reset the grace period. After the grace period (TTL), the HD key material is permanently deleted from Coinbase systems. This action is irreversible. Ejection is an opt-in feature. To enable it, reach out to us on Discord. */
+    eject?: boolean;
+};
+
+export declare type ExportEndUserBtcAccountParams = {
+    /**
+     * The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
+     * @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+     */
+    projectID?: ProjectIDOptionalParameter;
+};
+
+export declare type ExportEndUserBtcAccountResult = NonNullable<Awaited<ReturnType<typeof exportEndUserBtcAccount>>>;
+
 /**
  * Export an existing end user EVM account's private key. It is important to store the private key in a secure place after it's exported.
  * @summary Export end user EVM account
@@ -1806,7 +1872,7 @@ export declare type ExportEndUserEvmAccountBody = {
     walletSecretId: string;
     /** The origin of the parent site that opened the secure iframe. This origin will be validated against the project's configured allowed origins. Must be a valid origin in the format <scheme>://<host>(:<port>) (e.g., https://example.com, http://localhost:3000). */
     parentOrigin?: Url;
-    /** If true, the account is ejected after the private key is exported. Ejection immediately blocks all signing and sending operations on this account. The private key can still be re-exported during the grace period with eject set to false. After the configured grace period (TTL), the key material is permanently deleted from Coinbase systems. This action is irreversible. Ejection is an opt-in feature. To enable it, reach out to us on Discord. */
+    /** If true, the account is ejected after the private key is exported. Ejection immediately blocks all signing and sending operations on this account. The private key can still be re-exported during the server-controlled grace period. Setting eject to false or omitting it does not cancel ejection, and re-exporting does not extend or reset the grace period. After the grace period (TTL), the key material is permanently deleted from Coinbase systems. This action is irreversible. Ejection is an opt-in feature. To enable it, reach out to us on Discord. */
     eject?: boolean;
 };
 
@@ -1846,7 +1912,7 @@ export declare type ExportEndUserSolanaAccountBody = {
     walletSecretId: string;
     /** The origin of the parent site that opened the secure iframe. This origin will be validated against the project's configured allowed origins. Must be a valid origin in the format <scheme>://<host>(:<port>) (e.g., https://example.com, http://localhost:3000). */
     parentOrigin?: Url;
-    /** If true, the account is ejected after the private key is exported. Ejection immediately blocks all signing and sending operations on this account. The private key can still be re-exported during the grace period with eject set to false. After the configured grace period (TTL), the key material is permanently deleted from Coinbase systems. This action is irreversible. Ejection is an opt-in feature. To enable it, reach out to us on Discord. */
+    /** If true, the account is ejected after the private key is exported. Ejection immediately blocks all signing and sending operations on this account. The private key can still be re-exported during the server-controlled grace period. Setting eject to false or omitting it does not cancel ejection, and re-exporting does not extend or reset the grace period. After the grace period (TTL), the key material is permanently deleted from Coinbase systems. This action is irreversible. Ejection is an opt-in feature. To enable it, reach out to us on Discord. */
     eject?: boolean;
 };
 
@@ -1897,7 +1963,7 @@ export declare type GetAuthenticatedEndUserParams = {
     /**
      * When `true`, each Bitcoin account in `btcAccountObjects` includes its raw `xpub`. When `false` (the default), only `xpubHash` is returned.
      */
-    includeBtcXpubs?: boolean;
+    includeBtcXpubs?: IncludeBtcXpubsParameter;
 };
 
 export declare type GetAuthenticatedEndUserResult = NonNullable<Awaited<ReturnType<typeof getAuthenticatedEndUser>>>;
@@ -2222,6 +2288,11 @@ export declare type IdempotencyErrorResponse = Error_2;
  */
 export declare type IdempotencyKeyParameter = string;
 
+/**
+ * When `true`, each Bitcoin account in `btcAccountObjects` includes its raw `xpub`. When `false` (the default), only `xpubHash` is returned.
+ */
+export declare type IncludeBtcXpubsParameter = boolean;
+
 /**
  * Initiates the authentication flow for an end user. This is an optionally authenticated endpoint. The exact response depends on the authentication method specified in the request body. If a valid access token is included in the Authorization header, it is treated as an attempt to add an additional authentication method to the existing user associated with the token. If the authentication method already exists, an error is returned.
  * @summary Initiate end user authentication
@@ -2371,8 +2442,13 @@ export declare interface InitiateMfaEnrollmentTotpResponse {
 
 /**
  * Initiates an MFA verification flow for operations requiring MFA. This endpoint should be called when a user attempts a sensitive operation (like transaction signing) but doesn't have a valid MFA-verified session.
+
  For SMS, generates and sends a 6-digit OTP to the enrolled phone number. For TOTP, user generates code from their authenticator app.
+
  For passkey (WebAuthn), returns credential request options (in the response body) to pass to navigator.credentials.get() in the browser; the resulting assertion must be submitted to the submit endpoint. Only the passkey method returns a response body here; TOTP and SMS return `{}`.
+
+ When the project's `verificationScope` is `request`, the caller supplies the challenge from the `X-Mfa-Challenge-Id` header of the `403 mfa_required` response in the `X-Mfa-Challenge-Id` request header, which binds the ceremony to that request. A missing header is rejected. When the project's `verificationScope` is `session`, the caller doesn't need to supply the header.
+
  Passkey requests must carry an `Origin` header that is one of the project's configured CORS origins and is either `https://` or `http://localhost`; otherwise the request is rejected with a 400. Only passkeys enrolled from that exact host are offered, so a user with passkeys on other hosts only receives a 404 here and must enroll a passkey for this origin.
  * @summary Initiate MFA verification
  */
@@ -2859,6 +2935,18 @@ export declare type LogOutEndUserResult = NonNullable<Awaited<ReturnType<typeof
  */
 export declare type MfaAlreadyEnrolledErrorResponse = Error_2;
 
+/**
+ * The challenge returned via the `X-Mfa-Challenge-Id` response header when the server rejected an mfa-required operation with `403 mfa_required`. Include as the `X-Mfa-Challenge-Id` request header of the MFA initiate and submit endpoints so the ceremony binds to that specific request. Required when the project's `verificationScope` is `request`; ignored under `session`.
+ For passkey, this ID keys the pending WebAuthn ceremony; the authenticator signs the ceremony's own WebAuthn challenge (returned by `initiateMfaVerification`) via `clientDataJSON`. For TOTP and SMS, this ID is the per-request binding — the 6-digit code signs nothing, so phishing resistance under `request` scope requires passkey.
+ * @pattern ^mfa_challenge_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+ */
+export declare type MfaChallengeId = string;
+
+/**
+ * Sent as the `X-Mfa-Challenge-Id` request header on the MFA initiate and submit endpoints. See the `MfaChallengeId` schema for value semantics.
+ */
+export declare type MfaChallengeIdParameterParameter = string;
+
 /**
  * MFA configuration for a project.
  */
@@ -2869,7 +2957,9 @@ export declare interface MfaConfig {
     totpConfig: TotpConfig;
     smsConfig?: SmsConfig;
     passkeyConfig?: PasskeyConfig;
-    /** The duration in seconds for which a single MFA verification remains valid. After this period, the user must re-authenticate with MFA. */
+    verificationScope: MfaVerificationScope;
+    /** The duration in seconds for which a single MFA verification remains valid. After this period, the user must re-authenticate with MFA. Only applies when `verificationScope` is `session`; ignored under `request`, where each verification authorizes exactly one operation.
+     Read-only: the window is set server-side, 300 seconds by default, and is not writable through `updateMfaConfig`. */
     verificationWindowSeconds: number;
     /** Whether applications should prompt users for MFA enrollment during the login flow if they are not already enrolled. */
     promptEnrollmentOnLogin: boolean;
@@ -2930,6 +3020,18 @@ export declare type MFAMethodsTotp = {
     enrolledAt: string;
 };
 
+/**
+ * The configuration defining how a project enforces MFA. A project that has  never set one behaves as `session`.
+ Under `session` scope, one verification opens the project's verification window (`verificationWindowSeconds`, 300 by default), and any MFA-required operation inside that window is authorized.
+ Under `request` scope, one verification authorizes one sign/send request, bound to the pending challenge identified by `X-Mfa-Challenge-Id`. A failed submit consumes that challenge. The next attempt must re-initiate the flow; for SMS, that sends a new OTP. Under `session` scope, `mfa_invalid_code` leaves the retry loop open instead.
+ */
+export declare type MfaVerificationScope = (typeof MfaVerificationScope)[keyof typeof MfaVerificationScope];
+
+export declare const MfaVerificationScope: {
+    readonly MfaVerificationScopeSession: "session";
+    readonly MfaVerificationScopeRequest: "request";
+};
+
 /**
  * Morpho Blue's immutable onchain market parameters that uniquely define a borrow product.
  */
@@ -3138,6 +3240,23 @@ export declare interface OnrampSessionRequest {
     partnerUserRef?: string;
 }
 
+/**
+ * Borrow origination-fee configuration for a project.
+ */
+export declare interface OriginationFeeProjectConfig {
+    /**
+     * The EVM address that receives borrow origination fees.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    recipientAddress: string;
+    /**
+     * The customer-provided borrow origination-fee rate, in basis points.
+     * @minimum 0
+     * @maximum 1000
+     */
+    feeBps: number;
+}
+
 /**
  * An OTP email logo upload and its moderation state.
  */
@@ -3294,10 +3413,13 @@ export declare interface ProjectConfig {
     iCloudAutoLinkingEnabled?: boolean;
     /** Whether delegated signing is enabled for this project. When enabled, end users can delegate transaction signing to the project. */
     delegatedSigningEnabled?: boolean;
+    /** The OAuth client ID attributed as the manager of this project. This field is informational only and must not be used for authorization. Omitted for projects not managed by an OAuth client. */
+    readonly managingOAuthClientId?: string;
     /** The verified cookie domain for this project, if one is active. When present, the SDK should route all auth requests through https://{activeCookieDomain}/v2/embedded-wallet-api/... so that first-party HttpOnly session cookies are scoped to the developer's domain. Absent when no cookie domain is registered or the registered domain is not yet active. */
     activeCookieDomain?: string;
     appAttestation?: AppAttestationProjectConfig;
     passkey?: PasskeyProjectConfig;
+    originationFee?: OriginationFeeProjectConfig;
     /** The project's OTP email logos, sorted by upload time from oldest to newest. When the latest upload is approved, only that logo is returned. When the latest upload is pending or rejected, the previously approved logo is also returned when one exists.
      */
     logos?: OtpEmailLogo[];
@@ -4366,6 +4488,8 @@ export declare type SignSolanaTransactionWithEndUserAccountBody = {
      * @pattern ^[1-9A-HJ-NP-Za-km-z]{32,44}$
      */
     address: string;
+    /** The Solana network the transaction targets. Required when using versioned transactions that reference address lookup tables, since resolving those tables requires querying a specific network. Optional otherwise. */
+    network?: SignSolanaTransactionWithEndUserAccountBodyNetwork;
     /** The base64 encoded transaction to sign. */
     transaction: string;
     /**
@@ -4375,6 +4499,16 @@ export declare type SignSolanaTransactionWithEndUserAccountBody = {
     walletSecretId?: string;
 };
 
+/**
+ * The Solana network the transaction targets. Required when using versioned transactions that reference address lookup tables, since resolving those tables requires querying a specific network. Optional otherwise.
+ */
+export declare type SignSolanaTransactionWithEndUserAccountBodyNetwork = (typeof SignSolanaTransactionWithEndUserAccountBodyNetwork)[keyof typeof SignSolanaTransactionWithEndUserAccountBodyNetwork];
+
+export declare const SignSolanaTransactionWithEndUserAccountBodyNetwork: {
+    readonly solana: "solana";
+    readonly "solana-devnet": "solana-devnet";
+};
+
 export declare type SignSolanaTransactionWithEndUserAccountParams = {
     /**
      * The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
@@ -4580,6 +4714,7 @@ export declare type SubmitMfaEnrollmentResult = NonNullable<Awaited<ReturnType<t
 /**
  * Submits an MFA code to complete the verification process.
  For passkey, the request must carry the same `Origin` header the verification was initiated from — the ceremony is bound to that exact origin (scheme, host, and port). A missing, disallowed, or differing `Origin` restarts the ceremony rather than silently changing the Relying Party ID.
+ When the project's `verificationScope` is `request`, the caller supplies the same `X-Mfa-Challenge-Id` request header that was passed to `initiateMfaVerification`. A mismatched or missing header is rejected. When the project's `verificationScope` is `session`, the caller doesn't need to supply the header.
  * @summary Submit MFA verification
  */
 export declare const submitMfaVerification: (userId: string, mfaMethod: "totp" | "sms" | "passkey", submitMfaVerificationRequest: SubmitMfaVerificationRequest, params?: SubmitMfaVerificationParams, options?: SecondParameter<typeof cdpApiClient<void>>) => Promise<void>;
@@ -5467,6 +5602,50 @@ export declare type X402UptoEvmPermit2PayloadPermit2AuthorizationWitness = {
     validAfter: string;
 };
 
+/**
+ * The x402 protocol upto scheme payload for Solana networks. The `upto` scheme authorizes a maximum amount and lets the resource server settle for the actual amount used.
+
+ A Solana transfer commits to an exact amount once signed, so this scheme escrows the ceiling in an onchain payment channel instead: the client signs an `open` transaction that deposits `maxAmount`, the facilitator co-signs it as fee payer and channel rent payer and broadcasts it before the resource runs, and the resource server later authorizes the metered charge with an Ed25519 voucher signed by the `receiverAuthorizer` key it advertised in the payment requirements `extra`. The facilitator seals and distributes the channel for that amount and refunds the remainder to the client.
+
+ The payment requirements `extra` for this scheme carries `feePayer` (from the facilitator `/supported` response), `receiverAuthorizer`, `withdrawDelay`, and `tokenProgram`. For more details, see [Solana Upto Scheme Details](https://github.com/x402-foundation/x402/blob/main/specs/schemes/upto/scheme_upto_svm.md).
+ */
+export declare interface X402UptoSolanaPayload {
+    /** The base58-encoded Solana address of the payer that funds the channel deposit. */
+    from: BlockchainAddress;
+    /**
+     * The maximum amount the client authorizes in atomic units of the payment asset. Equals the verification-phase `amount` of the payment requirements.
+     * @pattern ^[0-9]+$
+     */
+    maxAmount: string;
+    /**
+     * The amount escrowed in the payment channel by the `open` transaction, in atomic units. Must equal `maxAmount`.
+     * @pattern ^[0-9]+$
+     */
+    deposit: string;
+    /** The unix timestamp in seconds after which the settlement voucher is no longer valid. Must be nonzero. */
+    expiresAt: number;
+    /** The unix timestamp in seconds after which the payment is valid. */
+    validAfter: number;
+    /**
+     * The unique unsigned 64-bit salt, as a decimal string, encoded in the `open` instruction and used as a channel PDA seed.
+     * @pattern ^[0-9]+$
+     */
+    nonce: string;
+    /**
+     * The Solana slot, an unsigned 64-bit integer as a decimal string, encoded in the `open` instruction and used as a channel PDA seed.
+     * @pattern ^[0-9]+$
+     */
+    openSlot: string;
+    /** The base58-encoded program-derived address of the payment channel, derived from `from`, the fee payer, the asset, the authorized signer, `nonce`, and `openSlot`. */
+    channelId: BlockchainAddress;
+    /** The base58-encoded Solana address authorized to sign settlement vouchers for this channel. Must equal the `receiverAuthorizer` advertised in the payment requirements `extra` field. */
+    authorizedSigner: BlockchainAddress;
+    /** The base64-encoded channel `open` transaction, signed by the payer. The facilitator adds its fee payer signature before broadcasting it. */
+    openTransaction: string;
+    /** The base58-encoded Ed25519 signature by `authorizedSigner` over the settlement voucher, which commits to `channelId`, the settled amount, and `expiresAt`. Added by the resource server on the settle request that claims the metered charge, and required there even when the settled amount is `0`. It is owned by the resource server, so verify and the deposit settle reject any client-supplied value. */
+    voucherSignature?: string;
+}
+
 /**
  * The x402 v1 network identifier. x402 v1 uses human-readable network names. Supported networks: Base mainnet and testnet, Solana mainnet and devnet.
  */
@@ -5606,7 +5785,7 @@ export declare type X402V2PaymentPayloadExtensions = {
 /**
  * The payload of the payment depending on the x402Version, scheme, and network. Discriminated by scheme-specific fields: exact-EVM/upto-EVM payloads carry a `signature`; exact-Solana carries a `transaction`; batch-settlement carries a `type` discriminator. See `x402BatchSettlementEvmPayload` for the documented batch-settlement variants.
  */
-export declare type X402V2PaymentPayloadPayload = X402ExactEvmPayload | X402ExactEvmPermit2Payload | X402ExactSolanaPayload | X402UptoEvmPermit2Payload | X402BatchSettlementEvmPayload;
+export declare type X402V2PaymentPayloadPayload = X402ExactEvmPayload | X402ExactEvmPermit2Payload | X402ExactSolanaPayload | X402UptoEvmPermit2Payload | X402UptoSolanaPayload | X402BatchSettlementEvmPayload;
 
 /**
  * The x402 v2 payment requirements. Uses CAIP-2 network identifiers and supports `exact`, `upto`, and `batch-settlement` schemes. Carries only the payment fields (no resource metadata — that is in the enclosing `x402V2PaymentPayload.resource`).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-api-client",
-  "version": "0.0.124",
+  "version": "0.0.125",
   "type": "module",
   "files": [
     "dist/**",