evm_body.yaml

# ========= EVM Methods ==============
eth_blockNumber:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_blockNumber
          enum:
            - eth_blockNumber
eth_getBlockByHash:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getBlockByHash
          enum:
            - eth_getBlockByHash
        params:
          type: array
          description: |
            1. String - Hash of block
            2. Boolean - If `true` it returns the full transaction objects, if `false` only the hashes of the transactions. Defaults to `false`.
          minItems: 2
          maxItems: 2
          prefixItems:
            types:
              - string
              - boolean
eth_getBlockByNumber:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getBlockByNumber
          enum:
            - eth_getBlockByNumber
        params:
          type: array
          description: |
            1. String - Either the hex value of a **block number** OR One of the following **block tags**:
                * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
                * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
                * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
                * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
                * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
            2. Boolean - If `true` it returns the full transaction objects, if `false` only the hashes of the transactions. Defaults to `false`.
          minItems: 2
          maxItems: 2
          items:
            type: string
eth_getBlockByNumber_l2:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getBlockByNumber
          enum:
            - eth_getBlockByNumber
        params:
          type: array
          description: |
            1. String - Either the hex value of a **block number** OR One of the following **block tags**:
                * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
                * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
                * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
            2. Boolean - If `true` it returns the full transaction objects, if `false` only the hashes of the transactions. Defaults to `false`.
          minItems: 2
          maxItems: 2
          items:
            type: string
eth_getLogs:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getLogs
          enum:
            - eth_getLogs
        params:
          type: array
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/filter_options'
eth_getTransactionByHash:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/transactionHash_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_getTransactionByHash
          enum:
            - eth_getTransactionByHash
eth_getTransactionReceipt:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/transactionHash_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_getTransactionReceipt
          enum:
            - eth_getTransactionReceipt
eth_getBlockTransactionCountByHash:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/blockHash_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_getBlockTransactionCountByHash
          enum:
            - eth_getBlockTransactionCountByHash
eth_getBlockTransactionCountByNumber:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getBlockTransactionCountByNumber
          enum:
            - eth_getBlockTransactionCountByNumber
        params:
          type: array
          minItems: 1
          maxItems: 1
          $ref: '#/blockNumber_or_blocktag_param_eth'
eth_getTransactionCount:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/address_and_blockNumber_param_eth'
    - type: object
      properties:
        method:
          type: string
          default: eth_getTransactionCount
          enum:
            - eth_getTransactionCount
eth_getTransactionByBlockHashAndIndex:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/blockHash_and_index_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_getTransactionByBlockHashAndIndex
          enum:
            - eth_getTransactionByBlockHashAndIndex
eth_getTransactionByBlockNumberAndIndex:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/blockNumber_and_index_param_eth'
    - type: object
      properties:
        method:
          type: string
          default: eth_getTransactionByBlockNumberAndIndex
          enum:
            - eth_getTransactionByBlockNumberAndIndex
eth_getBlockReceipts:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getBlockReceipts
          enum:
            - eth_getBlockReceipts
        params:
          $ref: '#/blockNumber_or_blockHash_param_eth'

eth_sendRawTransaction:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/signed_transaction_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_sendRawTransaction
          enum:
            - eth_sendRawTransaction
alchemy_getGasOptimizedTransactionStatus:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/signed_transaction_param'
    - type: object
      properties:
        method:
          type: string
          default: alchemy_getGasOptimizedTransactionStatus
          enum:
            - alchemy_getGasOptimizedTransactionStatus
eth_sendPrivateTransaction:
  type: array
  minItems: 1
  maxItems: 1
  items:
    type: object
    required:
      - tx
    properties:
      method:
        type: string
        default: eth_sendPrivateTransaction
        enum:
          - eth_sendPrivateTransaction
      tx:
        type: string
        description: 'Raw, signed transaction'
      maxBlockNumber:
        type: string
        description: Hex-encoded number for highest block number in which the transaction should be included.
      preferences:
        type: object
        properties:
          fast:
            type: boolean
            description: Sends transaction with fast mode when true.
