@coinbase/cdp-sdk 1.49.2 → 1.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -29
- package/_cjs/accounts/evm/chainToNetworkMapper.js.map +1 -1
- package/_cjs/accounts/evm/eip6492.js.map +1 -1
- package/_cjs/accounts/evm/getBaseNodeRpcUrl.js.map +1 -1
- package/_cjs/accounts/evm/networkCapabilities.js.map +1 -1
- package/_cjs/accounts/evm/networkToChainResolver.js.map +1 -1
- package/_cjs/accounts/evm/resolveViemClients.js.map +1 -1
- package/_cjs/accounts/evm/toEvmDelegatedAccount.js.map +1 -1
- package/_cjs/accounts/evm/toEvmServerAccount.js.map +1 -1
- package/_cjs/accounts/evm/toEvmSmartAccount.js.map +1 -1
- package/_cjs/accounts/evm/toNetworkScopedEvmServerAccount.js.map +1 -1
- package/_cjs/accounts/evm/toNetworkScopedEvmSmartAccount.js.map +1 -1
- package/_cjs/accounts/evm/types.js.map +1 -1
- package/_cjs/accounts/solana/toSolanaAccount.js.map +1 -1
- package/_cjs/accounts/solana/types.js.map +1 -1
- package/_cjs/actions/evm/getUserOperation.js.map +1 -1
- package/_cjs/actions/evm/listSpendPermissions.js.map +1 -1
- package/_cjs/actions/evm/listTokenBalances.js.map +1 -1
- package/_cjs/actions/evm/requestFaucet.js.map +1 -1
- package/_cjs/actions/evm/sendTransaction.js.map +1 -1
- package/_cjs/actions/evm/sendUserOperation.js.map +1 -1
- package/_cjs/actions/evm/signAndWrapTypedDataForSmartAccount.js.map +1 -1
- package/_cjs/actions/evm/spend-permissions/account.use.js.map +1 -1
- package/_cjs/actions/evm/spend-permissions/resolveSpendPermission.js.map +1 -1
- package/_cjs/actions/evm/spend-permissions/smartAccount.use.js.map +1 -1
- package/_cjs/actions/evm/spend-permissions/types.js.map +1 -1
- package/_cjs/actions/evm/swap/createSwapQuote.js.map +1 -1
- package/_cjs/actions/evm/swap/getSwapPrice.js.map +1 -1
- package/_cjs/actions/evm/swap/sendSwapOperation.js.map +1 -1
- package/_cjs/actions/evm/swap/sendSwapTransaction.js.map +1 -1
- package/_cjs/actions/evm/swap/types.js.map +1 -1
- package/_cjs/actions/evm/transfer/accountTransferStrategy.js.map +1 -1
- package/_cjs/actions/evm/transfer/smartAccountTransferStrategy.js.map +1 -1
- package/_cjs/actions/evm/transfer/transfer.js.map +1 -1
- package/_cjs/actions/evm/transfer/transferWithViem.js.map +1 -1
- package/_cjs/actions/evm/transfer/types.js.map +1 -1
- package/_cjs/actions/evm/transfer/utils.js.map +1 -1
- package/_cjs/actions/evm/types.js.map +1 -1
- package/_cjs/actions/evm/waitForEvmEip7702DelegationStatus.js.map +1 -1
- package/_cjs/actions/evm/waitForUserOperation.js.map +1 -1
- package/_cjs/actions/solana/constants.js.map +1 -1
- package/_cjs/actions/solana/requestFaucet.js.map +1 -1
- package/_cjs/actions/solana/rpc.js.map +1 -1
- package/_cjs/actions/solana/sendTransaction.js.map +1 -1
- package/_cjs/actions/solana/signMessage.js.map +1 -1
- package/_cjs/actions/solana/signTransaction.js.map +1 -1
- package/_cjs/actions/solana/transfer.js.map +1 -1
- package/_cjs/actions/solana/types.js.map +1 -1
- package/_cjs/actions/solana/utils.js.map +1 -1
- package/_cjs/actions/webhooks/createWebhookSubscription.js.map +1 -1
- package/_cjs/actions/webhooks/index.js.map +1 -1
- package/_cjs/analytics.js.map +1 -1
- package/_cjs/auth/errors.js.map +1 -1
- package/_cjs/auth/hooks/axios/index.js.map +1 -1
- package/_cjs/auth/hooks/axios/withAuth.js.map +1 -1
- package/_cjs/auth/index.js.map +1 -1
- package/_cjs/auth/utils/hash.js.map +1 -1
- package/_cjs/auth/utils/http.js.map +1 -1
- package/_cjs/auth/utils/index.js.map +1 -1
- package/_cjs/auth/utils/jwt.js.map +1 -1
- package/_cjs/auth/utils/ws.js.map +1 -1
- package/_cjs/client/cdp.js.map +1 -1
- package/_cjs/client/end-user/endUser.js +21 -42
- package/_cjs/client/end-user/endUser.js.map +1 -1
- package/_cjs/client/end-user/endUser.types.js.map +1 -1
- package/_cjs/client/end-user/toEndUserAccount.js +18 -43
- package/_cjs/client/end-user/toEndUserAccount.js.map +1 -1
- package/_cjs/client/evm/evm.js.map +1 -1
- package/_cjs/client/evm/evm.types.js.map +1 -1
- package/_cjs/client/policies/index.js.map +1 -1
- package/_cjs/client/policies/policies.js.map +1 -1
- package/_cjs/client/policies/policies.types.js.map +1 -1
- package/_cjs/client/solana/index.js.map +1 -1
- package/_cjs/client/solana/solana.js.map +1 -1
- package/_cjs/client/solana/solana.types.js.map +1 -1
- package/_cjs/client/webhooks/webhooks.js.map +1 -1
- package/_cjs/constants.js.map +1 -1
- package/_cjs/errors.js.map +1 -1
- package/_cjs/index.js.map +1 -1
- package/_cjs/openapi-client/cdpApiClient.js.map +1 -1
- package/_cjs/openapi-client/errors.js.map +1 -1
- package/_cjs/openapi-client/generated/accounts/accounts.js +50 -0
- package/_cjs/openapi-client/generated/accounts/accounts.js.map +1 -0
- package/_cjs/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.js +526 -46
- package/_cjs/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.js.map +1 -1
- package/_cjs/openapi-client/generated/deposit-destinations/deposit-destinations.js +34 -0
- package/_cjs/openapi-client/generated/deposit-destinations/deposit-destinations.js.map +1 -0
- package/_cjs/openapi-client/generated/end-user-account-management/end-user-account-management.js +132 -0
- package/_cjs/openapi-client/generated/end-user-account-management/end-user-account-management.js.map +1 -0
- package/_cjs/openapi-client/generated/end-user-accounts/end-user-accounts.js +228 -74
- package/_cjs/openapi-client/generated/end-user-accounts/end-user-accounts.js.map +1 -1
- package/_cjs/openapi-client/generated/evm-accounts/evm-accounts.js +12 -12
- package/_cjs/openapi-client/generated/evm-accounts/evm-accounts.js.map +1 -1
- package/_cjs/openapi-client/generated/evm-smart-accounts/evm-smart-accounts.js +10 -10
- package/_cjs/openapi-client/generated/evm-smart-accounts/evm-smart-accounts.js.map +1 -1
- package/_cjs/openapi-client/generated/evm-swaps/evm-swaps.js +2 -2
- package/_cjs/openapi-client/generated/evm-swaps/evm-swaps.js.map +1 -1
- package/_cjs/openapi-client/generated/evm-token-balances/evm-token-balances.js.map +1 -1
- package/_cjs/openapi-client/generated/faucets/faucets.js.map +1 -1
- package/_cjs/openapi-client/generated/onchain-data/onchain-data.js.map +1 -1
- package/_cjs/openapi-client/generated/onramp/onramp.js.map +1 -1
- package/_cjs/openapi-client/generated/payment-methods/payment-methods.js +28 -0
- package/_cjs/openapi-client/generated/payment-methods/payment-methods.js.map +1 -0
- package/_cjs/openapi-client/generated/policy-engine/policy-engine.js +4 -4
- package/_cjs/openapi-client/generated/policy-engine/policy-engine.js.map +1 -1
- package/_cjs/openapi-client/generated/solana-accounts/solana-accounts.js +11 -11
- package/_cjs/openapi-client/generated/solana-accounts/solana-accounts.js.map +1 -1
- package/_cjs/openapi-client/generated/solana-token-balances/solana-token-balances.js.map +1 -1
- package/_cjs/openapi-client/generated/sql-api/sql-api.js +1 -1
- package/_cjs/openapi-client/generated/sql-api/sql-api.js.map +1 -1
- package/_cjs/openapi-client/generated/transfers/transfers.js +87 -0
- package/_cjs/openapi-client/generated/transfers/transfers.js.map +1 -0
- package/_cjs/openapi-client/generated/webhooks/webhooks.js +1 -1
- package/_cjs/openapi-client/generated/webhooks/webhooks.js.map +1 -1
- package/_cjs/openapi-client/generated/x402-facilitator/x402-facilitator.js +3 -3
- package/_cjs/openapi-client/generated/x402-facilitator/x402-facilitator.js.map +1 -1
- package/_cjs/openapi-client/index.js +7 -3
- package/_cjs/openapi-client/index.js.map +1 -1
- package/_cjs/policies/evmSchema.js +54 -1
- package/_cjs/policies/evmSchema.js.map +1 -1
- package/_cjs/policies/solanaSchema.js.map +1 -1
- package/_cjs/policies/types.js +2 -0
- package/_cjs/policies/types.js.map +1 -1
- package/_cjs/spend-permissions/constants.js.map +1 -1
- package/_cjs/spend-permissions/types.js.map +1 -1
- package/_cjs/spend-permissions/utils.js.map +1 -1
- package/_cjs/types/calls.js.map +1 -1
- package/_cjs/types/contract.js.map +1 -1
- package/_cjs/types/misc.js.map +1 -1
- package/_cjs/types/multicall.js.map +1 -1
- package/_cjs/types/utils.js.map +1 -1
- package/_cjs/utils/bigint.js.map +1 -1
- package/_cjs/utils/export.js.map +1 -1
- package/_cjs/utils/hash.js.map +1 -1
- package/_cjs/utils/serializeTransaction.js.map +1 -1
- package/_cjs/utils/sortKeys.js.map +1 -1
- package/_cjs/utils/uuidV4.js.map +1 -1
- package/_cjs/utils/wait.js.map +1 -1
- package/_cjs/version.js +1 -1
- package/_cjs/version.js.map +1 -1
- package/_esm/accounts/evm/chainToNetworkMapper.js.map +1 -1
- package/_esm/accounts/evm/eip6492.js.map +1 -1
- package/_esm/accounts/evm/getBaseNodeRpcUrl.js.map +1 -1
- package/_esm/accounts/evm/networkCapabilities.js.map +1 -1
- package/_esm/accounts/evm/networkToChainResolver.js.map +1 -1
- package/_esm/accounts/evm/resolveViemClients.js.map +1 -1
- package/_esm/accounts/evm/toEvmDelegatedAccount.js.map +1 -1
- package/_esm/accounts/evm/toEvmServerAccount.js.map +1 -1
- package/_esm/accounts/evm/toEvmSmartAccount.js.map +1 -1
- package/_esm/accounts/evm/toNetworkScopedEvmServerAccount.js.map +1 -1
- package/_esm/accounts/evm/toNetworkScopedEvmSmartAccount.js.map +1 -1
- package/_esm/accounts/evm/types.js.map +1 -1
- package/_esm/accounts/solana/toSolanaAccount.js.map +1 -1
- package/_esm/accounts/solana/types.js.map +1 -1
- package/_esm/actions/evm/getUserOperation.js.map +1 -1
- package/_esm/actions/evm/listSpendPermissions.js.map +1 -1
- package/_esm/actions/evm/listTokenBalances.js.map +1 -1
- package/_esm/actions/evm/requestFaucet.js.map +1 -1
- package/_esm/actions/evm/sendTransaction.js.map +1 -1
- package/_esm/actions/evm/sendUserOperation.js.map +1 -1
- package/_esm/actions/evm/signAndWrapTypedDataForSmartAccount.js.map +1 -1
- package/_esm/actions/evm/spend-permissions/account.use.js.map +1 -1
- package/_esm/actions/evm/spend-permissions/resolveSpendPermission.js.map +1 -1
- package/_esm/actions/evm/spend-permissions/smartAccount.use.js.map +1 -1
- package/_esm/actions/evm/spend-permissions/types.js.map +1 -1
- package/_esm/actions/evm/swap/createSwapQuote.js.map +1 -1
- package/_esm/actions/evm/swap/getSwapPrice.js.map +1 -1
- package/_esm/actions/evm/swap/sendSwapOperation.js.map +1 -1
- package/_esm/actions/evm/swap/sendSwapTransaction.js.map +1 -1
- package/_esm/actions/evm/swap/types.js.map +1 -1
- package/_esm/actions/evm/transfer/accountTransferStrategy.js.map +1 -1
- package/_esm/actions/evm/transfer/smartAccountTransferStrategy.js.map +1 -1
- package/_esm/actions/evm/transfer/transfer.js.map +1 -1
- package/_esm/actions/evm/transfer/transferWithViem.js.map +1 -1
- package/_esm/actions/evm/transfer/types.js.map +1 -1
- package/_esm/actions/evm/transfer/utils.js.map +1 -1
- package/_esm/actions/evm/types.js.map +1 -1
- package/_esm/actions/evm/waitForEvmEip7702DelegationStatus.js.map +1 -1
- package/_esm/actions/evm/waitForUserOperation.js.map +1 -1
- package/_esm/actions/solana/constants.js.map +1 -1
- package/_esm/actions/solana/requestFaucet.js.map +1 -1
- package/_esm/actions/solana/rpc.js.map +1 -1
- package/_esm/actions/solana/sendTransaction.js.map +1 -1
- package/_esm/actions/solana/signMessage.js.map +1 -1
- package/_esm/actions/solana/signTransaction.js.map +1 -1
- package/_esm/actions/solana/transfer.js.map +1 -1
- package/_esm/actions/solana/types.js.map +1 -1
- package/_esm/actions/solana/utils.js.map +1 -1
- package/_esm/actions/webhooks/createWebhookSubscription.js.map +1 -1
- package/_esm/actions/webhooks/index.js.map +1 -1
- package/_esm/analytics.js.map +1 -1
- package/_esm/auth/errors.js.map +1 -1
- package/_esm/auth/hooks/axios/index.js.map +1 -1
- package/_esm/auth/hooks/axios/withAuth.js.map +1 -1
- package/_esm/auth/index.js.map +1 -1
- package/_esm/auth/utils/hash.js.map +1 -1
- package/_esm/auth/utils/http.js.map +1 -1
- package/_esm/auth/utils/index.js.map +1 -1
- package/_esm/auth/utils/jwt.js.map +1 -1
- package/_esm/auth/utils/ws.js.map +1 -1
- package/_esm/client/cdp.js.map +1 -1
- package/_esm/client/end-user/endUser.js +21 -42
- package/_esm/client/end-user/endUser.js.map +1 -1
- package/_esm/client/end-user/endUser.types.js.map +1 -1
- package/_esm/client/end-user/toEndUserAccount.js +18 -43
- package/_esm/client/end-user/toEndUserAccount.js.map +1 -1
- package/_esm/client/evm/evm.js.map +1 -1
- package/_esm/client/evm/evm.types.js.map +1 -1
- package/_esm/client/policies/index.js.map +1 -1
- package/_esm/client/policies/policies.js.map +1 -1
- package/_esm/client/policies/policies.types.js.map +1 -1
- package/_esm/client/solana/index.js.map +1 -1
- package/_esm/client/solana/solana.js.map +1 -1
- package/_esm/client/solana/solana.types.js.map +1 -1
- package/_esm/client/webhooks/webhooks.js.map +1 -1
- package/_esm/constants.js.map +1 -1
- package/_esm/errors.js.map +1 -1
- package/_esm/index.js.map +1 -1
- package/_esm/openapi-client/cdpApiClient.js.map +1 -1
- package/_esm/openapi-client/errors.js.map +1 -1
- package/_esm/openapi-client/generated/accounts/accounts.js +42 -0
- package/_esm/openapi-client/generated/accounts/accounts.js.map +1 -0
- package/_esm/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.js +522 -43
- package/_esm/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.js.map +1 -1
- package/_esm/openapi-client/generated/deposit-destinations/deposit-destinations.js +28 -0
- package/_esm/openapi-client/generated/deposit-destinations/deposit-destinations.js.map +1 -0
- package/_esm/openapi-client/generated/end-user-account-management/end-user-account-management.js +120 -0
- package/_esm/openapi-client/generated/end-user-account-management/end-user-account-management.js.map +1 -0
- package/_esm/openapi-client/generated/end-user-accounts/end-user-accounts.js +211 -64
- package/_esm/openapi-client/generated/end-user-accounts/end-user-accounts.js.map +1 -1
- package/_esm/openapi-client/generated/evm-accounts/evm-accounts.js +12 -12
- package/_esm/openapi-client/generated/evm-accounts/evm-accounts.js.map +1 -1
- package/_esm/openapi-client/generated/evm-smart-accounts/evm-smart-accounts.js +10 -10
- package/_esm/openapi-client/generated/evm-smart-accounts/evm-smart-accounts.js.map +1 -1
- package/_esm/openapi-client/generated/evm-swaps/evm-swaps.js +2 -2
- package/_esm/openapi-client/generated/evm-swaps/evm-swaps.js.map +1 -1
- package/_esm/openapi-client/generated/evm-token-balances/evm-token-balances.js.map +1 -1
- package/_esm/openapi-client/generated/faucets/faucets.js.map +1 -1
- package/_esm/openapi-client/generated/onchain-data/onchain-data.js.map +1 -1
- package/_esm/openapi-client/generated/onramp/onramp.js.map +1 -1
- package/_esm/openapi-client/generated/payment-methods/payment-methods.js +23 -0
- package/_esm/openapi-client/generated/payment-methods/payment-methods.js.map +1 -0
- package/_esm/openapi-client/generated/policy-engine/policy-engine.js +4 -4
- package/_esm/openapi-client/generated/policy-engine/policy-engine.js.map +1 -1
- package/_esm/openapi-client/generated/solana-accounts/solana-accounts.js +11 -11
- package/_esm/openapi-client/generated/solana-accounts/solana-accounts.js.map +1 -1
- package/_esm/openapi-client/generated/solana-token-balances/solana-token-balances.js.map +1 -1
- package/_esm/openapi-client/generated/sql-api/sql-api.js +1 -1
- package/_esm/openapi-client/generated/sql-api/sql-api.js.map +1 -1
- package/_esm/openapi-client/generated/transfers/transfers.js +79 -0
- package/_esm/openapi-client/generated/transfers/transfers.js.map +1 -0
- package/_esm/openapi-client/generated/webhooks/webhooks.js +1 -1
- package/_esm/openapi-client/generated/webhooks/webhooks.js.map +1 -1
- package/_esm/openapi-client/generated/x402-facilitator/x402-facilitator.js +3 -3
- package/_esm/openapi-client/generated/x402-facilitator/x402-facilitator.js.map +1 -1
- package/_esm/openapi-client/index.js +7 -3
- package/_esm/openapi-client/index.js.map +1 -1
- package/_esm/policies/evmSchema.js +52 -0
- package/_esm/policies/evmSchema.js.map +1 -1
- package/_esm/policies/solanaSchema.js.map +1 -1
- package/_esm/policies/types.js +3 -1
- package/_esm/policies/types.js.map +1 -1
- package/_esm/spend-permissions/constants.js.map +1 -1
- package/_esm/spend-permissions/types.js.map +1 -1
- package/_esm/spend-permissions/utils.js.map +1 -1
- package/_esm/types/calls.js.map +1 -1
- package/_esm/types/contract.js.map +1 -1
- package/_esm/types/misc.js.map +1 -1
- package/_esm/types/multicall.js.map +1 -1
- package/_esm/types/utils.js.map +1 -1
- package/_esm/utils/bigint.js.map +1 -1
- package/_esm/utils/export.js.map +1 -1
- package/_esm/utils/hash.js.map +1 -1
- package/_esm/utils/serializeTransaction.js.map +1 -1
- package/_esm/utils/sortKeys.js.map +1 -1
- package/_esm/utils/uuidV4.js.map +1 -1
- package/_esm/utils/wait.js.map +1 -1
- package/_esm/version.js +1 -1
- package/_esm/version.js.map +1 -1
- package/_types/accounts/evm/chainToNetworkMapper.d.ts.map +1 -1
- package/_types/accounts/evm/eip6492.d.ts.map +1 -1
- package/_types/accounts/evm/getBaseNodeRpcUrl.d.ts.map +1 -1
- package/_types/accounts/evm/networkCapabilities.d.ts.map +1 -1
- package/_types/accounts/evm/networkToChainResolver.d.ts.map +1 -1
- package/_types/accounts/evm/resolveViemClients.d.ts.map +1 -1
- package/_types/accounts/evm/toEvmDelegatedAccount.d.ts.map +1 -1
- package/_types/accounts/evm/toEvmServerAccount.d.ts.map +1 -1
- package/_types/accounts/evm/toEvmSmartAccount.d.ts.map +1 -1
- package/_types/accounts/evm/toNetworkScopedEvmServerAccount.d.ts.map +1 -1
- package/_types/accounts/evm/toNetworkScopedEvmSmartAccount.d.ts.map +1 -1
- package/_types/accounts/evm/types.d.ts.map +1 -1
- package/_types/accounts/solana/toSolanaAccount.d.ts.map +1 -1
- package/_types/accounts/solana/types.d.ts.map +1 -1
- package/_types/actions/evm/getUserOperation.d.ts.map +1 -1
- package/_types/actions/evm/listSpendPermissions.d.ts.map +1 -1
- package/_types/actions/evm/listTokenBalances.d.ts.map +1 -1
- package/_types/actions/evm/requestFaucet.d.ts.map +1 -1
- package/_types/actions/evm/sendTransaction.d.ts.map +1 -1
- package/_types/actions/evm/sendUserOperation.d.ts.map +1 -1
- package/_types/actions/evm/signAndWrapTypedDataForSmartAccount.d.ts.map +1 -1
- package/_types/actions/evm/spend-permissions/account.use.d.ts.map +1 -1
- package/_types/actions/evm/spend-permissions/resolveSpendPermission.d.ts.map +1 -1
- package/_types/actions/evm/spend-permissions/smartAccount.use.d.ts.map +1 -1
- package/_types/actions/evm/spend-permissions/types.d.ts.map +1 -1
- package/_types/actions/evm/swap/createSwapQuote.d.ts.map +1 -1
- package/_types/actions/evm/swap/getSwapPrice.d.ts.map +1 -1
- package/_types/actions/evm/swap/sendSwapOperation.d.ts.map +1 -1
- package/_types/actions/evm/swap/sendSwapTransaction.d.ts.map +1 -1
- package/_types/actions/evm/swap/types.d.ts.map +1 -1
- package/_types/actions/evm/transfer/accountTransferStrategy.d.ts.map +1 -1
- package/_types/actions/evm/transfer/smartAccountTransferStrategy.d.ts.map +1 -1
- package/_types/actions/evm/transfer/transfer.d.ts.map +1 -1
- package/_types/actions/evm/transfer/transferWithViem.d.ts.map +1 -1
- package/_types/actions/evm/transfer/types.d.ts.map +1 -1
- package/_types/actions/evm/transfer/utils.d.ts.map +1 -1
- package/_types/actions/evm/types.d.ts.map +1 -1
- package/_types/actions/evm/waitForEvmEip7702DelegationStatus.d.ts.map +1 -1
- package/_types/actions/evm/waitForUserOperation.d.ts.map +1 -1
- package/_types/actions/solana/constants.d.ts.map +1 -1
- package/_types/actions/solana/requestFaucet.d.ts.map +1 -1
- package/_types/actions/solana/rpc.d.ts.map +1 -1
- package/_types/actions/solana/sendTransaction.d.ts.map +1 -1
- package/_types/actions/solana/signMessage.d.ts.map +1 -1
- package/_types/actions/solana/signTransaction.d.ts.map +1 -1
- package/_types/actions/solana/transfer.d.ts.map +1 -1
- package/_types/actions/solana/types.d.ts.map +1 -1
- package/_types/actions/solana/utils.d.ts.map +1 -1
- package/_types/actions/webhooks/createWebhookSubscription.d.ts.map +1 -1
- package/_types/actions/webhooks/index.d.ts.map +1 -1
- package/_types/analytics.d.ts.map +1 -1
- package/_types/auth/errors.d.ts.map +1 -1
- package/_types/auth/hooks/axios/index.d.ts.map +1 -1
- package/_types/auth/hooks/axios/withAuth.d.ts.map +1 -1
- package/_types/auth/index.d.ts.map +1 -1
- package/_types/auth/utils/hash.d.ts.map +1 -1
- package/_types/auth/utils/http.d.ts.map +1 -1
- package/_types/auth/utils/index.d.ts.map +1 -1
- package/_types/auth/utils/jwt.d.ts.map +1 -1
- package/_types/auth/utils/ws.d.ts.map +1 -1
- package/_types/client/cdp.d.ts.map +1 -1
- package/_types/client/end-user/endUser.d.ts.map +1 -1
- package/_types/client/end-user/endUser.types.d.ts +63 -4
- package/_types/client/end-user/endUser.types.d.ts.map +1 -1
- package/_types/client/end-user/toEndUserAccount.d.ts.map +1 -1
- package/_types/client/evm/evm.d.ts.map +1 -1
- package/_types/client/evm/evm.types.d.ts.map +1 -1
- package/_types/client/policies/index.d.ts.map +1 -1
- package/_types/client/policies/policies.d.ts.map +1 -1
- package/_types/client/policies/policies.types.d.ts.map +1 -1
- package/_types/client/solana/index.d.ts.map +1 -1
- package/_types/client/solana/solana.d.ts.map +1 -1
- package/_types/client/solana/solana.types.d.ts.map +1 -1
- package/_types/client/webhooks/webhooks.d.ts.map +1 -1
- package/_types/constants.d.ts.map +1 -1
- package/_types/errors.d.ts.map +1 -1
- package/_types/index.d.ts.map +1 -1
- package/_types/openapi-client/cdpApiClient.d.ts.map +1 -1
- package/_types/openapi-client/errors.d.ts.map +1 -1
- package/_types/openapi-client/generated/accounts/accounts.d.ts +42 -0
- package/_types/openapi-client/generated/accounts/accounts.d.ts.map +1 -0
- package/_types/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.d.ts +1933 -269
- package/_types/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.d.ts.map +1 -1
- package/_types/openapi-client/generated/deposit-destinations/deposit-destinations.d.ts +30 -0
- package/_types/openapi-client/generated/deposit-destinations/deposit-destinations.d.ts.map +1 -0
- package/_types/openapi-client/generated/end-user-account-management/end-user-account-management.d.ts +91 -0
- package/_types/openapi-client/generated/end-user-account-management/end-user-account-management.d.ts.map +1 -0
- package/_types/openapi-client/generated/end-user-accounts/end-user-accounts.d.ts +142 -60
- package/_types/openapi-client/generated/end-user-accounts/end-user-accounts.d.ts.map +1 -1
- package/_types/openapi-client/generated/evm-accounts/evm-accounts.d.ts +12 -12
- package/_types/openapi-client/generated/evm-accounts/evm-accounts.d.ts.map +1 -1
- package/_types/openapi-client/generated/evm-smart-accounts/evm-smart-accounts.d.ts +10 -10
- package/_types/openapi-client/generated/evm-smart-accounts/evm-smart-accounts.d.ts.map +1 -1
- package/_types/openapi-client/generated/evm-swaps/evm-swaps.d.ts +2 -2
- package/_types/openapi-client/generated/evm-swaps/evm-swaps.d.ts.map +1 -1
- package/_types/openapi-client/generated/evm-token-balances/evm-token-balances.d.ts.map +1 -1
- package/_types/openapi-client/generated/faucets/faucets.d.ts.map +1 -1
- package/_types/openapi-client/generated/onchain-data/onchain-data.d.ts.map +1 -1
- package/_types/openapi-client/generated/onramp/onramp.d.ts.map +1 -1
- package/_types/openapi-client/generated/payment-methods/payment-methods.d.ts +31 -0
- package/_types/openapi-client/generated/payment-methods/payment-methods.d.ts.map +1 -0
- package/_types/openapi-client/generated/policy-engine/policy-engine.d.ts +4 -4
- package/_types/openapi-client/generated/policy-engine/policy-engine.d.ts.map +1 -1
- package/_types/openapi-client/generated/solana-accounts/solana-accounts.d.ts +11 -11
- package/_types/openapi-client/generated/solana-accounts/solana-accounts.d.ts.map +1 -1
- package/_types/openapi-client/generated/solana-token-balances/solana-token-balances.d.ts.map +1 -1
- package/_types/openapi-client/generated/sql-api/sql-api.d.ts +1 -1
- package/_types/openapi-client/generated/sql-api/sql-api.d.ts.map +1 -1
- package/_types/openapi-client/generated/transfers/transfers.d.ts +74 -0
- package/_types/openapi-client/generated/transfers/transfers.d.ts.map +1 -0
- package/_types/openapi-client/generated/webhooks/webhooks.d.ts +1 -1
- package/_types/openapi-client/generated/webhooks/webhooks.d.ts.map +1 -1
- package/_types/openapi-client/generated/x402-facilitator/x402-facilitator.d.ts +3 -3
- package/_types/openapi-client/generated/x402-facilitator/x402-facilitator.d.ts.map +1 -1
- package/_types/openapi-client/index.d.ts +14 -10
- package/_types/openapi-client/index.d.ts.map +1 -1
- package/_types/policies/evmSchema.d.ts +884 -39
- package/_types/policies/evmSchema.d.ts.map +1 -1
- package/_types/policies/solanaSchema.d.ts +20 -20
- package/_types/policies/solanaSchema.d.ts.map +1 -1
- package/_types/policies/types.d.ts +1996 -629
- package/_types/policies/types.d.ts.map +1 -1
- package/_types/spend-permissions/constants.d.ts.map +1 -1
- package/_types/spend-permissions/types.d.ts.map +1 -1
- package/_types/spend-permissions/utils.d.ts.map +1 -1
- package/_types/types/calls.d.ts.map +1 -1
- package/_types/types/contract.d.ts.map +1 -1
- package/_types/types/misc.d.ts.map +1 -1
- package/_types/types/multicall.d.ts.map +1 -1
- package/_types/types/utils.d.ts.map +1 -1
- package/_types/utils/bigint.d.ts.map +1 -1
- package/_types/utils/export.d.ts.map +1 -1
- package/_types/utils/hash.d.ts.map +1 -1
- package/_types/utils/serializeTransaction.d.ts.map +1 -1
- package/_types/utils/sortKeys.d.ts.map +1 -1
- package/_types/utils/uuidV4.d.ts.map +1 -1
- package/_types/utils/wait.d.ts.map +1 -1
- package/_types/version.d.ts +1 -1
- package/_types/version.d.ts.map +1 -1
- package/package.json +24 -3
- package/{auth → src/auth}/README.md +3 -3
- package/{client → src/client}/end-user/endUser.ts +113 -69
- package/{client → src/client}/end-user/endUser.types.ts +63 -4
- package/{client → src/client}/end-user/toEndUserAccount.ts +103 -64
- package/src/openapi-client/generated/accounts/accounts.ts +103 -0
- package/{openapi-client → src/openapi-client}/generated/coinbaseDeveloperPlatformAPIs.schemas.ts +2368 -363
- package/src/openapi-client/generated/deposit-destinations/deposit-destinations.ts +72 -0
- package/{openapi-client/generated/end-user-accounts/end-user-accounts.ts → src/openapi-client/generated/end-user-account-management/end-user-account-management.ts} +6 -6
- package/{openapi-client/generated/embedded-wallets/embedded-wallets.ts → src/openapi-client/generated/end-user-accounts/end-user-accounts.ts} +11 -11
- package/{openapi-client → src/openapi-client}/generated/evm-accounts/evm-accounts.ts +12 -12
- package/{openapi-client → src/openapi-client}/generated/evm-smart-accounts/evm-smart-accounts.ts +10 -10
- package/{openapi-client → src/openapi-client}/generated/evm-swaps/evm-swaps.ts +2 -2
- package/src/openapi-client/generated/payment-methods/payment-methods.ts +53 -0
- package/{openapi-client → src/openapi-client}/generated/policy-engine/policy-engine.ts +4 -4
- package/{openapi-client → src/openapi-client}/generated/solana-accounts/solana-accounts.ts +11 -11
- package/{openapi-client → src/openapi-client}/generated/sql-api/sql-api.ts +1 -1
- package/src/openapi-client/generated/transfers/transfers.ts +131 -0
- package/{openapi-client → src/openapi-client}/generated/webhooks/webhooks.ts +1 -1
- package/{openapi-client → src/openapi-client}/generated/x402-facilitator/x402-facilitator.ts +3 -3
- package/{openapi-client → src/openapi-client}/index.ts +7 -3
- package/{policies → src/policies}/evmSchema.ts +63 -0
- package/{policies → src/policies}/types.ts +4 -0
- package/src/version.ts +1 -0
- package/CHANGELOG.md +0 -631
- package/_cjs/openapi-client/generated/embedded-wallets/embedded-wallets.js +0 -286
- package/_cjs/openapi-client/generated/embedded-wallets/embedded-wallets.js.map +0 -1
- package/_esm/openapi-client/generated/embedded-wallets/embedded-wallets.js +0 -267
- package/_esm/openapi-client/generated/embedded-wallets/embedded-wallets.js.map +0 -1
- package/_types/openapi-client/generated/embedded-wallets/embedded-wallets.d.ts +0 -173
- package/_types/openapi-client/generated/embedded-wallets/embedded-wallets.d.ts.map +0 -1
- package/version.ts +0 -1
- /package/{accounts → src/accounts}/evm/chainToNetworkMapper.ts +0 -0
- /package/{accounts → src/accounts}/evm/eip6492.ts +0 -0
- /package/{accounts → src/accounts}/evm/getBaseNodeRpcUrl.ts +0 -0
- /package/{accounts → src/accounts}/evm/networkCapabilities.ts +0 -0
- /package/{accounts → src/accounts}/evm/networkToChainResolver.ts +0 -0
- /package/{accounts → src/accounts}/evm/resolveViemClients.ts +0 -0
- /package/{accounts → src/accounts}/evm/toEvmDelegatedAccount.ts +0 -0
- /package/{accounts → src/accounts}/evm/toEvmServerAccount.ts +0 -0
- /package/{accounts → src/accounts}/evm/toEvmSmartAccount.ts +0 -0
- /package/{accounts → src/accounts}/evm/toNetworkScopedEvmServerAccount.ts +0 -0
- /package/{accounts → src/accounts}/evm/toNetworkScopedEvmSmartAccount.ts +0 -0
- /package/{accounts → src/accounts}/evm/types.ts +0 -0
- /package/{accounts → src/accounts}/solana/toSolanaAccount.ts +0 -0
- /package/{accounts → src/accounts}/solana/types.ts +0 -0
- /package/{actions → src/actions}/evm/getUserOperation.ts +0 -0
- /package/{actions → src/actions}/evm/listSpendPermissions.ts +0 -0
- /package/{actions → src/actions}/evm/listTokenBalances.ts +0 -0
- /package/{actions → src/actions}/evm/requestFaucet.ts +0 -0
- /package/{actions → src/actions}/evm/sendTransaction.ts +0 -0
- /package/{actions → src/actions}/evm/sendUserOperation.ts +0 -0
- /package/{actions → src/actions}/evm/signAndWrapTypedDataForSmartAccount.ts +0 -0
- /package/{actions → src/actions}/evm/spend-permissions/account.use.ts +0 -0
- /package/{actions → src/actions}/evm/spend-permissions/resolveSpendPermission.ts +0 -0
- /package/{actions → src/actions}/evm/spend-permissions/smartAccount.use.ts +0 -0
- /package/{actions → src/actions}/evm/spend-permissions/types.ts +0 -0
- /package/{actions → src/actions}/evm/swap/createSwapQuote.ts +0 -0
- /package/{actions → src/actions}/evm/swap/getSwapPrice.ts +0 -0
- /package/{actions → src/actions}/evm/swap/sendSwapOperation.ts +0 -0
- /package/{actions → src/actions}/evm/swap/sendSwapTransaction.ts +0 -0
- /package/{actions → src/actions}/evm/swap/types.ts +0 -0
- /package/{actions → src/actions}/evm/transfer/accountTransferStrategy.ts +0 -0
- /package/{actions → src/actions}/evm/transfer/smartAccountTransferStrategy.ts +0 -0
- /package/{actions → src/actions}/evm/transfer/transfer.ts +0 -0
- /package/{actions → src/actions}/evm/transfer/transferWithViem.ts +0 -0
- /package/{actions → src/actions}/evm/transfer/types.ts +0 -0
- /package/{actions → src/actions}/evm/transfer/utils.ts +0 -0
- /package/{actions → src/actions}/evm/types.ts +0 -0
- /package/{actions → src/actions}/evm/waitForEvmEip7702DelegationStatus.ts +0 -0
- /package/{actions → src/actions}/evm/waitForUserOperation.ts +0 -0
- /package/{actions → src/actions}/solana/constants.ts +0 -0
- /package/{actions → src/actions}/solana/requestFaucet.ts +0 -0
- /package/{actions → src/actions}/solana/rpc.ts +0 -0
- /package/{actions → src/actions}/solana/sendTransaction.ts +0 -0
- /package/{actions → src/actions}/solana/signMessage.ts +0 -0
- /package/{actions → src/actions}/solana/signTransaction.ts +0 -0
- /package/{actions → src/actions}/solana/transfer.ts +0 -0
- /package/{actions → src/actions}/solana/types.ts +0 -0
- /package/{actions → src/actions}/solana/utils.ts +0 -0
- /package/{actions → src/actions}/webhooks/createWebhookSubscription.ts +0 -0
- /package/{actions → src/actions}/webhooks/index.ts +0 -0
- /package/{analytics.ts → src/analytics.ts} +0 -0
- /package/{auth → src/auth}/errors.ts +0 -0
- /package/{auth → src/auth}/hooks/axios/index.ts +0 -0
- /package/{auth → src/auth}/hooks/axios/withAuth.ts +0 -0
- /package/{auth → src/auth}/index.ts +0 -0
- /package/{auth → src/auth}/utils/hash.ts +0 -0
- /package/{auth → src/auth}/utils/http.ts +0 -0
- /package/{auth → src/auth}/utils/index.ts +0 -0
- /package/{auth → src/auth}/utils/jwt.ts +0 -0
- /package/{auth → src/auth}/utils/ws.ts +0 -0
- /package/{client → src/client}/cdp.ts +0 -0
- /package/{client → src/client}/evm/evm.ts +0 -0
- /package/{client → src/client}/evm/evm.types.ts +0 -0
- /package/{client → src/client}/policies/index.ts +0 -0
- /package/{client → src/client}/policies/policies.ts +0 -0
- /package/{client → src/client}/policies/policies.types.ts +0 -0
- /package/{client → src/client}/solana/index.ts +0 -0
- /package/{client → src/client}/solana/solana.ts +0 -0
- /package/{client → src/client}/solana/solana.types.ts +0 -0
- /package/{client → src/client}/webhooks/webhooks.ts +0 -0
- /package/{constants.ts → src/constants.ts} +0 -0
- /package/{errors.ts → src/errors.ts} +0 -0
- /package/{index.ts → src/index.ts} +0 -0
- /package/{openapi-client → src/openapi-client}/cdpApiClient.ts +0 -0
- /package/{openapi-client → src/openapi-client}/errors.ts +0 -0
- /package/{openapi-client → src/openapi-client}/generated/evm-token-balances/evm-token-balances.ts +0 -0
- /package/{openapi-client → src/openapi-client}/generated/faucets/faucets.ts +0 -0
- /package/{openapi-client → src/openapi-client}/generated/onchain-data/onchain-data.ts +0 -0
- /package/{openapi-client → src/openapi-client}/generated/onramp/onramp.ts +0 -0
- /package/{openapi-client → src/openapi-client}/generated/solana-token-balances/solana-token-balances.ts +0 -0
- /package/{policies → src/policies}/solanaSchema.ts +0 -0
- /package/{spend-permissions → src/spend-permissions}/constants.ts +0 -0
- /package/{spend-permissions → src/spend-permissions}/types.ts +0 -0
- /package/{spend-permissions → src/spend-permissions}/utils.ts +0 -0
- /package/{types → src/types}/calls.ts +0 -0
- /package/{types → src/types}/contract.ts +0 -0
- /package/{types → src/types}/misc.ts +0 -0
- /package/{types → src/types}/multicall.ts +0 -0
- /package/{types → src/types}/utils.ts +0 -0
- /package/{utils → src/utils}/bigint.ts +0 -0
- /package/{utils → src/utils}/export.ts +0 -0
- /package/{utils → src/utils}/hash.ts +0 -0
- /package/{utils → src/utils}/serializeTransaction.ts +0 -0
- /package/{utils → src/utils}/sortKeys.ts +0 -0
- /package/{utils → src/utils}/uuidV4.ts +0 -0
- /package/{utils → src/utils}/wait.ts +0 -0
|
@@ -5,6 +5,824 @@
|
|
|
5
5
|
* The Coinbase Developer Platform APIs - leading the world's transition onchain.
|
|
6
6
|
* OpenAPI spec version: 2.0.0
|
|
7
7
|
*/
|
|
8
|
+
/**
|
|
9
|
+
* The type of the Account.
|
|
10
|
+
*/
|
|
11
|
+
export type AccountType = (typeof AccountType)[keyof typeof AccountType];
|
|
12
|
+
export declare const AccountType: {
|
|
13
|
+
readonly prime: "prime";
|
|
14
|
+
readonly business: "business";
|
|
15
|
+
readonly cdp: "cdp";
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* The ID of the Account, which is a UUID prefixed by the string `account_`.
|
|
19
|
+
* @pattern ^account_[a-f0-9\-]{36}$
|
|
20
|
+
*/
|
|
21
|
+
export type AccountId = string;
|
|
22
|
+
/**
|
|
23
|
+
* The Owner ID of the Account.
|
|
24
|
+
Owner IDs are UUIDs prefixed with the Owner Type as follows:
|
|
25
|
+
* **Entity**: `entity_` - If the Owner is your Entity, e.g. `entity_af2937b0-9846-4fe7-bfe9-ccc22d935114`.
|
|
26
|
+
Support for Customer-owned accounts (`customer_` prefix) is in development.
|
|
27
|
+
* @pattern ^(entity|customer)_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
|
|
28
|
+
*/
|
|
29
|
+
export type Owner = string;
|
|
30
|
+
/**
|
|
31
|
+
* An optional name for the account. Must be 1-64 characters and can only contain alphanumeric characters, hyphens, and spaces.
|
|
32
|
+
* @maxLength 64
|
|
33
|
+
* @pattern ^[a-zA-Z0-9 -]{1,64}$
|
|
34
|
+
*/
|
|
35
|
+
export type AccountName = string;
|
|
36
|
+
export interface Account {
|
|
37
|
+
accountId: AccountId;
|
|
38
|
+
type: AccountType;
|
|
39
|
+
owner: Owner;
|
|
40
|
+
name?: AccountName;
|
|
41
|
+
/** The timestamp when the account was created. */
|
|
42
|
+
createdAt: string;
|
|
43
|
+
/** The timestamp when the account was last updated. */
|
|
44
|
+
updatedAt: string;
|
|
45
|
+
}
|
|
46
|
+
export interface ListResponse {
|
|
47
|
+
/** The token for the next page of items, if any. */
|
|
48
|
+
nextPageToken?: string;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.
|
|
52
|
+
*/
|
|
53
|
+
export type ErrorType = (typeof ErrorType)[keyof typeof ErrorType];
|
|
54
|
+
export declare const ErrorType: {
|
|
55
|
+
readonly already_exists: "already_exists";
|
|
56
|
+
readonly authorization_expired: "authorization_expired";
|
|
57
|
+
readonly bad_gateway: "bad_gateway";
|
|
58
|
+
readonly capture_expired: "capture_expired";
|
|
59
|
+
readonly client_closed_request: "client_closed_request";
|
|
60
|
+
readonly customer_not_authorized: "customer_not_authorized";
|
|
61
|
+
readonly endpoint_unavailable: "endpoint_unavailable";
|
|
62
|
+
readonly faucet_limit_exceeded: "faucet_limit_exceeded";
|
|
63
|
+
readonly forbidden: "forbidden";
|
|
64
|
+
readonly idempotency_error: "idempotency_error";
|
|
65
|
+
readonly internal_server_error: "internal_server_error";
|
|
66
|
+
readonly invalid_request: "invalid_request";
|
|
67
|
+
readonly invalid_sql_query: "invalid_sql_query";
|
|
68
|
+
readonly invalid_signature: "invalid_signature";
|
|
69
|
+
readonly malformed_transaction: "malformed_transaction";
|
|
70
|
+
readonly not_found: "not_found";
|
|
71
|
+
readonly payment_method_required: "payment_method_required";
|
|
72
|
+
readonly payment_required: "payment_required";
|
|
73
|
+
readonly settlement_failed: "settlement_failed";
|
|
74
|
+
readonly rate_limit_exceeded: "rate_limit_exceeded";
|
|
75
|
+
readonly request_canceled: "request_canceled";
|
|
76
|
+
readonly service_unavailable: "service_unavailable";
|
|
77
|
+
readonly timed_out: "timed_out";
|
|
78
|
+
readonly unauthorized: "unauthorized";
|
|
79
|
+
readonly unsupported_tos_language: "unsupported_tos_language";
|
|
80
|
+
readonly policy_violation: "policy_violation";
|
|
81
|
+
readonly policy_in_use: "policy_in_use";
|
|
82
|
+
readonly account_limit_exceeded: "account_limit_exceeded";
|
|
83
|
+
readonly network_not_tradable: "network_not_tradable";
|
|
84
|
+
readonly guest_permission_denied: "guest_permission_denied";
|
|
85
|
+
readonly guest_region_forbidden: "guest_region_forbidden";
|
|
86
|
+
readonly guest_transaction_limit: "guest_transaction_limit";
|
|
87
|
+
readonly guest_transaction_count: "guest_transaction_count";
|
|
88
|
+
readonly phone_number_verification_expired: "phone_number_verification_expired";
|
|
89
|
+
readonly document_verification_failed: "document_verification_failed";
|
|
90
|
+
readonly recipient_allowlist_violation: "recipient_allowlist_violation";
|
|
91
|
+
readonly recipient_allowlist_pending: "recipient_allowlist_pending";
|
|
92
|
+
readonly refund_expired: "refund_expired";
|
|
93
|
+
readonly travel_rules_recipient_violation: "travel_rules_recipient_violation";
|
|
94
|
+
readonly source_account_invalid: "source_account_invalid";
|
|
95
|
+
readonly target_account_invalid: "target_account_invalid";
|
|
96
|
+
readonly source_account_not_found: "source_account_not_found";
|
|
97
|
+
readonly target_account_not_found: "target_account_not_found";
|
|
98
|
+
readonly source_asset_not_supported: "source_asset_not_supported";
|
|
99
|
+
readonly target_asset_not_supported: "target_asset_not_supported";
|
|
100
|
+
readonly target_email_invalid: "target_email_invalid";
|
|
101
|
+
readonly target_onchain_address_invalid: "target_onchain_address_invalid";
|
|
102
|
+
readonly transfer_amount_invalid: "transfer_amount_invalid";
|
|
103
|
+
readonly transfer_asset_not_supported: "transfer_asset_not_supported";
|
|
104
|
+
readonly transfer_quote_expired: "transfer_quote_expired";
|
|
105
|
+
readonly insufficient_balance: "insufficient_balance";
|
|
106
|
+
readonly metadata_too_many_entries: "metadata_too_many_entries";
|
|
107
|
+
readonly metadata_key_too_long: "metadata_key_too_long";
|
|
108
|
+
readonly metadata_value_too_long: "metadata_value_too_long";
|
|
109
|
+
readonly travel_rules_field_missing: "travel_rules_field_missing";
|
|
110
|
+
readonly asset_mismatch: "asset_mismatch";
|
|
111
|
+
readonly mfa_already_enrolled: "mfa_already_enrolled";
|
|
112
|
+
readonly mfa_invalid_code: "mfa_invalid_code";
|
|
113
|
+
readonly mfa_flow_expired: "mfa_flow_expired";
|
|
114
|
+
readonly mfa_required: "mfa_required";
|
|
115
|
+
readonly mfa_not_enrolled: "mfa_not_enrolled";
|
|
116
|
+
readonly order_quote_expired: "order_quote_expired";
|
|
117
|
+
readonly order_already_filled: "order_already_filled";
|
|
118
|
+
readonly order_already_canceled: "order_already_canceled";
|
|
119
|
+
readonly account_not_ready: "account_not_ready";
|
|
120
|
+
readonly insufficient_liquidity: "insufficient_liquidity";
|
|
121
|
+
readonly insufficient_allowance: "insufficient_allowance";
|
|
122
|
+
readonly transaction_simulation_failed: "transaction_simulation_failed";
|
|
123
|
+
readonly delegation_not_found: "delegation_not_found";
|
|
124
|
+
readonly delegation_expired: "delegation_expired";
|
|
125
|
+
readonly delegation_revoked: "delegation_revoked";
|
|
126
|
+
readonly delegation_not_authorized: "delegation_not_authorized";
|
|
127
|
+
readonly delegation_not_enabled: "delegation_not_enabled";
|
|
128
|
+
readonly network_mismatch: "network_mismatch";
|
|
129
|
+
readonly already_enabled: "already_enabled";
|
|
130
|
+
};
|
|
131
|
+
/**
|
|
132
|
+
* A valid HTTP or HTTPS URL.
|
|
133
|
+
* @minLength 11
|
|
134
|
+
* @maxLength 2048
|
|
135
|
+
* @pattern ^https?://.*$
|
|
136
|
+
*/
|
|
137
|
+
export type Url = string;
|
|
138
|
+
/**
|
|
139
|
+
* The name of a capability. Capabilities represent granular functional permissions
|
|
140
|
+
that determine what actions a customer can perform. Each capability must be
|
|
141
|
+
explicitly requested before use.
|
|
142
|
+
|
|
143
|
+
*/
|
|
144
|
+
export type CapabilityName = (typeof CapabilityName)[keyof typeof CapabilityName];
|
|
145
|
+
export declare const CapabilityName: {
|
|
146
|
+
readonly custodyCrypto: "custodyCrypto";
|
|
147
|
+
readonly custodyFiat: "custodyFiat";
|
|
148
|
+
readonly custodyStablecoin: "custodyStablecoin";
|
|
149
|
+
readonly tradeCrypto: "tradeCrypto";
|
|
150
|
+
readonly tradeStablecoin: "tradeStablecoin";
|
|
151
|
+
readonly transferCrypto: "transferCrypto";
|
|
152
|
+
readonly transferFiat: "transferFiat";
|
|
153
|
+
readonly transferStablecoin: "transferStablecoin";
|
|
154
|
+
};
|
|
155
|
+
/**
|
|
156
|
+
* An error response including the code for the type of error and a human-readable message describing the error.
|
|
157
|
+
*/
|
|
158
|
+
export interface Error {
|
|
159
|
+
errorType: ErrorType;
|
|
160
|
+
/** The error message. */
|
|
161
|
+
errorMessage: string;
|
|
162
|
+
/** A unique identifier for the request that generated the error. This can be used to help debug issues with the API. */
|
|
163
|
+
correlationId?: string;
|
|
164
|
+
/** A link to the corresponding error documentation. */
|
|
165
|
+
errorLink?: Url;
|
|
166
|
+
/** The capability code(s) that were not authorized for the customer on
|
|
167
|
+
this request. Present only when `errorType` is
|
|
168
|
+
`customer_not_authorized`; absent for every other error type.
|
|
169
|
+
|
|
170
|
+
Use this list to render onboarding UX for the listed capabilities, or
|
|
171
|
+
fetch `GET /v2/customers/{customerId}` and inspect each entry's
|
|
172
|
+
`status` / `requirements` to discover what (if anything) can be
|
|
173
|
+
submitted to resolve the block.
|
|
174
|
+
*/
|
|
175
|
+
unauthorizedCapabilities?: CapabilityName[];
|
|
176
|
+
}
|
|
177
|
+
export interface CreateAccountRequest {
|
|
178
|
+
name?: AccountName;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* The symbol of the asset (e.g., eth, usd, usdc, usdt).
|
|
182
|
+
* @minLength 1
|
|
183
|
+
* @maxLength 42
|
|
184
|
+
*/
|
|
185
|
+
export type Asset = string;
|
|
186
|
+
/**
|
|
187
|
+
* The type of the asset.
|
|
188
|
+
*/
|
|
189
|
+
export type AssetType = (typeof AssetType)[keyof typeof AssetType];
|
|
190
|
+
export declare const AssetType: {
|
|
191
|
+
readonly fiat: "fiat";
|
|
192
|
+
readonly crypto: "crypto";
|
|
193
|
+
};
|
|
194
|
+
/**
|
|
195
|
+
* An asset, e.g. fiat or crypto.
|
|
196
|
+
*/
|
|
197
|
+
export interface BalancesAsset {
|
|
198
|
+
symbol: Asset;
|
|
199
|
+
type: AssetType;
|
|
200
|
+
/** The name of the asset. */
|
|
201
|
+
name: string;
|
|
202
|
+
/** The number of decimals (i.e. significant digits to the right of the decimal point) supported for the asset. */
|
|
203
|
+
decimals: number;
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* Available and total amounts for a specific currency.
|
|
207
|
+
*/
|
|
208
|
+
export interface AmountDetail {
|
|
209
|
+
/** The amount that is currently available to be used. */
|
|
210
|
+
available: string;
|
|
211
|
+
/** The total amount, including the amount that is currently on hold. */
|
|
212
|
+
total: string;
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* Amount details denominated in different assets.
|
|
216
|
+
- The keys represent the asset symbols (e.g., "btc", "usd"), - Each value contains available and total amounts. - There will always be an entry for the asset specified in the `asset` field.
|
|
217
|
+
*/
|
|
218
|
+
export type BalanceAmount = {
|
|
219
|
+
[key: string]: AmountDetail;
|
|
220
|
+
};
|
|
221
|
+
/**
|
|
222
|
+
* A balance of an asset.
|
|
223
|
+
*/
|
|
224
|
+
export interface Balance {
|
|
225
|
+
asset: BalancesAsset;
|
|
226
|
+
/** Amount details denominated in different assets.
|
|
227
|
+
- The keys represent the asset symbols (e.g., "btc", "usd"), - Each value contains available and total amounts. - There will always be an entry for the asset specified in the `asset` field. */
|
|
228
|
+
amount: BalanceAmount;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* A list of balances for an account.
|
|
232
|
+
*/
|
|
233
|
+
export interface Balances {
|
|
234
|
+
/** The list of balances. */
|
|
235
|
+
balances: Balance[];
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* The type of deposit destination.
|
|
239
|
+
*/
|
|
240
|
+
export type DepositDestinationType = string;
|
|
241
|
+
/**
|
|
242
|
+
* The ID of the Deposit Destination, which is a UUID prefixed by the string `depositDestination_`.
|
|
243
|
+
* @pattern ^depositDestination_[a-f0-9\-]{36}$
|
|
244
|
+
*/
|
|
245
|
+
export type DepositDestinationId = string;
|
|
246
|
+
/**
|
|
247
|
+
* The blockchain network for the payment. Supported networks depend on the account type. See [API and Network Support](https://docs.cdp.coinbase.com/api-reference/payment-apis/supported-networks-assets#by-asset-and-network) for more details.
|
|
248
|
+
*/
|
|
249
|
+
export type Network = (typeof Network)[keyof typeof Network];
|
|
250
|
+
export declare const Network: {
|
|
251
|
+
readonly base: "base";
|
|
252
|
+
readonly ethereum: "ethereum";
|
|
253
|
+
readonly solana: "solana";
|
|
254
|
+
readonly aptos: "aptos";
|
|
255
|
+
readonly arbitrum: "arbitrum";
|
|
256
|
+
readonly "arbitrum-sepolia": "arbitrum-sepolia";
|
|
257
|
+
readonly optimism: "optimism";
|
|
258
|
+
readonly polygon: "polygon";
|
|
259
|
+
readonly world: "world";
|
|
260
|
+
readonly "world-sepolia": "world-sepolia";
|
|
261
|
+
};
|
|
262
|
+
/**
|
|
263
|
+
* A blockchain address. Format varies by network (e.g., 0x-prefixed for EVM, base58 for Solana).
|
|
264
|
+
* @minLength 1
|
|
265
|
+
* @maxLength 128
|
|
266
|
+
*/
|
|
267
|
+
export type BlockchainAddress = string;
|
|
268
|
+
/**
|
|
269
|
+
* Crypto-specific deposit destination details. In responses, this object is always present. Contains the network and address for the deposit destination.
|
|
270
|
+
*/
|
|
271
|
+
export interface DepositDestinationCrypto {
|
|
272
|
+
network: Network;
|
|
273
|
+
address: BlockchainAddress;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* The account and asset where incoming deposits should be credited.
|
|
277
|
+
*/
|
|
278
|
+
export interface DepositDestinationTargetAccount {
|
|
279
|
+
/** The ID of the CDP Account to which deposited funds should be transferred. */
|
|
280
|
+
accountId?: AccountId;
|
|
281
|
+
/** The symbol of the asset that should land in the target account. */
|
|
282
|
+
asset: Asset;
|
|
283
|
+
}
|
|
284
|
+
/**
|
|
285
|
+
* The intended target for deposited funds.
|
|
286
|
+
*/
|
|
287
|
+
export type DepositDestinationTarget = DepositDestinationTargetAccount;
|
|
288
|
+
/**
|
|
289
|
+
* The status of the deposit destination.
|
|
290
|
+
*/
|
|
291
|
+
export type DepositDestinationStatus = (typeof DepositDestinationStatus)[keyof typeof DepositDestinationStatus];
|
|
292
|
+
export declare const DepositDestinationStatus: {
|
|
293
|
+
readonly active: "active";
|
|
294
|
+
readonly inactive: "inactive";
|
|
295
|
+
readonly pending: "pending";
|
|
296
|
+
};
|
|
297
|
+
/**
|
|
298
|
+
* Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.
|
|
299
|
+
*/
|
|
300
|
+
export interface Metadata {
|
|
301
|
+
[key: string]: string;
|
|
302
|
+
}
|
|
303
|
+
export type CryptoDepositDestinationType = (typeof CryptoDepositDestinationType)[keyof typeof CryptoDepositDestinationType];
|
|
304
|
+
export declare const CryptoDepositDestinationType: {
|
|
305
|
+
readonly crypto: "crypto";
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* A cryptocurrency deposit destination.
|
|
309
|
+
*/
|
|
310
|
+
export interface CryptoDepositDestination {
|
|
311
|
+
depositDestinationId: DepositDestinationId;
|
|
312
|
+
accountId: AccountId;
|
|
313
|
+
type: CryptoDepositDestinationType;
|
|
314
|
+
/** Crypto-specific details for this deposit destination. Always populated in responses. Contains the network and address. */
|
|
315
|
+
crypto: DepositDestinationCrypto;
|
|
316
|
+
target?: DepositDestinationTarget;
|
|
317
|
+
status: DepositDestinationStatus;
|
|
318
|
+
metadata?: Metadata;
|
|
319
|
+
/** The timestamp when the deposit destination was created. */
|
|
320
|
+
createdAt: string;
|
|
321
|
+
/** The timestamp when the deposit destination was last updated. */
|
|
322
|
+
updatedAt: string;
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
* A deposit destination for receiving funds to an account.
|
|
326
|
+
*/
|
|
327
|
+
export type DepositDestination = CryptoDepositDestination;
|
|
328
|
+
/**
|
|
329
|
+
* Common fields for creating a deposit destination.
|
|
330
|
+
*/
|
|
331
|
+
export interface CreateDepositDestinationRequestBase {
|
|
332
|
+
/** The ID of the Account, which is a UUID prefixed by the string `account_`, that owns the deposit destination. */
|
|
333
|
+
accountId: AccountId;
|
|
334
|
+
type: DepositDestinationType;
|
|
335
|
+
target?: DepositDestinationTarget;
|
|
336
|
+
metadata?: Metadata;
|
|
337
|
+
}
|
|
338
|
+
/**
|
|
339
|
+
* Crypto-specific details for creating a deposit destination.
|
|
340
|
+
*/
|
|
341
|
+
export interface CreateDepositDestinationCrypto {
|
|
342
|
+
network: Network;
|
|
343
|
+
}
|
|
344
|
+
export type CreateCryptoDepositDestinationRequestAllOfType = (typeof CreateCryptoDepositDestinationRequestAllOfType)[keyof typeof CreateCryptoDepositDestinationRequestAllOfType];
|
|
345
|
+
export declare const CreateCryptoDepositDestinationRequestAllOfType: {
|
|
346
|
+
readonly crypto: "crypto";
|
|
347
|
+
};
|
|
348
|
+
export type CreateCryptoDepositDestinationRequestAllOf = {
|
|
349
|
+
type?: CreateCryptoDepositDestinationRequestAllOfType;
|
|
350
|
+
/** Crypto-specific details. Required when `type` is `crypto`. */
|
|
351
|
+
crypto: CreateDepositDestinationCrypto;
|
|
352
|
+
};
|
|
353
|
+
export type CreateCryptoDepositDestinationRequestType = (typeof CreateCryptoDepositDestinationRequestType)[keyof typeof CreateCryptoDepositDestinationRequestType];
|
|
354
|
+
export declare const CreateCryptoDepositDestinationRequestType: {
|
|
355
|
+
readonly crypto: "crypto";
|
|
356
|
+
};
|
|
357
|
+
export type CreateCryptoDepositDestinationRequest = CreateDepositDestinationRequestBase & CreateCryptoDepositDestinationRequestAllOf & {
|
|
358
|
+
type: CreateCryptoDepositDestinationRequestType;
|
|
359
|
+
};
|
|
360
|
+
/**
|
|
361
|
+
* Request to create a new deposit destination. Provide the type-specific details matching the chosen `type`.
|
|
362
|
+
*/
|
|
363
|
+
export type CreateDepositDestinationRequest = CreateCryptoDepositDestinationRequest;
|
|
364
|
+
/**
|
|
365
|
+
* The current status of the transfer, indicating what action you need to take next. Required when validateOnly is false.
|
|
366
|
+
*/
|
|
367
|
+
export type TransferStatus = (typeof TransferStatus)[keyof typeof TransferStatus];
|
|
368
|
+
export declare const TransferStatus: {
|
|
369
|
+
/** Transfer was created with `execute: true`, but is momentarily being quoted before executing _or_ the transfer was created with `execute: false`. It can be executed by calling `\/v2\/transfers\/{transferId}\/execute` with `execute: true`. */
|
|
370
|
+
readonly quoted: "quoted";
|
|
371
|
+
/** Transfer is executing after being quoted. No action needed - monitor progress via the transfers webhook. */
|
|
372
|
+
readonly processing: "processing";
|
|
373
|
+
/** Transfer completed successfully. */
|
|
374
|
+
readonly completed: "completed";
|
|
375
|
+
/** Transfer failed. See `failureReason` for details. */
|
|
376
|
+
readonly failed: "failed";
|
|
377
|
+
};
|
|
378
|
+
/**
|
|
379
|
+
* An email address. Maximum length 254 characters per [RFC 5321](https://www.rfc-editor.org/rfc/rfc5321).
|
|
380
|
+
* @maxLength 254
|
|
381
|
+
*/
|
|
382
|
+
export type Email = string;
|
|
383
|
+
/**
|
|
384
|
+
* The Account specific details for the transfer.
|
|
385
|
+
*/
|
|
386
|
+
export interface TransfersAccount {
|
|
387
|
+
/** The ID of the Account. */
|
|
388
|
+
accountId: string;
|
|
389
|
+
asset: Asset;
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* The Payment Method specific details for the transfer.
|
|
393
|
+
*/
|
|
394
|
+
export interface PaymentMethod {
|
|
395
|
+
/** The ID of the Payment Method. */
|
|
396
|
+
paymentMethodId: string;
|
|
397
|
+
asset: Asset;
|
|
398
|
+
}
|
|
399
|
+
/**
|
|
400
|
+
* The target of the payment is an onchain address.
|
|
401
|
+
*/
|
|
402
|
+
export interface OnchainAddress {
|
|
403
|
+
/** The onchain crypto address of the recipient.
|
|
404
|
+
|
|
405
|
+
Examples:
|
|
406
|
+
- EVM address: 0xabc1234567890abcdef1234567890abcdef123456
|
|
407
|
+
- Solana address: HpabPRRCFbBKSuJr5PdkVvQc85FyxyTWkFM2obBRSvHT
|
|
408
|
+
- XRP address: rhccc5p23aKiCGFcEqqnjEfLRZ6xEvfy3s
|
|
409
|
+
*/
|
|
410
|
+
address: BlockchainAddress;
|
|
411
|
+
network: Network;
|
|
412
|
+
/** The destination tag of the onchain address. Destination tags are used by certain networks
|
|
413
|
+
(primarily XRP/Ripple) to identify specific recipients when multiple users share a single address.
|
|
414
|
+
The tag ensures funds are credited to the correct account within the shared address.
|
|
415
|
+
|
|
416
|
+
Examples by network:
|
|
417
|
+
- XRP/Ripple: Numeric values like "1234567890" or "123456"
|
|
418
|
+
- Stellar (XLM): Memos which can be text, ID, or hash format
|
|
419
|
+
|
|
420
|
+
Note: Most networks (Ethereum, Bitcoin, Solana) do not use destination tags.
|
|
421
|
+
*/
|
|
422
|
+
destinationTag?: string;
|
|
423
|
+
/** Asset symbol of the payment received by the recipient. */
|
|
424
|
+
asset: Asset;
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* The originating US bank account details for the transfer source. Present when funds were deposited from an external bank account into a deposit destination. Only the last 4 digits of the account number are exposed.
|
|
428
|
+
*/
|
|
429
|
+
export interface OriginatingBankAccountUS {
|
|
430
|
+
/** The name of the bank that originated the deposit. */
|
|
431
|
+
bankName: string;
|
|
432
|
+
/**
|
|
433
|
+
* The last 4 digits of the originating bank account number.
|
|
434
|
+
* @pattern ^[0-9]{4}$
|
|
435
|
+
*/
|
|
436
|
+
accountLast4: string;
|
|
437
|
+
/** The fiat currency of the deposit (e.g., `usd`). */
|
|
438
|
+
currency: string;
|
|
439
|
+
}
|
|
440
|
+
/**
|
|
441
|
+
* The source of the transfer.
|
|
442
|
+
*/
|
|
443
|
+
export type TransferSource = TransfersAccount | PaymentMethod | OnchainAddress | OriginatingBankAccountUS;
|
|
444
|
+
/**
|
|
445
|
+
* The target of the payment is an email address.
|
|
446
|
+
*/
|
|
447
|
+
export interface EmailAddress {
|
|
448
|
+
/** The email address of the recipient. The recipient will need to have an account with Coinbase or onboard to Coinbase to receive the payment. */
|
|
449
|
+
email: Email;
|
|
450
|
+
}
|
|
451
|
+
export type EmailInstrumentAllOf = {
|
|
452
|
+
/** Asset symbol of the payment received by the recipient. */
|
|
453
|
+
asset: Asset;
|
|
454
|
+
};
|
|
455
|
+
/**
|
|
456
|
+
* The target of the payment is an email address.
|
|
457
|
+
*/
|
|
458
|
+
export type EmailInstrument = EmailAddress & EmailInstrumentAllOf;
|
|
459
|
+
/**
|
|
460
|
+
* The target of the transfer.
|
|
461
|
+
*/
|
|
462
|
+
export type TransferTarget = TransfersAccount | PaymentMethod | OnchainAddress | EmailInstrument;
|
|
463
|
+
/**
|
|
464
|
+
* Exchange rate information for currency conversion. The rate indicates how much of the target asset is equivalent to one unit of the source asset.
|
|
465
|
+
*/
|
|
466
|
+
export interface TransferExchangeRate {
|
|
467
|
+
/** The asset being converted from. */
|
|
468
|
+
sourceAsset: Asset;
|
|
469
|
+
/** The asset being converted to. */
|
|
470
|
+
targetAsset: Asset;
|
|
471
|
+
/** The exchange rate value as a decimal string. Indicates how many units of the target asset equal one unit of the source asset. */
|
|
472
|
+
rate: string;
|
|
473
|
+
}
|
|
474
|
+
/**
|
|
475
|
+
* The type of the fee, indicating its purpose.
|
|
476
|
+
*/
|
|
477
|
+
export type TransferFeeType = (typeof TransferFeeType)[keyof typeof TransferFeeType];
|
|
478
|
+
export declare const TransferFeeType: {
|
|
479
|
+
readonly BankFee: "bank";
|
|
480
|
+
readonly ConversionFee: "conversion";
|
|
481
|
+
readonly NetworkFee: "network";
|
|
482
|
+
readonly OtherFee: "other";
|
|
483
|
+
};
|
|
484
|
+
/**
|
|
485
|
+
* A single fee for a transfer.
|
|
486
|
+
*/
|
|
487
|
+
export interface TransferFee {
|
|
488
|
+
/** The type of the fee, indicating its purpose. */
|
|
489
|
+
type: TransferFeeType;
|
|
490
|
+
/** The amount of the fee in units of the asset specified by `asset`. */
|
|
491
|
+
amount: string;
|
|
492
|
+
/** The asset symbol. */
|
|
493
|
+
asset: Asset;
|
|
494
|
+
}
|
|
495
|
+
/**
|
|
496
|
+
* The fees associated with this transfer. Different transfer types have different fee structures.
|
|
497
|
+
|
|
498
|
+
**NOTE:** These examples are not exhaustive.
|
|
499
|
+
|
|
500
|
+
Common examples:
|
|
501
|
+
* **Crypto transfers**: Network fees (gas) paid in the native token
|
|
502
|
+
* **Fiat conversions**: Processing fees + exchange fees in USD
|
|
503
|
+
* **Wire transfers**: Wire fees ($15) + processing fees ($5) in USD
|
|
504
|
+
* **Crypto conversions**: Spread fees paid in the source asset.
|
|
505
|
+
*/
|
|
506
|
+
export type TransferFees = TransferFee[];
|
|
507
|
+
/**
|
|
508
|
+
* A point-in-time snapshot of estimated values for a transfer where exact amounts cannot be locked in at quote time (e.g., when the executed rate is determined at execution time and moves with the market).
|
|
509
|
+
|
|
510
|
+
Present in both pre-execution and post-execution states:
|
|
511
|
+
* **Quoted state:** top-level fields whose values cannot be guaranteed are absent;
|
|
512
|
+
`estimate` holds their estimated values.
|
|
513
|
+
|
|
514
|
+
* **Completed state:** top-level fields contain the actual executed values;
|
|
515
|
+
`estimate` is retained as an immutable audit snapshot of the pre-execution estimate.
|
|
516
|
+
*/
|
|
517
|
+
export interface TransferEstimate {
|
|
518
|
+
exchangeRate?: TransferExchangeRate;
|
|
519
|
+
/** Estimated amount of the target asset that will be received, as a decimal string in standard unit denomination. */
|
|
520
|
+
targetAmount?: string;
|
|
521
|
+
/** The asset symbol of the estimated target amount. */
|
|
522
|
+
targetAsset?: Asset;
|
|
523
|
+
fees?: TransferFees;
|
|
524
|
+
/** The date and time when this estimate was captured. */
|
|
525
|
+
estimatedAt: string;
|
|
526
|
+
}
|
|
527
|
+
/**
|
|
528
|
+
* A reference to the deposit destination associated with the transfer.
|
|
529
|
+
*/
|
|
530
|
+
export interface DepositDestinationReference {
|
|
531
|
+
id: DepositDestinationId;
|
|
532
|
+
}
|
|
533
|
+
/**
|
|
534
|
+
* The status of a travel rule submission.
|
|
535
|
+
*/
|
|
536
|
+
export type TravelRuleStatus = (typeof TravelRuleStatus)[keyof typeof TravelRuleStatus];
|
|
537
|
+
export declare const TravelRuleStatus: {
|
|
538
|
+
/** Additional fields are required before the transfer can proceed. */
|
|
539
|
+
readonly TravelRuleStatusIncomplete: "incomplete";
|
|
540
|
+
/** All requirements are satisfied and the transfer will proceed. */
|
|
541
|
+
readonly TravelRuleStatusCompleted: "completed";
|
|
542
|
+
};
|
|
543
|
+
/**
|
|
544
|
+
* An onchain transaction associated with the transfer.
|
|
545
|
+
*/
|
|
546
|
+
export type TransferDetailsOnchainTransactionsItem = {
|
|
547
|
+
/** The transaction hash. */
|
|
548
|
+
transactionHash: string;
|
|
549
|
+
network: Network;
|
|
550
|
+
};
|
|
551
|
+
/**
|
|
552
|
+
* Travel rule compliance status for deposit transfers. Present when the transfer requires travel rule information.
|
|
553
|
+
*/
|
|
554
|
+
export type TransferDetailsTravelRule = {
|
|
555
|
+
status?: TravelRuleStatus;
|
|
556
|
+
/** Additional details about the current travel rule status. For example, when status is `incomplete`, this may indicate the specific missing information required to proceed. */
|
|
557
|
+
statusMessage?: string;
|
|
558
|
+
};
|
|
559
|
+
/**
|
|
560
|
+
* Additional details about the transfer. For example, if the transfer was sent to a deposit destination, the information about that destination will be included in this field.
|
|
561
|
+
*/
|
|
562
|
+
export interface TransferDetails {
|
|
563
|
+
depositDestination?: DepositDestinationReference;
|
|
564
|
+
/** The onchain transactions associated with the transfer. */
|
|
565
|
+
onchainTransactions?: TransferDetailsOnchainTransactionsItem[];
|
|
566
|
+
/** Travel rule compliance status for deposit transfers. Present when the transfer requires travel rule information. */
|
|
567
|
+
travelRule?: TransferDetailsTravelRule;
|
|
568
|
+
}
|
|
569
|
+
/**
|
|
570
|
+
* A Transfer represents all the information needed to execute a transfer and tracks the lifecycle of a transfer from initiation through completion or failure.
|
|
571
|
+
*/
|
|
572
|
+
export interface Transfer {
|
|
573
|
+
/** The ID of the transfer. Required when validateOnly is false. */
|
|
574
|
+
transferId?: string;
|
|
575
|
+
status?: TransferStatus;
|
|
576
|
+
source: TransferSource;
|
|
577
|
+
target: TransferTarget;
|
|
578
|
+
/** The amount of the source asset that will be transferred out, as a decimal string in standard unit denomination. */
|
|
579
|
+
sourceAmount?: string;
|
|
580
|
+
/** The asset symbol of the source amount. */
|
|
581
|
+
sourceAsset?: Asset;
|
|
582
|
+
/** The amount of the target asset that will be received, as a decimal string in standard unit denomination. */
|
|
583
|
+
targetAmount?: string;
|
|
584
|
+
/** The asset symbol of the target amount. */
|
|
585
|
+
targetAsset?: Asset;
|
|
586
|
+
exchangeRate?: TransferExchangeRate;
|
|
587
|
+
fees?: TransferFees;
|
|
588
|
+
estimate?: TransferEstimate;
|
|
589
|
+
/** The date and time the transfer was completed. */
|
|
590
|
+
completedAt?: string;
|
|
591
|
+
/** The reason for failure, if the transfer failed. Only present when status is `failed`. */
|
|
592
|
+
failureReason?: string;
|
|
593
|
+
/** The date and time when this transfer will expire if not executed. Only present for `quoted` status. A new transfer must be created to obtain an updated quote after expiration. Required when validateOnly is false. */
|
|
594
|
+
expiresAt?: string;
|
|
595
|
+
/** The date and time the transfer was executed and moved to processing. Only present when status has progressed beyond `quoted`. */
|
|
596
|
+
executedAt?: string;
|
|
597
|
+
/** The date and time the transfer was created. Required when validateOnly is false. */
|
|
598
|
+
createdAt?: string;
|
|
599
|
+
/** The date and time the transfer was last updated. Required when validateOnly is false. */
|
|
600
|
+
updatedAt?: string;
|
|
601
|
+
metadata?: Metadata;
|
|
602
|
+
details?: TransferDetails;
|
|
603
|
+
}
|
|
604
|
+
/**
|
|
605
|
+
* The source of the transfer.
|
|
606
|
+
*/
|
|
607
|
+
export type CreateTransferSource = TransfersAccount | PaymentMethod;
|
|
608
|
+
/**
|
|
609
|
+
* A physical address with standard address components including street, city, state/province, postal code, and country.
|
|
610
|
+
*/
|
|
611
|
+
export interface PhysicalAddress {
|
|
612
|
+
/** Primary street address. */
|
|
613
|
+
line1?: string;
|
|
614
|
+
/** Secondary address information. */
|
|
615
|
+
line2?: string;
|
|
616
|
+
/** City or locality. */
|
|
617
|
+
city?: string;
|
|
618
|
+
/** State, province, or region. */
|
|
619
|
+
state?: string;
|
|
620
|
+
/** Postal or ZIP code. */
|
|
621
|
+
postCode?: string;
|
|
622
|
+
/**
|
|
623
|
+
* ISO 3166-1 alpha-2 country code (2 characters). See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes.
|
|
624
|
+
* @minLength 2
|
|
625
|
+
* @maxLength 2
|
|
626
|
+
*/
|
|
627
|
+
countryCode?: string;
|
|
628
|
+
}
|
|
629
|
+
/**
|
|
630
|
+
* Information about a party (originator or beneficiary) for travel rule compliance.
|
|
631
|
+
*/
|
|
632
|
+
export interface TravelRuleParty {
|
|
633
|
+
/** Name of the financial institution. */
|
|
634
|
+
financialInstitution?: string;
|
|
635
|
+
/** Full name of the party. */
|
|
636
|
+
name?: string;
|
|
637
|
+
address?: PhysicalAddress;
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* Information about the originating Virtual Asset Service Provider (VASP) that handles cryptocurrency or other virtual assets on behalf of customers.
|
|
641
|
+
*/
|
|
642
|
+
export type TravelRuleOriginatorAllOfVirtualAssetServiceProvider = {
|
|
643
|
+
/** The name of the originating Virtual Asset Service Provider (VASP). */
|
|
644
|
+
name?: string;
|
|
645
|
+
/** The address of the originating Virtual Asset Service Provider (VASP). */
|
|
646
|
+
address?: PhysicalAddress;
|
|
647
|
+
/** The Legal Entity Identifier of the originating Virtual Asset Service Provider (VASP). */
|
|
648
|
+
identifier?: string;
|
|
649
|
+
};
|
|
650
|
+
export type TravelRuleOriginatorAllOf = {
|
|
651
|
+
/** Information about the originating Virtual Asset Service Provider (VASP) that handles cryptocurrency or other virtual assets on behalf of customers. */
|
|
652
|
+
virtualAssetServiceProvider?: TravelRuleOriginatorAllOfVirtualAssetServiceProvider;
|
|
653
|
+
};
|
|
654
|
+
/**
|
|
655
|
+
* Originator (sender) party.
|
|
656
|
+
*/
|
|
657
|
+
export type TravelRuleOriginator = TravelRuleParty & TravelRuleOriginatorAllOf;
|
|
658
|
+
/**
|
|
659
|
+
* The type of the beneficiary's wallet.
|
|
660
|
+
*/
|
|
661
|
+
export type TravelRuleBeneficiaryAllOfWalletType = (typeof TravelRuleBeneficiaryAllOfWalletType)[keyof typeof TravelRuleBeneficiaryAllOfWalletType];
|
|
662
|
+
export declare const TravelRuleBeneficiaryAllOfWalletType: {
|
|
663
|
+
readonly custodial: "custodial";
|
|
664
|
+
readonly self_custody: "self_custody";
|
|
665
|
+
};
|
|
666
|
+
export type TravelRuleBeneficiaryAllOf = {
|
|
667
|
+
/** The type of the beneficiary's wallet. */
|
|
668
|
+
walletType?: TravelRuleBeneficiaryAllOfWalletType;
|
|
669
|
+
};
|
|
670
|
+
/**
|
|
671
|
+
* Beneficiary (receiver) party.
|
|
672
|
+
*/
|
|
673
|
+
export type TravelRuleBeneficiary = TravelRuleParty & TravelRuleBeneficiaryAllOf;
|
|
674
|
+
/**
|
|
675
|
+
* Required Travel Rule fields differ by region. These requirements are determined based on which Coinbase entity the customer has signed the service agreement for.
|
|
676
|
+
*/
|
|
677
|
+
export interface TravelRule {
|
|
678
|
+
/** Indicates whether the user attests that the receiving wallet belongs to them. */
|
|
679
|
+
isSelf?: boolean;
|
|
680
|
+
/** Indicates whether Coinbase is being used as an intermediary Virtual Asset Service Provider (VASP) to send crypto on behalf of your customer.
|
|
681
|
+
|
|
682
|
+
**Background:**
|
|
683
|
+
|
|
684
|
+
The Travel Rule (FATF Recommendation 16) requires VASPs to share originator and beneficiary information for virtual asset transfers. When Coinbase acts as an intermediary, additional Travel Rule data must be provided to satisfy compliance requirements.
|
|
685
|
+
|
|
686
|
+
**Set to `true` when:**
|
|
687
|
+
|
|
688
|
+
- Your organization is a VASP using Coinbase to send crypto **on behalf of your end customer**
|
|
689
|
+
- In this scenario, Coinbase acts as an intermediary in the transfer chain and handles Travel Rule data exchange with the beneficiary VASP
|
|
690
|
+
|
|
691
|
+
**Set to `false` (or omit) when:**
|
|
692
|
+
|
|
693
|
+
- You are transferring funds directly from your own Coinbase account, where **Coinbase is your primary VASP** rather than an intermediary for another institution
|
|
694
|
+
|
|
695
|
+
**Impact on required fields:**
|
|
696
|
+
|
|
697
|
+
When `isIntermediary` is `true`, you must provide the `originator` object with details about the original sender, including:
|
|
698
|
+
- Originator name
|
|
699
|
+
- Originator address
|
|
700
|
+
- Your VASP information (`virtualAssetServiceProvider` object with `name`, `address`, and `identifier`)
|
|
701
|
+
*/
|
|
702
|
+
isIntermediary?: boolean;
|
|
703
|
+
originator?: TravelRuleOriginator;
|
|
704
|
+
beneficiary?: TravelRuleBeneficiary;
|
|
705
|
+
}
|
|
706
|
+
/**
|
|
707
|
+
* Specifies whether the given amount is to be received by the target or taken from the source.
|
|
708
|
+
|
|
709
|
+
- `target`: The transfer `target` receives the exact value specified in `amount`. Fees are added to the amount taken from the transfer `source`.
|
|
710
|
+
- `source`: The transfer `target` receives the value specified in `amount`, minus any fees.
|
|
711
|
+
|
|
712
|
+
*/
|
|
713
|
+
export type TransferRequestAmountType = (typeof TransferRequestAmountType)[keyof typeof TransferRequestAmountType];
|
|
714
|
+
export declare const TransferRequestAmountType: {
|
|
715
|
+
readonly target: "target";
|
|
716
|
+
readonly source: "source";
|
|
717
|
+
};
|
|
718
|
+
/**
|
|
719
|
+
* A request to create a transfer.
|
|
720
|
+
*/
|
|
721
|
+
export interface TransferRequest {
|
|
722
|
+
source: CreateTransferSource;
|
|
723
|
+
target: TransferTarget;
|
|
724
|
+
/** The amount of the transfer, as a decimal string in standard unit denomination of the asset specified by `asset` (e.g., "100.00" for 100 USD, "0.05" for 0.05 ETH). */
|
|
725
|
+
amount: string;
|
|
726
|
+
/** The symbol of the asset for the amount. This must be one of the assets of the source or target. */
|
|
727
|
+
asset: Asset;
|
|
728
|
+
/** Specifies whether the given amount is to be received by the target or taken from the source.
|
|
729
|
+
|
|
730
|
+
- `target`: The transfer `target` receives the exact value specified in `amount`. Fees are added to the amount taken from the transfer `source`.
|
|
731
|
+
- `source`: The transfer `target` receives the value specified in `amount`, minus any fees.
|
|
732
|
+
*/
|
|
733
|
+
amountType?: TransferRequestAmountType;
|
|
734
|
+
/** If true, validates the transfer without initiating it. If the request is valid, a 2xx will be returned. If the request is invalid, a 4xx error will be returned. The response will include an errorType, for e.g. invalid_target if the specified target cannot receive funds. */
|
|
735
|
+
validateOnly?: boolean;
|
|
736
|
+
/** Whether to immediately execute the transfer. If false, the transfer will be created in quoted status and must be executed manually via the /execute endpoint. */
|
|
737
|
+
execute: boolean;
|
|
738
|
+
metadata?: Metadata;
|
|
739
|
+
travelRule?: TravelRule;
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* Information about the Virtual Asset Service Provider (VASP) for a deposit travel rule submission.
|
|
743
|
+
*/
|
|
744
|
+
export interface DepositTravelRuleVasp {
|
|
745
|
+
/** The Legal Entity Identifier (LEI) of the Virtual Asset Service Provider (VASP). */
|
|
746
|
+
identifier?: string;
|
|
747
|
+
/** The name of the Virtual Asset Service Provider (VASP). */
|
|
748
|
+
name?: string;
|
|
749
|
+
}
|
|
750
|
+
/**
|
|
751
|
+
* Date of birth.
|
|
752
|
+
*/
|
|
753
|
+
export interface DateOfBirth {
|
|
754
|
+
/**
|
|
755
|
+
* Day of birth (01-31).
|
|
756
|
+
* @minLength 2
|
|
757
|
+
* @maxLength 2
|
|
758
|
+
* @pattern ^[0-9]{2}$
|
|
759
|
+
*/
|
|
760
|
+
day?: string;
|
|
761
|
+
/**
|
|
762
|
+
* Month of birth (01-12).
|
|
763
|
+
* @minLength 2
|
|
764
|
+
* @maxLength 2
|
|
765
|
+
* @pattern ^[0-9]{2}$
|
|
766
|
+
*/
|
|
767
|
+
month?: string;
|
|
768
|
+
/**
|
|
769
|
+
* Year of birth (four digits).
|
|
770
|
+
* @minLength 4
|
|
771
|
+
* @maxLength 4
|
|
772
|
+
* @pattern ^[0-9]{4}$
|
|
773
|
+
*/
|
|
774
|
+
year?: string;
|
|
775
|
+
}
|
|
776
|
+
/**
|
|
777
|
+
* The type of the originator's wallet.
|
|
778
|
+
*/
|
|
779
|
+
export type DepositTravelRuleOriginatorWalletType = (typeof DepositTravelRuleOriginatorWalletType)[keyof typeof DepositTravelRuleOriginatorWalletType];
|
|
780
|
+
export declare const DepositTravelRuleOriginatorWalletType: {
|
|
781
|
+
/** The originator\'s wallet is held by a custodial service. */
|
|
782
|
+
readonly custodial: "custodial";
|
|
783
|
+
/** The originator\'s wallet is self-custodied. */
|
|
784
|
+
readonly self_custody: "self_custody";
|
|
785
|
+
};
|
|
786
|
+
/**
|
|
787
|
+
* Originator information for a deposit travel rule submission.
|
|
788
|
+
*/
|
|
789
|
+
export interface DepositTravelRuleOriginator {
|
|
790
|
+
/** Full name of the originator. */
|
|
791
|
+
name?: string;
|
|
792
|
+
address?: PhysicalAddress;
|
|
793
|
+
/** The type of the originator's wallet. */
|
|
794
|
+
walletType?: DepositTravelRuleOriginatorWalletType;
|
|
795
|
+
virtualAssetServiceProvider?: DepositTravelRuleVasp;
|
|
796
|
+
/** Government-issued personal identification number for the originator. */
|
|
797
|
+
personalId?: string;
|
|
798
|
+
dateOfBirth?: DateOfBirth;
|
|
799
|
+
}
|
|
800
|
+
/**
|
|
801
|
+
* Beneficiary information for a deposit travel rule submission.
|
|
802
|
+
*/
|
|
803
|
+
export interface DepositTravelRuleBeneficiary {
|
|
804
|
+
/** Full name of the beneficiary. */
|
|
805
|
+
name?: string;
|
|
806
|
+
}
|
|
807
|
+
/**
|
|
808
|
+
* Request body for submitting travel rule information for a deposit transfer. Required fields vary by jurisdiction.
|
|
809
|
+
*/
|
|
810
|
+
export interface DepositTravelRuleRequest {
|
|
811
|
+
originator?: DepositTravelRuleOriginator;
|
|
812
|
+
beneficiary?: DepositTravelRuleBeneficiary;
|
|
813
|
+
/** Indicates whether the user attests that the originating wallet belongs to them. */
|
|
814
|
+
isSelf?: boolean;
|
|
815
|
+
}
|
|
816
|
+
/**
|
|
817
|
+
* Response from submitting travel rule information for a deposit transfer.
|
|
818
|
+
*/
|
|
819
|
+
export interface DepositTravelRuleResponse {
|
|
820
|
+
status: TravelRuleStatus;
|
|
821
|
+
/** List of field paths that are still required to complete travel rule compliance. Each entry is a dot-separated path (e.g., "originator.name", "originator.address.countryCode"). Empty when status is "completed". */
|
|
822
|
+
missingFields?: string[];
|
|
823
|
+
/** Additional context about the current status. Present when status is `incomplete` to explain what needs to be fixed before the transfer can proceed. */
|
|
824
|
+
reason?: string;
|
|
825
|
+
}
|
|
8
826
|
/**
|
|
9
827
|
* The type of authentication information.
|
|
10
828
|
*/
|
|
@@ -19,8 +837,13 @@ export interface EmailAuthentication {
|
|
|
19
837
|
/** The type of authentication information. */
|
|
20
838
|
type: EmailAuthenticationType;
|
|
21
839
|
/** The email address of the end user. */
|
|
22
|
-
email:
|
|
840
|
+
email: Email;
|
|
23
841
|
}
|
|
842
|
+
/**
|
|
843
|
+
* A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
|
|
844
|
+
* @pattern ^\+[1-9]\d{1,14}$
|
|
845
|
+
*/
|
|
846
|
+
export type PhoneNumber = string;
|
|
24
847
|
/**
|
|
25
848
|
* The type of authentication information.
|
|
26
849
|
*/
|
|
@@ -34,11 +857,8 @@ export declare const SmsAuthenticationType: {
|
|
|
34
857
|
export interface SmsAuthentication {
|
|
35
858
|
/** The type of authentication information. */
|
|
36
859
|
type: SmsAuthenticationType;
|
|
37
|
-
/**
|
|
38
|
-
|
|
39
|
-
* @pattern ^\+[1-9]\d{1,14}$
|
|
40
|
-
*/
|
|
41
|
-
phoneNumber: string;
|
|
860
|
+
/** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. */
|
|
861
|
+
phoneNumber: PhoneNumber;
|
|
42
862
|
}
|
|
43
863
|
/**
|
|
44
864
|
* The type of authentication information.
|
|
@@ -101,12 +921,6 @@ export interface TelegramAuthentication {
|
|
|
101
921
|
/** The Telegram user's username. */
|
|
102
922
|
username?: string;
|
|
103
923
|
}
|
|
104
|
-
/**
|
|
105
|
-
* A blockchain address. Format varies by network (e.g., 0x-prefixed for EVM, base58 for Solana).
|
|
106
|
-
* @minLength 1
|
|
107
|
-
* @maxLength 128
|
|
108
|
-
*/
|
|
109
|
-
export type BlockchainAddress = string;
|
|
110
924
|
/**
|
|
111
925
|
* The type of authentication information.
|
|
112
926
|
*/
|
|
@@ -225,110 +1039,11 @@ export interface EndUser {
|
|
|
225
1039
|
* @deprecated
|
|
226
1040
|
*/
|
|
227
1041
|
solanaAccounts: string[];
|
|
228
|
-
/** The list of Solana accounts associated with the end user. End users can have up to 10 Solana accounts. */
|
|
229
|
-
solanaAccountObjects: EndUserSolanaAccount[];
|
|
230
|
-
/** The date and time when the end user was created, in ISO 8601 format. */
|
|
231
|
-
createdAt: string;
|
|
232
|
-
}
|
|
233
|
-
export interface ListResponse {
|
|
234
|
-
/** The token for the next page of items, if any. */
|
|
235
|
-
nextPageToken?: string;
|
|
236
|
-
}
|
|
237
|
-
/**
|
|
238
|
-
* The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.
|
|
239
|
-
*/
|
|
240
|
-
export type ErrorType = (typeof ErrorType)[keyof typeof ErrorType];
|
|
241
|
-
export declare const ErrorType: {
|
|
242
|
-
readonly already_exists: "already_exists";
|
|
243
|
-
readonly authorization_expired: "authorization_expired";
|
|
244
|
-
readonly bad_gateway: "bad_gateway";
|
|
245
|
-
readonly capture_expired: "capture_expired";
|
|
246
|
-
readonly client_closed_request: "client_closed_request";
|
|
247
|
-
readonly faucet_limit_exceeded: "faucet_limit_exceeded";
|
|
248
|
-
readonly forbidden: "forbidden";
|
|
249
|
-
readonly idempotency_error: "idempotency_error";
|
|
250
|
-
readonly internal_server_error: "internal_server_error";
|
|
251
|
-
readonly invalid_request: "invalid_request";
|
|
252
|
-
readonly invalid_sql_query: "invalid_sql_query";
|
|
253
|
-
readonly invalid_signature: "invalid_signature";
|
|
254
|
-
readonly malformed_transaction: "malformed_transaction";
|
|
255
|
-
readonly not_found: "not_found";
|
|
256
|
-
readonly payment_method_required: "payment_method_required";
|
|
257
|
-
readonly payment_required: "payment_required";
|
|
258
|
-
readonly settlement_failed: "settlement_failed";
|
|
259
|
-
readonly rate_limit_exceeded: "rate_limit_exceeded";
|
|
260
|
-
readonly request_canceled: "request_canceled";
|
|
261
|
-
readonly service_unavailable: "service_unavailable";
|
|
262
|
-
readonly timed_out: "timed_out";
|
|
263
|
-
readonly unauthorized: "unauthorized";
|
|
264
|
-
readonly policy_violation: "policy_violation";
|
|
265
|
-
readonly policy_in_use: "policy_in_use";
|
|
266
|
-
readonly account_limit_exceeded: "account_limit_exceeded";
|
|
267
|
-
readonly network_not_tradable: "network_not_tradable";
|
|
268
|
-
readonly guest_permission_denied: "guest_permission_denied";
|
|
269
|
-
readonly guest_region_forbidden: "guest_region_forbidden";
|
|
270
|
-
readonly guest_transaction_limit: "guest_transaction_limit";
|
|
271
|
-
readonly guest_transaction_count: "guest_transaction_count";
|
|
272
|
-
readonly phone_number_verification_expired: "phone_number_verification_expired";
|
|
273
|
-
readonly document_verification_failed: "document_verification_failed";
|
|
274
|
-
readonly recipient_allowlist_violation: "recipient_allowlist_violation";
|
|
275
|
-
readonly recipient_allowlist_pending: "recipient_allowlist_pending";
|
|
276
|
-
readonly refund_expired: "refund_expired";
|
|
277
|
-
readonly travel_rules_recipient_violation: "travel_rules_recipient_violation";
|
|
278
|
-
readonly source_account_invalid: "source_account_invalid";
|
|
279
|
-
readonly target_account_invalid: "target_account_invalid";
|
|
280
|
-
readonly source_account_not_found: "source_account_not_found";
|
|
281
|
-
readonly target_account_not_found: "target_account_not_found";
|
|
282
|
-
readonly source_asset_not_supported: "source_asset_not_supported";
|
|
283
|
-
readonly target_asset_not_supported: "target_asset_not_supported";
|
|
284
|
-
readonly target_email_invalid: "target_email_invalid";
|
|
285
|
-
readonly target_onchain_address_invalid: "target_onchain_address_invalid";
|
|
286
|
-
readonly transfer_amount_invalid: "transfer_amount_invalid";
|
|
287
|
-
readonly transfer_asset_not_supported: "transfer_asset_not_supported";
|
|
288
|
-
readonly insufficient_balance: "insufficient_balance";
|
|
289
|
-
readonly metadata_too_many_entries: "metadata_too_many_entries";
|
|
290
|
-
readonly metadata_key_too_long: "metadata_key_too_long";
|
|
291
|
-
readonly metadata_value_too_long: "metadata_value_too_long";
|
|
292
|
-
readonly travel_rules_field_missing: "travel_rules_field_missing";
|
|
293
|
-
readonly asset_mismatch: "asset_mismatch";
|
|
294
|
-
readonly mfa_already_enrolled: "mfa_already_enrolled";
|
|
295
|
-
readonly mfa_invalid_code: "mfa_invalid_code";
|
|
296
|
-
readonly mfa_flow_expired: "mfa_flow_expired";
|
|
297
|
-
readonly mfa_required: "mfa_required";
|
|
298
|
-
readonly mfa_not_enrolled: "mfa_not_enrolled";
|
|
299
|
-
readonly order_quote_expired: "order_quote_expired";
|
|
300
|
-
readonly order_already_filled: "order_already_filled";
|
|
301
|
-
readonly order_already_canceled: "order_already_canceled";
|
|
302
|
-
readonly account_not_ready: "account_not_ready";
|
|
303
|
-
readonly insufficient_liquidity: "insufficient_liquidity";
|
|
304
|
-
readonly insufficient_allowance: "insufficient_allowance";
|
|
305
|
-
readonly transaction_simulation_failed: "transaction_simulation_failed";
|
|
306
|
-
};
|
|
307
|
-
/**
|
|
308
|
-
* A valid HTTP or HTTPS URL.
|
|
309
|
-
* @minLength 11
|
|
310
|
-
* @maxLength 2048
|
|
311
|
-
* @pattern ^https?://.*$
|
|
312
|
-
*/
|
|
313
|
-
export type Url = string;
|
|
314
|
-
/**
|
|
315
|
-
* An error response including the code for the type of error and a human-readable message describing the error.
|
|
316
|
-
*/
|
|
317
|
-
export interface Error {
|
|
318
|
-
errorType: ErrorType;
|
|
319
|
-
/** The error message. */
|
|
320
|
-
errorMessage: string;
|
|
321
|
-
/** A unique identifier for the request that generated the error. This can be used to help debug issues with the API. */
|
|
322
|
-
correlationId?: string;
|
|
323
|
-
/** A link to the corresponding error documentation. */
|
|
324
|
-
errorLink?: Url;
|
|
1042
|
+
/** The list of Solana accounts associated with the end user. End users can have up to 10 Solana accounts. */
|
|
1043
|
+
solanaAccountObjects: EndUserSolanaAccount[];
|
|
1044
|
+
/** The date and time when the end user was created, in ISO 8601 format. */
|
|
1045
|
+
createdAt: string;
|
|
325
1046
|
}
|
|
326
|
-
/**
|
|
327
|
-
* The symbol of the asset (e.g., eth, usd, usdc, usdt).
|
|
328
|
-
* @minLength 1
|
|
329
|
-
* @maxLength 42
|
|
330
|
-
*/
|
|
331
|
-
export type Asset = string;
|
|
332
1047
|
/**
|
|
333
1048
|
* The domain of the EIP-712 typed data.
|
|
334
1049
|
*/
|
|
@@ -1968,7 +2683,7 @@ export interface PrepareUserOperationRule {
|
|
|
1968
2683
|
operation: PrepareUserOperationRuleOperation;
|
|
1969
2684
|
criteria: PrepareUserOperationCriteria;
|
|
1970
2685
|
}
|
|
1971
|
-
export type SendUserOperationCriteriaItem = EthValueCriterion | EvmAddressCriterion | EvmDataCriterion | NetUSDChangeCriterion;
|
|
2686
|
+
export type SendUserOperationCriteriaItem = EthValueCriterion | EvmAddressCriterion | EvmNetworkCriterion | EvmDataCriterion | NetUSDChangeCriterion;
|
|
1972
2687
|
/**
|
|
1973
2688
|
* A schema for specifying criteria for the SendUserOperation operation.
|
|
1974
2689
|
*/
|
|
@@ -2257,6 +2972,33 @@ export interface SendEndUserSolAssetRule {
|
|
|
2257
2972
|
operation: SendEndUserSolAssetRuleOperation;
|
|
2258
2973
|
criteria: SendEndUserSolAssetCriteria;
|
|
2259
2974
|
}
|
|
2975
|
+
export type SendEndUserOperationCriteriaItem = EthValueCriterion | EvmAddressCriterion | EvmNetworkCriterion | EvmDataCriterion | NetUSDChangeCriterion;
|
|
2976
|
+
/**
|
|
2977
|
+
* A schema for specifying criteria for the sendEndUserOperation operation.
|
|
2978
|
+
*/
|
|
2979
|
+
export type SendEndUserOperationCriteria = SendEndUserOperationCriteriaItem[];
|
|
2980
|
+
/**
|
|
2981
|
+
* Whether matching the rule will cause the request to be rejected or accepted.
|
|
2982
|
+
*/
|
|
2983
|
+
export type SendEndUserOperationRuleAction = (typeof SendEndUserOperationRuleAction)[keyof typeof SendEndUserOperationRuleAction];
|
|
2984
|
+
export declare const SendEndUserOperationRuleAction: {
|
|
2985
|
+
readonly reject: "reject";
|
|
2986
|
+
readonly accept: "accept";
|
|
2987
|
+
};
|
|
2988
|
+
/**
|
|
2989
|
+
* The operation to which the rule applies. Every element of the `criteria` array must match the specified operation.
|
|
2990
|
+
*/
|
|
2991
|
+
export type SendEndUserOperationRuleOperation = (typeof SendEndUserOperationRuleOperation)[keyof typeof SendEndUserOperationRuleOperation];
|
|
2992
|
+
export declare const SendEndUserOperationRuleOperation: {
|
|
2993
|
+
readonly sendEndUserOperation: "sendEndUserOperation";
|
|
2994
|
+
};
|
|
2995
|
+
export interface SendEndUserOperationRule {
|
|
2996
|
+
/** Whether matching the rule will cause the request to be rejected or accepted. */
|
|
2997
|
+
action: SendEndUserOperationRuleAction;
|
|
2998
|
+
/** The operation to which the rule applies. Every element of the `criteria` array must match the specified operation. */
|
|
2999
|
+
operation: SendEndUserOperationRuleOperation;
|
|
3000
|
+
criteria: SendEndUserOperationCriteria;
|
|
3001
|
+
}
|
|
2260
3002
|
export type CreateEndUserEvmSwapCriteriaItem = EvmNetworkCriterion | EvmDataCriterion | NetUSDChangeCriterion;
|
|
2261
3003
|
/**
|
|
2262
3004
|
* A schema for specifying criteria for the createEndUserEvmSwap operation.
|
|
@@ -2287,7 +3029,7 @@ export interface CreateEndUserEvmSwapRule {
|
|
|
2287
3029
|
/**
|
|
2288
3030
|
* A rule that limits the behavior of an account.
|
|
2289
3031
|
*/
|
|
2290
|
-
export type Rule = SignEvmTransactionRule | SendEvmTransactionRule | SignEvmMessageRule | SignEvmTypedDataRule | SignSolTransactionRule | SendSolTransactionRule | SignSolMessageRule | SignEvmHashRule | PrepareUserOperationRule | SendUserOperationRule | SignEndUserEvmTransactionRule | SendEndUserEvmTransactionRule | SignEndUserEvmMessageRule | SignEndUserEvmTypedDataRule | SignEndUserEvmHashRule | SignEndUserSolTransactionRule | SendEndUserSolTransactionRule | SignEndUserSolMessageRule | SendEndUserEvmAssetRule | SendEndUserSolAssetRule | CreateEndUserEvmSwapRule;
|
|
3032
|
+
export type Rule = SignEvmTransactionRule | SendEvmTransactionRule | SignEvmMessageRule | SignEvmTypedDataRule | SignSolTransactionRule | SendSolTransactionRule | SignSolMessageRule | SignEvmHashRule | PrepareUserOperationRule | SendUserOperationRule | SignEndUserEvmTransactionRule | SendEndUserEvmTransactionRule | SignEndUserEvmMessageRule | SignEndUserEvmTypedDataRule | SignEndUserEvmHashRule | SignEndUserSolTransactionRule | SendEndUserSolTransactionRule | SignEndUserSolMessageRule | SendEndUserEvmAssetRule | SendEndUserSolAssetRule | SendEndUserOperationRule | CreateEndUserEvmSwapRule;
|
|
2291
3033
|
/**
|
|
2292
3034
|
* The scope of the policy. Only one project-level policy can exist at any time.
|
|
2293
3035
|
*/
|
|
@@ -2537,12 +3279,6 @@ export interface AccountTokenAddressesResponse {
|
|
|
2537
3279
|
*/
|
|
2538
3280
|
totalCount?: number;
|
|
2539
3281
|
}
|
|
2540
|
-
/**
|
|
2541
|
-
* Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.
|
|
2542
|
-
*/
|
|
2543
|
-
export interface Metadata {
|
|
2544
|
-
[key: string]: string;
|
|
2545
|
-
}
|
|
2546
3282
|
/**
|
|
2547
3283
|
* Additional headers to include in webhook requests.
|
|
2548
3284
|
*/
|
|
@@ -2862,12 +3598,331 @@ export interface X402ExactSolanaPayload {
|
|
|
2862
3598
|
transaction: string;
|
|
2863
3599
|
}
|
|
2864
3600
|
/**
|
|
2865
|
-
* The
|
|
3601
|
+
* The token permissions for the transfer.
|
|
3602
|
+
*/
|
|
3603
|
+
export type X402UptoEvmPermit2PayloadPermit2AuthorizationPermitted = {
|
|
3604
|
+
/**
|
|
3605
|
+
* The 0x-prefixed, checksum EVM address of the token to transfer.
|
|
3606
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3607
|
+
*/
|
|
3608
|
+
token: string;
|
|
3609
|
+
/** The maximum amount the client authorizes to transfer in atomic units. */
|
|
3610
|
+
amount: string;
|
|
3611
|
+
};
|
|
3612
|
+
/**
|
|
3613
|
+
* The witness data containing payment details. Includes a `facilitator` field to bind the authorization to a specific facilitator address.
|
|
3614
|
+
*/
|
|
3615
|
+
export type X402UptoEvmPermit2PayloadPermit2AuthorizationWitness = {
|
|
3616
|
+
/**
|
|
3617
|
+
* The 0x-prefixed, checksum EVM address of the recipient.
|
|
3618
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3619
|
+
*/
|
|
3620
|
+
to: string;
|
|
3621
|
+
/**
|
|
3622
|
+
* The 0x-prefixed, checksum EVM address of the facilitator authorized to settle this payment. MUST match the `facilitatorAddress` advertised in the payment requirements `extra` field.
|
|
3623
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3624
|
+
*/
|
|
3625
|
+
facilitator: string;
|
|
3626
|
+
/** The unix timestamp after which the payment is valid. */
|
|
3627
|
+
validAfter: string;
|
|
3628
|
+
};
|
|
3629
|
+
/**
|
|
3630
|
+
* The authorization data for the Permit2 PermitWitnessTransferFrom message. The `permitted.amount` is the maximum the client authorizes; the actual settled amount is decided by the resource server at settle time and MUST be less than or equal to it.
|
|
3631
|
+
*/
|
|
3632
|
+
export type X402UptoEvmPermit2PayloadPermit2Authorization = {
|
|
3633
|
+
/**
|
|
3634
|
+
* The 0x-prefixed, checksum EVM address of the sender of the payment.
|
|
3635
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3636
|
+
*/
|
|
3637
|
+
from: string;
|
|
3638
|
+
/** The token permissions for the transfer. */
|
|
3639
|
+
permitted: X402UptoEvmPermit2PayloadPermit2AuthorizationPermitted;
|
|
3640
|
+
/**
|
|
3641
|
+
* The 0x-prefixed, checksum EVM address of the spender (the x402 Upto Permit2 proxy contract).
|
|
3642
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3643
|
+
*/
|
|
3644
|
+
spender: string;
|
|
3645
|
+
/**
|
|
3646
|
+
* The Permit2 nonce as a decimal string (uint256).
|
|
3647
|
+
* @pattern ^[0-9]+$
|
|
3648
|
+
*/
|
|
3649
|
+
nonce: string;
|
|
3650
|
+
/** The unix timestamp before which the permit is valid. */
|
|
3651
|
+
deadline: string;
|
|
3652
|
+
/** The witness data containing payment details. Includes a `facilitator` field to bind the authorization to a specific facilitator address. */
|
|
3653
|
+
witness: X402UptoEvmPermit2PayloadPermit2AuthorizationWitness;
|
|
3654
|
+
};
|
|
3655
|
+
/**
|
|
3656
|
+
* The x402 protocol upto scheme payload for EVM networks using Permit2. The `upto` scheme authorizes a maximum amount and lets the facilitator settle for the actual amount used. Structurally identical to `x402ExactEvmPermit2Payload` except `permit2Authorization.witness` carries an additional `facilitator` address that binds the authorization to a specific facilitator (the one announced via `extra.facilitatorAddress` in the payment requirements). For more details, see [EVM Upto Scheme Details](https://github.com/x402-foundation/x402/blob/main/specs/schemes/upto/scheme_upto_evm.md).
|
|
3657
|
+
*/
|
|
3658
|
+
export interface X402UptoEvmPermit2Payload {
|
|
3659
|
+
/**
|
|
3660
|
+
* The EIP-712 hex-encoded signature of the Permit2 PermitWitnessTransferFrom message. Smart account signatures may be longer than 65 bytes.
|
|
3661
|
+
* @pattern ^0x[0-9a-fA-F]{130,}$
|
|
3662
|
+
*/
|
|
3663
|
+
signature: string;
|
|
3664
|
+
/** The authorization data for the Permit2 PermitWitnessTransferFrom message. The `permitted.amount` is the maximum the client authorizes; the actual settled amount is decided by the resource server at settle time and MUST be less than or equal to it. */
|
|
3665
|
+
permit2Authorization: X402UptoEvmPermit2PayloadPermit2Authorization;
|
|
3666
|
+
}
|
|
3667
|
+
/**
|
|
3668
|
+
* Immutable configuration for an x402 batch-settlement payment channel. The EIP-712 hash of this struct produces the `channelId` used by all batch-settlement payloads.
|
|
3669
|
+
*/
|
|
3670
|
+
export interface X402BatchSettlementChannelConfig {
|
|
3671
|
+
/**
|
|
3672
|
+
* The 0x-prefixed, checksum EVM address of the payer (channel funder).
|
|
3673
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3674
|
+
*/
|
|
3675
|
+
payer: string;
|
|
3676
|
+
/**
|
|
3677
|
+
* The 0x-prefixed, checksum EVM address authorized to sign vouchers on behalf of the payer.
|
|
3678
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3679
|
+
*/
|
|
3680
|
+
payerAuthorizer: string;
|
|
3681
|
+
/**
|
|
3682
|
+
* The 0x-prefixed, checksum EVM address of the receiver (resource server / merchant).
|
|
3683
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3684
|
+
*/
|
|
3685
|
+
receiver: string;
|
|
3686
|
+
/**
|
|
3687
|
+
* The 0x-prefixed, checksum EVM address authorized to sign claim batches on behalf of the receiver (typically the facilitator).
|
|
3688
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3689
|
+
*/
|
|
3690
|
+
receiverAuthorizer: string;
|
|
3691
|
+
/**
|
|
3692
|
+
* The 0x-prefixed, checksum EVM address of the ERC-20 payment token.
|
|
3693
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3694
|
+
*/
|
|
3695
|
+
token: string;
|
|
3696
|
+
/**
|
|
3697
|
+
* The non-cooperative withdraw delay in seconds. Must be between 900 (15 minutes) and 2,592,000 (30 days).
|
|
3698
|
+
* @minimum 900
|
|
3699
|
+
* @maximum 2592000
|
|
3700
|
+
*/
|
|
3701
|
+
withdrawDelay: number;
|
|
3702
|
+
/**
|
|
3703
|
+
* A 32-byte salt used to differentiate channels between the same payer/receiver pair.
|
|
3704
|
+
* @pattern ^0x[0-9a-fA-F]{64}$
|
|
3705
|
+
*/
|
|
3706
|
+
salt: string;
|
|
3707
|
+
}
|
|
3708
|
+
/**
|
|
3709
|
+
* A signed cumulative-ceiling voucher for an x402 batch-settlement channel. `maxClaimableAmount` is monotonically increasing across requests in the same channel; the receiver may claim any amount up to this ceiling.
|
|
3710
|
+
*/
|
|
3711
|
+
export interface X402BatchSettlementVoucher {
|
|
3712
|
+
/**
|
|
3713
|
+
* The 32-byte EIP-712 hash of the `channelConfig` for this voucher's channel.
|
|
3714
|
+
* @pattern ^0x[0-9a-fA-F]{64}$
|
|
3715
|
+
*/
|
|
3716
|
+
channelId: string;
|
|
3717
|
+
/**
|
|
3718
|
+
* The cumulative maximum amount (uint128 as decimal string) the receiver is authorized to claim from this channel as of this voucher.
|
|
3719
|
+
* @pattern ^[0-9]+$
|
|
3720
|
+
*/
|
|
3721
|
+
maxClaimableAmount: string;
|
|
3722
|
+
/**
|
|
3723
|
+
* The EIP-712 hex-encoded signature of the voucher by `payerAuthorizer`.
|
|
3724
|
+
* @pattern ^0x[0-9a-fA-F]+$
|
|
3725
|
+
*/
|
|
3726
|
+
signature: string;
|
|
3727
|
+
}
|
|
3728
|
+
export type X402BatchSettlementDepositPayloadType = (typeof X402BatchSettlementDepositPayloadType)[keyof typeof X402BatchSettlementDepositPayloadType];
|
|
3729
|
+
export declare const X402BatchSettlementDepositPayloadType: {
|
|
3730
|
+
readonly deposit: "deposit";
|
|
3731
|
+
};
|
|
3732
|
+
/**
|
|
3733
|
+
* An ERC-3009 receiveWithAuthorization message authorizing the channel-funding transfer.
|
|
3734
|
+
*/
|
|
3735
|
+
export type X402BatchSettlementDepositPayloadDepositAuthorizationErc3009Authorization = {
|
|
3736
|
+
/** The unix timestamp after which the authorization is valid. */
|
|
3737
|
+
validAfter: string;
|
|
3738
|
+
/** The unix timestamp before which the authorization is valid. */
|
|
3739
|
+
validBefore: string;
|
|
3740
|
+
/**
|
|
3741
|
+
* The 32-byte ERC-3009 nonce/salt for replay protection.
|
|
3742
|
+
* @pattern ^0x[0-9a-fA-F]{64}$
|
|
3743
|
+
*/
|
|
3744
|
+
salt: string;
|
|
3745
|
+
/**
|
|
3746
|
+
* The EIP-712 hex-encoded signature of the ERC-3009 authorization.
|
|
3747
|
+
* @pattern ^0x[0-9a-fA-F]+$
|
|
3748
|
+
*/
|
|
3749
|
+
signature: string;
|
|
3750
|
+
};
|
|
3751
|
+
/**
|
|
3752
|
+
* The asset-transfer authorization for the deposit. Currently only ERC-3009 is supported.
|
|
3753
|
+
*/
|
|
3754
|
+
export type X402BatchSettlementDepositPayloadDepositAuthorization = {
|
|
3755
|
+
/** An ERC-3009 receiveWithAuthorization message authorizing the channel-funding transfer. */
|
|
3756
|
+
erc3009Authorization?: X402BatchSettlementDepositPayloadDepositAuthorizationErc3009Authorization;
|
|
3757
|
+
};
|
|
3758
|
+
/**
|
|
3759
|
+
* The deposit amount and asset-transfer authorization that funds the channel.
|
|
3760
|
+
*/
|
|
3761
|
+
export type X402BatchSettlementDepositPayloadDeposit = {
|
|
3762
|
+
/**
|
|
3763
|
+
* The deposit amount in atomic units of `channelConfig.token`.
|
|
3764
|
+
* @pattern ^[0-9]+$
|
|
3765
|
+
*/
|
|
3766
|
+
amount: string;
|
|
3767
|
+
/** The asset-transfer authorization for the deposit. Currently only ERC-3009 is supported. */
|
|
3768
|
+
authorization: X402BatchSettlementDepositPayloadDepositAuthorization;
|
|
3769
|
+
};
|
|
3770
|
+
/**
|
|
3771
|
+
* Sent on the first request to fund a channel via an ERC-3009 receiveWithAuthorization deposit.
|
|
3772
|
+
*/
|
|
3773
|
+
export interface X402BatchSettlementDepositPayload {
|
|
3774
|
+
type: X402BatchSettlementDepositPayloadType;
|
|
3775
|
+
channelConfig: X402BatchSettlementChannelConfig;
|
|
3776
|
+
voucher: X402BatchSettlementVoucher;
|
|
3777
|
+
/** The deposit amount and asset-transfer authorization that funds the channel. */
|
|
3778
|
+
deposit: X402BatchSettlementDepositPayloadDeposit;
|
|
3779
|
+
}
|
|
3780
|
+
export type X402BatchSettlementVoucherPayloadType = (typeof X402BatchSettlementVoucherPayloadType)[keyof typeof X402BatchSettlementVoucherPayloadType];
|
|
3781
|
+
export declare const X402BatchSettlementVoucherPayloadType: {
|
|
3782
|
+
readonly voucher: "voucher";
|
|
3783
|
+
};
|
|
3784
|
+
/**
|
|
3785
|
+
* Sent on subsequent requests against an already-funded channel; carries only the latest cumulative voucher.
|
|
3786
|
+
*/
|
|
3787
|
+
export interface X402BatchSettlementVoucherPayload {
|
|
3788
|
+
type: X402BatchSettlementVoucherPayloadType;
|
|
3789
|
+
channelConfig: X402BatchSettlementChannelConfig;
|
|
3790
|
+
voucher: X402BatchSettlementVoucher;
|
|
3791
|
+
}
|
|
3792
|
+
/**
|
|
3793
|
+
* The voucher to claim, identified by the channel config it was signed against and its cumulative ceiling. Field shape mirrors the on-chain claim struct.
|
|
3794
|
+
*/
|
|
3795
|
+
export type X402BatchSettlementClaimVoucher = {
|
|
3796
|
+
channel: X402BatchSettlementChannelConfig;
|
|
3797
|
+
/**
|
|
3798
|
+
* The cumulative maximum claimable amount (uint128 as decimal string) signed by the payer authorizer.
|
|
3799
|
+
* @pattern ^[0-9]+$
|
|
3800
|
+
*/
|
|
3801
|
+
maxClaimableAmount: string;
|
|
3802
|
+
};
|
|
3803
|
+
/**
|
|
3804
|
+
* A single voucher claim within a batched on-chain claim transaction. Used by `x402BatchSettlementClaimPayload.claims` and by the server-enriched shape of `x402BatchSettlementRefundPayload.claims`.
|
|
3805
|
+
NOTE: the nested `voucher` here has a **different shape** from the top-level `x402BatchSettlementVoucher` schema. The top-level voucher is the signed cumulative-ceiling message sent by a client (`{channelId, maxClaimableAmount, signature}`). This nested `voucher` mirrors the on-chain claim struct (`{channel: ChannelConfig, maxClaimableAmount}`) that participates in the EIP-712 hash, with `signature` and `totalClaimed` as siblings rather than nested fields. The field names match the upstream x402 protocol and the on-chain Solidity struct; they cannot be renamed without breaking wire and EIP-712 compatibility.
|
|
3806
|
+
*/
|
|
3807
|
+
export interface X402BatchSettlementClaim {
|
|
3808
|
+
/** The voucher to claim, identified by the channel config it was signed against and its cumulative ceiling. Field shape mirrors the on-chain claim struct. */
|
|
3809
|
+
voucher: X402BatchSettlementClaimVoucher;
|
|
3810
|
+
/**
|
|
3811
|
+
* The voucher signature from `payerAuthorizer`.
|
|
3812
|
+
* @pattern ^0x[0-9a-fA-F]+$
|
|
3813
|
+
*/
|
|
3814
|
+
signature: string;
|
|
3815
|
+
/**
|
|
3816
|
+
* The cumulative amount already claimed from this channel as of this claim.
|
|
3817
|
+
* @pattern ^[0-9]+$
|
|
3818
|
+
*/
|
|
3819
|
+
totalClaimed: string;
|
|
3820
|
+
}
|
|
3821
|
+
export type X402BatchSettlementRefundPayloadType = (typeof X402BatchSettlementRefundPayloadType)[keyof typeof X402BatchSettlementRefundPayloadType];
|
|
3822
|
+
export declare const X402BatchSettlementRefundPayloadType: {
|
|
3823
|
+
readonly refund: "refund";
|
|
3824
|
+
};
|
|
3825
|
+
/**
|
|
3826
|
+
* A cooperative refund request. The client emits the minimal shape (just `channelConfig` and `voucher`, with an optional `amount`). A mediating server enriches the payload with `amount`, `refundNonce`, and `claims` before forwarding to the facilitator. Authorizer signatures are optional — the facilitator auto-signs when absent. Field presence determines which shape was sent; the facilitator dispatches accordingly.
|
|
3827
|
+
*/
|
|
3828
|
+
export interface X402BatchSettlementRefundPayload {
|
|
3829
|
+
type: X402BatchSettlementRefundPayloadType;
|
|
3830
|
+
channelConfig: X402BatchSettlementChannelConfig;
|
|
3831
|
+
voucher: X402BatchSettlementVoucher;
|
|
3832
|
+
/**
|
|
3833
|
+
* The refund amount in atomic units of `channelConfig.token`. Optional in the client-emitted shape (defaults to the full remaining channel balance). Required when the payload is enriched by a mediating server.
|
|
3834
|
+
* @pattern ^[0-9]+$
|
|
3835
|
+
*/
|
|
3836
|
+
amount?: string;
|
|
3837
|
+
/**
|
|
3838
|
+
* The on-chain refund nonce for replay protection (uint256 as decimal string). Only present on the server-enriched shape.
|
|
3839
|
+
* @pattern ^[0-9]+$
|
|
3840
|
+
*/
|
|
3841
|
+
refundNonce?: string;
|
|
3842
|
+
/** Voucher claims to include atomically with the refund. Only present on the server-enriched shape. */
|
|
3843
|
+
claims?: X402BatchSettlementClaim[];
|
|
3844
|
+
/**
|
|
3845
|
+
* Optional EIP-712 signature from the receiver authorizer over the refund. When omitted, the facilitator auto-signs.
|
|
3846
|
+
* @pattern ^0x[0-9a-fA-F]+$
|
|
3847
|
+
*/
|
|
3848
|
+
refundAuthorizerSignature?: string;
|
|
3849
|
+
/**
|
|
3850
|
+
* Optional EIP-712 signature from the receiver authorizer over the included claims. When omitted, the facilitator auto-signs.
|
|
3851
|
+
* @pattern ^0x[0-9a-fA-F]+$
|
|
3852
|
+
*/
|
|
3853
|
+
claimAuthorizerSignature?: string;
|
|
3854
|
+
}
|
|
3855
|
+
export type X402BatchSettlementClaimPayloadType = (typeof X402BatchSettlementClaimPayloadType)[keyof typeof X402BatchSettlementClaimPayloadType];
|
|
3856
|
+
export declare const X402BatchSettlementClaimPayloadType: {
|
|
3857
|
+
readonly claim: "claim";
|
|
3858
|
+
};
|
|
3859
|
+
/**
|
|
3860
|
+
* Server-to-facilitator request to batch on-chain claims of accumulated vouchers. `claimAuthorizerSignature` is optional; when absent the facilitator auto-signs with its receiver-authorizer key.
|
|
3861
|
+
*/
|
|
3862
|
+
export interface X402BatchSettlementClaimPayload {
|
|
3863
|
+
type: X402BatchSettlementClaimPayloadType;
|
|
3864
|
+
/** The list of voucher claims to batch in a single on-chain `claim` call. */
|
|
3865
|
+
claims: X402BatchSettlementClaim[];
|
|
3866
|
+
/**
|
|
3867
|
+
* Optional EIP-712 signature from the receiver authorizer over the claim batch. When omitted, the facilitator auto-signs.
|
|
3868
|
+
* @pattern ^0x[0-9a-fA-F]+$
|
|
3869
|
+
*/
|
|
3870
|
+
claimAuthorizerSignature?: string;
|
|
3871
|
+
}
|
|
3872
|
+
export type X402BatchSettlementSettlePayloadType = (typeof X402BatchSettlementSettlePayloadType)[keyof typeof X402BatchSettlementSettlePayloadType];
|
|
3873
|
+
export declare const X402BatchSettlementSettlePayloadType: {
|
|
3874
|
+
readonly settle: "settle";
|
|
3875
|
+
};
|
|
3876
|
+
/**
|
|
3877
|
+
* Server-to-facilitator request to transfer claimed funds for a `(receiver, token)` pair to the receiver wallet.
|
|
3878
|
+
*/
|
|
3879
|
+
export interface X402BatchSettlementSettlePayload {
|
|
3880
|
+
type: X402BatchSettlementSettlePayloadType;
|
|
3881
|
+
/**
|
|
3882
|
+
* The 0x-prefixed, checksum EVM address of the receiver to settle to.
|
|
3883
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3884
|
+
*/
|
|
3885
|
+
receiver: string;
|
|
3886
|
+
/**
|
|
3887
|
+
* The 0x-prefixed, checksum EVM address of the token to settle.
|
|
3888
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
3889
|
+
*/
|
|
3890
|
+
token: string;
|
|
3891
|
+
}
|
|
3892
|
+
/**
|
|
3893
|
+
* The x402 protocol batch-settlement scheme payload for EVM networks. The `batch-settlement` scheme uses pre-funded payment channels with off-chain cumulative-ceiling vouchers, allowing servers to batch-claim accumulated value in a single on-chain transaction. The payload is a discriminated union on the `type` field with five variants:
|
|
3894
|
+
|
|
3895
|
+
- `deposit`: client-initiated channel funding via ERC-3009.
|
|
3896
|
+
- `voucher`: client-side cumulative voucher against an already-funded channel.
|
|
3897
|
+
- `refund`: cooperative refund request. The client emits a minimal shape (just channelConfig + voucher, with an optional `amount`); a mediating server enriches it with `amount`, `refundNonce`, and `claims` before forwarding to the facilitator. Authorizer signatures are optional — the facilitator auto-signs when absent.
|
|
3898
|
+
- `claim`: server-to-facilitator request to batch on-chain voucher claims.
|
|
3899
|
+
- `settle`: server-to-facilitator request to transfer claimed funds to the receiver.
|
|
3900
|
+
|
|
3901
|
+
For more details, see [batch-settlement specs](https://github.com/x402-foundation/x402/tree/main/specs/schemes/batch-settlement).
|
|
3902
|
+
*/
|
|
3903
|
+
export type X402BatchSettlementEvmPayload = X402BatchSettlementDepositPayload | X402BatchSettlementVoucherPayload | X402BatchSettlementRefundPayload | X402BatchSettlementClaimPayload | X402BatchSettlementSettlePayload;
|
|
3904
|
+
/**
|
|
3905
|
+
* The x402 v2 network identifier in CAIP-2 format. x402 v2 identifies networks by their CAIP-2 chain ID (e.g. `eip155:<chainId>` for EVM networks, `solana:<genesisHash>` for Solana). Supported networks: Base, Polygon, Arbitrum One, World Chain (EVM), and Solana.
|
|
3906
|
+
*/
|
|
3907
|
+
export type X402V2Network = (typeof X402V2Network)[keyof typeof X402V2Network];
|
|
3908
|
+
export declare const X402V2Network: {
|
|
3909
|
+
readonly "eip155:8453": "eip155:8453";
|
|
3910
|
+
readonly "eip155:84532": "eip155:84532";
|
|
3911
|
+
readonly "eip155:137": "eip155:137";
|
|
3912
|
+
readonly "eip155:42161": "eip155:42161";
|
|
3913
|
+
readonly "eip155:480": "eip155:480";
|
|
3914
|
+
readonly "eip155:4801": "eip155:4801";
|
|
3915
|
+
readonly "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp";
|
|
3916
|
+
readonly "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1": "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1";
|
|
3917
|
+
};
|
|
3918
|
+
/**
|
|
3919
|
+
* The scheme of the payment protocol to use. Supported schemes are `exact`, `upto`, and `batch-settlement`.
|
|
2866
3920
|
*/
|
|
2867
3921
|
export type X402V2PaymentRequirementsScheme = (typeof X402V2PaymentRequirementsScheme)[keyof typeof X402V2PaymentRequirementsScheme];
|
|
2868
3922
|
export declare const X402V2PaymentRequirementsScheme: {
|
|
2869
3923
|
readonly exact: "exact";
|
|
2870
3924
|
readonly upto: "upto";
|
|
3925
|
+
readonly "batch-settlement": "batch-settlement";
|
|
2871
3926
|
};
|
|
2872
3927
|
/**
|
|
2873
3928
|
* The optional additional scheme-specific payment info.
|
|
@@ -2876,33 +3931,27 @@ export type X402V2PaymentRequirementsExtra = {
|
|
|
2876
3931
|
[key: string]: unknown;
|
|
2877
3932
|
};
|
|
2878
3933
|
/**
|
|
2879
|
-
* The x402
|
|
3934
|
+
* 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`).
|
|
2880
3935
|
*/
|
|
2881
3936
|
export interface X402V2PaymentRequirements {
|
|
2882
|
-
/** The scheme of the payment protocol to use. Supported schemes are `exact` and `
|
|
3937
|
+
/** The scheme of the payment protocol to use. Supported schemes are `exact`, `upto`, and `batch-settlement`. */
|
|
2883
3938
|
scheme: X402V2PaymentRequirementsScheme;
|
|
2884
|
-
/** The network of the blockchain to send payment on in
|
|
2885
|
-
network:
|
|
2886
|
-
/**
|
|
2887
|
-
* The asset to pay with.
|
|
3939
|
+
/** The network of the blockchain to send payment on in CAIP-2 format. */
|
|
3940
|
+
network: X402V2Network;
|
|
3941
|
+
/** The asset to pay with.
|
|
2888
3942
|
|
|
2889
3943
|
For EVM networks, the asset will be a 0x-prefixed, checksum EVM address.
|
|
2890
3944
|
|
|
2891
|
-
For Solana-based networks, the asset will be a base58-encoded Solana address.
|
|
2892
|
-
|
|
2893
|
-
*/
|
|
2894
|
-
asset: string;
|
|
3945
|
+
For Solana-based networks, the asset will be a base58-encoded Solana address. */
|
|
3946
|
+
asset: BlockchainAddress;
|
|
2895
3947
|
/** The amount to pay for the resource in atomic units of the payment asset. */
|
|
2896
3948
|
amount: string;
|
|
2897
|
-
/**
|
|
2898
|
-
* The destination to pay value to.
|
|
3949
|
+
/** The destination to pay value to.
|
|
2899
3950
|
|
|
2900
3951
|
For EVM networks, payTo will be a 0x-prefixed, checksum EVM address.
|
|
2901
3952
|
|
|
2902
|
-
For Solana-based networks, payTo will be a base58-encoded Solana address.
|
|
2903
|
-
|
|
2904
|
-
*/
|
|
2905
|
-
payTo: string;
|
|
3953
|
+
For Solana-based networks, payTo will be a base58-encoded Solana address. */
|
|
3954
|
+
payTo: BlockchainAddress;
|
|
2906
3955
|
/** The maximum time in seconds for the resource server to respond. */
|
|
2907
3956
|
maxTimeoutSeconds: number;
|
|
2908
3957
|
/** The optional additional scheme-specific payment info. */
|
|
@@ -2920,9 +3969,9 @@ export interface X402ResourceInfo {
|
|
|
2920
3969
|
mimeType?: string;
|
|
2921
3970
|
}
|
|
2922
3971
|
/**
|
|
2923
|
-
* The payload of the payment depending on the x402Version, scheme, and network.
|
|
3972
|
+
* 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.
|
|
2924
3973
|
*/
|
|
2925
|
-
export type X402V2PaymentPayloadPayload = X402ExactEvmPayload | X402ExactEvmPermit2Payload | X402ExactSolanaPayload;
|
|
3974
|
+
export type X402V2PaymentPayloadPayload = X402ExactEvmPayload | X402ExactEvmPermit2Payload | X402ExactSolanaPayload | X402UptoEvmPermit2Payload | X402BatchSettlementEvmPayload;
|
|
2926
3975
|
/**
|
|
2927
3976
|
* Optional protocol extensions.
|
|
2928
3977
|
*/
|
|
@@ -2930,17 +3979,28 @@ export type X402V2PaymentPayloadExtensions = {
|
|
|
2930
3979
|
[key: string]: unknown;
|
|
2931
3980
|
};
|
|
2932
3981
|
/**
|
|
2933
|
-
* The x402 protocol payment payload
|
|
3982
|
+
* The x402 v2 protocol payment payload. Uses CAIP-2 network identifiers. The `accepted` field carries the full payment requirements; `scheme` and `network` are not top-level fields (they are on the nested `accepted` object).
|
|
2934
3983
|
*/
|
|
2935
3984
|
export interface X402V2PaymentPayload {
|
|
3985
|
+
/** The x402 protocol version. Must be `2` for this payload shape. */
|
|
2936
3986
|
x402Version: X402Version;
|
|
2937
|
-
/** The payload of the payment depending on the x402Version, scheme, and network. */
|
|
3987
|
+
/** 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. */
|
|
2938
3988
|
payload: X402V2PaymentPayloadPayload;
|
|
2939
3989
|
accepted: X402V2PaymentRequirements;
|
|
2940
3990
|
resource?: X402ResourceInfo;
|
|
2941
3991
|
/** Optional protocol extensions. */
|
|
2942
3992
|
extensions?: X402V2PaymentPayloadExtensions;
|
|
2943
3993
|
}
|
|
3994
|
+
/**
|
|
3995
|
+
* The x402 v1 network identifier. x402 v1 uses human-readable network names. Supported networks: Base mainnet and testnet, Solana mainnet and devnet.
|
|
3996
|
+
*/
|
|
3997
|
+
export type X402V1Network = (typeof X402V1Network)[keyof typeof X402V1Network];
|
|
3998
|
+
export declare const X402V1Network: {
|
|
3999
|
+
readonly base: "base";
|
|
4000
|
+
readonly "base-sepolia": "base-sepolia";
|
|
4001
|
+
readonly solana: "solana";
|
|
4002
|
+
readonly "solana-devnet": "solana-devnet";
|
|
4003
|
+
};
|
|
2944
4004
|
/**
|
|
2945
4005
|
* The scheme of the payment protocol to use. Currently, the only supported scheme is `exact`.
|
|
2946
4006
|
*/
|
|
@@ -2948,30 +4008,20 @@ export type X402V1PaymentPayloadScheme = (typeof X402V1PaymentPayloadScheme)[key
|
|
|
2948
4008
|
export declare const X402V1PaymentPayloadScheme: {
|
|
2949
4009
|
readonly exact: "exact";
|
|
2950
4010
|
};
|
|
2951
|
-
/**
|
|
2952
|
-
* The network of the blockchain to send payment on.
|
|
2953
|
-
*/
|
|
2954
|
-
export type X402V1PaymentPayloadNetwork = (typeof X402V1PaymentPayloadNetwork)[keyof typeof X402V1PaymentPayloadNetwork];
|
|
2955
|
-
export declare const X402V1PaymentPayloadNetwork: {
|
|
2956
|
-
readonly "base-sepolia": "base-sepolia";
|
|
2957
|
-
readonly base: "base";
|
|
2958
|
-
readonly "solana-devnet": "solana-devnet";
|
|
2959
|
-
readonly solana: "solana";
|
|
2960
|
-
readonly polygon: "polygon";
|
|
2961
|
-
};
|
|
2962
4011
|
/**
|
|
2963
4012
|
* The payload of the payment depending on the x402Version, scheme, and network.
|
|
2964
4013
|
*/
|
|
2965
4014
|
export type X402V1PaymentPayloadPayload = X402ExactEvmPayload | X402ExactEvmPermit2Payload | X402ExactSolanaPayload;
|
|
2966
4015
|
/**
|
|
2967
|
-
* The x402 protocol payment payload
|
|
4016
|
+
* The x402 v1 protocol payment payload. Uses human-readable network names and requires `scheme` and `network` alongside the inner `payload` object.
|
|
2968
4017
|
*/
|
|
2969
4018
|
export interface X402V1PaymentPayload {
|
|
4019
|
+
/** The x402 protocol version. Must be `1` for this payload shape. */
|
|
2970
4020
|
x402Version: X402Version;
|
|
2971
4021
|
/** The scheme of the payment protocol to use. Currently, the only supported scheme is `exact`. */
|
|
2972
4022
|
scheme: X402V1PaymentPayloadScheme;
|
|
2973
4023
|
/** The network of the blockchain to send payment on. */
|
|
2974
|
-
network:
|
|
4024
|
+
network: X402V1Network;
|
|
2975
4025
|
/** The payload of the payment depending on the x402Version, scheme, and network. */
|
|
2976
4026
|
payload: X402V1PaymentPayloadPayload;
|
|
2977
4027
|
}
|
|
@@ -2980,23 +4030,12 @@ export interface X402V1PaymentPayload {
|
|
|
2980
4030
|
For EVM networks, smart account signatures can be longer than 65 bytes.
|
|
2981
4031
|
*/
|
|
2982
4032
|
export type X402PaymentPayload = X402V2PaymentPayload | X402V1PaymentPayload;
|
|
2983
|
-
/**
|
|
2984
|
-
* The scheme of the payment protocol to use. Currently, the only supported scheme is `exact`.
|
|
2985
|
-
*/
|
|
2986
|
-
export type X402V1PaymentRequirementsScheme = (typeof X402V1PaymentRequirementsScheme)[keyof typeof X402V1PaymentRequirementsScheme];
|
|
2987
|
-
export declare const X402V1PaymentRequirementsScheme: {
|
|
2988
|
-
readonly exact: "exact";
|
|
2989
|
-
};
|
|
2990
|
-
/**
|
|
2991
|
-
* The network of the blockchain to send payment on.
|
|
2992
|
-
*/
|
|
2993
|
-
export type X402V1PaymentRequirementsNetwork = (typeof X402V1PaymentRequirementsNetwork)[keyof typeof X402V1PaymentRequirementsNetwork];
|
|
2994
|
-
export declare const X402V1PaymentRequirementsNetwork: {
|
|
2995
|
-
readonly "base-sepolia": "base-sepolia";
|
|
2996
|
-
readonly base: "base";
|
|
2997
|
-
readonly "solana-devnet": "solana-devnet";
|
|
2998
|
-
readonly solana: "solana";
|
|
2999
|
-
readonly polygon: "polygon";
|
|
4033
|
+
/**
|
|
4034
|
+
* The scheme of the payment protocol to use. Currently, the only supported scheme is `exact`.
|
|
4035
|
+
*/
|
|
4036
|
+
export type X402V1PaymentRequirementsScheme = (typeof X402V1PaymentRequirementsScheme)[keyof typeof X402V1PaymentRequirementsScheme];
|
|
4037
|
+
export declare const X402V1PaymentRequirementsScheme: {
|
|
4038
|
+
readonly exact: "exact";
|
|
3000
4039
|
};
|
|
3001
4040
|
/**
|
|
3002
4041
|
* The optional JSON schema describing the resource output.
|
|
@@ -3011,13 +4050,13 @@ export type X402V1PaymentRequirementsExtra = {
|
|
|
3011
4050
|
[key: string]: unknown;
|
|
3012
4051
|
};
|
|
3013
4052
|
/**
|
|
3014
|
-
* The x402
|
|
4053
|
+
* The x402 v1 payment requirements. Uses human-readable network names, and carries resource metadata (`resource`, `description`, `mimeType`) alongside the payment fields. The only supported scheme is `exact`.
|
|
3015
4054
|
*/
|
|
3016
4055
|
export interface X402V1PaymentRequirements {
|
|
3017
4056
|
/** The scheme of the payment protocol to use. Currently, the only supported scheme is `exact`. */
|
|
3018
4057
|
scheme: X402V1PaymentRequirementsScheme;
|
|
3019
4058
|
/** The network of the blockchain to send payment on. */
|
|
3020
|
-
network:
|
|
4059
|
+
network: X402V1Network;
|
|
3021
4060
|
/** The maximum amount required to pay for the resource in atomic units of the payment asset. */
|
|
3022
4061
|
maxAmountRequired: string;
|
|
3023
4062
|
/** The URL of the resource to pay for. */
|
|
@@ -3028,26 +4067,20 @@ export interface X402V1PaymentRequirements {
|
|
|
3028
4067
|
mimeType: string;
|
|
3029
4068
|
/** The optional JSON schema describing the resource output. */
|
|
3030
4069
|
outputSchema?: X402V1PaymentRequirementsOutputSchema;
|
|
3031
|
-
/**
|
|
3032
|
-
* The destination to pay value to.
|
|
4070
|
+
/** The destination to pay value to.
|
|
3033
4071
|
|
|
3034
4072
|
For EVM networks, payTo will be a 0x-prefixed, checksum EVM address.
|
|
3035
4073
|
|
|
3036
|
-
For Solana-based networks, payTo will be a base58-encoded Solana address.
|
|
3037
|
-
|
|
3038
|
-
*/
|
|
3039
|
-
payTo: string;
|
|
4074
|
+
For Solana-based networks, payTo will be a base58-encoded Solana address. */
|
|
4075
|
+
payTo: BlockchainAddress;
|
|
3040
4076
|
/** The maximum time in seconds for the resource server to respond. */
|
|
3041
4077
|
maxTimeoutSeconds: number;
|
|
3042
|
-
/**
|
|
3043
|
-
* The asset to pay with.
|
|
4078
|
+
/** The asset to pay with.
|
|
3044
4079
|
|
|
3045
4080
|
For EVM networks, the asset will be a 0x-prefixed, checksum EVM address.
|
|
3046
4081
|
|
|
3047
|
-
For Solana-based networks, the asset will be a base58-encoded Solana address.
|
|
3048
|
-
|
|
3049
|
-
*/
|
|
3050
|
-
asset: string;
|
|
4082
|
+
For Solana-based networks, the asset will be a base58-encoded Solana address. */
|
|
4083
|
+
asset: BlockchainAddress;
|
|
3051
4084
|
/** The optional additional scheme-specific payment info. */
|
|
3052
4085
|
extra?: X402V1PaymentRequirementsExtra;
|
|
3053
4086
|
}
|
|
@@ -3102,6 +4135,158 @@ export declare const X402VerifyInvalidReason: {
|
|
|
3102
4135
|
readonly invalid_exact_svm_payload_transaction_transfer_to_incorrect_ata: "invalid_exact_svm_payload_transaction_transfer_to_incorrect_ata";
|
|
3103
4136
|
readonly invalid_exact_svm_payload_transaction_fee_payer_included_in_instruction_accounts: "invalid_exact_svm_payload_transaction_fee_payer_included_in_instruction_accounts";
|
|
3104
4137
|
readonly invalid_exact_svm_payload_transaction_fee_payer_transferring_funds: "invalid_exact_svm_payload_transaction_fee_payer_transferring_funds";
|
|
4138
|
+
readonly invalid_batch_settlement_evm_scheme: "invalid_batch_settlement_evm_scheme";
|
|
4139
|
+
readonly invalid_batch_settlement_evm_network_mismatch: "invalid_batch_settlement_evm_network_mismatch";
|
|
4140
|
+
readonly invalid_batch_settlement_evm_payload_type: "invalid_batch_settlement_evm_payload_type";
|
|
4141
|
+
readonly invalid_batch_settlement_evm_channel_not_found: "invalid_batch_settlement_evm_channel_not_found";
|
|
4142
|
+
readonly invalid_batch_settlement_evm_deposit_simulation_failed: "invalid_batch_settlement_evm_deposit_simulation_failed";
|
|
4143
|
+
readonly invalid_batch_settlement_evm_channel_id_mismatch: "invalid_batch_settlement_evm_channel_id_mismatch";
|
|
4144
|
+
readonly invalid_batch_settlement_evm_channel_state_read_failed: "invalid_batch_settlement_evm_channel_state_read_failed";
|
|
4145
|
+
readonly invalid_batch_settlement_evm_cumulative_below_claimed: "invalid_batch_settlement_evm_cumulative_below_claimed";
|
|
4146
|
+
readonly invalid_batch_settlement_evm_cumulative_exceeds_balance: "invalid_batch_settlement_evm_cumulative_exceeds_balance";
|
|
4147
|
+
readonly invalid_batch_settlement_evm_eip2612_amount_mismatch: "invalid_batch_settlement_evm_eip2612_amount_mismatch";
|
|
4148
|
+
readonly invalid_batch_settlement_evm_eip2612_asset_mismatch: "invalid_batch_settlement_evm_eip2612_asset_mismatch";
|
|
4149
|
+
readonly invalid_batch_settlement_evm_eip2612_deadline_expired: "invalid_batch_settlement_evm_eip2612_deadline_expired";
|
|
4150
|
+
readonly invalid_batch_settlement_evm_eip2612_invalid_format: "invalid_batch_settlement_evm_eip2612_invalid_format";
|
|
4151
|
+
readonly invalid_batch_settlement_evm_eip2612_invalid_signature: "invalid_batch_settlement_evm_eip2612_invalid_signature";
|
|
4152
|
+
readonly invalid_batch_settlement_evm_eip2612_owner_mismatch: "invalid_batch_settlement_evm_eip2612_owner_mismatch";
|
|
4153
|
+
readonly invalid_batch_settlement_evm_eip2612_spender_mismatch: "invalid_batch_settlement_evm_eip2612_spender_mismatch";
|
|
4154
|
+
readonly invalid_batch_settlement_evm_erc20_approval_asset_mismatch: "invalid_batch_settlement_evm_erc20_approval_asset_mismatch";
|
|
4155
|
+
readonly invalid_batch_settlement_evm_erc20_approval_from_mismatch: "invalid_batch_settlement_evm_erc20_approval_from_mismatch";
|
|
4156
|
+
readonly invalid_batch_settlement_evm_erc20_approval_invalid_format: "invalid_batch_settlement_evm_erc20_approval_invalid_format";
|
|
4157
|
+
readonly invalid_batch_settlement_evm_erc20_approval_unavailable: "invalid_batch_settlement_evm_erc20_approval_unavailable";
|
|
4158
|
+
readonly invalid_batch_settlement_evm_erc20_approval_wrong_spender: "invalid_batch_settlement_evm_erc20_approval_wrong_spender";
|
|
4159
|
+
readonly invalid_batch_settlement_evm_erc3009_authorization_required: "invalid_batch_settlement_evm_erc3009_authorization_required";
|
|
4160
|
+
readonly invalid_batch_settlement_evm_insufficient_balance: "invalid_batch_settlement_evm_insufficient_balance";
|
|
4161
|
+
readonly invalid_batch_settlement_evm_deposit_payload: "invalid_batch_settlement_evm_deposit_payload";
|
|
4162
|
+
readonly invalid_batch_settlement_evm_receive_authorization_signature: "invalid_batch_settlement_evm_receive_authorization_signature";
|
|
4163
|
+
readonly invalid_batch_settlement_evm_refund_payload: "invalid_batch_settlement_evm_refund_payload";
|
|
4164
|
+
readonly invalid_batch_settlement_evm_voucher_payload: "invalid_batch_settlement_evm_voucher_payload";
|
|
4165
|
+
readonly invalid_batch_settlement_evm_voucher_signature: "invalid_batch_settlement_evm_voucher_signature";
|
|
4166
|
+
readonly invalid_batch_settlement_evm_missing_eip712_domain: "invalid_batch_settlement_evm_missing_eip712_domain";
|
|
4167
|
+
readonly invalid_batch_settlement_evm_payload_authorization_valid_after: "invalid_batch_settlement_evm_payload_authorization_valid_after";
|
|
4168
|
+
readonly invalid_batch_settlement_evm_payload_authorization_valid_before: "invalid_batch_settlement_evm_payload_authorization_valid_before";
|
|
4169
|
+
readonly invalid_batch_settlement_evm_permit2_allowance_required: "invalid_batch_settlement_evm_permit2_allowance_required";
|
|
4170
|
+
readonly invalid_batch_settlement_evm_permit2_amount_mismatch: "invalid_batch_settlement_evm_permit2_amount_mismatch";
|
|
4171
|
+
readonly invalid_batch_settlement_evm_permit2_authorization_required: "invalid_batch_settlement_evm_permit2_authorization_required";
|
|
4172
|
+
readonly invalid_batch_settlement_evm_permit2_deadline_expired: "invalid_batch_settlement_evm_permit2_deadline_expired";
|
|
4173
|
+
readonly invalid_batch_settlement_evm_permit2_invalid_signature: "invalid_batch_settlement_evm_permit2_invalid_signature";
|
|
4174
|
+
readonly invalid_batch_settlement_evm_permit2_invalid_spender: "invalid_batch_settlement_evm_permit2_invalid_spender";
|
|
4175
|
+
readonly invalid_batch_settlement_evm_receiver_authorizer_mismatch: "invalid_batch_settlement_evm_receiver_authorizer_mismatch";
|
|
4176
|
+
readonly invalid_batch_settlement_evm_receiver_mismatch: "invalid_batch_settlement_evm_receiver_mismatch";
|
|
4177
|
+
readonly invalid_batch_settlement_evm_rpc_read_failed: "invalid_batch_settlement_evm_rpc_read_failed";
|
|
4178
|
+
readonly invalid_batch_settlement_evm_token_mismatch: "invalid_batch_settlement_evm_token_mismatch";
|
|
4179
|
+
readonly invalid_batch_settlement_evm_withdraw_delay_mismatch: "invalid_batch_settlement_evm_withdraw_delay_mismatch";
|
|
4180
|
+
readonly invalid_batch_settlement_evm_withdraw_delay_out_of_range: "invalid_batch_settlement_evm_withdraw_delay_out_of_range";
|
|
4181
|
+
readonly invalid_exact_evm_scheme: "invalid_exact_evm_scheme";
|
|
4182
|
+
readonly invalid_exact_evm_network_mismatch: "invalid_exact_evm_network_mismatch";
|
|
4183
|
+
readonly invalid_exact_evm_payload: "invalid_exact_evm_payload";
|
|
4184
|
+
readonly invalid_exact_evm_payload_missing_signature: "invalid_exact_evm_payload_missing_signature";
|
|
4185
|
+
readonly invalid_exact_evm_failed_to_get_network_config: "invalid_exact_evm_failed_to_get_network_config";
|
|
4186
|
+
readonly invalid_exact_evm_missing_eip712_domain: "invalid_exact_evm_missing_eip712_domain";
|
|
4187
|
+
readonly invalid_exact_evm_recipient_mismatch: "invalid_exact_evm_recipient_mismatch";
|
|
4188
|
+
readonly invalid_exact_evm_authorization_value: "invalid_exact_evm_authorization_value";
|
|
4189
|
+
readonly invalid_exact_evm_required_amount: "invalid_exact_evm_required_amount";
|
|
4190
|
+
readonly invalid_exact_evm_payload_authorization_value_mismatch: "invalid_exact_evm_payload_authorization_value_mismatch";
|
|
4191
|
+
readonly invalid_exact_evm_failed_to_check_nonce: "invalid_exact_evm_failed_to_check_nonce";
|
|
4192
|
+
readonly invalid_exact_evm_nonce_already_used: "invalid_exact_evm_nonce_already_used";
|
|
4193
|
+
readonly invalid_exact_evm_failed_to_get_balance: "invalid_exact_evm_failed_to_get_balance";
|
|
4194
|
+
readonly invalid_exact_evm_insufficient_balance: "invalid_exact_evm_insufficient_balance";
|
|
4195
|
+
readonly invalid_exact_evm_signature_format: "invalid_exact_evm_signature_format";
|
|
4196
|
+
readonly invalid_exact_evm_failed_to_verify_signature: "invalid_exact_evm_failed_to_verify_signature";
|
|
4197
|
+
readonly invalid_exact_evm_signature: "invalid_exact_evm_signature";
|
|
4198
|
+
readonly invalid_exact_evm_token_name_mismatch: "invalid_exact_evm_token_name_mismatch";
|
|
4199
|
+
readonly invalid_exact_evm_token_version_mismatch: "invalid_exact_evm_token_version_mismatch";
|
|
4200
|
+
readonly invalid_exact_evm_eip3009_not_supported: "invalid_exact_evm_eip3009_not_supported";
|
|
4201
|
+
readonly invalid_exact_evm_transaction_simulation_failed: "invalid_exact_evm_transaction_simulation_failed";
|
|
4202
|
+
readonly invalid_exact_evm_verification_failed: "invalid_exact_evm_verification_failed";
|
|
4203
|
+
readonly invalid_exact_evm_failed_to_parse_signature: "invalid_exact_evm_failed_to_parse_signature";
|
|
4204
|
+
readonly invalid_exact_evm_failed_to_check_deployment: "invalid_exact_evm_failed_to_check_deployment";
|
|
4205
|
+
readonly invalid_exact_evm_failed_to_execute_transfer: "invalid_exact_evm_failed_to_execute_transfer";
|
|
4206
|
+
readonly invalid_exact_evm_failed_to_get_receipt: "invalid_exact_evm_failed_to_get_receipt";
|
|
4207
|
+
readonly invalid_exact_evm_transaction_failed: "invalid_exact_evm_transaction_failed";
|
|
4208
|
+
readonly invalid_exact_evm_payload_undeployed_smart_wallet: "invalid_exact_evm_payload_undeployed_smart_wallet";
|
|
4209
|
+
readonly smart_wallet_deployment_failed: "smart_wallet_deployment_failed";
|
|
4210
|
+
readonly unsupported_payload_type: "unsupported_payload_type";
|
|
4211
|
+
readonly invalid_erc20_approval_extension_format: "invalid_erc20_approval_extension_format";
|
|
4212
|
+
readonly erc20_approval_tx_failed: "erc20_approval_tx_failed";
|
|
4213
|
+
readonly erc20_approval_from_mismatch: "erc20_approval_from_mismatch";
|
|
4214
|
+
readonly erc20_approval_asset_mismatch: "erc20_approval_asset_mismatch";
|
|
4215
|
+
readonly erc20_approval_spender_not_permit2: "erc20_approval_spender_not_permit2";
|
|
4216
|
+
readonly erc20_approval_tx_parse_failed: "erc20_approval_tx_parse_failed";
|
|
4217
|
+
readonly erc20_approval_tx_wrong_target: "erc20_approval_tx_wrong_target";
|
|
4218
|
+
readonly erc20_approval_tx_wrong_selector: "erc20_approval_tx_wrong_selector";
|
|
4219
|
+
readonly erc20_approval_tx_wrong_spender: "erc20_approval_tx_wrong_spender";
|
|
4220
|
+
readonly erc20_approval_tx_signer_mismatch: "erc20_approval_tx_signer_mismatch";
|
|
4221
|
+
readonly erc20_approval_tx_invalid_signature: "erc20_approval_tx_invalid_signature";
|
|
4222
|
+
readonly invalid_exact_evm_unsupported_scheme: "invalid_exact_evm_unsupported_scheme";
|
|
4223
|
+
readonly invalid_exact_evm_extra_field: "invalid_exact_evm_extra_field";
|
|
4224
|
+
readonly invalid_exact_evm_payload_recipient_mismatch: "invalid_exact_evm_payload_recipient_mismatch";
|
|
4225
|
+
readonly invalid_exact_evm_insufficient_funds: "invalid_exact_evm_insufficient_funds";
|
|
4226
|
+
readonly invalid_exact_evm_transaction_state: "invalid_exact_evm_transaction_state";
|
|
4227
|
+
readonly invalid_permit2_spender: "invalid_permit2_spender";
|
|
4228
|
+
readonly invalid_permit2_recipient_mismatch: "invalid_permit2_recipient_mismatch";
|
|
4229
|
+
readonly permit2_deadline_expired: "permit2_deadline_expired";
|
|
4230
|
+
readonly permit2_not_yet_valid: "permit2_not_yet_valid";
|
|
4231
|
+
readonly permit2_amount_mismatch: "permit2_amount_mismatch";
|
|
4232
|
+
readonly permit2_token_mismatch: "permit2_token_mismatch";
|
|
4233
|
+
readonly invalid_permit2_signature: "invalid_permit2_signature";
|
|
4234
|
+
readonly permit2_allowance_required: "permit2_allowance_required";
|
|
4235
|
+
readonly permit2_invalid_amount: "permit2_invalid_amount";
|
|
4236
|
+
readonly permit2_invalid_destination: "permit2_invalid_destination";
|
|
4237
|
+
readonly permit2_invalid_owner: "permit2_invalid_owner";
|
|
4238
|
+
readonly permit2_payment_too_early: "permit2_payment_too_early";
|
|
4239
|
+
readonly permit2_invalid_nonce: "permit2_invalid_nonce";
|
|
4240
|
+
readonly permit2_2612_amount_mismatch: "permit2_2612_amount_mismatch";
|
|
4241
|
+
readonly permit2_simulation_failed: "permit2_simulation_failed";
|
|
4242
|
+
readonly permit2_insufficient_balance: "permit2_insufficient_balance";
|
|
4243
|
+
readonly permit2_proxy_not_deployed: "permit2_proxy_not_deployed";
|
|
4244
|
+
readonly erc20_approval_insufficient_eth_for_gas: "erc20_approval_insufficient_eth_for_gas";
|
|
4245
|
+
readonly erc20_approval_broadcast_failed: "erc20_approval_broadcast_failed";
|
|
4246
|
+
readonly invalid_exact_solana_unsupported_scheme: "invalid_exact_solana_unsupported_scheme";
|
|
4247
|
+
readonly invalid_exact_solana_network_mismatch: "invalid_exact_solana_network_mismatch";
|
|
4248
|
+
readonly invalid_exact_solana_payload_missing_fee_payer: "invalid_exact_solana_payload_missing_fee_payer";
|
|
4249
|
+
readonly invalid_exact_solana_fee_payer_not_managed_by_facilitator: "invalid_exact_solana_fee_payer_not_managed_by_facilitator";
|
|
4250
|
+
readonly invalid_exact_solana_payload_transaction: "invalid_exact_solana_payload_transaction";
|
|
4251
|
+
readonly invalid_exact_solana_payload_transaction_could_not_be_decoded: "invalid_exact_solana_payload_transaction_could_not_be_decoded";
|
|
4252
|
+
readonly invalid_exact_solana_payload_transaction_instructions_length: "invalid_exact_solana_payload_transaction_instructions_length";
|
|
4253
|
+
readonly invalid_exact_solana_payload_unknown_fourth_instruction: "invalid_exact_solana_payload_unknown_fourth_instruction";
|
|
4254
|
+
readonly invalid_exact_solana_payload_unknown_fifth_instruction: "invalid_exact_solana_payload_unknown_fifth_instruction";
|
|
4255
|
+
readonly invalid_exact_solana_payload_unknown_sixth_instruction: "invalid_exact_solana_payload_unknown_sixth_instruction";
|
|
4256
|
+
readonly invalid_exact_solana_payload_transaction_instructions_compute_limit_instruction: "invalid_exact_solana_payload_transaction_instructions_compute_limit_instruction";
|
|
4257
|
+
readonly invalid_exact_solana_payload_transaction_instructions_compute_price_instruction: "invalid_exact_solana_payload_transaction_instructions_compute_price_instruction";
|
|
4258
|
+
readonly invalid_exact_solana_payload_transaction_instructions_compute_price_instruction_too_high: "invalid_exact_solana_payload_transaction_instructions_compute_price_instruction_too_high";
|
|
4259
|
+
readonly invalid_exact_solana_payload_no_transfer_instruction: "invalid_exact_solana_payload_no_transfer_instruction";
|
|
4260
|
+
readonly invalid_exact_solana_payload_transaction_fee_payer_transferring_funds: "invalid_exact_solana_payload_transaction_fee_payer_transferring_funds";
|
|
4261
|
+
readonly invalid_exact_solana_payload_mint_mismatch: "invalid_exact_solana_payload_mint_mismatch";
|
|
4262
|
+
readonly invalid_exact_solana_payload_recipient_mismatch: "invalid_exact_solana_payload_recipient_mismatch";
|
|
4263
|
+
readonly invalid_exact_solana_payload_amount_insufficient: "invalid_exact_solana_payload_amount_insufficient";
|
|
4264
|
+
readonly invalid_exact_solana_invalid_fee_payer: "invalid_exact_solana_invalid_fee_payer";
|
|
4265
|
+
readonly invalid_exact_solana_transaction_signing_failed: "invalid_exact_solana_transaction_signing_failed";
|
|
4266
|
+
readonly invalid_exact_solana_transaction_simulation_failed: "invalid_exact_solana_transaction_simulation_failed";
|
|
4267
|
+
readonly invalid_exact_solana_payload_memo_mismatch: "invalid_exact_solana_payload_memo_mismatch";
|
|
4268
|
+
readonly invalid_exact_solana_payload_memo_count: "invalid_exact_solana_payload_memo_count";
|
|
4269
|
+
readonly invalid_exact_solana_verification_failed: "invalid_exact_solana_verification_failed";
|
|
4270
|
+
readonly invalid_exact_solana_fee_payer_mismatch: "invalid_exact_solana_fee_payer_mismatch";
|
|
4271
|
+
readonly invalid_exact_solana_transaction_failed: "invalid_exact_solana_transaction_failed";
|
|
4272
|
+
readonly invalid_exact_solana_transaction_confirmation_failed: "invalid_exact_solana_transaction_confirmation_failed";
|
|
4273
|
+
readonly duplicate_settlement: "duplicate_settlement";
|
|
4274
|
+
readonly invalid_exact_solana_extra_field: "invalid_exact_solana_extra_field";
|
|
4275
|
+
readonly batch_settlement_cumulative_amount_mismatch: "batch_settlement_cumulative_amount_mismatch";
|
|
4276
|
+
readonly batch_settlement_channel_busy: "batch_settlement_channel_busy";
|
|
4277
|
+
readonly missing_batch_settlement_channel: "missing_batch_settlement_channel";
|
|
4278
|
+
readonly batch_settlement_charge_exceeds_signed_cumulative: "batch_settlement_charge_exceeds_signed_cumulative";
|
|
4279
|
+
readonly batch_settlement_refund_no_balance: "batch_settlement_refund_no_balance";
|
|
4280
|
+
readonly batch_settlement_refund_amount_invalid: "batch_settlement_refund_amount_invalid";
|
|
4281
|
+
readonly batch_settlement_refund_amount_exceeds_balance: "batch_settlement_refund_amount_exceeds_balance";
|
|
4282
|
+
readonly amount_too_low: "amount_too_low";
|
|
4283
|
+
readonly invalid_amount: "invalid_amount";
|
|
4284
|
+
readonly kyt_risk_detected: "kyt_risk_detected";
|
|
4285
|
+
readonly permit2_disabled: "permit2_disabled";
|
|
4286
|
+
readonly preflight_validation_failed: "preflight_validation_failed";
|
|
4287
|
+
readonly request_blocked_by_location: "request_blocked_by_location";
|
|
4288
|
+
readonly self_send_not_allowed: "self_send_not_allowed";
|
|
4289
|
+
readonly invalid_bazaar_extension: "invalid_bazaar_extension";
|
|
3105
4290
|
readonly unknown_error: "unknown_error";
|
|
3106
4291
|
};
|
|
3107
4292
|
/**
|
|
@@ -3113,15 +4298,12 @@ export interface X402VerifyPaymentRejection {
|
|
|
3113
4298
|
invalidReason: X402VerifyInvalidReason;
|
|
3114
4299
|
/** The message describing the invalid reason. */
|
|
3115
4300
|
invalidMessage?: string;
|
|
3116
|
-
/**
|
|
3117
|
-
* The onchain address of the client that is paying for the resource.
|
|
4301
|
+
/** The onchain address of the client that is paying for the resource.
|
|
3118
4302
|
|
|
3119
4303
|
For EVM networks, the payer will be a 0x-prefixed, checksum EVM address.
|
|
3120
4304
|
|
|
3121
|
-
For Solana-based networks, the payer will be a base58-encoded Solana address.
|
|
3122
|
-
|
|
3123
|
-
*/
|
|
3124
|
-
payer?: string;
|
|
4305
|
+
For Solana-based networks, the payer will be a base58-encoded Solana address. */
|
|
4306
|
+
payer?: BlockchainAddress;
|
|
3125
4307
|
}
|
|
3126
4308
|
/**
|
|
3127
4309
|
* The reason the payment settlement errored on the x402 protocol.
|
|
@@ -3175,6 +4357,172 @@ export declare const X402SettleErrorReason: {
|
|
|
3175
4357
|
readonly settle_exact_failed_onchain: "settle_exact_failed_onchain";
|
|
3176
4358
|
readonly settle_exact_svm_block_height_exceeded: "settle_exact_svm_block_height_exceeded";
|
|
3177
4359
|
readonly settle_exact_svm_transaction_confirmation_timed_out: "settle_exact_svm_transaction_confirmation_timed_out";
|
|
4360
|
+
readonly invalid_batch_settlement_evm_unknown_settle_action: "invalid_batch_settlement_evm_unknown_settle_action";
|
|
4361
|
+
readonly invalid_batch_settlement_evm_claim_payload: "invalid_batch_settlement_evm_claim_payload";
|
|
4362
|
+
readonly invalid_batch_settlement_evm_settle_payload: "invalid_batch_settlement_evm_settle_payload";
|
|
4363
|
+
readonly invalid_batch_settlement_evm_authorizer_address_mismatch: "invalid_batch_settlement_evm_authorizer_address_mismatch";
|
|
4364
|
+
readonly invalid_batch_settlement_evm_claim_simulation_failed: "invalid_batch_settlement_evm_claim_simulation_failed";
|
|
4365
|
+
readonly invalid_batch_settlement_evm_claim_transaction_failed: "invalid_batch_settlement_evm_claim_transaction_failed";
|
|
4366
|
+
readonly invalid_batch_settlement_evm_deposit_transaction_failed: "invalid_batch_settlement_evm_deposit_transaction_failed";
|
|
4367
|
+
readonly invalid_batch_settlement_evm_refund_simulation_failed: "invalid_batch_settlement_evm_refund_simulation_failed";
|
|
4368
|
+
readonly invalid_batch_settlement_evm_refund_transaction_failed: "invalid_batch_settlement_evm_refund_transaction_failed";
|
|
4369
|
+
readonly invalid_batch_settlement_evm_settle_simulation_failed: "invalid_batch_settlement_evm_settle_simulation_failed";
|
|
4370
|
+
readonly invalid_batch_settlement_evm_settle_transaction_failed: "invalid_batch_settlement_evm_settle_transaction_failed";
|
|
4371
|
+
readonly invalid_batch_settlement_evm_transaction_reverted: "invalid_batch_settlement_evm_transaction_reverted";
|
|
4372
|
+
readonly invalid_batch_settlement_evm_wait_for_receipt_failed: "invalid_batch_settlement_evm_wait_for_receipt_failed";
|
|
4373
|
+
readonly invalid_batch_settlement_evm_erc20_approval_broadcast_failed: "invalid_batch_settlement_evm_erc20_approval_broadcast_failed";
|
|
4374
|
+
readonly invalid_batch_settlement_evm_channel_id_mismatch: "invalid_batch_settlement_evm_channel_id_mismatch";
|
|
4375
|
+
readonly invalid_batch_settlement_evm_channel_state_read_failed: "invalid_batch_settlement_evm_channel_state_read_failed";
|
|
4376
|
+
readonly invalid_batch_settlement_evm_cumulative_below_claimed: "invalid_batch_settlement_evm_cumulative_below_claimed";
|
|
4377
|
+
readonly invalid_batch_settlement_evm_cumulative_exceeds_balance: "invalid_batch_settlement_evm_cumulative_exceeds_balance";
|
|
4378
|
+
readonly invalid_batch_settlement_evm_eip2612_amount_mismatch: "invalid_batch_settlement_evm_eip2612_amount_mismatch";
|
|
4379
|
+
readonly invalid_batch_settlement_evm_eip2612_asset_mismatch: "invalid_batch_settlement_evm_eip2612_asset_mismatch";
|
|
4380
|
+
readonly invalid_batch_settlement_evm_eip2612_deadline_expired: "invalid_batch_settlement_evm_eip2612_deadline_expired";
|
|
4381
|
+
readonly invalid_batch_settlement_evm_eip2612_invalid_format: "invalid_batch_settlement_evm_eip2612_invalid_format";
|
|
4382
|
+
readonly invalid_batch_settlement_evm_eip2612_invalid_signature: "invalid_batch_settlement_evm_eip2612_invalid_signature";
|
|
4383
|
+
readonly invalid_batch_settlement_evm_eip2612_owner_mismatch: "invalid_batch_settlement_evm_eip2612_owner_mismatch";
|
|
4384
|
+
readonly invalid_batch_settlement_evm_eip2612_spender_mismatch: "invalid_batch_settlement_evm_eip2612_spender_mismatch";
|
|
4385
|
+
readonly invalid_batch_settlement_evm_erc20_approval_asset_mismatch: "invalid_batch_settlement_evm_erc20_approval_asset_mismatch";
|
|
4386
|
+
readonly invalid_batch_settlement_evm_erc20_approval_from_mismatch: "invalid_batch_settlement_evm_erc20_approval_from_mismatch";
|
|
4387
|
+
readonly invalid_batch_settlement_evm_erc20_approval_invalid_format: "invalid_batch_settlement_evm_erc20_approval_invalid_format";
|
|
4388
|
+
readonly invalid_batch_settlement_evm_erc20_approval_unavailable: "invalid_batch_settlement_evm_erc20_approval_unavailable";
|
|
4389
|
+
readonly invalid_batch_settlement_evm_erc20_approval_wrong_spender: "invalid_batch_settlement_evm_erc20_approval_wrong_spender";
|
|
4390
|
+
readonly invalid_batch_settlement_evm_erc3009_authorization_required: "invalid_batch_settlement_evm_erc3009_authorization_required";
|
|
4391
|
+
readonly invalid_batch_settlement_evm_insufficient_balance: "invalid_batch_settlement_evm_insufficient_balance";
|
|
4392
|
+
readonly invalid_batch_settlement_evm_deposit_payload: "invalid_batch_settlement_evm_deposit_payload";
|
|
4393
|
+
readonly invalid_batch_settlement_evm_receive_authorization_signature: "invalid_batch_settlement_evm_receive_authorization_signature";
|
|
4394
|
+
readonly invalid_batch_settlement_evm_refund_payload: "invalid_batch_settlement_evm_refund_payload";
|
|
4395
|
+
readonly invalid_batch_settlement_evm_voucher_payload: "invalid_batch_settlement_evm_voucher_payload";
|
|
4396
|
+
readonly invalid_batch_settlement_evm_voucher_signature: "invalid_batch_settlement_evm_voucher_signature";
|
|
4397
|
+
readonly invalid_batch_settlement_evm_missing_eip712_domain: "invalid_batch_settlement_evm_missing_eip712_domain";
|
|
4398
|
+
readonly invalid_batch_settlement_evm_payload_authorization_valid_after: "invalid_batch_settlement_evm_payload_authorization_valid_after";
|
|
4399
|
+
readonly invalid_batch_settlement_evm_payload_authorization_valid_before: "invalid_batch_settlement_evm_payload_authorization_valid_before";
|
|
4400
|
+
readonly invalid_batch_settlement_evm_permit2_allowance_required: "invalid_batch_settlement_evm_permit2_allowance_required";
|
|
4401
|
+
readonly invalid_batch_settlement_evm_permit2_amount_mismatch: "invalid_batch_settlement_evm_permit2_amount_mismatch";
|
|
4402
|
+
readonly invalid_batch_settlement_evm_permit2_authorization_required: "invalid_batch_settlement_evm_permit2_authorization_required";
|
|
4403
|
+
readonly invalid_batch_settlement_evm_permit2_deadline_expired: "invalid_batch_settlement_evm_permit2_deadline_expired";
|
|
4404
|
+
readonly invalid_batch_settlement_evm_permit2_invalid_signature: "invalid_batch_settlement_evm_permit2_invalid_signature";
|
|
4405
|
+
readonly invalid_batch_settlement_evm_permit2_invalid_spender: "invalid_batch_settlement_evm_permit2_invalid_spender";
|
|
4406
|
+
readonly invalid_batch_settlement_evm_receiver_authorizer_mismatch: "invalid_batch_settlement_evm_receiver_authorizer_mismatch";
|
|
4407
|
+
readonly invalid_batch_settlement_evm_receiver_mismatch: "invalid_batch_settlement_evm_receiver_mismatch";
|
|
4408
|
+
readonly invalid_batch_settlement_evm_rpc_read_failed: "invalid_batch_settlement_evm_rpc_read_failed";
|
|
4409
|
+
readonly invalid_batch_settlement_evm_token_mismatch: "invalid_batch_settlement_evm_token_mismatch";
|
|
4410
|
+
readonly invalid_batch_settlement_evm_withdraw_delay_mismatch: "invalid_batch_settlement_evm_withdraw_delay_mismatch";
|
|
4411
|
+
readonly invalid_batch_settlement_evm_withdraw_delay_out_of_range: "invalid_batch_settlement_evm_withdraw_delay_out_of_range";
|
|
4412
|
+
readonly invalid_batch_settlement_evm_scheme: "invalid_batch_settlement_evm_scheme";
|
|
4413
|
+
readonly invalid_batch_settlement_evm_network_mismatch: "invalid_batch_settlement_evm_network_mismatch";
|
|
4414
|
+
readonly invalid_batch_settlement_evm_payload_type: "invalid_batch_settlement_evm_payload_type";
|
|
4415
|
+
readonly invalid_batch_settlement_evm_channel_not_found: "invalid_batch_settlement_evm_channel_not_found";
|
|
4416
|
+
readonly invalid_batch_settlement_evm_deposit_simulation_failed: "invalid_batch_settlement_evm_deposit_simulation_failed";
|
|
4417
|
+
readonly invalid_exact_evm_scheme: "invalid_exact_evm_scheme";
|
|
4418
|
+
readonly invalid_exact_evm_network_mismatch: "invalid_exact_evm_network_mismatch";
|
|
4419
|
+
readonly invalid_exact_evm_payload: "invalid_exact_evm_payload";
|
|
4420
|
+
readonly invalid_exact_evm_payload_missing_signature: "invalid_exact_evm_payload_missing_signature";
|
|
4421
|
+
readonly invalid_exact_evm_failed_to_get_network_config: "invalid_exact_evm_failed_to_get_network_config";
|
|
4422
|
+
readonly invalid_exact_evm_missing_eip712_domain: "invalid_exact_evm_missing_eip712_domain";
|
|
4423
|
+
readonly invalid_exact_evm_recipient_mismatch: "invalid_exact_evm_recipient_mismatch";
|
|
4424
|
+
readonly invalid_exact_evm_authorization_value: "invalid_exact_evm_authorization_value";
|
|
4425
|
+
readonly invalid_exact_evm_required_amount: "invalid_exact_evm_required_amount";
|
|
4426
|
+
readonly invalid_exact_evm_payload_authorization_value_mismatch: "invalid_exact_evm_payload_authorization_value_mismatch";
|
|
4427
|
+
readonly invalid_exact_evm_failed_to_check_nonce: "invalid_exact_evm_failed_to_check_nonce";
|
|
4428
|
+
readonly invalid_exact_evm_nonce_already_used: "invalid_exact_evm_nonce_already_used";
|
|
4429
|
+
readonly invalid_exact_evm_failed_to_get_balance: "invalid_exact_evm_failed_to_get_balance";
|
|
4430
|
+
readonly invalid_exact_evm_insufficient_balance: "invalid_exact_evm_insufficient_balance";
|
|
4431
|
+
readonly invalid_exact_evm_signature_format: "invalid_exact_evm_signature_format";
|
|
4432
|
+
readonly invalid_exact_evm_failed_to_verify_signature: "invalid_exact_evm_failed_to_verify_signature";
|
|
4433
|
+
readonly invalid_exact_evm_signature: "invalid_exact_evm_signature";
|
|
4434
|
+
readonly invalid_exact_evm_token_name_mismatch: "invalid_exact_evm_token_name_mismatch";
|
|
4435
|
+
readonly invalid_exact_evm_token_version_mismatch: "invalid_exact_evm_token_version_mismatch";
|
|
4436
|
+
readonly invalid_exact_evm_eip3009_not_supported: "invalid_exact_evm_eip3009_not_supported";
|
|
4437
|
+
readonly invalid_exact_evm_transaction_simulation_failed: "invalid_exact_evm_transaction_simulation_failed";
|
|
4438
|
+
readonly invalid_exact_evm_verification_failed: "invalid_exact_evm_verification_failed";
|
|
4439
|
+
readonly invalid_exact_evm_failed_to_parse_signature: "invalid_exact_evm_failed_to_parse_signature";
|
|
4440
|
+
readonly invalid_exact_evm_failed_to_check_deployment: "invalid_exact_evm_failed_to_check_deployment";
|
|
4441
|
+
readonly invalid_exact_evm_failed_to_execute_transfer: "invalid_exact_evm_failed_to_execute_transfer";
|
|
4442
|
+
readonly invalid_exact_evm_failed_to_get_receipt: "invalid_exact_evm_failed_to_get_receipt";
|
|
4443
|
+
readonly invalid_exact_evm_transaction_failed: "invalid_exact_evm_transaction_failed";
|
|
4444
|
+
readonly invalid_exact_evm_payload_undeployed_smart_wallet: "invalid_exact_evm_payload_undeployed_smart_wallet";
|
|
4445
|
+
readonly smart_wallet_deployment_failed: "smart_wallet_deployment_failed";
|
|
4446
|
+
readonly unsupported_payload_type: "unsupported_payload_type";
|
|
4447
|
+
readonly invalid_erc20_approval_extension_format: "invalid_erc20_approval_extension_format";
|
|
4448
|
+
readonly erc20_approval_tx_failed: "erc20_approval_tx_failed";
|
|
4449
|
+
readonly erc20_approval_from_mismatch: "erc20_approval_from_mismatch";
|
|
4450
|
+
readonly erc20_approval_asset_mismatch: "erc20_approval_asset_mismatch";
|
|
4451
|
+
readonly erc20_approval_spender_not_permit2: "erc20_approval_spender_not_permit2";
|
|
4452
|
+
readonly erc20_approval_tx_parse_failed: "erc20_approval_tx_parse_failed";
|
|
4453
|
+
readonly erc20_approval_tx_wrong_target: "erc20_approval_tx_wrong_target";
|
|
4454
|
+
readonly erc20_approval_tx_wrong_selector: "erc20_approval_tx_wrong_selector";
|
|
4455
|
+
readonly erc20_approval_tx_wrong_spender: "erc20_approval_tx_wrong_spender";
|
|
4456
|
+
readonly erc20_approval_tx_signer_mismatch: "erc20_approval_tx_signer_mismatch";
|
|
4457
|
+
readonly erc20_approval_tx_invalid_signature: "erc20_approval_tx_invalid_signature";
|
|
4458
|
+
readonly invalid_exact_evm_unsupported_scheme: "invalid_exact_evm_unsupported_scheme";
|
|
4459
|
+
readonly invalid_exact_evm_extra_field: "invalid_exact_evm_extra_field";
|
|
4460
|
+
readonly invalid_exact_evm_payload_recipient_mismatch: "invalid_exact_evm_payload_recipient_mismatch";
|
|
4461
|
+
readonly invalid_exact_evm_insufficient_funds: "invalid_exact_evm_insufficient_funds";
|
|
4462
|
+
readonly invalid_exact_evm_transaction_state: "invalid_exact_evm_transaction_state";
|
|
4463
|
+
readonly invalid_permit2_spender: "invalid_permit2_spender";
|
|
4464
|
+
readonly invalid_permit2_recipient_mismatch: "invalid_permit2_recipient_mismatch";
|
|
4465
|
+
readonly permit2_deadline_expired: "permit2_deadline_expired";
|
|
4466
|
+
readonly permit2_not_yet_valid: "permit2_not_yet_valid";
|
|
4467
|
+
readonly permit2_amount_mismatch: "permit2_amount_mismatch";
|
|
4468
|
+
readonly permit2_token_mismatch: "permit2_token_mismatch";
|
|
4469
|
+
readonly invalid_permit2_signature: "invalid_permit2_signature";
|
|
4470
|
+
readonly permit2_allowance_required: "permit2_allowance_required";
|
|
4471
|
+
readonly permit2_invalid_amount: "permit2_invalid_amount";
|
|
4472
|
+
readonly permit2_invalid_destination: "permit2_invalid_destination";
|
|
4473
|
+
readonly permit2_invalid_owner: "permit2_invalid_owner";
|
|
4474
|
+
readonly permit2_payment_too_early: "permit2_payment_too_early";
|
|
4475
|
+
readonly permit2_invalid_nonce: "permit2_invalid_nonce";
|
|
4476
|
+
readonly permit2_2612_amount_mismatch: "permit2_2612_amount_mismatch";
|
|
4477
|
+
readonly permit2_simulation_failed: "permit2_simulation_failed";
|
|
4478
|
+
readonly permit2_insufficient_balance: "permit2_insufficient_balance";
|
|
4479
|
+
readonly permit2_proxy_not_deployed: "permit2_proxy_not_deployed";
|
|
4480
|
+
readonly erc20_approval_insufficient_eth_for_gas: "erc20_approval_insufficient_eth_for_gas";
|
|
4481
|
+
readonly erc20_approval_broadcast_failed: "erc20_approval_broadcast_failed";
|
|
4482
|
+
readonly invalid_exact_solana_unsupported_scheme: "invalid_exact_solana_unsupported_scheme";
|
|
4483
|
+
readonly invalid_exact_solana_network_mismatch: "invalid_exact_solana_network_mismatch";
|
|
4484
|
+
readonly invalid_exact_solana_payload_missing_fee_payer: "invalid_exact_solana_payload_missing_fee_payer";
|
|
4485
|
+
readonly invalid_exact_solana_fee_payer_not_managed_by_facilitator: "invalid_exact_solana_fee_payer_not_managed_by_facilitator";
|
|
4486
|
+
readonly invalid_exact_solana_payload_transaction: "invalid_exact_solana_payload_transaction";
|
|
4487
|
+
readonly invalid_exact_solana_payload_transaction_could_not_be_decoded: "invalid_exact_solana_payload_transaction_could_not_be_decoded";
|
|
4488
|
+
readonly invalid_exact_solana_payload_transaction_instructions_length: "invalid_exact_solana_payload_transaction_instructions_length";
|
|
4489
|
+
readonly invalid_exact_solana_payload_unknown_fourth_instruction: "invalid_exact_solana_payload_unknown_fourth_instruction";
|
|
4490
|
+
readonly invalid_exact_solana_payload_unknown_fifth_instruction: "invalid_exact_solana_payload_unknown_fifth_instruction";
|
|
4491
|
+
readonly invalid_exact_solana_payload_unknown_sixth_instruction: "invalid_exact_solana_payload_unknown_sixth_instruction";
|
|
4492
|
+
readonly invalid_exact_solana_payload_transaction_instructions_compute_limit_instruction: "invalid_exact_solana_payload_transaction_instructions_compute_limit_instruction";
|
|
4493
|
+
readonly invalid_exact_solana_payload_transaction_instructions_compute_price_instruction: "invalid_exact_solana_payload_transaction_instructions_compute_price_instruction";
|
|
4494
|
+
readonly invalid_exact_solana_payload_transaction_instructions_compute_price_instruction_too_high: "invalid_exact_solana_payload_transaction_instructions_compute_price_instruction_too_high";
|
|
4495
|
+
readonly invalid_exact_solana_payload_no_transfer_instruction: "invalid_exact_solana_payload_no_transfer_instruction";
|
|
4496
|
+
readonly invalid_exact_solana_payload_transaction_fee_payer_transferring_funds: "invalid_exact_solana_payload_transaction_fee_payer_transferring_funds";
|
|
4497
|
+
readonly invalid_exact_solana_payload_mint_mismatch: "invalid_exact_solana_payload_mint_mismatch";
|
|
4498
|
+
readonly invalid_exact_solana_payload_recipient_mismatch: "invalid_exact_solana_payload_recipient_mismatch";
|
|
4499
|
+
readonly invalid_exact_solana_payload_amount_insufficient: "invalid_exact_solana_payload_amount_insufficient";
|
|
4500
|
+
readonly invalid_exact_solana_invalid_fee_payer: "invalid_exact_solana_invalid_fee_payer";
|
|
4501
|
+
readonly invalid_exact_solana_transaction_signing_failed: "invalid_exact_solana_transaction_signing_failed";
|
|
4502
|
+
readonly invalid_exact_solana_transaction_simulation_failed: "invalid_exact_solana_transaction_simulation_failed";
|
|
4503
|
+
readonly invalid_exact_solana_payload_memo_mismatch: "invalid_exact_solana_payload_memo_mismatch";
|
|
4504
|
+
readonly invalid_exact_solana_payload_memo_count: "invalid_exact_solana_payload_memo_count";
|
|
4505
|
+
readonly invalid_exact_solana_verification_failed: "invalid_exact_solana_verification_failed";
|
|
4506
|
+
readonly invalid_exact_solana_fee_payer_mismatch: "invalid_exact_solana_fee_payer_mismatch";
|
|
4507
|
+
readonly invalid_exact_solana_transaction_failed: "invalid_exact_solana_transaction_failed";
|
|
4508
|
+
readonly invalid_exact_solana_transaction_confirmation_failed: "invalid_exact_solana_transaction_confirmation_failed";
|
|
4509
|
+
readonly duplicate_settlement: "duplicate_settlement";
|
|
4510
|
+
readonly invalid_exact_solana_extra_field: "invalid_exact_solana_extra_field";
|
|
4511
|
+
readonly batch_settlement_cumulative_amount_mismatch: "batch_settlement_cumulative_amount_mismatch";
|
|
4512
|
+
readonly batch_settlement_channel_busy: "batch_settlement_channel_busy";
|
|
4513
|
+
readonly missing_batch_settlement_channel: "missing_batch_settlement_channel";
|
|
4514
|
+
readonly batch_settlement_charge_exceeds_signed_cumulative: "batch_settlement_charge_exceeds_signed_cumulative";
|
|
4515
|
+
readonly batch_settlement_refund_no_balance: "batch_settlement_refund_no_balance";
|
|
4516
|
+
readonly batch_settlement_refund_amount_invalid: "batch_settlement_refund_amount_invalid";
|
|
4517
|
+
readonly batch_settlement_refund_amount_exceeds_balance: "batch_settlement_refund_amount_exceeds_balance";
|
|
4518
|
+
readonly amount_too_low: "amount_too_low";
|
|
4519
|
+
readonly invalid_amount: "invalid_amount";
|
|
4520
|
+
readonly kyt_risk_detected: "kyt_risk_detected";
|
|
4521
|
+
readonly permit2_disabled: "permit2_disabled";
|
|
4522
|
+
readonly preflight_validation_failed: "preflight_validation_failed";
|
|
4523
|
+
readonly request_blocked_by_location: "request_blocked_by_location";
|
|
4524
|
+
readonly self_send_not_allowed: "self_send_not_allowed";
|
|
4525
|
+
readonly invalid_bazaar_extension: "invalid_bazaar_extension";
|
|
3178
4526
|
readonly unknown_error: "unknown_error";
|
|
3179
4527
|
};
|
|
3180
4528
|
/**
|
|
@@ -3186,15 +4534,12 @@ export interface X402SettlePaymentRejection {
|
|
|
3186
4534
|
errorReason: X402SettleErrorReason;
|
|
3187
4535
|
/** The message describing the error reason. */
|
|
3188
4536
|
errorMessage?: string;
|
|
3189
|
-
/**
|
|
3190
|
-
* The onchain address of the client that is paying for the resource.
|
|
4537
|
+
/** The onchain address of the client that is paying for the resource.
|
|
3191
4538
|
|
|
3192
4539
|
For EVM networks, the payer will be a 0x-prefixed, checksum EVM address.
|
|
3193
4540
|
|
|
3194
|
-
For Solana-based networks, the payer will be a base58-encoded Solana address.
|
|
3195
|
-
|
|
3196
|
-
*/
|
|
3197
|
-
payer?: string;
|
|
4541
|
+
For Solana-based networks, the payer will be a base58-encoded Solana address. */
|
|
4542
|
+
payer?: BlockchainAddress;
|
|
3198
4543
|
/**
|
|
3199
4544
|
* The transaction of the settlement.
|
|
3200
4545
|
For EVM networks, the transaction will be a 0x-prefixed, EVM transaction hash.
|
|
@@ -3212,9 +4557,10 @@ export type X402SupportedPaymentKindScheme = (typeof X402SupportedPaymentKindSch
|
|
|
3212
4557
|
export declare const X402SupportedPaymentKindScheme: {
|
|
3213
4558
|
readonly exact: "exact";
|
|
3214
4559
|
readonly upto: "upto";
|
|
4560
|
+
readonly "batch-settlement": "batch-settlement";
|
|
3215
4561
|
};
|
|
3216
4562
|
/**
|
|
3217
|
-
* The network of the blockchain.
|
|
4563
|
+
* The network of the blockchain. The format corresponds to the `x402Version` of the enclosing `x402SupportedPaymentKind`: v1 uses human-readable names (see `X402V1Network`); v2 uses CAIP-2 chain IDs (see `X402V2Network`).
|
|
3218
4564
|
*/
|
|
3219
4565
|
export type X402SupportedPaymentKindNetwork = (typeof X402SupportedPaymentKindNetwork)[keyof typeof X402SupportedPaymentKindNetwork];
|
|
3220
4566
|
export declare const X402SupportedPaymentKindNetwork: {
|
|
@@ -3222,20 +4568,21 @@ export declare const X402SupportedPaymentKindNetwork: {
|
|
|
3222
4568
|
readonly base: "base";
|
|
3223
4569
|
readonly "solana-devnet": "solana-devnet";
|
|
3224
4570
|
readonly solana: "solana";
|
|
3225
|
-
readonly polygon: "polygon";
|
|
3226
4571
|
readonly "eip155:8453": "eip155:8453";
|
|
3227
4572
|
readonly "eip155:84532": "eip155:84532";
|
|
3228
4573
|
readonly "eip155:137": "eip155:137";
|
|
4574
|
+
readonly "eip155:42161": "eip155:42161";
|
|
4575
|
+
readonly "eip155:480": "eip155:480";
|
|
4576
|
+
readonly "eip155:4801": "eip155:4801";
|
|
3229
4577
|
readonly "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp";
|
|
3230
4578
|
readonly "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1": "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1";
|
|
3231
|
-
readonly avalanche: "avalanche";
|
|
3232
|
-
readonly arbitrum: "arbitrum";
|
|
3233
|
-
readonly "arbitrum-sepolia": "arbitrum-sepolia";
|
|
3234
|
-
readonly world: "world";
|
|
3235
|
-
readonly "world-sepolia": "world-sepolia";
|
|
3236
4579
|
};
|
|
3237
4580
|
/**
|
|
3238
4581
|
* The optional additional scheme-specific payment info.
|
|
4582
|
+
Common scheme-specific fields:
|
|
4583
|
+
- `exact` on Solana: `feePayer` — the base58-encoded Solana address that pays transaction fees.
|
|
4584
|
+
- `upto` on EVM: `name`, `version`, and `facilitatorAddress` — the EVM address of the facilitator that the client must bind into the Permit2 witness when constructing the payment payload.
|
|
4585
|
+
- `batch-settlement` on EVM: `name`, `version`, `receiverAuthorizer` (the EVM address authorized to sign claim batches), `withdrawDelay` (channel non-cooperative withdraw delay in seconds, 900–2,592,000), and optionally `assetTransferMethod` (e.g., `"eip3009"`).
|
|
3239
4586
|
*/
|
|
3240
4587
|
export type X402SupportedPaymentKindExtra = {
|
|
3241
4588
|
[key: string]: unknown;
|
|
@@ -3247,9 +4594,13 @@ export interface X402SupportedPaymentKind {
|
|
|
3247
4594
|
x402Version: X402Version;
|
|
3248
4595
|
/** The scheme of the payment protocol. */
|
|
3249
4596
|
scheme: X402SupportedPaymentKindScheme;
|
|
3250
|
-
/** The network of the blockchain. */
|
|
4597
|
+
/** The network of the blockchain. The format corresponds to the `x402Version` of the enclosing `x402SupportedPaymentKind`: v1 uses human-readable names (see `X402V1Network`); v2 uses CAIP-2 chain IDs (see `X402V2Network`). */
|
|
3251
4598
|
network: X402SupportedPaymentKindNetwork;
|
|
3252
|
-
/** The optional additional scheme-specific payment info.
|
|
4599
|
+
/** The optional additional scheme-specific payment info.
|
|
4600
|
+
Common scheme-specific fields:
|
|
4601
|
+
- `exact` on Solana: `feePayer` — the base58-encoded Solana address that pays transaction fees.
|
|
4602
|
+
- `upto` on EVM: `name`, `version`, and `facilitatorAddress` — the EVM address of the facilitator that the client must bind into the Permit2 witness when constructing the payment payload.
|
|
4603
|
+
- `batch-settlement` on EVM: `name`, `version`, `receiverAuthorizer` (the EVM address authorized to sign claim batches), `withdrawDelay` (channel non-cooperative withdraw delay in seconds, 900–2,592,000), and optionally `assetTransferMethod` (e.g., `"eip3009"`). */
|
|
3253
4604
|
extra?: X402SupportedPaymentKindExtra;
|
|
3254
4605
|
}
|
|
3255
4606
|
/**
|
|
@@ -3295,6 +4646,24 @@ export interface X402DiscoveryResource {
|
|
|
3295
4646
|
/** Map of x402 protocol extensions supported by the resource, keyed by extension name. */
|
|
3296
4647
|
extensions?: X402DiscoveryResourceExtensions;
|
|
3297
4648
|
quality?: X402ResourceQuality;
|
|
4649
|
+
/** Provider-supplied display name of the service this resource belongs to. This is a free-form
|
|
4650
|
+
label for grouping and presentation only — it is not a stable identifier, and two resources
|
|
4651
|
+
sharing the same `serviceName` are not guaranteed to belong to the same logical service.
|
|
4652
|
+
*/
|
|
4653
|
+
serviceName?: string;
|
|
4654
|
+
/** Provider-supplied, low-cardinality string labels associated with the resource for client-side
|
|
4655
|
+
filtering and display. Values are free-form (no controlled vocabulary) and case-sensitive.
|
|
4656
|
+
Order is not significant and duplicates are not expected.
|
|
4657
|
+
*/
|
|
4658
|
+
tags?: string[];
|
|
4659
|
+
/** URL of a square icon representing the service this resource belongs to. Distinct from a
|
|
4660
|
+
brand logo: this is intended for compact, list-view rendering (favicon-style) and is
|
|
4661
|
+
normalized to a square aspect ratio at ingestion. The image is moderated and re-hosted by
|
|
4662
|
+
Coinbase, so the URL is stable and safe to render directly in clients. Omitted when the
|
|
4663
|
+
provider did not supply an icon, when the supplied icon failed moderation, or when image
|
|
4664
|
+
processing was unavailable at ingestion time.
|
|
4665
|
+
*/
|
|
4666
|
+
iconUrl?: Url;
|
|
3298
4667
|
}
|
|
3299
4668
|
/**
|
|
3300
4669
|
* Pagination information for the response.
|
|
@@ -3340,12 +4709,13 @@ export interface X402DiscoveryMerchantResponse {
|
|
|
3340
4709
|
pagination: X402DiscoveryMerchantResponsePagination;
|
|
3341
4710
|
}
|
|
3342
4711
|
/**
|
|
3343
|
-
* The search method used to retrieve the results (e.g., "text"
|
|
4712
|
+
* The search method used to retrieve the results (e.g., "text", "vector", "hybrid").
|
|
3344
4713
|
*/
|
|
3345
4714
|
export type X402SearchResourcesResponseSearchMethod = (typeof X402SearchResourcesResponseSearchMethod)[keyof typeof X402SearchResourcesResponseSearchMethod];
|
|
3346
4715
|
export declare const X402SearchResourcesResponseSearchMethod: {
|
|
3347
4716
|
readonly text: "text";
|
|
3348
4717
|
readonly vector: "vector";
|
|
4718
|
+
readonly hybrid: "hybrid";
|
|
3349
4719
|
};
|
|
3350
4720
|
/**
|
|
3351
4721
|
* Response from a search for x402 resources.
|
|
@@ -3355,7 +4725,7 @@ export interface X402SearchResourcesResponse {
|
|
|
3355
4725
|
resources: X402DiscoveryResource[];
|
|
3356
4726
|
/** Indicates whether the result set was truncated because there were more results than the requested limit. */
|
|
3357
4727
|
partialResults: boolean;
|
|
3358
|
-
/** The search method used to retrieve the results (e.g., "text"
|
|
4728
|
+
/** The search method used to retrieve the results (e.g., "text", "vector", "hybrid"). */
|
|
3359
4729
|
searchMethod?: X402SearchResourcesResponseSearchMethod;
|
|
3360
4730
|
x402Version: X402Version;
|
|
3361
4731
|
}
|
|
@@ -3612,32 +4982,6 @@ export interface OnrampUserLimit {
|
|
|
3612
4982
|
/** The remaining amount or count available. */
|
|
3613
4983
|
remaining: string;
|
|
3614
4984
|
}
|
|
3615
|
-
/**
|
|
3616
|
-
* Date of birth.
|
|
3617
|
-
*/
|
|
3618
|
-
export interface DateOfBirth {
|
|
3619
|
-
/**
|
|
3620
|
-
* Day of birth (01-31).
|
|
3621
|
-
* @minLength 2
|
|
3622
|
-
* @maxLength 2
|
|
3623
|
-
* @pattern ^[0-9]{2}$
|
|
3624
|
-
*/
|
|
3625
|
-
day?: string;
|
|
3626
|
-
/**
|
|
3627
|
-
* Month of birth (01-12).
|
|
3628
|
-
* @minLength 2
|
|
3629
|
-
* @maxLength 2
|
|
3630
|
-
* @pattern ^[0-9]{2}$
|
|
3631
|
-
*/
|
|
3632
|
-
month?: string;
|
|
3633
|
-
/**
|
|
3634
|
-
* Year of birth (four digits).
|
|
3635
|
-
* @minLength 4
|
|
3636
|
-
* @maxLength 4
|
|
3637
|
-
* @pattern ^[0-9]{4}$
|
|
3638
|
-
*/
|
|
3639
|
-
year?: string;
|
|
3640
|
-
}
|
|
3641
4985
|
/**
|
|
3642
4986
|
* Populate the properties that correspond to the `fields` array from the user's `OnrampLimitUpgradeOption`.
|
|
3643
4987
|
*/
|
|
@@ -3658,9 +5002,168 @@ export interface OnrampLimitUpgradeRequest {
|
|
|
3658
5002
|
fields: OnrampLimitUpgradeIdentityFields;
|
|
3659
5003
|
}
|
|
3660
5004
|
/**
|
|
3661
|
-
*
|
|
5005
|
+
* The ID of the Payment Method, which is a UUID prefixed by the string `paymentMethod_`.
|
|
5006
|
+
* @pattern ^paymentMethod_[a-f0-9\-]{36}$
|
|
3662
5007
|
*/
|
|
3663
|
-
export type
|
|
5008
|
+
export type PaymentMethodId = string;
|
|
5009
|
+
/**
|
|
5010
|
+
* Common properties shared by all payment method types.
|
|
5011
|
+
*/
|
|
5012
|
+
export interface PaymentMethodBase {
|
|
5013
|
+
paymentMethodId: PaymentMethodId;
|
|
5014
|
+
/** Whether the payment method is active and can be used in transfers. A payment method may be inactive due to verification requirements or entity-level restrictions. */
|
|
5015
|
+
active: boolean;
|
|
5016
|
+
/** The timestamp when the payment method was created. */
|
|
5017
|
+
createdAt: string;
|
|
5018
|
+
/** The timestamp when the payment method was last updated. */
|
|
5019
|
+
updatedAt: string;
|
|
5020
|
+
}
|
|
5021
|
+
/**
|
|
5022
|
+
* Details specific to Fedwire (domestic USD wire) payment methods.
|
|
5023
|
+
*/
|
|
5024
|
+
export interface FedwireDetails {
|
|
5025
|
+
/** The asset for this payment method. Always `usd` for Fedwire. */
|
|
5026
|
+
asset: string;
|
|
5027
|
+
/** The name of the bank. */
|
|
5028
|
+
bankName: string;
|
|
5029
|
+
/**
|
|
5030
|
+
* The last 4 digits of the bank account number.
|
|
5031
|
+
* @pattern ^[0-9]{4}$
|
|
5032
|
+
*/
|
|
5033
|
+
accountLast4: string;
|
|
5034
|
+
/**
|
|
5035
|
+
* The ABA routing number of the bank.
|
|
5036
|
+
* @pattern ^[0-9]{9}$
|
|
5037
|
+
*/
|
|
5038
|
+
routingNumber: string;
|
|
5039
|
+
}
|
|
5040
|
+
/**
|
|
5041
|
+
* The payment rail for this payment method.
|
|
5042
|
+
*/
|
|
5043
|
+
export type FedwirePaymentMethodAllOfPaymentRail = (typeof FedwirePaymentMethodAllOfPaymentRail)[keyof typeof FedwirePaymentMethodAllOfPaymentRail];
|
|
5044
|
+
export declare const FedwirePaymentMethodAllOfPaymentRail: {
|
|
5045
|
+
readonly fedwire: "fedwire";
|
|
5046
|
+
};
|
|
5047
|
+
export type FedwirePaymentMethodAllOf = {
|
|
5048
|
+
/** The payment rail for this payment method. */
|
|
5049
|
+
paymentRail: FedwirePaymentMethodAllOfPaymentRail;
|
|
5050
|
+
/** Fedwire (domestic USD wire) details. */
|
|
5051
|
+
fedwire: FedwireDetails;
|
|
5052
|
+
};
|
|
5053
|
+
export type FedwirePaymentMethodPaymentRail = (typeof FedwirePaymentMethodPaymentRail)[keyof typeof FedwirePaymentMethodPaymentRail];
|
|
5054
|
+
export declare const FedwirePaymentMethodPaymentRail: {
|
|
5055
|
+
readonly fedwire: "fedwire";
|
|
5056
|
+
};
|
|
5057
|
+
/**
|
|
5058
|
+
* A Fedwire (domestic USD wire) payment method linked to your entity.
|
|
5059
|
+
*/
|
|
5060
|
+
export type FedwirePaymentMethod = PaymentMethodBase & FedwirePaymentMethodAllOf & {
|
|
5061
|
+
paymentRail: FedwirePaymentMethodPaymentRail;
|
|
5062
|
+
};
|
|
5063
|
+
/**
|
|
5064
|
+
* Details specific to SWIFT (international wire) payment methods.
|
|
5065
|
+
*/
|
|
5066
|
+
export interface SwiftDetails {
|
|
5067
|
+
/** The asset for this payment method (e.g., `eur`, `gbp`). */
|
|
5068
|
+
asset: string;
|
|
5069
|
+
/** The name of the bank. */
|
|
5070
|
+
bankName: string;
|
|
5071
|
+
/**
|
|
5072
|
+
* The last 4 characters of the account identifier. For IBAN-based accounts (e.g., EU), this is the last 4 characters of the IBAN. For account number-based accounts (e.g., US), this is the last 4 digits of the account number.
|
|
5073
|
+
* @pattern ^[A-Z0-9]{4}$
|
|
5074
|
+
*/
|
|
5075
|
+
accountLast4: string;
|
|
5076
|
+
/**
|
|
5077
|
+
* Deprecated: use `accountLast4` instead. The last 4 characters of the account identifier.
|
|
5078
|
+
* @deprecated
|
|
5079
|
+
* @pattern ^[A-Z0-9]{4}$
|
|
5080
|
+
*/
|
|
5081
|
+
ibanLast4?: string;
|
|
5082
|
+
/**
|
|
5083
|
+
* The Bank Identifier Code (BIC) / SWIFT code.
|
|
5084
|
+
* @pattern ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$
|
|
5085
|
+
*/
|
|
5086
|
+
bic: string;
|
|
5087
|
+
}
|
|
5088
|
+
/**
|
|
5089
|
+
* The payment rail for this payment method.
|
|
5090
|
+
*/
|
|
5091
|
+
export type SwiftPaymentMethodAllOfPaymentRail = (typeof SwiftPaymentMethodAllOfPaymentRail)[keyof typeof SwiftPaymentMethodAllOfPaymentRail];
|
|
5092
|
+
export declare const SwiftPaymentMethodAllOfPaymentRail: {
|
|
5093
|
+
readonly swift: "swift";
|
|
5094
|
+
};
|
|
5095
|
+
export type SwiftPaymentMethodAllOf = {
|
|
5096
|
+
/** The payment rail for this payment method. */
|
|
5097
|
+
paymentRail: SwiftPaymentMethodAllOfPaymentRail;
|
|
5098
|
+
/** SWIFT (international wire) details. */
|
|
5099
|
+
swift: SwiftDetails;
|
|
5100
|
+
};
|
|
5101
|
+
export type SwiftPaymentMethodPaymentRail = (typeof SwiftPaymentMethodPaymentRail)[keyof typeof SwiftPaymentMethodPaymentRail];
|
|
5102
|
+
export declare const SwiftPaymentMethodPaymentRail: {
|
|
5103
|
+
readonly swift: "swift";
|
|
5104
|
+
};
|
|
5105
|
+
/**
|
|
5106
|
+
* A SWIFT (international wire) payment method linked to your entity.
|
|
5107
|
+
*/
|
|
5108
|
+
export type SwiftPaymentMethod = PaymentMethodBase & SwiftPaymentMethodAllOf & {
|
|
5109
|
+
paymentRail: SwiftPaymentMethodPaymentRail;
|
|
5110
|
+
};
|
|
5111
|
+
/**
|
|
5112
|
+
* Details specific to SEPA (Single Euro Payments Area) payment methods.
|
|
5113
|
+
*/
|
|
5114
|
+
export interface SepaDetails {
|
|
5115
|
+
/** The asset for this payment method. Always `eur` for SEPA. */
|
|
5116
|
+
asset: string;
|
|
5117
|
+
/** The name of the bank. */
|
|
5118
|
+
bankName: string;
|
|
5119
|
+
/**
|
|
5120
|
+
* The last 4 characters of the IBAN.
|
|
5121
|
+
* @pattern ^[A-Z0-9]{4}$
|
|
5122
|
+
*/
|
|
5123
|
+
ibanLast4: string;
|
|
5124
|
+
/**
|
|
5125
|
+
* The Bank Identifier Code (BIC) / SWIFT code.
|
|
5126
|
+
* @pattern ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$
|
|
5127
|
+
*/
|
|
5128
|
+
bic: string;
|
|
5129
|
+
}
|
|
5130
|
+
/**
|
|
5131
|
+
* The payment rail for this payment method.
|
|
5132
|
+
*/
|
|
5133
|
+
export type SepaPaymentMethodAllOfPaymentRail = (typeof SepaPaymentMethodAllOfPaymentRail)[keyof typeof SepaPaymentMethodAllOfPaymentRail];
|
|
5134
|
+
export declare const SepaPaymentMethodAllOfPaymentRail: {
|
|
5135
|
+
readonly sepa: "sepa";
|
|
5136
|
+
};
|
|
5137
|
+
export type SepaPaymentMethodAllOf = {
|
|
5138
|
+
/** The payment rail for this payment method. */
|
|
5139
|
+
paymentRail: SepaPaymentMethodAllOfPaymentRail;
|
|
5140
|
+
/** SEPA (Single Euro Payments Area) details. */
|
|
5141
|
+
sepa: SepaDetails;
|
|
5142
|
+
};
|
|
5143
|
+
export type SepaPaymentMethodPaymentRail = (typeof SepaPaymentMethodPaymentRail)[keyof typeof SepaPaymentMethodPaymentRail];
|
|
5144
|
+
export declare const SepaPaymentMethodPaymentRail: {
|
|
5145
|
+
readonly sepa: "sepa";
|
|
5146
|
+
};
|
|
5147
|
+
/**
|
|
5148
|
+
* A SEPA (Single Euro Payments Area) payment method linked to your entity.
|
|
5149
|
+
*/
|
|
5150
|
+
export type SepaPaymentMethod = PaymentMethodBase & SepaPaymentMethodAllOf & {
|
|
5151
|
+
paymentRail: SepaPaymentMethodPaymentRail;
|
|
5152
|
+
};
|
|
5153
|
+
/**
|
|
5154
|
+
* A payment method linked to your entity. Payment methods represent external financial instruments that can be used as a target for transfers.
|
|
5155
|
+
|
|
5156
|
+
The `paymentRail` field indicates which type-specific details object is present. Type-specific fields are nested under a key matching the rail name (e.g., `fedwire`, `swift`).
|
|
5157
|
+
*/
|
|
5158
|
+
export type PaymentMethodsPaymentMethod = FedwirePaymentMethod | SwiftPaymentMethod | SepaPaymentMethod;
|
|
5159
|
+
/**
|
|
5160
|
+
* Idempotency key conflict.
|
|
5161
|
+
*/
|
|
5162
|
+
export type IdempotencyErrorResponse = Error;
|
|
5163
|
+
/**
|
|
5164
|
+
* The endpoint cannot serve the request right now, either because the API is in an unintended outage (`service_unavailable` — dependency failure, deploy issue) or because an operator has intentionally disabled this specific endpoint via a kill switch (`endpoint_unavailable`). Clients should dispatch on `errorType`: `service_unavailable` is typically transient and safe to retry, while `endpoint_unavailable` may persist until an operator re-enables the endpoint.
|
|
5165
|
+
*/
|
|
5166
|
+
export type EndpointUnavailableErrorResponse = Error;
|
|
3664
5167
|
/**
|
|
3665
5168
|
* Internal server error.
|
|
3666
5169
|
*/
|
|
@@ -3673,14 +5176,18 @@ export type BadGatewayErrorResponse = Error;
|
|
|
3673
5176
|
* Service unavailable.
|
|
3674
5177
|
*/
|
|
3675
5178
|
export type ServiceUnavailableErrorResponse = Error;
|
|
5179
|
+
/**
|
|
5180
|
+
* Unauthorized.
|
|
5181
|
+
*/
|
|
5182
|
+
export type UnauthorizedErrorResponse = Error;
|
|
3676
5183
|
/**
|
|
3677
5184
|
* A payment method is required to complete this operation.
|
|
3678
5185
|
*/
|
|
3679
5186
|
export type PaymentMethodRequiredErrorResponse = Error;
|
|
3680
5187
|
/**
|
|
3681
|
-
*
|
|
5188
|
+
* The request was rejected due to a delegation issue. The errorType field indicates the specific reason.
|
|
3682
5189
|
*/
|
|
3683
|
-
export type
|
|
5190
|
+
export type DelegationForbiddenErrorResponse = Error;
|
|
3684
5191
|
/**
|
|
3685
5192
|
* The resource already exists.
|
|
3686
5193
|
*/
|
|
@@ -3697,41 +5204,49 @@ export type ClientClosedRequestErrorResponse = Error;
|
|
|
3697
5204
|
* The request timed out.
|
|
3698
5205
|
*/
|
|
3699
5206
|
export type TimedOutErrorResponse = Error;
|
|
5207
|
+
/**
|
|
5208
|
+
* Optional scheme-specific verify metadata returned by the facilitator.
|
|
5209
|
+
*/
|
|
5210
|
+
export type X402VerifyResponseResponseExtra = {
|
|
5211
|
+
[key: string]: unknown;
|
|
5212
|
+
};
|
|
3700
5213
|
export type X402VerifyResponseResponse = {
|
|
3701
5214
|
/** Indicates whether the payment is valid. */
|
|
3702
5215
|
isValid: boolean;
|
|
3703
5216
|
invalidReason?: X402VerifyInvalidReason;
|
|
3704
5217
|
/** The message describing the invalid reason. */
|
|
3705
5218
|
invalidMessage?: string;
|
|
3706
|
-
/**
|
|
3707
|
-
* The onchain address of the client that is paying for the resource.
|
|
5219
|
+
/** The onchain address of the client that is paying for the resource.
|
|
3708
5220
|
|
|
3709
5221
|
For EVM networks, the payer will be a 0x-prefixed, checksum EVM address.
|
|
3710
5222
|
|
|
3711
|
-
For Solana-based networks, the payer will be a base58-encoded Solana address.
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
|
-
|
|
5223
|
+
For Solana-based networks, the payer will be a base58-encoded Solana address. */
|
|
5224
|
+
payer: BlockchainAddress;
|
|
5225
|
+
/** Optional scheme-specific verify metadata returned by the facilitator. */
|
|
5226
|
+
extra?: X402VerifyResponseResponseExtra;
|
|
3715
5227
|
};
|
|
3716
5228
|
/**
|
|
3717
5229
|
* Invalid payment verification on the x402 protocol.
|
|
3718
5230
|
*/
|
|
3719
5231
|
export type X402VerifyInvalidErrorResponse = X402VerifyPaymentRejection;
|
|
5232
|
+
/**
|
|
5233
|
+
* Optional scheme-specific success metadata returned by the facilitator.
|
|
5234
|
+
*/
|
|
5235
|
+
export type X402SettleResponseResponseExtra = {
|
|
5236
|
+
[key: string]: unknown;
|
|
5237
|
+
};
|
|
3720
5238
|
export type X402SettleResponseResponse = {
|
|
3721
5239
|
/** Indicates whether the payment settlement is successful. */
|
|
3722
5240
|
success: boolean;
|
|
3723
5241
|
errorReason?: X402SettleErrorReason;
|
|
3724
5242
|
/** The message describing the error reason. */
|
|
3725
5243
|
errorMessage?: string;
|
|
3726
|
-
/**
|
|
3727
|
-
* The onchain address of the client that is paying for the resource.
|
|
5244
|
+
/** The onchain address of the client that is paying for the resource.
|
|
3728
5245
|
|
|
3729
5246
|
For EVM networks, the payer will be a 0x-prefixed, checksum EVM address.
|
|
3730
5247
|
|
|
3731
|
-
For Solana-based networks, the payer will be a base58-encoded Solana address.
|
|
3732
|
-
|
|
3733
|
-
*/
|
|
3734
|
-
payer: string;
|
|
5248
|
+
For Solana-based networks, the payer will be a base58-encoded Solana address. */
|
|
5249
|
+
payer: BlockchainAddress;
|
|
3735
5250
|
/**
|
|
3736
5251
|
* The transaction of the settlement.
|
|
3737
5252
|
For EVM networks, the transaction will be a 0x-prefixed, EVM transaction hash.
|
|
@@ -3743,6 +5258,8 @@ export type X402SettleResponseResponse = {
|
|
|
3743
5258
|
network: string;
|
|
3744
5259
|
/** The amount that was settled, in atomic units. */
|
|
3745
5260
|
amount?: string;
|
|
5261
|
+
/** Optional scheme-specific success metadata returned by the facilitator. */
|
|
5262
|
+
extra?: X402SettleResponseResponseExtra;
|
|
3746
5263
|
};
|
|
3747
5264
|
/**
|
|
3748
5265
|
* Unsuccessful payment settlement on the x402 protocol.
|
|
@@ -3767,12 +5284,13 @@ export type X402SupportedPaymentKindsResponseResponse = {
|
|
|
3767
5284
|
*/
|
|
3768
5285
|
export type RateLimitExceededResponse = Error;
|
|
3769
5286
|
/**
|
|
3770
|
-
*
|
|
3771
|
-
[Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token)
|
|
3772
|
-
section of our Authentication docs for more details on how to generate your Wallet Token.
|
|
3773
|
-
|
|
5287
|
+
* The number of resources to return per page.
|
|
3774
5288
|
*/
|
|
3775
|
-
export type
|
|
5289
|
+
export type PageSizeParameter = number;
|
|
5290
|
+
/**
|
|
5291
|
+
* The token for the next page of resources, if any.
|
|
5292
|
+
*/
|
|
5293
|
+
export type PageTokenParameter = string;
|
|
3776
5294
|
/**
|
|
3777
5295
|
* An optional string request header for making requests safely retryable.
|
|
3778
5296
|
When included, duplicate requests with the same key will return identical responses.
|
|
@@ -3783,6 +5301,13 @@ export type IdempotencyKeyParameter = string;
|
|
|
3783
5301
|
/**
|
|
3784
5302
|
* A JWT signed using your Wallet Secret, encoded in base64. Refer to the
|
|
3785
5303
|
[Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token)
|
|
5304
|
+
section of our Authentication docs for more details on how to generate your Wallet Token.
|
|
5305
|
+
|
|
5306
|
+
*/
|
|
5307
|
+
export type XWalletAuthParameter = string;
|
|
5308
|
+
/**
|
|
5309
|
+
* A JWT signed using your Wallet Secret, encoded in base64. Refer to the
|
|
5310
|
+
[Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token)
|
|
3786
5311
|
section of our Authentication docs for more details on how to generate your Wallet Token.
|
|
3787
5312
|
|
|
3788
5313
|
*/
|
|
@@ -3798,14 +5323,139 @@ export type XDeveloperAuthParameter = string;
|
|
|
3798
5323
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3799
5324
|
*/
|
|
3800
5325
|
export type ProjectIDOptionalParameter = string;
|
|
3801
|
-
|
|
3802
|
-
|
|
3803
|
-
|
|
3804
|
-
|
|
3805
|
-
|
|
3806
|
-
|
|
3807
|
-
|
|
3808
|
-
|
|
5326
|
+
export type ListFoundationAccountsParams = {
|
|
5327
|
+
/**
|
|
5328
|
+
* The number of resources to return per page.
|
|
5329
|
+
*/
|
|
5330
|
+
pageSize?: PageSizeParameter;
|
|
5331
|
+
/**
|
|
5332
|
+
* The token for the next page of resources, if any.
|
|
5333
|
+
*/
|
|
5334
|
+
pageToken?: PageTokenParameter;
|
|
5335
|
+
/**
|
|
5336
|
+
* Filter accounts by account type. When omitted, accounts of any type are returned. Combined with `owner` using AND.
|
|
5337
|
+
*/
|
|
5338
|
+
type?: AccountType;
|
|
5339
|
+
};
|
|
5340
|
+
export type ListFoundationAccounts200AllOf = {
|
|
5341
|
+
/** The list of accounts. */
|
|
5342
|
+
accounts: Account[];
|
|
5343
|
+
};
|
|
5344
|
+
export type ListFoundationAccounts200 = ListFoundationAccounts200AllOf & ListResponse;
|
|
5345
|
+
export type ListBalancesParams = {
|
|
5346
|
+
/**
|
|
5347
|
+
* The number of resources to return per page.
|
|
5348
|
+
*/
|
|
5349
|
+
pageSize?: PageSizeParameter;
|
|
5350
|
+
/**
|
|
5351
|
+
* The token for the next page of resources, if any.
|
|
5352
|
+
*/
|
|
5353
|
+
pageToken?: PageTokenParameter;
|
|
5354
|
+
};
|
|
5355
|
+
export type ListBalances200 = Balances & ListResponse;
|
|
5356
|
+
export type ListDepositDestinationsParams = {
|
|
5357
|
+
/**
|
|
5358
|
+
* Filter deposit destinations by account ID.
|
|
5359
|
+
*/
|
|
5360
|
+
accountId?: AccountId;
|
|
5361
|
+
/**
|
|
5362
|
+
* The cryptocurrency address to filter by. Format depends on the network (e.g., 0x-prefixed for EVM networks, base58 for Solana).
|
|
5363
|
+
*/
|
|
5364
|
+
address?: string;
|
|
5365
|
+
/**
|
|
5366
|
+
* Filter deposit destinations by type.
|
|
5367
|
+
*/
|
|
5368
|
+
type?: DepositDestinationType;
|
|
5369
|
+
/**
|
|
5370
|
+
* The blockchain network to filter by (e.g., base, ethereum). Only applies to crypto deposit destinations.
|
|
5371
|
+
*/
|
|
5372
|
+
network?: string;
|
|
5373
|
+
/**
|
|
5374
|
+
* The number of resources to return per page.
|
|
5375
|
+
*/
|
|
5376
|
+
pageSize?: PageSizeParameter;
|
|
5377
|
+
/**
|
|
5378
|
+
* The token for the next page of resources, if any.
|
|
5379
|
+
*/
|
|
5380
|
+
pageToken?: PageTokenParameter;
|
|
5381
|
+
};
|
|
5382
|
+
export type ListDepositDestinations200AllOf = {
|
|
5383
|
+
/** The list of deposit destinations. */
|
|
5384
|
+
depositDestinations: DepositDestination[];
|
|
5385
|
+
};
|
|
5386
|
+
export type ListDepositDestinations200 = ListDepositDestinations200AllOf & ListResponse;
|
|
5387
|
+
export type ListTransfersParams = {
|
|
5388
|
+
/**
|
|
5389
|
+
* Filter transfers by status. Useful for building dashboards, monitoring active transfers, or finding transfers needing action.
|
|
5390
|
+
*/
|
|
5391
|
+
status?: TransferStatus;
|
|
5392
|
+
/**
|
|
5393
|
+
* Filter transfers by account ID. Returns transfers where the specified account is either the source or target (OR semantics). Cannot be combined with `sourceAccountId` or `targetAccountId`.
|
|
5394
|
+
*/
|
|
5395
|
+
accountId?: AccountId;
|
|
5396
|
+
/**
|
|
5397
|
+
* Filter transfers by source account ID. Returns only transfers where the specified account is the source. Cannot be combined with `accountId`.
|
|
5398
|
+
*/
|
|
5399
|
+
sourceAccountId?: AccountId;
|
|
5400
|
+
/**
|
|
5401
|
+
* Filter transfers by target account ID. Returns only transfers where the specified account is the target. Cannot be combined with `accountId`.
|
|
5402
|
+
*/
|
|
5403
|
+
targetAccountId?: AccountId;
|
|
5404
|
+
/**
|
|
5405
|
+
* Filter transfers to those created at or after this datetime (inclusive). ISO 8601 format.
|
|
5406
|
+
*/
|
|
5407
|
+
createdAfter?: string;
|
|
5408
|
+
/**
|
|
5409
|
+
* Filter transfers to those created at or before this datetime (inclusive). ISO 8601 format.
|
|
5410
|
+
*/
|
|
5411
|
+
createdBefore?: string;
|
|
5412
|
+
/**
|
|
5413
|
+
* Filter transfers to those updated at or after this datetime (inclusive). ISO 8601 format. Useful for incremental sync — poll for transfers that changed state since your last check.
|
|
5414
|
+
*/
|
|
5415
|
+
updatedAfter?: string;
|
|
5416
|
+
/**
|
|
5417
|
+
* Filter transfers to those updated at or before this datetime (inclusive). ISO 8601 format.
|
|
5418
|
+
*/
|
|
5419
|
+
updatedBefore?: string;
|
|
5420
|
+
/**
|
|
5421
|
+
* Filter transfers by source asset symbol (e.g., `usd`, `usdc`).
|
|
5422
|
+
*/
|
|
5423
|
+
sourceAsset?: string;
|
|
5424
|
+
/**
|
|
5425
|
+
* Filter transfers by target asset symbol (e.g., `usdc`, `eth`).
|
|
5426
|
+
*/
|
|
5427
|
+
targetAsset?: string;
|
|
5428
|
+
/**
|
|
5429
|
+
* Filter transfers by the on-chain address of the source.
|
|
5430
|
+
*/
|
|
5431
|
+
sourceAddress?: BlockchainAddress;
|
|
5432
|
+
/**
|
|
5433
|
+
* Filter transfers by the on-chain destination address of the target.
|
|
5434
|
+
*/
|
|
5435
|
+
targetAddress?: BlockchainAddress;
|
|
5436
|
+
/**
|
|
5437
|
+
* Filter transfers by the email address of the target recipient.
|
|
5438
|
+
*/
|
|
5439
|
+
targetEmail?: Email;
|
|
5440
|
+
/**
|
|
5441
|
+
* Filter to a specific transfer by ID. When provided, returns only the matching transfer and bypasses pagination.
|
|
5442
|
+
* @pattern ^transfer_[a-f0-9\-]{36}$
|
|
5443
|
+
*/
|
|
5444
|
+
transferId?: string;
|
|
5445
|
+
/**
|
|
5446
|
+
* The number of resources to return per page.
|
|
5447
|
+
*/
|
|
5448
|
+
pageSize?: PageSizeParameter;
|
|
5449
|
+
/**
|
|
5450
|
+
* The token for the next page of resources, if any.
|
|
5451
|
+
*/
|
|
5452
|
+
pageToken?: PageTokenParameter;
|
|
5453
|
+
};
|
|
5454
|
+
export type ListTransfers200AllOf = {
|
|
5455
|
+
/** The list of transfers. */
|
|
5456
|
+
transfers: Transfer[];
|
|
5457
|
+
};
|
|
5458
|
+
export type ListTransfers200 = ListTransfers200AllOf & ListResponse;
|
|
3809
5459
|
/**
|
|
3810
5460
|
* Configuration for creating an EVM account for the end user.
|
|
3811
5461
|
*/
|
|
@@ -3873,7 +5523,7 @@ export type LookupEndUserParams = {
|
|
|
3873
5523
|
/**
|
|
3874
5524
|
* The email address to search for across all email-based authentication methods.
|
|
3875
5525
|
*/
|
|
3876
|
-
email?:
|
|
5526
|
+
email?: Email;
|
|
3877
5527
|
/**
|
|
3878
5528
|
* The OAuth provider to search by. Must be provided together with oauthSubject.
|
|
3879
5529
|
*/
|
|
@@ -3884,9 +5534,8 @@ export type LookupEndUserParams = {
|
|
|
3884
5534
|
oauthSubject?: string;
|
|
3885
5535
|
/**
|
|
3886
5536
|
* The E.164-formatted phone number to search for. Must be URL-encoded when passed as a query parameter (e.g. `+14155552671` → `%2B14155552671`).
|
|
3887
|
-
* @pattern ^\+[1-9]\d{1,14}$
|
|
3888
5537
|
*/
|
|
3889
|
-
phoneNumber?:
|
|
5538
|
+
phoneNumber?: PhoneNumber;
|
|
3890
5539
|
};
|
|
3891
5540
|
export type LookupEndUser200 = {
|
|
3892
5541
|
/** The list of end users matching the lookup. */
|
|
@@ -5111,4 +6760,19 @@ export type GetOnrampUserLimits200 = {
|
|
|
5111
6760
|
/** The list of limits applicable to the user. */
|
|
5112
6761
|
limits: OnrampUserLimit[];
|
|
5113
6762
|
};
|
|
6763
|
+
export type ListPaymentMethodsParams = {
|
|
6764
|
+
/**
|
|
6765
|
+
* The number of resources to return per page.
|
|
6766
|
+
*/
|
|
6767
|
+
pageSize?: PageSizeParameter;
|
|
6768
|
+
/**
|
|
6769
|
+
* The token for the next page of resources, if any.
|
|
6770
|
+
*/
|
|
6771
|
+
pageToken?: PageTokenParameter;
|
|
6772
|
+
};
|
|
6773
|
+
export type ListPaymentMethods200AllOf = {
|
|
6774
|
+
/** The list of payment methods. */
|
|
6775
|
+
paymentMethods: PaymentMethodsPaymentMethod[];
|
|
6776
|
+
};
|
|
6777
|
+
export type ListPaymentMethods200 = ListPaymentMethods200AllOf & ListResponse;
|
|
5114
6778
|
//# sourceMappingURL=coinbaseDeveloperPlatformAPIs.schemas.d.ts.map
|