Module types

Source

Expand description

Types used as operation parameters and responses.

Modules§

builder: Types for composing complex structures.
defaults: Generation of default values for serde.
error: Error types.

Structs§

Abi: Contract ABI Specification following Solidity’s external JSON interface format.
AbiFunction: ABI function type for contract functions.
AbiInput: Generic ABI item type encapsulating all other types besides function.
AbiParameter: Parameter definition for ABI functions, errors, and constructors.
AccountTokenAddressesResponse: Response containing token addresses that an account has received.
AccountTokenAddressesResponseTokenAddressesItem: Token contract address.
AuthenticationMethods: The list of valid authentication methods linked to the end user.
CommonSwapResponse: CommonSwapResponse
CommonSwapResponseBlockNumber: The block number at which the liquidity conditions were examined.
CommonSwapResponseFees: The estimated fees for the swap.
CommonSwapResponseFromAmount: The amount of the fromToken that will be sent in this swap, in atomic units of the fromToken. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
CommonSwapResponseFromToken: The 0x-prefixed contract address of the token that will be sent.
CommonSwapResponseIssues: An object containing potential issues discovered during validation that could prevent the swap from being executed successfully.
CommonSwapResponseIssuesAllowance: Details of the allowances that the taker must set in order to execute the swap successfully. Null if no allowance is required.
CommonSwapResponseIssuesAllowanceCurrentAllowance: The current allowance of the fromToken by the taker.
CommonSwapResponseIssuesAllowanceSpender: The 0x-prefixed address of to set the allowance on.
CommonSwapResponseIssuesBalance: Details of the balance of the fromToken that the taker must hold. Null if the taker has a sufficient balance.
CommonSwapResponseIssuesBalanceCurrentBalance: The current balance of the fromToken by the taker.
CommonSwapResponseIssuesBalanceRequiredBalance: The amount of the token that the taker must hold.
CommonSwapResponseIssuesBalanceToken: The 0x-prefixed contract address of the token.
CommonSwapResponseMinToAmount: The minimum amount of the toToken that must be received for the swap to succeed, in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc. This value is influenced by the slippageBps parameter.
CommonSwapResponseToAmount: The amount of the toToken that will be received in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc.
CommonSwapResponseToToken: The 0x-prefixed contract address of the token that will be received.
CreateEvmAccountBody: CreateEvmAccountBody
CreateEvmAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account.
CreateEvmAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
CreateEvmAccountXIdempotencyKey: CreateEvmAccountXIdempotencyKey
CreateEvmSmartAccountBody: CreateEvmSmartAccountBody
CreateEvmSmartAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
CreateEvmSmartAccountBodyOwnersItem: CreateEvmSmartAccountBodyOwnersItem
CreateEvmSmartAccountXIdempotencyKey: CreateEvmSmartAccountXIdempotencyKey
CreateEvmSwapQuoteBody: CreateEvmSwapQuoteBody
CreateEvmSwapQuoteBodyFromAmount: The amount of the fromToken to send in atomic units of the token. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
CreateEvmSwapQuoteBodyFromToken: The 0x-prefixed contract address of the token to send.
CreateEvmSwapQuoteBodyGasPrice: The target gas price for the swap transaction, in Wei. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. If not provided, the API will use an estimate based on the current network conditions.
CreateEvmSwapQuoteBodySignerAddress: The 0x-prefixed Externally Owned Account (EOA) address that will sign the Permit2 EIP-712 permit message. This is only needed if taker is a smart contract.
CreateEvmSwapQuoteBodyTaker: The 0x-prefixed address that holds the fromToken balance and has the Permit2 allowance set for the swap.
CreateEvmSwapQuoteBodyToToken: The 0x-prefixed contract address of the token to receive.
CreateEvmSwapQuoteXIdempotencyKey: CreateEvmSwapQuoteXIdempotencyKey
CreateOnrampOrderBody: CreateOnrampOrderBody
CreateOnrampOrderResponse: CreateOnrampOrderResponse
CreatePaymentTransferQuoteBody: CreatePaymentTransferQuoteBody
CreatePaymentTransferQuoteResponse: CreatePaymentTransferQuoteResponse
CreatePolicyBody: CreatePolicyBody
CreatePolicyBodyDescription: An optional human-readable description for the policy. Policy descriptions can consist of alphanumeric characters, spaces, commas, and periods, and be 50 characters or less.
CreatePolicyXIdempotencyKey: CreatePolicyXIdempotencyKey
CreateSolanaAccountBody: CreateSolanaAccountBody
CreateSolanaAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account.
CreateSolanaAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all Solana accounts in the developer’s CDP Project.
CreateSolanaAccountXIdempotencyKey: CreateSolanaAccountXIdempotencyKey
CreateSpendPermissionAddress: CreateSpendPermissionAddress
CreateSpendPermissionRequest: CreateSpendPermissionRequest
CreateSpendPermissionRequestSpender: Entity that can spend account’s tokens. Can be either a Smart Account or an EOA.
CreateSpendPermissionRequestToken: ERC-7528 native token address (e.g. “0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE” for native ETH), or an ERC-20 contract address.
CreateSpendPermissionXIdempotencyKey: CreateSpendPermissionXIdempotencyKey
CreateSwapQuoteResponse: CreateSwapQuoteResponse
CreateSwapQuoteResponseBlockNumber: The block number at which the liquidity conditions were examined.
CreateSwapQuoteResponseFees: The estimated fees for the swap.
CreateSwapQuoteResponseFromAmount: The amount of the fromToken that will be sent in this swap, in atomic units of the fromToken. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
CreateSwapQuoteResponseFromToken: The 0x-prefixed contract address of the token that will be sent.
CreateSwapQuoteResponseIssues: An object containing potential issues discovered during validation that could prevent the swap from being executed successfully.
CreateSwapQuoteResponseIssuesAllowance: Details of the allowances that the taker must set in order to execute the swap successfully. Null if no allowance is required.
CreateSwapQuoteResponseIssuesAllowanceCurrentAllowance: The current allowance of the fromToken by the taker.
CreateSwapQuoteResponseIssuesAllowanceSpender: The 0x-prefixed address of to set the allowance on.
CreateSwapQuoteResponseIssuesBalance: Details of the balance of the fromToken that the taker must hold. Null if the taker has a sufficient balance.
CreateSwapQuoteResponseIssuesBalanceCurrentBalance: The current balance of the fromToken by the taker.
CreateSwapQuoteResponseIssuesBalanceRequiredBalance: The amount of the token that the taker must hold.
CreateSwapQuoteResponseIssuesBalanceToken: The 0x-prefixed contract address of the token.
CreateSwapQuoteResponseMinToAmount: The minimum amount of the toToken that must be received for the swap to succeed, in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc. This value is influenced by the slippageBps parameter.
CreateSwapQuoteResponsePermit2: The approval object which contains the necessary fields to submit an approval for this transaction. Null if the fromToken is the native token or the transaction is a native token wrap / unwrap.
CreateSwapQuoteResponsePermit2Hash: The hash for the approval according to EIP-712. Computing the hash of the eip712 field should match the value of this field.
CreateSwapQuoteResponseToAmount: The amount of the toToken that will be received in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc.
CreateSwapQuoteResponseToToken: The 0x-prefixed contract address of the token that will be received.
CreateSwapQuoteResponseTransaction: The details of the transaction to be signed and submitted to execute the swap.
CreateSwapQuoteResponseTransactionGas: The estimated gas limit that should be used to send the transaction to guarantee settlement.
CreateSwapQuoteResponseTransactionGasPrice: The gas price, in Wei, that should be used to send the transaction. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. The transaction should be sent with this gas price to guarantee settlement.
CreateSwapQuoteResponseTransactionTo: The 0x-prefixed address of the contract to call.
CreateSwapQuoteResponseTransactionValue: The value of the transaction in Wei.
CryptoRail: The crypto rails available.
CryptoRailAddress: The crypto rail input object which specifies the symbol, network, and address which is the source or destination wallet address.
CryptoRailNetworksItem: The networks of the asset.
DeletePolicyPolicyId: DeletePolicyPolicyId
DeletePolicyXIdempotencyKey: DeletePolicyXIdempotencyKey
DeveloperJwtAuthentication: Information about an end user who authenticates using a JWT issued by the developer.
Eip712Domain: The domain of the EIP-712 typed data.
Eip712DomainSalt: The optional 32-byte 0x-prefixed hex salt for domain separation.
Eip712DomainVerifyingContract: The 0x-prefixed EVM address of the verifying smart contract.
Eip712Message: The message to sign using EIP-712.
Eip712Types: A mapping of struct names to an array of type objects (name + type). Each key corresponds to a type name (e.g., “EIP712Domain”, “PermitTransferFrom”).
EmailAuthentication: Information about an end user who authenticates using a one-time password sent to their email address.
EndUser: Information about the end user.
EndUserEvmAccountsItem: The address of the EVM account associated with the end user.
EndUserEvmSmartAccountsItem: The address of the EVM smart account associated with the end user.
EndUserSolanaAccountsItem: The base58 encoded address of the Solana account associated with the end user.
EndUserUserId: A stable, unique identifier for the end user. The userId must be unique across all end users in the developer’s CDP Project. It must be between 1 and 100 characters long and can only contain alphanumeric characters and hyphens.
Error: An error response including the code for the type of error and a human-readable message describing the error.
EthValueCriterion: A schema for specifying a criterion for the value field of an EVM transaction.
EthValueCriterionEthValue: The amount of ETH, in wei, that the transaction’s value field should be compared to.
EvmAccount: EvmAccount
EvmAccountAddress: The 0x-prefixed, checksum EVM address.
EvmAccountName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names are guaranteed to be unique across all EVM accounts in the developer’s CDP Project.
EvmAccountPoliciesItem: EvmAccountPoliciesItem
EvmAddressCriterion: A schema for specifying a criterion for the to field of an EVM transaction.
EvmAddressCriterionAddressesItem: The 0x-prefixed EVM address that the transaction’s to field should be compared to.
EvmCall: EvmCall
EvmCallData: The call data to send. This is the hex-encoded data of the function call consisting of the method selector and the function arguments.
EvmCallTo: The address the call is directed to.
EvmDataCondition: A single condition to apply against the function and encoded arguments in the transaction’s data field. Each parameter configuration must be successfully evaluated against the corresponding function argument in order for a policy to be accepted.
EvmDataCriterion: A schema for specifying a criterion for the data field of an EVM transaction.
EvmDataParameterCondition: EvmDataParameterCondition
EvmDataParameterConditionList: EvmDataParameterConditionList
EvmMessageCriterion: A schema for specifying a criterion for the message being signed.
EvmNetworkCriterion: A schema for specifying a criterion for the intended network of an EVM transaction.
EvmSmartAccount: EvmSmartAccount
EvmSmartAccountAddress: The 0x-prefixed, checksum address of the Smart Account.
EvmSmartAccountName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names are guaranteed to be unique across all Smart Accounts in the developer’s CDP Project.
EvmSmartAccountOwnersItem: EvmSmartAccountOwnersItem
EvmSmartAccountPoliciesItem: EvmSmartAccountPoliciesItem
EvmTypedAddressCondition: A schema for specifying criterion for an address field of an EVM typed message. The address can be deeply nested within the typed data’s message.
EvmTypedAddressConditionAddressesItem: The 0x-prefixed EVM address that the value located at the message’s path should be compared to.
EvmTypedNumericalCondition: A schema for specifying criterion for a numerical field of an EVM typed message. The value can be deeply nested within the typed data’s message.
EvmTypedNumericalConditionValue: The amount that the value located at the message’s path should be compared to.
EvmTypedStringCondition: A schema for specifying criterion for a string field of an EVM typed message. The value can be deeply nested within the typed data’s message.
EvmUserOperation: EvmUserOperation
EvmUserOperationTransactionHash: The hash of the transaction that included this particular user operation. This gets set after the user operation is broadcasted and the transaction is included in a block.
EvmUserOperationUserOpHash: The hash of the user operation. This is not the transaction hash, as a transaction consists of multiple user operations. The user operation hash is the hash of this particular user operation which gets signed by the owner of the Smart Account.
ExecutePaymentTransferQuoteTransferId: ExecutePaymentTransferQuoteTransferId
ExportEvmAccountAddress: ExportEvmAccountAddress
ExportEvmAccountBody: ExportEvmAccountBody
ExportEvmAccountByNameBody: ExportEvmAccountByNameBody
ExportEvmAccountByNameResponse: ExportEvmAccountByNameResponse
ExportEvmAccountByNameXIdempotencyKey: ExportEvmAccountByNameXIdempotencyKey
ExportEvmAccountResponse: ExportEvmAccountResponse
ExportEvmAccountXIdempotencyKey: ExportEvmAccountXIdempotencyKey
ExportSolanaAccountAddress: ExportSolanaAccountAddress
ExportSolanaAccountBody: ExportSolanaAccountBody
ExportSolanaAccountByNameBody: ExportSolanaAccountByNameBody
ExportSolanaAccountByNameResponse: ExportSolanaAccountByNameResponse
ExportSolanaAccountByNameXIdempotencyKey: ExportSolanaAccountByNameXIdempotencyKey
ExportSolanaAccountResponse: ExportSolanaAccountResponse
ExportSolanaAccountXIdempotencyKey: ExportSolanaAccountXIdempotencyKey
Fee: The fee for the transfer.
FromAmount: The amount of the fromToken to send in atomic units of the token. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
FromToken: The 0x-prefixed contract address of the token to send.
GasPrice: The target gas price for the swap transaction, in Wei. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. If not provided, the API will use an estimate based on the current network conditions.
GetEvmAccountAddress: GetEvmAccountAddress
GetEvmSmartAccountAddress: GetEvmSmartAccountAddress
GetOnrampOrderByIdResponse: GetOnrampOrderByIdResponse
GetPaymentTransferTransferId: GetPaymentTransferTransferId
GetPolicyByIdPolicyId: GetPolicyByIdPolicyId
GetSolanaAccountAddress: GetSolanaAccountAddress
GetSwapPriceResponse: GetSwapPriceResponse
GetSwapPriceResponseBlockNumber: The block number at which the liquidity conditions were examined.
GetSwapPriceResponseFees: The estimated fees for the swap.
GetSwapPriceResponseFromAmount: The amount of the fromToken that will be sent in this swap, in atomic units of the fromToken. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.
GetSwapPriceResponseFromToken: The 0x-prefixed contract address of the token that will be sent.
GetSwapPriceResponseGas: The estimated gas limit that should be used to send the transaction to guarantee settlement.
GetSwapPriceResponseGasPrice: The gas price, in Wei, that should be used to send the transaction. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. The transaction should be sent with this gas price to guarantee settlement.
GetSwapPriceResponseIssues: An object containing potential issues discovered during validation that could prevent the swap from being executed successfully.
GetSwapPriceResponseIssuesAllowance: Details of the allowances that the taker must set in order to execute the swap successfully. Null if no allowance is required.
GetSwapPriceResponseIssuesAllowanceCurrentAllowance: The current allowance of the fromToken by the taker.
GetSwapPriceResponseIssuesAllowanceSpender: The 0x-prefixed address of to set the allowance on.
GetSwapPriceResponseIssuesBalance: Details of the balance of the fromToken that the taker must hold. Null if the taker has a sufficient balance.
GetSwapPriceResponseIssuesBalanceCurrentBalance: The current balance of the fromToken by the taker.
GetSwapPriceResponseIssuesBalanceRequiredBalance: The amount of the token that the taker must hold.
GetSwapPriceResponseIssuesBalanceToken: The 0x-prefixed contract address of the token.
GetSwapPriceResponseMinToAmount: The minimum amount of the toToken that must be received for the swap to succeed, in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc. This value is influenced by the slippageBps parameter.
GetSwapPriceResponseToAmount: The amount of the toToken that will be received in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc.
GetSwapPriceResponseToToken: The 0x-prefixed contract address of the token that will be received.
GetUserOperationAddress: GetUserOperationAddress
GetUserOperationUserOpHash: GetUserOperationUserOpHash
Idl: IDL Specification following Anchor’s IDL format v0.30+.
IdlInstructionsItem: IdlInstructionsItem
IdlInstructionsItemAccountsItem: IdlInstructionsItemAccountsItem
IdlInstructionsItemArgsItem: IdlInstructionsItemArgsItem
IdlMetadata: Optional metadata about the IDL.
ImportEvmAccountBody: ImportEvmAccountBody
ImportEvmAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account.
ImportEvmAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
ImportEvmAccountXIdempotencyKey: ImportEvmAccountXIdempotencyKey
ImportSolanaAccountBody: ImportSolanaAccountBody
ImportSolanaAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
ImportSolanaAccountXIdempotencyKey: ImportSolanaAccountXIdempotencyKey
ListDataTokenBalancesAddress: ListDataTokenBalancesAddress
ListDataTokenBalancesResponse: ListDataTokenBalancesResponse
ListEvmAccountsResponse: ListEvmAccountsResponse
ListEvmSmartAccountsResponse: ListEvmSmartAccountsResponse
ListEvmTokenBalancesAddress: ListEvmTokenBalancesAddress
ListEvmTokenBalancesResponse: ListEvmTokenBalancesResponse
ListPoliciesResponse: ListPoliciesResponse
ListResponse: ListResponse
ListSolanaAccountsResponse: ListSolanaAccountsResponse
ListSolanaTokenBalancesAddress: ListSolanaTokenBalancesAddress
ListSolanaTokenBalancesResponse: ListSolanaTokenBalancesResponse
ListSpendPermissionsAddress: ListSpendPermissionsAddress
ListSpendPermissionsResponse: ListSpendPermissionsResponse
ListTokensForAccountAddress: ListTokensForAccountAddress
MintAddressCriterion: The criterion for the token mint addresses of a Solana transaction’s SPL token transfer instructions.
MintAddressCriterionAddressesItem: The Solana address that is compared to the list of token mint addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array.
NetUsdChangeCriterion: A schema for specifying a criterion for the USD denominated asset transfer or exposure for a transaction. This includes native transfers, as well as token transfers.
OnchainDataQuery: Request to execute a SQL query against indexed blockchain data.
OnchainDataQuerySql: SQL query to execute against the indexed blockchain data.
OnchainDataResult: Result of executing a SQL query.
OnchainDataResultMetadata: Metadata about query execution.
OnchainDataResultSchema: Schema information for the query result. This is a derived schema from the query result, so types may not match the underlying table.
OnchainDataResultSchemaColumnsItem: OnchainDataResultSchemaColumnsItem
OnrampOrder: An Onramp order.
OnrampOrderFee: A fee associated with an order.
OnrampPaymentLink: A payment link to pay for an order.
PaymentMethod: The fiat payment method object.
PaymentMethodId: The ID of the payment method which previously was added.
PaymentMethodLimits: The limits of the payment method.
PaymentMethodLimitsSourceLimit: The limit for this payment method being used as a source for transfers.
PaymentMethodLimitsTargetLimit: The limit for this payment method being used as a target for transfers.
PaymentMethodRequest: The fiat payment method request object.
PaymentMethodRequestId: The ID of the payment method.
Policy: Policy
PolicyDescription: An optional human-readable description of the policy. Policy descriptions can consist of alphanumeric characters, spaces, commas, and periods, and be 50 characters or less.
PolicyId: The unique identifier for the policy.
PrepareUserOperationAddress: PrepareUserOperationAddress
PrepareUserOperationBody: PrepareUserOperationBody
PrepareUserOperationCriteria: A schema for specifying criteria for the PrepareUserOperation operation.
PrepareUserOperationRule: PrepareUserOperationRule
RequestEvmFaucetBody: RequestEvmFaucetBody
RequestEvmFaucetBodyAddress: The address to request funds to, which is a 0x-prefixed hexadecimal string.
RequestEvmFaucetResponse: RequestEvmFaucetResponse
RequestSolanaFaucetBody: RequestSolanaFaucetBody
RequestSolanaFaucetBodyAddress: The address to request funds to, which is a base58-encoded string.
RequestSolanaFaucetResponse: RequestSolanaFaucetResponse
RevokeSpendPermissionAddress: RevokeSpendPermissionAddress
RevokeSpendPermissionRequest: RevokeSpendPermissionRequest
RevokeSpendPermissionXIdempotencyKey: RevokeSpendPermissionXIdempotencyKey
SendEvmTransactionAddress: SendEvmTransactionAddress
SendEvmTransactionBody: SendEvmTransactionBody
SendEvmTransactionCriteria: A schema for specifying criteria for the SignEvmTransaction operation.
SendEvmTransactionResponse: SendEvmTransactionResponse
SendEvmTransactionRule: SendEvmTransactionRule
SendEvmTransactionXIdempotencyKey: SendEvmTransactionXIdempotencyKey
SendSolTransactionCriteria: A schema for specifying criteria for the SendSolTransaction operation.
SendSolTransactionRule: SendSolTransactionRule
SendSolanaTransactionBody: SendSolanaTransactionBody
SendSolanaTransactionResponse: SendSolanaTransactionResponse
SendSolanaTransactionXIdempotencyKey: SendSolanaTransactionXIdempotencyKey
SendUserOperationAddress: SendUserOperationAddress
SendUserOperationBody: SendUserOperationBody
SendUserOperationCriteria: A schema for specifying criteria for the SendUserOperation operation.
SendUserOperationRule: SendUserOperationRule
SendUserOperationUserOpHash: SendUserOperationUserOpHash
SettleX402PaymentBody: SettleX402PaymentBody
SettleX402PaymentResponse: SettleX402PaymentResponse
SettleX402PaymentResponsePayer: The onchain address of the client that is paying for the resource.
SettleX402PaymentResponseTransaction: The transaction of the settlement. For EVM networks, the transaction will be a 0x-prefixed, EVM transaction hash. For Solana-based networks, the transaction will be a base58-encoded Solana signature.
SignEvmHashAddress: SignEvmHashAddress
SignEvmHashBody: SignEvmHashBody
SignEvmHashResponse: SignEvmHashResponse
SignEvmHashRule: SignEvmHashRule
SignEvmHashXIdempotencyKey: SignEvmHashXIdempotencyKey
SignEvmMessageAddress: SignEvmMessageAddress
SignEvmMessageBody: SignEvmMessageBody
SignEvmMessageCriteria: A schema for specifying the rejection criteria for the SignEvmMessage operation.
SignEvmMessageResponse: SignEvmMessageResponse
SignEvmMessageRule: SignEvmMessageRule
SignEvmMessageXIdempotencyKey: SignEvmMessageXIdempotencyKey
SignEvmTransactionAddress: SignEvmTransactionAddress
SignEvmTransactionBody: SignEvmTransactionBody
SignEvmTransactionCriteria: A schema for specifying criteria for the SignEvmTransaction operation.
SignEvmTransactionResponse: SignEvmTransactionResponse
SignEvmTransactionRule: SignEvmTransactionRule
SignEvmTransactionXIdempotencyKey: SignEvmTransactionXIdempotencyKey
SignEvmTypedDataAddress: SignEvmTypedDataAddress
SignEvmTypedDataCriteria: A schema for specifying criteria for the SignEvmTypedData operation.
SignEvmTypedDataFieldCriterion: SignEvmTypedDataFieldCriterion
SignEvmTypedDataFieldCriterionTypes: An object containing EIP-712 type definitions, as well as a primary type for the root message object.
SignEvmTypedDataFieldCriterionTypesTypesValueItem: SignEvmTypedDataFieldCriterionTypesTypesValueItem
SignEvmTypedDataResponse: SignEvmTypedDataResponse
SignEvmTypedDataRule: SignEvmTypedDataRule
SignEvmTypedDataVerifyingContractCriterion: A schema for specifying criterion for a domain’s verifying contract.
SignEvmTypedDataVerifyingContractCriterionAddressesItem: The 0x-prefixed EVM address that the domain’s verifying contract should be compared to.
SignEvmTypedDataXIdempotencyKey: SignEvmTypedDataXIdempotencyKey
SignSolTransactionCriteria: A schema for specifying criteria for the SignSolTransaction operation.
SignSolTransactionRule: SignSolTransactionRule
SignSolanaMessageAddress: SignSolanaMessageAddress
SignSolanaMessageBody: SignSolanaMessageBody
SignSolanaMessageResponse: SignSolanaMessageResponse
SignSolanaMessageXIdempotencyKey: SignSolanaMessageXIdempotencyKey
SignSolanaTransactionAddress: SignSolanaTransactionAddress
SignSolanaTransactionBody: SignSolanaTransactionBody
SignSolanaTransactionResponse: SignSolanaTransactionResponse
SignSolanaTransactionXIdempotencyKey: SignSolanaTransactionXIdempotencyKey
SignerAddress: The 0x-prefixed Externally Owned Account (EOA) address that will sign the Permit2 EIP-712 permit message. This is only needed if taker is a smart contract.
SlippageBps: The maximum acceptable slippage of the toToken in basis points. If this parameter is set to 0, no slippage will be tolerated. If not provided, the default slippage tolerance is 100 bps (i.e., 1%).
SmsAuthentication: Information about an end user who authenticates using a one-time password sent to their phone number via SMS.
SmsAuthenticationPhoneNumber: The phone number of the end user in E.164 format.
SolAddressCriterion: The criterion for the recipient addresses of a Solana transaction’s native transfer instruction.
SolAddressCriterionAddressesItem: The Solana address that is compared to the list of native transfer recipient addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array.
SolDataCondition: A single condition to apply against a specific instruction type and its parameters.
SolDataCriterion: A schema for specifying criterion for instruction data in a Solana transaction.
SolDataParameterCondition: A single parameter condition to apply against a specific instruction’s parameters.
SolDataParameterConditionList: A single parameter condition to apply against a specific instruction’s parameters.
SolValueCriterion: The criterion for the SOL value in lamports of a native transfer instruction in a Solana transaction.
SolanaAccount: SolanaAccount
SolanaAccountAddress: The base58 encoded Solana address.
SolanaAccountName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names are guaranteed to be unique across all Solana accounts in the developer’s CDP Project.
SolanaAccountPoliciesItem: SolanaAccountPoliciesItem
SolanaToken: General information about a Solana token. Includes the mint address, and other identifying information.
SolanaTokenAmount: Amount of a given Solana token.
SolanaTokenAmountAmount: The amount is denominated in the smallest indivisible unit of the token. For SOL, the smallest indivisible unit is lamports (10^-9 SOL). For SPL tokens, the smallest unit is defined by the token’s decimals configuration.
SolanaTokenBalance: SolanaTokenBalance
SolanaTokenMintAddress: The mint address of the token. For native SOL, the mint address is So11111111111111111111111111111111111111111. For SPL tokens, this is the mint address where the token is defined.
SpendPermission: The core spend permission.
SpendPermissionAccount: Smart account this spend permission is valid for.
SpendPermissionResponseObject: SpendPermissionResponseObject
SpendPermissionSpender: Entity that can spend account’s tokens.
SpendPermissionToken: Token address (ERC-7528 native token address or ERC-20 contract).
SplAddressCriterion: The criterion for the recipient addresses of a Solana transaction’s SPL token transfer instructions.
SplAddressCriterionAddressesItem: The Solana address that is compared to the list of SPL token transfer recipient addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array.
SplValueCriterion: The criterion for the SPL token value of a SPL token transfer instruction in a Solana transaction.
SupportedX402PaymentKindsResponse: SupportedX402PaymentKindsResponse
SwapUnavailableResponse: SwapUnavailableResponse
Taker: The 0x-prefixed address that holds the fromToken balance and has the Permit2 allowance set for the swap.
ToToken: The 0x-prefixed contract address of the token to receive.
Token: General information about a token. Includes the type, the network, and other identifying information.
TokenAmount: Amount of a given token.
TokenAmountAmount: The amount is denominated in the smallest indivisible unit of the token. For ETH, the smallest indivisible unit is Wei (10^-18 ETH). For ERC-20s, the smallest unit is the unit returned from function totalSupply() public view returns (uint256).
TokenBalance: TokenBalance
TokenContractAddress: The contract address of the token. For Ether, the contract address is 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE per EIP-7528. For ERC-20 tokens, this is the contract address where the token is deployed.
TokenFee: TokenFee
TokenFeeAmount: The estimated amount of the fee in atomic units of the token. For example, 1000000000000000 if the fee is in ETH equates to 0.001 ETH, 10000 if the fee is in USDC equates to 0.01 USDC, etc.
TokenFeeToken: The contract address of the token that the fee is paid in. The address 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE is used for the native token of the network (e.g. ETH).
Transfer: The transfer object.
TransferId: The ID of the transfer.
TransferSource: The source of the transfer.
TransferTarget: The target of the transfer.
UpdateEvmAccountAddress: UpdateEvmAccountAddress
UpdateEvmAccountBody: UpdateEvmAccountBody
UpdateEvmAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account, or an empty string to unset attached policy.
UpdateEvmAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM accounts in the developer’s CDP Project.
UpdateEvmAccountXIdempotencyKey: UpdateEvmAccountXIdempotencyKey
UpdateEvmSmartAccountAddress: UpdateEvmSmartAccountAddress
UpdateEvmSmartAccountBody: UpdateEvmSmartAccountBody
UpdateEvmSmartAccountBodyName: An optional name for the smart account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all EVM smart accounts in the developer’s CDP Project.
UpdatePolicyBody: UpdatePolicyBody
UpdatePolicyBodyDescription: An optional human-readable description for the policy. Policy descriptions can consist of alphanumeric characters, spaces, commas, and periods, and be 50 characters or less.
UpdatePolicyPolicyId: UpdatePolicyPolicyId
UpdatePolicyXIdempotencyKey: UpdatePolicyXIdempotencyKey
UpdateSolanaAccountAddress: UpdateSolanaAccountAddress
UpdateSolanaAccountBody: UpdateSolanaAccountBody
UpdateSolanaAccountBodyAccountPolicy: The ID of the account-level policy to apply to the account, or an empty string to unset attached policy.
UpdateSolanaAccountBodyName: An optional name for the account. Account names can consist of alphanumeric characters and hyphens, and be between 2 and 36 characters long. Account names must be unique across all Solana accounts in the developer’s CDP Project.
UpdateSolanaAccountXIdempotencyKey: UpdateSolanaAccountXIdempotencyKey
UserOperationReceipt: The receipt that contains information about the execution of user operation.
UserOperationReceiptBlockHash: The block hash of the block including the transaction as 0x-prefixed string.
UserOperationReceiptRevert: The revert data if the user operation has reverted.
UserOperationReceiptRevertData: The 0x-prefixed raw hex string.
UserOperationReceiptTransactionHash: The hash of this transaction as 0x-prefixed string.
ValidateEndUserAccessTokenBody: The request body for a developer to verify an end user’s access token.
VerifyX402PaymentBody: VerifyX402PaymentBody
VerifyX402PaymentResponse: VerifyX402PaymentResponse
VerifyX402PaymentResponsePayer: The onchain address of the client that is paying for the resource.
X402ExactEvmPayload: The x402 protocol exact scheme payload for EVM networks. The scheme is implemented using ERC-3009. For more details, please see EVM Exact Scheme Details.
X402ExactEvmPayloadAuthorization: The authorization data for the ERC-3009 authorization message.
X402ExactEvmPayloadAuthorizationFrom: The 0x-prefixed, checksum EVM address of the sender of the payment.
X402ExactEvmPayloadAuthorizationTo: The 0x-prefixed, checksum EVM address of the recipient of the payment.
X402PaymentPayload: The x402 protocol payment payload that the client attaches to x402-paid API requests to the resource server in the X-PAYMENT header.
X402PaymentRequirements: The x402 protocol payment requirements that the resource server expects the client’s payment payload to meet.
X402PaymentRequirementsAsset: The asset to pay with.
X402PaymentRequirementsPayTo: The destination to pay value to.
X402SupportedPaymentKind: The supported payment kind for the x402 protocol. A kind is comprised of a scheme and a network, which together uniquely identify a way to move money on the x402 protocol. For more details, please see x402 Schemes.
X402Version: The version of the x402 protocol.