eth_cancelPrivateTransaction:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_cancelPrivateTransaction
          enum:
            - eth_cancelPrivateTransaction
        params:
          type: array
          minItems: 1
          maxItems: 1
          items:
            type: object
            properties:
              txHash:
                type: string
                description: Transaction hash for private transaction to be cancelled.
eth_getBalance:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/address_and_blockNumber_param_eth'
    - type: object
      properties:
        method:
          type: string
          default: eth_getBalance
          enum:
            - eth_getBalance
eth_getStorageAt:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getStorageAt
          enum:
            - eth_getStorageAt
        params:
          type: array
          description: |
            1. String - 20 Bytes - address of the storage
            2. String - Integer of the slot position in the storage (in hex)
            3. String - Either the hex value of a **block number** OR One of the following **block tags**:
              * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
              * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
              * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
              * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
              * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
          minItems: 3
          maxItems: 3
          items:
            type: string
eth_getCode:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/address_and_blockNumber_param_eth'
    - type: object
      properties:
        method:
          type: string
          default: eth_getCode
          enum:
            - eth_getCode
eth_accounts:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_accounts
          enum:
            - eth_accounts
eth_getProof:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getProof
          enum:
            - eth_getProof
        params:
          description: |
            1. String - 20 Bytes - Address of the account
            2. Array - 32 Bytes - array of storage-keys which should be proofed and included
            3. String - Either the hex value of a **block number** OR One of the following **block tags**:
              * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
              * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
              * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
              * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
              * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
          type: array
          minItems: 3
          maxItems: 3
          items:
            anyOf:
              - type: string
                title: Address
                description: Address of the account
              - type: array
                title: Array of storage keys
                description: array of storage-keys which should be proofed and included
                items:
                  type: string
              - $ref: '#/blockNumber_or_blocktag_param_eth'
                title: Block Number or Block Tag
eth_protocolVersion:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_protocolVersion
          enum:
            - eth_protocolVersion
eth_gasPrice:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_gasPrice
          enum:
            - eth_gasPrice
eth_estimateGas_550:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_estimateGas
          enum:
            - eth_estimateGas
        params:
          type: array
          minItems: 2
          maxItems: 2
          items:
            oneOf:
              - allOf:
                  - $ref: '#/transaction_object'
                  - $ref: '#/gas_550'
              - $ref: '#/blockNumber_or_blocktag_param_eth'
eth_feeHistory:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_feeHistory
          enum:
            - eth_feeHistory
        params:
          type: array
          minItems: 3
          maxItems: 3
          description: |
              1. `integer` - Block count or range
              2. `string` - Block number (in hex) or block tag
              3. `array` of `integers` - (optional) Reward percentiles to sample from each block
          items:
            anyOf:
            - type: integer
              title: Block count
              description: Number of blocks in the requested range. Between 1 and 1024 blocks can be requested in a single query (may return less than requested range if not all blocks are available).
              default: 4
            - $ref: '#/blockNumber_or_blocktag_param_eth'
              title: Newest block
              description: highest number block in the requested range
              default: latest
            - type: array
              items:
                type: number
              title: reward percentiles
              description: (optional) A monotonically increasing list of percentile values to sample from each block's effective priority fees per gas in ascending order, weighted by gas used.
              default: [25,75]
eth_maxPriorityFeePerGas:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_maxPriorityFeePerGas
          enum:
            - eth_maxPriorityFeePerGas
eth_chainId:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_chainId
          enum:
            - eth_chainId
net_version:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: net_version
          enum:
            - net_version
net_listening:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: net_listening
          enum:
            - net_listening
eth_getUncleByBlockHashAndIndex:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/blockHash_uncleIndex_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_getUncleByBlockHashAndIndex
          enum:
            - eth_getUncleByBlockHashAndIndex
eth_getUncleByBlockNumberAndIndex:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/blockNumber_uncleIndex_param_eth'
    - type: object
      properties:
        method:
          type: string
          default: eth_getUncleByBlockNumberAndIndex
          enum:
            - eth_getUncleByBlockNumberAndIndex
