github.com/phillinzzz/newBsc@v1.1.6/graphql/schema.go (about)

     1  // Copyright 2019 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package graphql
    18  
    19  const schema string = `
    20      # Bytes32 is a 32 byte binary string, represented as 0x-prefixed hexadecimal.
    21      scalar Bytes32
    22      # Address is a 20 byte Ethereum address, represented as 0x-prefixed hexadecimal.
    23      scalar Address
    24      # Bytes is an arbitrary length binary string, represented as 0x-prefixed hexadecimal.
    25      # An empty byte string is represented as '0x'. Byte strings must have an even number of hexadecimal nybbles.
    26      scalar Bytes
    27      # BigInt is a large integer. Input is accepted as either a JSON number or as a string.
    28      # Strings may be either decimal or 0x-prefixed hexadecimal. Output values are all
    29      # 0x-prefixed hexadecimal.
    30      scalar BigInt
    31      # Long is a 64 bit unsigned integer.
    32      scalar Long
    33  
    34      schema {
    35          query: Query
    36          mutation: Mutation
    37      }
    38  
    39      # Account is an Ethereum account at a particular block.
    40      type Account {
    41          # Address is the address owning the account.
    42          address: Address!
    43          # Balance is the balance of the account, in wei.
    44          balance: BigInt!
    45          # TransactionCount is the number of transactions sent from this account,
    46          # or in the case of a contract, the number of contracts created. Otherwise
    47          # known as the nonce.
    48          transactionCount: Long!
    49          # Code contains the smart contract code for this account, if the account
    50          # is a (non-self-destructed) contract.
    51          code: Bytes!
    52          # Storage provides access to the storage of a contract account, indexed
    53          # by its 32 byte slot identifier.
    54          storage(slot: Bytes32!): Bytes32!
    55      }
    56  
    57      # Log is an Ethereum event log.
    58      type Log {
    59          # Index is the index of this log in the block.
    60          index: Int!
    61          # Account is the account which generated this log - this will always
    62          # be a contract account.
    63          account(block: Long): Account!
    64          # Topics is a list of 0-4 indexed topics for the log.
    65          topics: [Bytes32!]!
    66          # Data is unindexed data for this log.
    67          data: Bytes!
    68          # Transaction is the transaction that generated this log entry.
    69          transaction: Transaction!
    70      }
    71  
    72      #EIP-2718 
    73      type AccessTuple{
    74          address: Address!
    75          storageKeys : [Bytes32!]
    76      }
    77  
    78      # Transaction is an Ethereum transaction.
    79      type Transaction {
    80          # Hash is the hash of this transaction.
    81          hash: Bytes32!
    82          # Nonce is the nonce of the account this transaction was generated with.
    83          nonce: Long!
    84          # Index is the index of this transaction in the parent block. This will
    85          # be null if the transaction has not yet been mined.
    86          index: Int
    87          # From is the account that sent this transaction - this will always be
    88          # an externally owned account.
    89          from(block: Long): Account!
    90          # To is the account the transaction was sent to. This is null for
    91          # contract-creating transactions.
    92          to(block: Long): Account
    93          # Value is the value, in wei, sent along with this transaction.
    94          value: BigInt!
    95          # GasPrice is the price offered to miners for gas, in wei per unit.
    96          gasPrice: BigInt!
    97          # Gas is the maximum amount of gas this transaction can consume.
    98          gas: Long!
    99          # InputData is the data supplied to the target of the transaction.
   100          inputData: Bytes!
   101          # Block is the block this transaction was mined in. This will be null if
   102          # the transaction has not yet been mined.
   103          block: Block
   104  
   105          # Status is the return status of the transaction. This will be 1 if the
   106          # transaction succeeded, or 0 if it failed (due to a revert, or due to
   107          # running out of gas). If the transaction has not yet been mined, this
   108          # field will be null.
   109          status: Long
   110          # GasUsed is the amount of gas that was used processing this transaction.
   111          # If the transaction has not yet been mined, this field will be null.
   112          gasUsed: Long
   113          # CumulativeGasUsed is the total gas used in the block up to and including
   114          # this transaction. If the transaction has not yet been mined, this field
   115          # will be null.
   116          cumulativeGasUsed: Long
   117          # CreatedContract is the account that was created by a contract creation
   118          # transaction. If the transaction was not a contract creation transaction,
   119          # or it has not yet been mined, this field will be null.
   120          createdContract(block: Long): Account
   121          # Logs is a list of log entries emitted by this transaction. If the
   122          # transaction has not yet been mined, this field will be null.
   123          logs: [Log!]
   124          r: BigInt!
   125          s: BigInt!
   126          v: BigInt!
   127          #Envelope transaction support
   128          type: Int
   129          accessList: [AccessTuple!]
   130      }
   131  
   132      # BlockFilterCriteria encapsulates log filter criteria for a filter applied
   133      # to a single block.
   134      input BlockFilterCriteria {
   135          # Addresses is list of addresses that are of interest. If this list is
   136          # empty, results will not be filtered by address.
   137          addresses: [Address!]
   138          # Topics list restricts matches to particular event topics. Each event has a list
   139        # of topics. Topics matches a prefix of that list. An empty element array matches any
   140        # topic. Non-empty elements represent an alternative that matches any of the
   141        # contained topics.
   142        #
   143        # Examples:
   144        #  - [] or nil          matches any topic list
   145        #  - [[A]]              matches topic A in first position
   146        #  - [[], [B]]          matches any topic in first position, B in second position
   147        #  - [[A], [B]]         matches topic A in first position, B in second position
   148        #  - [[A, B]], [C, D]]  matches topic (A OR B) in first position, (C OR D) in second position
   149          topics: [[Bytes32!]!]
   150      }
   151  
   152      # Block is an Ethereum block.
   153      type Block {
   154          # Number is the number of this block, starting at 0 for the genesis block.
   155          number: Long!
   156          # Hash is the block hash of this block.
   157          hash: Bytes32!
   158          # Parent is the parent block of this block.
   159          parent: Block
   160          # Nonce is the block nonce, an 8 byte sequence determined by the miner.
   161          nonce: Bytes!
   162          # TransactionsRoot is the keccak256 hash of the root of the trie of transactions in this block.
   163          transactionsRoot: Bytes32!
   164          # TransactionCount is the number of transactions in this block. if
   165          # transactions are not available for this block, this field will be null.
   166          transactionCount: Int
   167          # StateRoot is the keccak256 hash of the state trie after this block was processed.
   168          stateRoot: Bytes32!
   169          # ReceiptsRoot is the keccak256 hash of the trie of transaction receipts in this block.
   170          receiptsRoot: Bytes32!
   171          # Miner is the account that mined this block.
   172          miner(block: Long): Account!
   173          # ExtraData is an arbitrary data field supplied by the miner.
   174          extraData: Bytes!
   175          # GasLimit is the maximum amount of gas that was available to transactions in this block.
   176          gasLimit: Long!
   177          # GasUsed is the amount of gas that was used executing transactions in this block.
   178          gasUsed: Long!
   179          # Timestamp is the unix timestamp at which this block was mined.
   180          timestamp: Long!
   181          # LogsBloom is a bloom filter that can be used to check if a block may
   182          # contain log entries matching a filter.
   183          logsBloom: Bytes!
   184          # MixHash is the hash that was used as an input to the PoW process.
   185          mixHash: Bytes32!
   186          # Difficulty is a measure of the difficulty of mining this block.
   187          difficulty: BigInt!
   188          # TotalDifficulty is the sum of all difficulty values up to and including
   189          # this block.
   190          totalDifficulty: BigInt!
   191          # OmmerCount is the number of ommers (AKA uncles) associated with this
   192          # block. If ommers are unavailable, this field will be null.
   193          ommerCount: Int
   194          # Ommers is a list of ommer (AKA uncle) blocks associated with this block.
   195          # If ommers are unavailable, this field will be null. Depending on your
   196          # node, the transactions, transactionAt, transactionCount, ommers,
   197          # ommerCount and ommerAt fields may not be available on any ommer blocks.
   198          ommers: [Block]
   199          # OmmerAt returns the ommer (AKA uncle) at the specified index. If ommers
   200          # are unavailable, or the index is out of bounds, this field will be null.
   201          ommerAt(index: Int!): Block
   202          # OmmerHash is the keccak256 hash of all the ommers (AKA uncles)
   203          # associated with this block.
   204          ommerHash: Bytes32!
   205          # Transactions is a list of transactions associated with this block. If
   206          # transactions are unavailable for this block, this field will be null.
   207          transactions: [Transaction!]
   208          # TransactionAt returns the transaction at the specified index. If
   209          # transactions are unavailable for this block, or if the index is out of
   210          # bounds, this field will be null.
   211          transactionAt(index: Int!): Transaction
   212          # Logs returns a filtered set of logs from this block.
   213          logs(filter: BlockFilterCriteria!): [Log!]!
   214          # Account fetches an Ethereum account at the current block's state.
   215          account(address: Address!): Account!
   216          # Call executes a local call operation at the current block's state.
   217          call(data: CallData!): CallResult
   218          # EstimateGas estimates the amount of gas that will be required for
   219          # successful execution of a transaction at the current block's state.
   220          estimateGas(data: CallData!): Long!
   221      }
   222  
   223      # CallData represents the data associated with a local contract call.
   224      # All fields are optional.
   225      input CallData {
   226          # From is the address making the call.
   227          from: Address
   228          # To is the address the call is sent to.
   229          to: Address
   230          # Gas is the amount of gas sent with the call.
   231          gas: Long
   232          # GasPrice is the price, in wei, offered for each unit of gas.
   233          gasPrice: BigInt
   234          # Value is the value, in wei, sent along with the call.
   235          value: BigInt
   236          # Data is the data sent to the callee.
   237          data: Bytes
   238      }
   239  
   240      # CallResult is the result of a local call operation.
   241      type CallResult {
   242          # Data is the return data of the called contract.
   243          data: Bytes!
   244          # GasUsed is the amount of gas used by the call, after any refunds.
   245          gasUsed: Long!
   246          # Status is the result of the call - 1 for success or 0 for failure.
   247          status: Long!
   248      }
   249  
   250      # FilterCriteria encapsulates log filter criteria for searching log entries.
   251      input FilterCriteria {
   252          # FromBlock is the block at which to start searching, inclusive. Defaults
   253          # to the latest block if not supplied.
   254          fromBlock: Long
   255          # ToBlock is the block at which to stop searching, inclusive. Defaults
   256          # to the latest block if not supplied.
   257          toBlock: Long
   258          # Addresses is a list of addresses that are of interest. If this list is
   259          # empty, results will not be filtered by address.
   260          addresses: [Address!]
   261          # Topics list restricts matches to particular event topics. Each event has a list
   262        # of topics. Topics matches a prefix of that list. An empty element array matches any
   263        # topic. Non-empty elements represent an alternative that matches any of the
   264        # contained topics.
   265        #
   266        # Examples:
   267        #  - [] or nil          matches any topic list
   268        #  - [[A]]              matches topic A in first position
   269        #  - [[], [B]]          matches any topic in first position, B in second position
   270        #  - [[A], [B]]         matches topic A in first position, B in second position
   271        #  - [[A, B]], [C, D]]  matches topic (A OR B) in first position, (C OR D) in second position
   272          topics: [[Bytes32!]!]
   273      }
   274  
   275      # SyncState contains the current synchronisation state of the client.
   276      type SyncState{
   277          # StartingBlock is the block number at which synchronisation started.
   278          startingBlock: Long!
   279          # CurrentBlock is the point at which synchronisation has presently reached.
   280          currentBlock: Long!
   281          # HighestBlock is the latest known block number.
   282          highestBlock: Long!
   283          # PulledStates is the number of state entries fetched so far, or null
   284          # if this is not known or not relevant.
   285          pulledStates: Long
   286          # KnownStates is the number of states the node knows of so far, or null
   287          # if this is not known or not relevant.
   288          knownStates: Long
   289      }
   290  
   291      # Pending represents the current pending state.
   292      type Pending {
   293        # TransactionCount is the number of transactions in the pending state.
   294        transactionCount: Int!
   295        # Transactions is a list of transactions in the current pending state.
   296        transactions: [Transaction!]
   297        # Account fetches an Ethereum account for the pending state.
   298        account(address: Address!): Account!
   299        # Call executes a local call operation for the pending state.
   300        call(data: CallData!): CallResult
   301        # EstimateGas estimates the amount of gas that will be required for
   302        # successful execution of a transaction for the pending state.
   303        estimateGas(data: CallData!): Long!
   304      }
   305  
   306      type Query {
   307          # Block fetches an Ethereum block by number or by hash. If neither is
   308          # supplied, the most recent known block is returned.
   309          block(number: Long, hash: Bytes32): Block
   310          # Blocks returns all the blocks between two numbers, inclusive. If
   311          # to is not supplied, it defaults to the most recent known block.
   312          blocks(from: Long, to: Long): [Block!]!
   313          # Pending returns the current pending state.
   314          pending: Pending!
   315          # Transaction returns a transaction specified by its hash.
   316          transaction(hash: Bytes32!): Transaction
   317          # Logs returns log entries matching the provided filter.
   318          logs(filter: FilterCriteria!): [Log!]!
   319          # GasPrice returns the node's estimate of a gas price sufficient to
   320          # ensure a transaction is mined in a timely fashion.
   321          gasPrice: BigInt!
   322          # Syncing returns information on the current synchronisation state.
   323          syncing: SyncState
   324          # ChainID returns the current chain ID for transaction replay protection.
   325          chainID: BigInt!
   326      }
   327  
   328      type Mutation {
   329          # SendRawTransaction sends an RLP-encoded transaction to the network.
   330          sendRawTransaction(data: Bytes!): Bytes32!
   331      }
   332  `