github.com/Night-mk/quorum@v21.1.0+incompatible/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 # Transaction is an Ethereum transaction. 73 type Transaction { 74 # Hash is the hash of this transaction. 75 hash: Bytes32! 76 # Nonce is the nonce of the account this transaction was generated with. 77 nonce: Long! 78 # Index is the index of this transaction in the parent block. This will 79 # be null if the transaction has not yet been mined. 80 index: Int 81 # From is the account that sent this transaction - this will always be 82 # an externally owned account. 83 from(block: Long): Account! 84 # To is the account the transaction was sent to. This is null for 85 # contract-creating transactions. 86 to(block: Long): Account 87 # Value is the value, in wei, sent along with this transaction. 88 value: BigInt! 89 # GasPrice is the price offered to miners for gas, in wei per unit. 90 gasPrice: BigInt! 91 # Gas is the maximum amount of gas this transaction can consume. 92 gas: Long! 93 # InputData is the data supplied to the target of the transaction. 94 inputData: Bytes! 95 # Block is the block this transaction was mined in. This will be null if 96 # the transaction has not yet been mined. 97 block: Block 98 99 # Status is the return status of the transaction. This will be 1 if the 100 # transaction succeeded, or 0 if it failed (due to a revert, or due to 101 # running out of gas). If the transaction has not yet been mined, this 102 # field will be null. 103 status: Long 104 # GasUsed is the amount of gas that was used processing this transaction. 105 # If the transaction has not yet been mined, this field will be null. 106 gasUsed: Long 107 # CumulativeGasUsed is the total gas used in the block up to and including 108 # this transaction. If the transaction has not yet been mined, this field 109 # will be null. 110 cumulativeGasUsed: Long 111 # CreatedContract is the account that was created by a contract creation 112 # transaction. If the transaction was not a contract creation transaction, 113 # or it has not yet been mined, this field will be null. 114 createdContract(block: Long): Account 115 # Logs is a list of log entries emitted by this transaction. If the 116 # transaction has not yet been mined, this field will be null. 117 logs: [Log!] 118 r: BigInt! 119 s: BigInt! 120 v: BigInt! 121 # IsPrivate is an indicator of Quorum private transaction 122 isPrivate: Boolean 123 # PrivateInputData is the actual payload of Quorum private transaction 124 privateInputData: Bytes 125 } 126 127 # BlockFilterCriteria encapsulates log filter criteria for a filter applied 128 # to a single block. 129 input BlockFilterCriteria { 130 # Addresses is list of addresses that are of interest. If this list is 131 # empty, results will not be filtered by address. 132 addresses: [Address!] 133 # Topics list restricts matches to particular event topics. Each event has a list 134 # of topics. Topics matches a prefix of that list. An empty element array matches any 135 # topic. Non-empty elements represent an alternative that matches any of the 136 # contained topics. 137 # 138 # Examples: 139 # - [] or nil matches any topic list 140 # - [[A]] matches topic A in first position 141 # - [[], [B]] matches any topic in first position, B in second position 142 # - [[A], [B]] matches topic A in first position, B in second position 143 # - [[A, B]], [C, D]] matches topic (A OR B) in first position, (C OR D) in second position 144 topics: [[Bytes32!]!] 145 } 146 147 # Block is an Ethereum block. 148 type Block { 149 # Number is the number of this block, starting at 0 for the genesis block. 150 number: Long! 151 # Hash is the block hash of this block. 152 hash: Bytes32! 153 # Parent is the parent block of this block. 154 parent: Block 155 # Nonce is the block nonce, an 8 byte sequence determined by the miner. 156 nonce: Bytes! 157 # TransactionsRoot is the keccak256 hash of the root of the trie of transactions in this block. 158 transactionsRoot: Bytes32! 159 # TransactionCount is the number of transactions in this block. if 160 # transactions are not available for this block, this field will be null. 161 transactionCount: Int 162 # StateRoot is the keccak256 hash of the state trie after this block was processed. 163 stateRoot: Bytes32! 164 # ReceiptsRoot is the keccak256 hash of the trie of transaction receipts in this block. 165 receiptsRoot: Bytes32! 166 # Miner is the account that mined this block. 167 miner(block: Long): Account! 168 # ExtraData is an arbitrary data field supplied by the miner. 169 extraData: Bytes! 170 # GasLimit is the maximum amount of gas that was available to transactions in this block. 171 gasLimit: Long! 172 # GasUsed is the amount of gas that was used executing transactions in this block. 173 gasUsed: Long! 174 # Timestamp is the unix timestamp at which this block was mined. 175 timestamp: Long! 176 # LogsBloom is a bloom filter that can be used to check if a block may 177 # contain log entries matching a filter. 178 logsBloom: Bytes! 179 # MixHash is the hash that was used as an input to the PoW process. 180 mixHash: Bytes32! 181 # Difficulty is a measure of the difficulty of mining this block. 182 difficulty: BigInt! 183 # TotalDifficulty is the sum of all difficulty values up to and including 184 # this block. 185 totalDifficulty: BigInt! 186 # OmmerCount is the number of ommers (AKA uncles) associated with this 187 # block. If ommers are unavailable, this field will be null. 188 ommerCount: Int 189 # Ommers is a list of ommer (AKA uncle) blocks associated with this block. 190 # If ommers are unavailable, this field will be null. Depending on your 191 # node, the transactions, transactionAt, transactionCount, ommers, 192 # ommerCount and ommerAt fields may not be available on any ommer blocks. 193 ommers: [Block] 194 # OmmerAt returns the ommer (AKA uncle) at the specified index. If ommers 195 # are unavailable, or the index is out of bounds, this field will be null. 196 ommerAt(index: Int!): Block 197 # OmmerHash is the keccak256 hash of all the ommers (AKA uncles) 198 # associated with this block. 199 ommerHash: Bytes32! 200 # Transactions is a list of transactions associated with this block. If 201 # transactions are unavailable for this block, this field will be null. 202 transactions: [Transaction!] 203 # TransactionAt returns the transaction at the specified index. If 204 # transactions are unavailable for this block, or if the index is out of 205 # bounds, this field will be null. 206 transactionAt(index: Int!): Transaction 207 # Logs returns a filtered set of logs from this block. 208 logs(filter: BlockFilterCriteria!): [Log!]! 209 # Account fetches an Ethereum account at the current block's state. 210 account(address: Address!): Account! 211 # Call executes a local call operation at the current block's state. 212 call(data: CallData!): CallResult 213 # EstimateGas estimates the amount of gas that will be required for 214 # successful execution of a transaction at the current block's state. 215 estimateGas(data: CallData!): Long! 216 } 217 218 # CallData represents the data associated with a local contract call. 219 # All fields are optional. 220 input CallData { 221 # From is the address making the call. 222 from: Address 223 # To is the address the call is sent to. 224 to: Address 225 # Gas is the amount of gas sent with the call. 226 gas: Long 227 # GasPrice is the price, in wei, offered for each unit of gas. 228 gasPrice: BigInt 229 # Value is the value, in wei, sent along with the call. 230 value: BigInt 231 # Data is the data sent to the callee. 232 data: Bytes 233 } 234 235 # CallResult is the result of a local call operation. 236 type CallResult { 237 # Data is the return data of the called contract. 238 data: Bytes! 239 # GasUsed is the amount of gas used by the call, after any refunds. 240 gasUsed: Long! 241 # Status is the result of the call - 1 for success or 0 for failure. 242 status: Long! 243 } 244 245 # FilterCriteria encapsulates log filter criteria for searching log entries. 246 input FilterCriteria { 247 # FromBlock is the block at which to start searching, inclusive. Defaults 248 # to the latest block if not supplied. 249 fromBlock: Long 250 # ToBlock is the block at which to stop searching, inclusive. Defaults 251 # to the latest block if not supplied. 252 toBlock: Long 253 # Addresses is a list of addresses that are of interest. If this list is 254 # empty, results will not be filtered by address. 255 addresses: [Address!] 256 # Topics list restricts matches to particular event topics. Each event has a list 257 # of topics. Topics matches a prefix of that list. An empty element array matches any 258 # topic. Non-empty elements represent an alternative that matches any of the 259 # contained topics. 260 # 261 # Examples: 262 # - [] or nil matches any topic list 263 # - [[A]] matches topic A in first position 264 # - [[], [B]] matches any topic in first position, B in second position 265 # - [[A], [B]] matches topic A in first position, B in second position 266 # - [[A, B]], [C, D]] matches topic (A OR B) in first position, (C OR D) in second position 267 topics: [[Bytes32!]!] 268 } 269 270 # SyncState contains the current synchronisation state of the client. 271 type SyncState{ 272 # StartingBlock is the block number at which synchronisation started. 273 startingBlock: Long! 274 # CurrentBlock is the point at which synchronisation has presently reached. 275 currentBlock: Long! 276 # HighestBlock is the latest known block number. 277 highestBlock: Long! 278 # PulledStates is the number of state entries fetched so far, or null 279 # if this is not known or not relevant. 280 pulledStates: Long 281 # KnownStates is the number of states the node knows of so far, or null 282 # if this is not known or not relevant. 283 knownStates: Long 284 } 285 286 # Pending represents the current pending state. 287 type Pending { 288 # TransactionCount is the number of transactions in the pending state. 289 transactionCount: Int! 290 # Transactions is a list of transactions in the current pending state. 291 transactions: [Transaction!] 292 # Account fetches an Ethereum account for the pending state. 293 account(address: Address!): Account! 294 # Call executes a local call operation for the pending state. 295 call(data: CallData!): CallResult 296 # EstimateGas estimates the amount of gas that will be required for 297 # successful execution of a transaction for the pending state. 298 estimateGas(data: CallData!): Long! 299 } 300 301 type Query { 302 # Block fetches an Ethereum block by number or by hash. If neither is 303 # supplied, the most recent known block is returned. 304 block(number: Long, hash: Bytes32): Block 305 # Blocks returns all the blocks between two numbers, inclusive. If 306 # to is not supplied, it defaults to the most recent known block. 307 blocks(from: Long!, to: Long): [Block!]! 308 # Pending returns the current pending state. 309 pending: Pending! 310 # Transaction returns a transaction specified by its hash. 311 transaction(hash: Bytes32!): Transaction 312 # Logs returns log entries matching the provided filter. 313 logs(filter: FilterCriteria!): [Log!]! 314 # GasPrice returns the node's estimate of a gas price sufficient to 315 # ensure a transaction is mined in a timely fashion. 316 gasPrice: BigInt! 317 # ProtocolVersion returns the current wire protocol version number. 318 protocolVersion: Int! 319 # Syncing returns information on the current synchronisation state. 320 syncing: SyncState 321 } 322 323 type Mutation { 324 # SendRawTransaction sends an RLP-encoded transaction to the network. 325 sendRawTransaction(data: Bytes!): Bytes32! 326 } 327 `