eth_getUncleCountByBlockHash:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/blockHash_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_getUncleCountByBlockHash
          enum:
            - eth_getUncleCountByBlockHash
eth_getUncleCountByBlockNumber:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/blockNumber_or_blocktag_param_eth'
    - type: object
      properties:
        method:
          type: string
          default: eth_getUncleCountByBlockNumber
          enum:
            - eth_getUncleCountByBlockNumber
eth_getFilterChanges:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/filterId_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_getFilterChanges
          enum:
            - eth_getFilterChanges
eth_getFilterLogs:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/filterId_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_getFilterLogs
          enum:
            - eth_getFilterLogs
eth_newBlockFilter:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_newBlockFilter
          enum:
            - eth_newBlockFilter
eth_newFilter:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_newFilter
          enum:
            - eth_newFilter
        params:
          type: array
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/filter_options'
eth_newPendingTransactionFilter:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_newPendingTransactionFilter
          enum:
            - eth_newPendingTransactionFilter
eth_uninstallFilter:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/filterId_param'
    - type: object
      properties:
        method:
          type: string
          default: eth_uninstallFilter
          enum:
            - eth_uninstallFilter
web3_clientVersion:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: web3_clientVersion
          enum:
            - web3_clientVersion
web3_sha3:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/shaHash_param'
    - type: object
      properties:
        method:
          type: string
          default: web3_sha3
          enum:
            - web3_sha3
eth_getTransactionReceiptsByBlock:
  allOf:
    - $ref: '#/common_request_fields'
    - $ref: '#/blockNumber_or_blockHash_param_l2'
    - type: object
      properties:
        method:
          type: string
          default: eth_getTransactionReceiptsByBlock
          enum:
            - eth_getTransactionReceiptsByBlock
        params:
          type: array
          minItems: 1
          maxItems: 1
          description: block_number in hex OR block_hash.
          items:
            type: string
eth_syncing:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_syncing
          enum:
            - eth_syncing

# ============= Transaction Receipts API Method ===============
alchemy_getTransactionReceipts_param:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: alchemy_getTransactionReceipts
          enum:
            - alchemy_getTransactionReceipts
        params:
          type: array
          description: 'The api only takes in one parameter - an object with at least a blockNumber or blockHash. If both are provided, an error is returned asking you to choose either blockNumber or blockHash.'
          minItems: 1
          maxItems: 1
          items:
            type: object
            properties:
              blockNumber:
                type: string
                description: The block number you want to get transaction receipts for, in hex
                pattern: '^0[xX][0-9a-fA-F]+$'
                default: '0xF1D1C6'
              blockHash:
                type: string
                description: The block hash you want to get transaction receipts for
                pattern: '^0[xX][0-9a-fA-F]+$'

# ============= Token API Methods ===============
alchemy_getTokenAllowance:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: alchemy_getTokenAllowance
          enum:
            - alchemy_getTokenAllowance
        params:
          type: array
          description: null
          minItems: 1
          maxItems: 1
          items:
            type: object
            required:
              - contract
              - owner
              - spender
            properties:
              contract:
                type: string
                description: 'String - DATA, 20 Bytes - The address of the token contract.'
                default: '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'
              owner:
                type: string
                description: 'String - DATA, 20 Bytes - The address of the token owner.'
                default: '0xf1a726210550c306a9964b251cbcd3fa5ecb275d'
              spender:
                type: string
                description: 'String - DATA, 20 Bytes - The address of the token spender.'
                default: '0xdef1c0ded9bec7f1a1670819833240f027b25eff'