Enums§

AbiFunctionType: The type of the ABI item, must be function.
AbiInputType: The type of the ABI item.
AbiItem: AbiItem
AbiStateMutability: State mutability of a function in Solidity.
AuthenticationMethod: Information about how the end user is authenticated.
CreatePaymentTransferQuoteBodySourceType: The type of the source of the transfer.
CreatePaymentTransferQuoteBodyTargetType: The type of the target of the transfer.
CreatePolicyBodyScope: The scope of the policy.
CreateSwapQuoteResponseWrapper: A wrapper for the response of a swap quote operation.
DeveloperJwtAuthenticationType: The type of authentication information.
EmailAuthenticationType: The type of authentication information.
ErrorType: The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.
EthValueCriterionOperator: The operator to use for the comparison. The transaction’s value field will be on the left-hand side of the operator, and the ethValue field will be on the right-hand side.
EthValueCriterionType: The type of criterion to use. This should be ethValue.
EvmAddressCriterionOperator: The operator to use for the comparison. The transaction’s to field will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
EvmAddressCriterionType: The type of criterion to use. This should be evmAddress.
EvmDataConditionParamsItem: A list of parameter conditions to apply against encoded arguments in the transaction’s data field.
EvmDataCriterionAbi: The ABI of the smart contract being called. This can be a partial structure with only specific functions.
EvmDataCriterionType: The type of criterion to use. This should be evmData.
EvmDataParameterConditionListOperator: The operator to use for the comparison. The value resolved at the name will be on the left-hand side of the operator, and the values field will be on the right-hand side.
EvmDataParameterConditionOperator: The operator to use for the comparison. The value resolved at the name will be on the left-hand side of the operator, and the value field will be on the right-hand side.
EvmMessageCriterionType: The type of criterion to use. This should be evmMessage.
EvmNetworkCriterionNetworksItem: The network the transaction is for.
EvmNetworkCriterionOperator: The operator to use for the comparison. The transaction’s intended network will be on the left-hand side of the operator, and the networks field will be on the right-hand side.
EvmNetworkCriterionType: The type of criterion to use. This should be evmNetwork.
EvmSwapsNetwork: The network on which to perform the swap.
EvmTypedAddressConditionOperator: The operator to use for the comparison. The value located at the message’s path will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
EvmTypedNumericalConditionOperator: The operator to use for the comparison. The value located at the message’s path will be on the left-hand side of the operator, and the value field will be on the right-hand side.
EvmUserOperationNetwork: The network the user operation is for.
EvmUserOperationStatus: The status of the user operation.
FeeType: The type of fee.
GetSwapPriceResponseWrapper: A wrapper for the response of a swap price operation.
KnownAbiType: A reference to an established EIP standard. When referencing a KnownAbiType within a policy rule configuring an EvmDataCriterion, criteria will only decode function data officially documented in the standard. For more information on supported token standards, see the links below. - erc20 - Token Standard. - erc721 - Non-Fungible Token Standard. - erc1155 - Multi Token Standard.
KnownIdlType: A reference to an established Solana program. When referencing a KnownIdlType within a policy rule configuring an SolDataCriterion, criteria will decode instruction data as documented in the programs. For more information on supported programs, see the links below. - SystemProgram. - TokenProgram. - AssociatedTokenProgram.
ListEvmTokenBalancesNetwork: The name of the supported EVM networks in human-readable format.
ListPoliciesScope: ListPoliciesScope
ListSolanaTokenBalancesNetwork: The name of the supported Solana networks in human-readable format.
ListTokensForAccountNetwork: ListTokensForAccountNetwork
MintAddressCriterionOperator: The operator to use for the comparison. Each of the token mint addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
MintAddressCriterionType: The type of criterion to use. This should be mintAddress.
NetUsdChangeCriterionOperator: The operator to use for the comparison. The total value of a transaction’s asset transfer will be on the left-hand side of the operator, and the changeCents field will be on the right-hand side.
NetUsdChangeCriterionType: The type of criterion to use. This should be netUSDChange.
OnchainDataResultSchemaColumnsItemType: Column data type (ClickHouse types).
OnrampOrderFeeType: The type of fee.
OnrampOrderPaymentMethodTypeId: The type of payment method to be used to complete an onramp order.
OnrampOrderStatus: The status of an onramp order.
OnrampPaymentLinkType: The type of payment link.
PaymentMethodType: The type of payment method.
PaymentRailAction: The action of the payment method.
PolicyScope: The scope of the policy. Only one project-level policy can exist at any time.
PrepareUserOperationCriteriaItem: PrepareUserOperationCriteriaItem
PrepareUserOperationRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
PrepareUserOperationRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
RequestEvmFaucetBodyNetwork: The network to request funds from.
RequestEvmFaucetBodyToken: The token to request funds for.
RequestSolanaFaucetBodyToken: The token to request funds for.
Rule: A rule that limits the behavior of an account.
SendEvmTransactionBodyNetwork: The network to send the transaction to.
SendEvmTransactionCriteriaItem: SendEvmTransactionCriteriaItem
SendEvmTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SendEvmTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SendSolTransactionCriteriaItem: SendSolTransactionCriteriaItem
SendSolTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SendSolTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SendSolanaTransactionBodyNetwork: The Solana network to send the transaction to.
SendUserOperationCriteriaItem: SendUserOperationCriteriaItem
SendUserOperationRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SendUserOperationRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEvmHashRuleAction: Whether any attempts to sign a hash will be accepted or rejected. This rule does not accept any criteria.
SignEvmHashRuleOperation: The operation to which the rule applies.
SignEvmMessageRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEvmMessageRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEvmTransactionCriteriaItem: SignEvmTransactionCriteriaItem
SignEvmTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEvmTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEvmTypedDataCriteriaItem: SignEvmTypedDataCriteriaItem
SignEvmTypedDataFieldCriterionConditionsItem: SignEvmTypedDataFieldCriterionConditionsItem
SignEvmTypedDataFieldCriterionType: The type of criterion to use. This should be evmTypedDataField.
SignEvmTypedDataRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignEvmTypedDataRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SignEvmTypedDataVerifyingContractCriterionOperator: The operator to use for the comparison. The domain’s verifying contract will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
SignEvmTypedDataVerifyingContractCriterionType: The type of criterion to use. This should be evmTypedDataVerifyingContract.
SignSolTransactionCriteriaItem: SignSolTransactionCriteriaItem
SignSolTransactionRuleAction: Whether matching the rule will cause the request to be rejected or accepted.
SignSolTransactionRuleOperation: The operation to which the rule applies. Every element of the criteria array must match the specified operation.
SmsAuthenticationType: The type of authentication information.
SolAddressCriterionOperator: The operator to use for the comparison. Each of the native transfer recipient addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
SolAddressCriterionType: The type of criterion to use. This should be solAddress.
SolDataConditionParamsItem: A list of parameter conditions to apply against a specific instruction’s data.
SolDataCriterionIdlsItem: SolDataCriterionIdlsItem
SolDataCriterionType: The type of criterion to use. This should be solData.
SolDataParameterConditionListOperator: The operator to use for the comparison. The value resolved at the name will be on the left-hand side of the operator, and the value field will be on the right-hand side.
SolDataParameterConditionOperator: The operator to use for the comparison. The value resolved at the name will be on the left-hand side of the operator, and the value field will be on the right-hand side.
SolValueCriterionOperator: The operator to use for the comparison. The transaction instruction’s value field will be on the left-hand side of the operator, and the solValue field will be on the right-hand side.
SolValueCriterionType: The type of criterion to use. This should be solValue.
SpendPermissionNetwork: The network the spend permission is on.
SplAddressCriterionOperator: The operator to use for the comparison. Each of the SPL token transfer recipient addresses in the transaction’s accountKeys (for legacy transactions) or staticAccountKeys (for V0 transactions) array will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
SplAddressCriterionType: The type of criterion to use. This should be splAddress.
SplValueCriterionOperator: The operator to use for the comparison. The transaction instruction’s value field will be on the left-hand side of the operator, and the splValue field will be on the right-hand side.
SplValueCriterionType: The type of criterion to use. This should be splValue.
TransferSourceType: The type of the source of the transfer.
TransferStatus: The status of the transfer.
TransferTargetType: The type of the target of the transfer.
X402PaymentPayloadNetwork: The network of the blockchain to send payment on.
X402PaymentPayloadScheme: The scheme of the payment protocol to use. Currently, the only supported scheme is exact.
X402PaymentRequirementsNetwork: The network of the blockchain to send payment on.
X402PaymentRequirementsScheme: The scheme of the payment protocol to use. Currently, the only supported scheme is exact.
X402SettleErrorReason: The reason the payment settlement errored on the x402 protocol.
X402SupportedPaymentKindNetwork: The network of the blockchain.
X402SupportedPaymentKindScheme: The scheme of the payment protocol.
X402VerifyInvalidReason: The reason the payment is invalid on the x402 protocol.

Module types

Module types Copy item path

Modules§

Structs§

Enums§

Module types