synapsecns/sanguine

View on GitHub
services/omnirpc/swagger/openapi.yaml

Summary

Maintainability
Test Coverage
openapi: 3.0.3
info:
  title: Ethereum JSON-RPC
  description: A collection holding all the Ethereum JSIN RPC API calls
  version: 1.0.0
  contact: {}
servers:
- url: '{{ENVIRONMENT}}'
paths:
  /rpc/{CHAIN_ID}:
    post:
      tags:
      - eth
      summary: protocolVersion
      description: "Returns the current ethereum protocol version.\r\n\r\n**Parameters**\r\n\r\nnone\r\n\r\n**Returns**\r\n\r\n`String` - The current ethereum protocol version"
      operationId: protocolversion
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: number
                  example: 73
                jsonrpc:
                  type: string
                  example: '2.0'
                method:
                  type: string
                  example: eth_submitHashrate
                params:
                  type: array
                  items:
                    type: string
                    example: '0x0000000000000000000000000000000000000000000000000000000000500000'
                  example:
                  - '0x0000000000000000000000000000000000000000000000000000000000500000'
                  - 0x59daa26581d0acd1fce254fb7e85952f4c09d0915afd33d3886cd914bc7d283c
            examples:
              accounts:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_accounts
                  params: []
              blockNumber:
                value:
                  id: 83
                  jsonrpc: '2.0'
                  method: eth_blockNumber
                  params: []
              call:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_call
                  params:
                  - data: ''
                    from: ''
                    gas: ''
                    gasPrice: ''
                    to: ''
                    value: ''
                  - latest
              coinbase:
                value:
                  id: 64
                  jsonrpc: '2.0'
                  method: eth_coinbase
                  params: []
              compileLLL:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_compileLLL
                  params:
                  - (returnlll (suicide (caller)))
              compileSerpent:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_compileSerpent
                  params:
                  - /* some serpent */
              compileSolidity:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_compileSolidity
                  params:
                  - contract test { function multiply(uint a) returns(uint d) {   return a * 7;   } }
              estimateGas:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_estimateGas
                  params: []
              gasPrice:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_gasPrice
                  params: []
              getBalance:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBalance
                  params:
                  - 0x407d73d8a49eeb85d32cf465507dd71d507100c1
                  - latest
              getBlockByHash:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBlockByHash
                  params:
                  - 0xad1328d13f833b8af722117afdc406a762033321df8e48c00cd372d462f48169
                  - true
              getBlockByNumber:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBlockByNumber
                  params:
                  - '0x1b4'
                  - true
              getBlockTransactionCountByHash:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBlockTransactionCountByHash
                  params:
                  - 0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238
              getBlockTransactionCountByNumber:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBlockTransactionCountByNumber
                  params:
                  - '0x52A8CA'
              getCode:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getCode
                  params:
                  - 0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b
                  - '0x2'
              getCompilers:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getCompilers
                  params: []
              getFilterChanges:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_getFilterChanges
                  params:
                  - '0x16'
              getLogs:
                value:
                  id: 74
                  jsonrpc: '2.0'
                  method: eth_getLogs
                  params:
                  - topics:
                    - 0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b
              getStorageAt:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getStorageAt
                  params:
                  - 0x295a70b2de5e3953354a6a8344e616ed314d7251
                  - '0x0'
                  - latest
              getTransactionByBlockHashAndIndex:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionByBlockHashAndIndex
                  params:
                  - 0x3c82bc62179602b67318c013c10f99011037c49cba84e31ffe6e465a21c521a7
                  - '0x0'
              getTransactionByBlockNumberAndIndex:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionByBlockNumberAndIndex
                  params:
                  - '0x52A96E'
                  - '0x1'
              getTransactionByHash:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionByHash
                  params:
                  - 0xb2fea9c4b24775af6990237aa90228e5e092c56bdaee74496992a53c208da1ee
              getTransactionCount:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionCount
                  params:
                  - 0x407d73d8a49eeb85d32cf465507dd71d507100c1
                  - latest
              getTransactionReceipt:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionReceipt
                  params:
                  - 0xa3ece39ae137617669c6933b7578b94e705e765683f260fcfe30eaa41932610f
              getUncleByBlockHashAndIndex:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getUncleByBlockHashAndIndex
                  params:
                  - 0x7cea0c9ae53df7073fcd4e7b19fc3f1905a2540bbdbd9a10796c9296f5af55dc
                  - '0x0'
              getUncleByBlockNumberAndIndex:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getUncleByBlockNumberAndIndex
                  params:
                  - '0x29c'
                  - '0x0'
              getWork:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_getWork
                  params: []
              hashrate:
                value:
                  id: 71
                  jsonrpc: '2.0'
                  method: eth_hashrate
                  params: []
              mining:
                value:
                  id: 71
                  jsonrpc: '2.0'
                  method: eth_mining
                  params: []
              newBlockFilter:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_newBlockFilter
                  params: []
              newFilter:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_newFilter
                  params:
                  - topics:
                    - '0x12341234'
              newPendingTransactionFilter:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_newPendingTransactionFilter
                  params: []
              protocolVersion:
                value:
                  id: 67
                  jsonrpc: '2.0'
                  method: eth_protocolVersion
                  params: []
              sendRawTransaction:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_sendRawTransaction
                  params:
                  - 0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675
              sendTransaction:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_sendTransaction
                  params:
                  - data: 0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675
                    from: 0xb60e8dd61c5d32be8058bb8eb970870f07233155
                    gas: '0x76c0'
                    gasPrice: '0x9184e72a000'
                    to: 0xd46e8dd67c5d32be8058bb8eb970870f07244567
                    value: '0x9184e72a'
              sign:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_sign
                  params:
                  - 0x9b2055d370f73ec7d8a03e965129118dc8f5bf83
                  - '0xdeadbeaf'
              submitHashrate:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_submitHashrate
                  params:
                  - '0x0000000000000000000000000000000000000000000000000000000000500000'
                  - 0x59daa26581d0acd1fce254fb7e85952f4c09d0915afd33d3886cd914bc7d283c
              submitWork:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_submitWork
                  params:
                  - '0x0000000000000001'
                  - 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
                  - 0xD1GE5700000000000000000000000000D1GE5700000000000000000000000000
              syncing:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_syncing
                  params: []
              uninstallFilter:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_uninstallFilter
                  params:
                  - '0xb'
      responses:
        '200':
          description: ''
    parameters:
    - name: CHAIN_ID
      in: path
      required: true
      schema:
        type: string
  /confirmations/{CONFIRMATIONS}/rpc/{CHAIN_ID}:
    post:
      tags:
      - eth (confirmations)
      summary: protocolVersion
      description: "Returns the current ethereum protocol version.\r\n\r\n**Parameters**\r\n\r\nnone\r\n\r\n**Returns**\r\n\r\n`String` - The current ethereum protocol version"
      operationId: protocolversion1
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: number
                  example: 73
                jsonrpc:
                  type: string
                  example: '2.0'
                method:
                  type: string
                  example: eth_submitHashrate
                params:
                  type: array
                  items:
                    type: string
                    example: '0x0000000000000000000000000000000000000000000000000000000000500000'
                  example:
                  - '0x0000000000000000000000000000000000000000000000000000000000500000'
                  - 0x59daa26581d0acd1fce254fb7e85952f4c09d0915afd33d3886cd914bc7d283c
            examples:
              accounts:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_accounts
                  params: []
              blockNumber:
                value:
                  id: 83
                  jsonrpc: '2.0'
                  method: eth_blockNumber
                  params: []
              call:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_call
                  params:
                  - data: ''
                    from: ''
                    gas: ''
                    gasPrice: ''
                    to: ''
                    value: ''
                  - latest
              coinbase:
                value:
                  id: 64
                  jsonrpc: '2.0'
                  method: eth_coinbase
                  params: []
              compileLLL:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_compileLLL
                  params:
                  - (returnlll (suicide (caller)))
              compileSerpent:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_compileSerpent
                  params:
                  - /* some serpent */
              compileSolidity:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_compileSolidity
                  params:
                  - contract test { function multiply(uint a) returns(uint d) {   return a * 7;   } }
              estimateGas:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_estimateGas
                  params: []
              gasPrice:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_gasPrice
                  params: []
              getBalance:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBalance
                  params:
                  - 0x407d73d8a49eeb85d32cf465507dd71d507100c1
                  - latest
              getBlockByHash:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBlockByHash
                  params:
                  - 0xad1328d13f833b8af722117afdc406a762033321df8e48c00cd372d462f48169
                  - true
              getBlockByNumber:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBlockByNumber
                  params:
                  - '0x1b4'
                  - true
              getBlockTransactionCountByHash:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBlockTransactionCountByHash
                  params:
                  - 0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238
              getBlockTransactionCountByNumber:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getBlockTransactionCountByNumber
                  params:
                  - '0x52A8CA'
              getCode:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getCode
                  params:
                  - 0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b
                  - '0x2'
              getCompilers:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getCompilers
                  params: []
              getFilterChanges:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_getFilterChanges
                  params:
                  - '0x16'
              getLogs:
                value:
                  id: 74
                  jsonrpc: '2.0'
                  method: eth_getLogs
                  params:
                  - topics:
                    - 0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b
              getStorageAt:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getStorageAt
                  params:
                  - 0x295a70b2de5e3953354a6a8344e616ed314d7251
                  - '0x0'
                  - latest
              getTransactionByBlockHashAndIndex:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionByBlockHashAndIndex
                  params:
                  - 0x3c82bc62179602b67318c013c10f99011037c49cba84e31ffe6e465a21c521a7
                  - '0x0'
              getTransactionByBlockNumberAndIndex:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionByBlockNumberAndIndex
                  params:
                  - '0x52A96E'
                  - '0x1'
              getTransactionByHash:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionByHash
                  params:
                  - 0xb2fea9c4b24775af6990237aa90228e5e092c56bdaee74496992a53c208da1ee
              getTransactionCount:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionCount
                  params:
                  - 0x407d73d8a49eeb85d32cf465507dd71d507100c1
                  - latest
              getTransactionReceipt:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getTransactionReceipt
                  params:
                  - 0xa3ece39ae137617669c6933b7578b94e705e765683f260fcfe30eaa41932610f
              getUncleByBlockHashAndIndex:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getUncleByBlockHashAndIndex
                  params:
                  - 0x7cea0c9ae53df7073fcd4e7b19fc3f1905a2540bbdbd9a10796c9296f5af55dc
                  - '0x0'
              getUncleByBlockNumberAndIndex:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_getUncleByBlockNumberAndIndex
                  params:
                  - '0x29c'
                  - '0x0'
              getWork:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_getWork
                  params: []
              hashrate:
                value:
                  id: 71
                  jsonrpc: '2.0'
                  method: eth_hashrate
                  params: []
              mining:
                value:
                  id: 71
                  jsonrpc: '2.0'
                  method: eth_mining
                  params: []
              newBlockFilter:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_newBlockFilter
                  params: []
              newFilter:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_newFilter
                  params:
                  - topics:
                    - '0x12341234'
              newPendingTransactionFilter:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_newPendingTransactionFilter
                  params: []
              protocolVersion:
                value:
                  id: 67
                  jsonrpc: '2.0'
                  method: eth_protocolVersion
                  params: []
              sendRawTransaction:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_sendRawTransaction
                  params:
                  - 0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675
              sendTransaction:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_sendTransaction
                  params:
                  - data: 0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675
                    from: 0xb60e8dd61c5d32be8058bb8eb970870f07233155
                    gas: '0x76c0'
                    gasPrice: '0x9184e72a000'
                    to: 0xd46e8dd67c5d32be8058bb8eb970870f07244567
                    value: '0x9184e72a'
              sign:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_sign
                  params:
                  - 0x9b2055d370f73ec7d8a03e965129118dc8f5bf83
                  - '0xdeadbeaf'
              submitHashrate:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_submitHashrate
                  params:
                  - '0x0000000000000000000000000000000000000000000000000000000000500000'
                  - 0x59daa26581d0acd1fce254fb7e85952f4c09d0915afd33d3886cd914bc7d283c
              submitWork:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_submitWork
                  params:
                  - '0x0000000000000001'
                  - 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
                  - 0xD1GE5700000000000000000000000000D1GE5700000000000000000000000000
              syncing:
                value:
                  id: 1
                  jsonrpc: '2.0'
                  method: eth_syncing
                  params: []
              uninstallFilter:
                value:
                  id: 73
                  jsonrpc: '2.0'
                  method: eth_uninstallFilter
                  params:
                  - '0xb'
      responses:
        '200':
          description: ''
    parameters:
    - name: CONFIRMATIONS
      in: path
      required: true
      schema:
        type: string
    - name: CHAIN_ID
      in: path
      required: true
      schema:
        type: string
tags:
- name: eth
- name: eth (confirmations)