alchemy_getTokenBalances:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: alchemy_getTokenBalances
          enum:
            - alchemy_getTokenBalances
        params:
          type: array
          description: |
            1. String, 20 Bytes - The address to check token balances for.
            2. OneOf the following token specifications, defaults to `erc20`
              - **[omitted below]** Array - A list of contract addresses. Suggested limit: 100 addresses
              - The String `DEFAULT_TOKENS` - denotes a query for the top 100 tokens by 24 hour volume - only available on Mainnet for Ethereum, Polygon, and Arbitrum.
              - The String `erc20` - denotes the set of erc20 tokens that the address has ever held.
            3. **[omitted below]**  Object `pageKey` - A string address used for pagination. If more results are available, a pageKey will be returned in the response.
          minItems: 1
          maxItems: 2
          items:
            type: string
            default: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
            
alchemy_getTokenMetadata: 
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: alchemy_getTokenMetadata
          enum:
            - alchemy_getTokenMetadata
        params:
          type: array
          description: 'string, 20 Bytes - Singluar address for the token contract.'
          minItems: 1
          maxItems: 1
          items:
            type: string
            default: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'

# ============= Trace API Methods ===============
trace_call:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: trace_call
          enum:
            - trace_call
        params:
          type: array
          items:
            oneOf:
              - $ref: '#/transaction_object'
                description: Call options.
              - type: array
                description: 'Type of trace, one or more of "trace" or "stateDiff".'
                items:
                  type: string
                  enum:
                    - trace
                    - stateDiff
              - $ref: '#/blockNumber_or_blocktag_param_eth'
trace_rawTransaction:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: trace_rawTransaction
          enum:
            - trace_rawTransaction
        params:
          type: array
          items:
            oneOf:
              - type: string
                description: Raw transaction data.
              - type: array
                description: 'Array - Type of trace, one or more of "trace" or "stateDiff".'
                items:
                  type: string
trace_replayBlockTransactions:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: trace_replayBlockTransactions
          enum:
            - trace_replayBlockTransactions
        params:
          type: array
          items:
            oneOf:
              - $ref: '#/blockNumber_or_blocktag_param_eth'
              - type: array
                description: 'Array - Type of trace, one or more of "trace" or "stateDiff".'
                items:
                  type: string
trace_replayTransaction:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: trace_replayTransaction
          enum:
            - trace_replayTransaction
        params:
          type: array
          items:
            oneOf:
              - type: string
                description: Hash - Transaction hash.
              - type: array
                description: 'Array - Type of trace, one or more of "trace" or "stateDiff".'
                items:
                  type: string
trace_block:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: trace_block
          enum:
            - trace_block
        params:
          type: array
          description: |
            Array of HEX String.
            </br>The following options are possible for the defaultBlock parameter.
            - An integer block number (in hex)
            - String 'earliest' for the earliest/genesis block. String 'latest' - for the latest mined block. String 'pending' - for the pending state/transactions.
          items:
            $ref: '#/blockNumber_or_blocktag_param_eth'
trace_filter:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: trace_filter
          enum:
            - trace_filter
        params:
          type: array
          minItems: 1
          maxItems: 1
          items:
            type: object
            properties:
              fromBlock:
                type: string
                description: From this block
              toBlock:
                type: string
                description: To this block.
              fromAddress:
                type: string
                description: Sent from these addresses.
              toAddress:
                type: string
                description: Sent to these addresses.
              after:
                type: string
                description: The offset trace number.
              count:
                type: integer
                description: Integer number of traces to display in a batch.
trace_get:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: trace_get
          enum:
            - trace_get
        params:
          type: array
          items:
            oneOf:
              - type: string
                description: Hash - Transaction hash.
              - type: array
                description: Array - Index positions of the traces.
                items:
                  type: string
trace_transaction:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: trace_transaction
          enum:
            - trace_transaction
        params:
          type: array
          items:
            type: string
            description: Hash - Transaction hash.

# ============= Polygon API Methods ===============
bor_getAuthor:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: bor_getAuthor
          enum:
            - bor_getAuthor
        params:
          description: Array of block number (in hexadecimal format).
          type: array
          items:
            type: string
bor_getCurrentValidators:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: bor_getCurrentValidators
          enum:
            - bor_getCurrentValidators
