diff --git a/public/content/developers/docs/apis/json-rpc/index.md b/public/content/developers/docs/apis/json-rpc/index.md index 1175c4b7137..e831cffe7b2 100755 --- a/public/content/developers/docs/apis/json-rpc/index.md +++ b/public/content/developers/docs/apis/json-rpc/index.md @@ -303,6 +303,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_protocolVersion","params":[] Returns an object with data about the sync status or `false`. + + Try endpoint in playground + + **Parameters** None @@ -387,6 +391,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1} Returns the client coinbase address. + + Try endpoint in playground + + > **Note:** This method has been deprecated as of **v1.14.0** and is no longer supported. Attempting to use this method will result in a "Method not supported" error. **Parameters** @@ -414,6 +422,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_coinbase","params":[],"id":6 Returns the chain ID used for signing replay-protected transactions. + + Try endpoint in playground + + **Parameters** None @@ -439,6 +451,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_chainId","params":[],"id":67 Returns `true` if client is actively mining new blocks. This can only return `true` for proof-of-work networks and may not be available in some clients since [The Merge](/roadmap/merge/). + + Try endpoint in playground + + **Parameters** None @@ -464,6 +480,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_mining","params":[],"id":71} Returns the number of hashes per second that the node is mining with. This can only return `true` for proof-of-work networks and may not be available in some clients since [The Merge](/roadmap/merge/). + + Try endpoint in playground + + **Parameters** None @@ -489,6 +509,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_hashrate","params":[],"id":7 Returns an estimate of the current price per gas in wei. For example, the Besu client examines the last 100 blocks and returns the median gas unit price by default. + + Try endpoint in playground + + **Parameters** None @@ -514,6 +538,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":7 Returns a list of addresses owned by client. + + Try endpoint in playground + + **Parameters** None @@ -539,6 +567,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1 Returns the number of most recent block. + + Try endpoint in playground + + **Parameters** None @@ -564,6 +596,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id Returns the balance of the account of given address. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 20 Bytes - address to check for balance. @@ -594,6 +630,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBalance","params":["0x407 Returns the value from a storage position at a given address. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 20 Bytes - address of the storage. @@ -662,6 +702,10 @@ curl -X POST --data '{"jsonrpc":"2.0", "method": "eth_getStorageAt", "params": [ Returns the number of transactions _sent_ from an address. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 20 Bytes - address. @@ -695,6 +739,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params Returns the number of transactions in a block from a block matching the given block hash. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 32 Bytes - hash of a block @@ -724,6 +772,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByHa Returns the number of transactions in a block matching the given block number. + + Try endpoint in playground + + **Parameters** 1. `QUANTITY|TAG` - integer of a block number, or the string `"earliest"`, `"latest"`, `"pending"`, `"safe"` or `"finalized"`, as in the [block parameter](/developers/docs/apis/json-rpc/#block-parameter). @@ -755,6 +807,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByNu Returns the number of uncles in a block from a block matching the given block hash. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 32 Bytes - hash of a block @@ -784,6 +840,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockHash","p Returns the number of uncles in a block from a block matching the given block number. + + Try endpoint in playground + + **Parameters** 1. `QUANTITY|TAG` - integer of a block number, or the string `"latest"`, `"earliest"`, `"pending"`, `"safe"` or `"finalized"`, see the [block parameter](/developers/docs/apis/json-rpc/#block-parameter) @@ -815,6 +875,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockNumber", Returns code at a given address. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 20 Bytes - address @@ -994,6 +1058,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sendRawTransaction","params" Executes a new message call immediately without creating a transaction on the blockchain. Often used for executing read-only smart contract functions, for example the `balanceOf` for an ERC-20 contract. + + Try endpoint in playground + + **Parameters** 1. `Object` - The transaction call object @@ -1028,6 +1096,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_call","params":[{see above}] Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain. Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance. + + Try endpoint in playground + + **Parameters** See [eth_call](#eth_call) parameters, except that all properties are optional. If no gas limit is specified geth uses the block gas limit from the pending block as an upper bound. As a result the returned estimate might not be enough to executed the call/transaction when the amount of gas is higher than the pending block gas limit. @@ -1053,6 +1125,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_estimateGas","params":[{see Returns information about a block by hash. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 32 Bytes - Hash of a block. @@ -1130,6 +1206,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockByHash","params":["0 Returns information about a block by block number. + + Try endpoint in playground + + **Parameters** 1. `QUANTITY|TAG` - integer of a block number, or the string `"earliest"`, `"latest"`, `"pending"`, `"safe"` or `"finalized"`, as in the [block parameter](/developers/docs/apis/json-rpc/#block-parameter). @@ -1158,6 +1238,10 @@ Result see [eth_getBlockByHash](#eth_getblockbyhash) Returns the information about a transaction requested by transaction hash. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 32 Bytes - hash of a transaction @@ -1217,6 +1301,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByHash","param Returns information about a transaction by block hash and transaction index position. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 32 Bytes - hash of a block. @@ -1245,6 +1333,10 @@ Result see [eth_getTransactionByHash](#eth_gettransactionbyhash) Returns information about a transaction by block number and transaction index position. + + Try endpoint in playground + + **Parameters** 1. `QUANTITY|TAG` - a block number, or the string `"earliest"`, `"latest"`, `"pending"`, `"safe"` or `"finalized"`, as in the [block parameter](/developers/docs/apis/json-rpc/#block-parameter). @@ -1341,6 +1433,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionReceipt","para Returns information about a uncle of a block by hash and uncle index position. + + Try endpoint in playground + + **Parameters** 1. `DATA`, 32 Bytes - The hash of a block. @@ -1371,6 +1467,10 @@ Result see [eth_getBlockByHash](#eth_getblockbyhash) Returns information about a uncle of a block by number and uncle index position. + + Try endpoint in playground + + **Parameters** 1. `QUANTITY|TAG` - a block number, or the string `"earliest"`, `"latest"`, `"pending"`, `"safe"`, `"finalized"`, as in the [block parameter](/developers/docs/apis/json-rpc/#block-parameter).