bor_getCurrentProposer:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: bor_getCurrentProposer
          enum:
            - bor_getCurrentProposer
bor_getRootHash:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: bor_getCurrentProposer
          enum:
            - bor_getCurrentProposer
        params:
          type: array
          items:
            type: object
            properties:
              from:
                type: integer
                description: Block number (in int format).
              to:
                type: integer
                description: Block number (in int format).
eth_getRootHash:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getRootHash
          enum:
            - eth_getRootHash
        params:
          type: array
          items:
            type: object
            properties:
              from:
                type: integer
                description: Block number (in int format).
              to:
                type: integer
                description: Block number (in int format).
eth_getSignersAtHash:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_getSignersAtHash
          enum:
            - eth_getSignersAtHash
        params:
          type: array
          minItems: 1
          maxItems: 1
          description: Blockhash.
          items:
            type: string

# ============= Arbitrum API Methods ===============
eth_createAccessList:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_createAccessList
          enum:
            - eth_createAccessList
        params:
          type: array
          description: |
            1. Transaction Object
            2. Blog number or block tag
          minItems: 1
          maxItems: 2
          items:
            anyOf:
            - $ref: '#/transaction_object'
              title: Transaction object
            - $ref: '#/blockNumber_or_blocktag_param_l2'
              title: Block number or block tag
              default: pending

# ============= Transfers API Methods ===============
alchemy_getAssetTransfers:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: alchemy_getAssetTransfers
          enum:
            - alchemy_getAssetTransfers
        params:
          type: array
          minItems: 1
          maxItems: 1
          items:
            type: object
            required:
              - category
            properties:
              fromBlock:
                type: string
                description: 'String - Inclusive from block (hex string, int, or latest). Defaults to `0x0`'
                default: '0x0'
              toBlock:
                type: string
                description: 'String - Inclusive to block (hex string, int, or latest). Defaults to `latest`'
                default: latest
              fromAddress:
                type: string
                description: String - From address (hex string). Default wildcard - any address
                pattern: '^0[xX][0-9a-fA-F]+$'
              toAddress:
                type: string
                description: String - To address (hex string). Default wildcard - any address
                pattern: '^0[xX][0-9a-fA-F]+$'
              contractAddresses:
                type: array
                description: 'String - List of contract addresses (hex strings) to filter for - only applies to "erc20", "erc721", "erc1155" transfers. Default wildcard - any address'
                items:
                  type: string
                  pattern: '^0[xX][0-9a-fA-F]+$'
              category:
                type: array
                description: |
                  'Array of categories, can be any of the following: "external", "internal", "erc20", "erc721", "erc1155", or "specialnft". See the table above for supported categories on each network.'
                items:
                  type: string
                  enum:
                    - external
                    - internal
                    - erc20
                    - erc721
                    - erc1155
                    - specialnft
                default: ["external"]
              order:
                type: string
                description: |
                  String - Whether to return results in ascending (`asc`) or descending (`desc`) order. Ascending order is from oldest to newest transactions, decending order is from newest to oldest. Defaults to `asc`.
                enum:
                  - asc
                  - desc
              withMetadata:
                type: boolean
                description: Boolean - Whether or not to include additional metadata about each transfer event. Defaults to `false`.
                default: false
              excludeZeroValue:
                type: boolean
                description: Boolean - A boolean to exclude transfers with zero value - zero value is not the same as null value. Defaults to `true`.
                default: true
              maxCount:
                type: string
                description: Max hex string number of results to return per call. Defaults to `0x3e8` (1000).
                default: '0x3e8'
              pageKey:
                type: string
                description: 'String - UUID for pagination. If more results are available, a uuid pageKey will be returned in the response. Pass that uuid into pageKey to fetch the next 1000 or maxCount.'

# ============= Debug API Methods ===============
tracer:
  type: string
  default: callTracer
  enum:
    - callTracer
    - prestateTracer
tracerConfig:
  type: object
  properties:
    onlyTopCall:
      type: boolean

debug_traceCall:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: debug_traceCall
          enum:
            - debug_traceCall
        params:
          type: array
          minItems: 3
          maxItems: 3
          description: |
            1. `object` - Transaction Object
            2. `string` - Block Identifier: Block hash, block number (in hex), or block tag
            3. `tracer` - Object: Currently only supports `callTracer` (see above for definition)
          items:
            anyOf:
            - $ref: '#/transaction_object'
              title: Transaction object
            - type: string
              title: Block identifier
              description: |
                String - One of the following options:
                  1. **block hash**
                  2. **block number** (in hex)
                  3. **block tag** (one of the following):
                    * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
                    * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
                    * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
                    * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
                    * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
              default: finalized
            - type: object
              title: Tracer
              properties:
                tracer:
                  $ref: '#/tracer'
                tracerConfig:
                  $ref: '#/tracerConfig'

debug_traceBlockByHash:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: debug_traceBlockByHash
          enum:
            - debug_traceBlockByHash
        params:
          type: array
          description: |
            1. `string` - Block hash for the block to be traced
            2. `tracer` Object - Currently only supports `callTracer` (see above for definition)
          minItems: 2
          maxItems: 2
          items:
            anyOf:
            - type: string
              title: Block hash
              description: block hash
              default: '0x7bd8357213af34d3fe7f725d9b21187a5a58127e39aac5776fd0594e3391ea6e'
            - type: object
              title: Tracer
              properties:
                tracer:
                  $ref: '#/tracer'
                tracerConfig:
                  $ref: '#/tracerConfig'
debug_traceBlockByNumber:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: debug_traceBlockByNumber
          enum:
            - debug_traceBlockByNumber
        params:
          type: array
          description: |
            1. String - Block number (in hex) or block tag
            2. `tracer` Object - Currently only supports `callTracer` (see above for definition).
          minItems: 2
          maxItems: 2
          items:
            anyOf:
              - $ref: '#/blockNumber_or_blocktag_param_eth'
                title: Block Number or Block Tag
              - type: object
                title: tracer
                properties:
                  tracer:
                    $ref: '#/tracer'
                  tracerConfig:
                    $ref: '#/tracerConfig'
debug_traceTransaction:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: debug_traceTransaction
          enum:
            - debug_traceTransaction
        params:
          type: array
          minItems: 2
          maxItems: 2
          description: |
            1. String - Transaction hash
            2. Object - options for call, can be any of the following options:
              - `tracer`: Object - Currently only supports `callTracer` (see above for definition).
              - `timeout`: String - A duration string of decimal numbers that overrides the default timeout of 5 seconds for JavaScript-based tracing calls. Max timeout is "10s". Valid time units are "ns", "us", "ms", "s" each with optional fraction, such as "300ms" or "2s45ms".
          items:
            anyOf:
            - type: string
              title: Transaction hash
              description: Transaction hash
              default: '0x8fc90a6c3ee3001cdcbbb685b4fbe67b1fa2bec575b15b0395fea5540d0901ae'
            - type: object
              description: options for call
              title: Options
              properties:
                tracer:
                  $ref: '#/tracer'
                tracerConfig:
                  $ref: '#/tracerConfig'
                timeout:
                  type: string
                  description: A duration string of decimal numbers that overrides the default timeout of 5 seconds for JavaScript-based tracing calls. Max timeout is "10s". Valid time units are "ns", "us", "ms", "s" each with optional fraction, such as "300ms" or "2s45ms".
                  default: 5s

# ============ EVM Models ==============
common_request_fields:
  type: object
  properties:
    id:
      type: integer
      default: 1
    jsonrpc:
      type: string
      default: '2.0'
filter_options:
  type: object
  properties:
    blockHash:
      type: string
      pattern: '^0[xX][0-9a-fA-F]+$'
      description: 'Using blockHash is equivalent to fromBlock = toBlock = the block number with hash blockHash. If blockHash is present in the filter criteria, then neither fromBlock nor toBlock are allowed.'
    address:
      type: array
      items:
        type: string
      description: Contract address or a list of addresses from which logs should originate.
    fromBlock:
      $ref: '#/blockNumber_or_blocktag_param_eth'
      default: latest
    toBlock:
      $ref: '#/blockNumber_or_blocktag_param_eth'
      default: latest
    topics:
      $ref: '#/topics'
topics:
  type: array
  description: Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with "or" options.
  items:
    type: string
eth_call_550_gas:
  allOf:
    - $ref: '#/common_request_fields'
    - type: object
      properties:
        method:
          type: string
          default: eth_call
          enum:
            - eth_call
        params:
          type: array
          minItems: 2
          maxItems: 2
          items:
            oneOf:
              - allOf:
                  - $ref: '#/transaction_object'
                  - $ref: '#/gas_550'
              - $ref: '#/blockNumber_or_blocktag_param_eth'

transaction_object:
  type: object
  description: The transaction call object
  properties:
    from:
      type: string
      description: 20 Bytes - The address the transaction is sent from.
      pattern: '^0[xX][0-9a-fA-F]+$'
    to:
      type: string
      description: 20 Bytes - The address the transaction is directed to
      default: '0xd46e8dd67c5d32be8058bb8eb970870f07244567'
      pattern: '^0[xX][0-9a-fA-F]+$'
    gasPrice:
      type: string
      description: |
        Integer of the gasPrice used for each paid gas.
        <br/><strong>NOTE:</strong> most of our users <b>(95%+)</b> never set the gasPrice on eth_call.
      pattern: '^0[xX][0-9a-fA-F]+$'
    value:
      type: string
      description: Integer of the value sent with this transaction
    data:
      type: string
      description: Hash of the method signature and encoded parameters
      pattern: '^0[xX][0-9a-fA-F]+$'
  required:
    - to
gas_550:
  type: object
  properties:
    gas:
      type: string
      pattern: '^0[xX][0-9a-fA-F]+$'
      description: |
        Integer of the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
        </br><strong> NOTE: </strong>this parameter has a cap of <b>550</b> Million gas per request. Reach out to us at support@alchemy.com if you want to increase this limit!
transactionHash_param:
  type: object
  properties:
    params:
      type: array
      description: String - 32 Bytes - Hash of a transaction
      minItems: 1
      maxItems: 1
      items:
        type: string
        pattern: '^0[xX][0-9a-fA-F]+$'
blockHash_param:
  type: object
  properties:
    params:
      type: array
      description: String - 32 Bytes - Hash of a block
      minItems: 1
      maxItems: 1
      items:
        type: string
        pattern: '^0[xX][0-9a-fA-F]+$'
blockHash_and_index_param:
  type: object
  properties:
    params:
      type: array
      description: |
        1. String - 32 Bytes - Hash of a block
        2. String - Integer of the transaction index position (in hex).
      minItems: 2
      maxItems: 2
      items:
        type: string
        pattern: '^0[xX][0-9a-fA-F]+$'
signed_transaction_param:
  type: object
  properties:
    method:
      type: string
      default: alchemy_getGasOptimizedTransactionStatus
      enum:
        - alchemy_getGasOptimizedTransactionStatus
    params:
      type: array
      description: String - The signed transaction data.
      minItems: 1
      maxItems: 1
      items:
        type: string
        pattern: '^0[xX][0-9a-fA-F]+$'
get_signed_txns_status_param:
  type: object
  properties:
    params:
      type: array
      minItems: 1
      maxItems: 1
      items:
        type: string
        description: String - The transactionId returned from alchemy_sendGasOptimizedTransactions
bundled_signed_transaction_param:
  type: object
  properties:
    method:
      type: string
      default: alchemy_sendGasOptimizedTransaction
      enum:
        - alchemy_sendGasOptimizedTransaction
    params:
      type: array
      minItems: 1
      maxItems: 1
      items:
        $ref: '#/bundle_options'
bundle_options:
  type: object
  properties:
    rawTransactions:
      type: array
      minItems: 1
      maxItems: 20
      items:
        type: string
      description: Array - The bundle of signed transactions
blockHash_uncleIndex_param:
  type: object
  properties:
    params:
      type: array
      description: |
        1. String - 32 Bytes - Hash of a block
        2. String - The uncle''s index position (in hex)
      minItems: 2
      maxItems: 2
      items:
        type: string
        pattern: '^0[xX][0-9a-fA-F]+$'
filterId_param:
  type: object
  properties:
    params:
      type: array
      description: String - The filter id.
      minItems: 1
      maxItems: 1
      items:
        type: string
shaHash_param:
  type: object
  properties:
    params:
      type: array
      description: String - The data in hex form to convert into a SHA3 hash.
      minItems: 1
      maxItems: 1
      items:
        type: string
        pattern: '^0[xX][0-9a-fA-F]+$'


# ======= Definitions for blockNumber methods ==========
# After the merge, Ethereum offers more block tags than other EVM chains so we separated them out

blockNumber_or_blocktag_param_eth:
  type: string
  description: |
    String - Either the hex value of a **block number** OR One of the following **block tags**:
      * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
      * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
      * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
      * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
      * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
  default: finalized
blockNumber_or_blocktag_param_l2:
  type: string
  description: |
    String - Either the hex value of a **block number** OR One of the following **block tags**:
      * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
      * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
      * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
address_and_blockNumber_param_eth:
  type: object
  properties:
    params:
      type: array
      description: |
        1. String - 20 Bytes - Address
        2. String - Either the hex value of a **block number** OR One of the following **block tags**:
            * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
            * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
            * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
            * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
            * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
      minItems: 2
      maxItems: 2
      items:
        type: string
address_and_blockNumber_param_l2:
  type: object
  properties:
    params:
      type: array
      description: |
        1. String - 20 Bytes - Address
        2. String - Either the hex value of a **block number** OR One of the following **block tags**:
            * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
            * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
            * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
      minItems: 2
      maxItems: 2
      items:
        type: string
blockNumber_and_index_param_eth:
  type: object
  properties:
    params:
      type: array
      description: |
        1. String - either the hex value of a **block number** OR One of the following **block tags**:
            * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
            * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
            * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
            * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
            * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
        2. String - The transaction index position (in hex)
      minItems: 2
      maxItems: 2
      items:
        type: string
blockNumber_and_index_param_eth_l2:
  type: object
  properties:
    params:
      type: array
      description: |
        1. String - either the hex value of a **block number** OR One of the following **block tags**:
            * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
            * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
            * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
        2. String - The transaction index position (in hex)
      minItems: 2
      maxItems: 2
      items:
        type: string
blockNumber_or_blockHash_param_eth:
  type: string
  description: |
    String - One of the following options:
      1. **block hash**
      2. **block number** (in hex)
      3. **block tag** (one of the following):
        * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
        * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
        * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
        * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
        * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
  minItems: 1
  maxItems: 1
  items:
    type: string
blockNumber_or_blockHash_param_l2:
  type: object
  properties:
    params:
      type: array
      description: |
        String - One of the following options:
          1. **block hash**
          2. **block number** (in hex)
          3. **block tag** (one of the following):
            * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
            * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
            * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
      minItems: 1
      maxItems: 1
      items:
        type: string
blockNumber_uncleIndex_param_eth:
  type: object
  properties:
    params:
      type: array
      description: |
        1. String - either the hex value of a **block number** OR One of the following **block tags**:
            * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
            * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
            * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
            * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. **Only available on Ethereum Mainnet and Goerli**.
            * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
        2. String - The uncle''s index position (in hex)
      minItems: 2
      maxItems: 2
      items:
        type: string
blockNumber_uncleIndex_param_l2:
  type: object
  properties:
    params:
      type: array
      description: |
        1. String - either the hex value of a **block number** OR One of the following **block tags**:
            * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
            * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions.
            * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
        2. String - The uncle''s index position (in hex)
      minItems: 2
      maxItems: 2
      items:
        type: string