chore: Update outdated links to ETH JSON RPC Specification in docstrings (#10041)

* Update outdated links to ETH JSON RPC Specification in docstrings

* Remove empty line
vb-graphql-req-size-limit
Kevin Mathew 7 months ago committed by GitHub
parent fe9000cff9
commit 18ef2c0ef5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 2
      apps/block_scout_web/lib/block_scout_web/templates/api_docs/eth_rpc.html.eex
  2. 11
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/block.ex
  3. 2
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/block/by_hash.ex
  4. 2
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/block/by_nephew.ex
  5. 2
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/block/by_number.ex
  6. 4
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/blocks.ex
  7. 2
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/log.ex
  8. 2
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/logs.ex
  9. 2
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/receipt.ex
  10. 2
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/receipts.ex
  11. 10
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/transaction.ex
  12. 4
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/transactions.ex
  13. 2
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/uncle.ex
  14. 2
      apps/ethereum_jsonrpc/lib/ethereum_jsonrpc/uncles.ex

@ -6,7 +6,7 @@
<p class="card-subtitle margin-bottom-0">
<%= gettext "This API is provided to support some rpc methods in the exact format specified for ethereum nodes, which can be found " %>
<a href="https://github.com/ethereum/wiki/wiki/JSON-RPC"><%= gettext "here." %></a>
<a href="https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b"><%= gettext "here." %></a>
<%= gettext "This is useful to allow sending requests to blockscout without having to change anything about the request." %>
<%= gettext "However, in general, the" %> <%= link(
gettext("custom RPC"),

@ -1,7 +1,7 @@
defmodule EthereumJSONRPC.Block do
@moduledoc """
Block format as returned by [`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbyhash)
and [`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbynumber).
Block format as returned by [`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbyhash)
and [`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbynumber).
"""
import EthereumJSONRPC, only: [quantity_to_integer: 1, timestamp_to_datetime: 1]
@ -75,20 +75,20 @@ defmodule EthereumJSONRPC.Block do
* `"number"` - the block number `t:EthereumJSONRPC.quantity/0`. `nil` when block is pending.
* `"parentHash" - the `t:EthereumJSONRPC.hash/0` of the parent block.
* `"receiptsRoot"` - `t:EthereumJSONRPC.hash/0` of the root of the receipts.
[trie](https://github.com/ethereum/wiki/wiki/Patricia-Tree) of the block.
[trie](https://ethereum.org/en/developers/docs/data-structures-and-encoding/patricia-merkle-trie/) of the block.
* `"sealFields"` - UNKNOWN
* `"sha3Uncles"` - `t:EthereumJSONRPC.hash/0` of the
[uncles](https://bitcoin.stackexchange.com/questions/39329/in-ethereum-what-is-an-uncle-block) data in the block.
* `"signature"` - UNKNOWN
* `"size"` - `t:EthereumJSONRPC.quantity/0` of bytes in this block
* `"stateRoot" - `t:EthereumJSONRPC.hash/0` of the root of the final state
[trie](https://github.com/ethereum/wiki/wiki/Patricia-Tree) of the block.
[trie](https://ethereum.org/en/developers/docs/data-structures-and-encoding/patricia-merkle-trie/) of the block.
* `"step"` - UNKNOWN
* `"timestamp"`: the unix timestamp as a `t:EthereumJSONRPC.quantity/0` for when the block was collated.
* `"totalDifficulty" - `t:EthereumJSONRPC.quantity/0` of the total difficulty of the chain until this block.
* `"transactions"` - `t:list/0` of `t:EthereumJSONRPC.Transaction.t/0`.
* `"transactionsRoot" - `t:EthereumJSONRPC.hash/0` of the root of the transaction
[trie](https://github.com/ethereum/wiki/wiki/Patricia-Tree) of the block.
[trie](https://ethereum.org/en/developers/docs/data-structures-and-encoding/patricia-merkle-trie/) of the block.
* `uncles`: `t:list/0` of
[uncles](https://bitcoin.stackexchange.com/questions/39329/in-ethereum-what-is-an-uncle-block)
`t:EthereumJSONRPC.hash/0`.
@ -198,7 +198,6 @@ defmodule EthereumJSONRPC.Block do
transactions_root: "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",\
#{case Application.compile_env(:explorer, :chain_type) do
:rsk -> """
bitcoin_merged_mining_coinbase_transaction: "0x00000000000000805bf0dc9203da49a3b4e3ec913806e43102cc07db991272dc8b7018da57eb5abe59a32d070000ffffffff03449a4d26000000001976a914536ffa992491508dca0354e52f32a3a7a679a53a88ac00000000000000002b6a2952534b424c4f434b3ad2508d21d28c8f89d495923c0758ec3f64bd6755b4ec416f5601312600542a400000000000000000266a24aa21a9ed4ae42ea6dca2687aaed665714bf58b055c4e11f2fb038605930d630b49ad7b9d00000000",\
bitcoin_merged_mining_header: "0x00006d20ffd048280094a6ea0851d854036aacaa25ee0f23f0040200000000000000000078d2638fe0b4477c54601e6449051afba8228e0a88ff06b0c91f091fd34d5da57487c76402610517372c2fe9",\
bitcoin_merged_mining_merkle_proof: "0x8e5a4ba74eb4eb2f9ad4cabc2913aeed380a5becf7cd4d513341617efb798002bd83a783c31c66a8a8f6cc56c071c2d471cb610e3dc13054b9d216021d8c7e9112f622564449ebedcedf7d4ccb6fe0ffac861b7ed1446c310813cdf712e1e6add28b1fe1c0ae5e916194ba4f285a9340aba41e91bf847bf31acf37a9623a04a2348a37ab9faa5908122db45596bbc03e9c3644b0d4589471c4ff30fc139f3ba50506e9136fa0df799b487494de3e2b3dec937338f1a2e18da057c1f60590a9723672a4355b9914b1d01af9f582d9e856f6e1744be00f268b0b01d559329f7e0685aa63ffeb7c28486d7462292021d1345cddbf7c920ca34bb7aa4c6cdbe068806e35d0db662e7fcda03cb4d779594638c62a1fdd7ec98d1fb6d240d853958abe57561d9b9d0465cf8b9d6ee3c58b0d8b07d6c4c5d8f348e43fe3c06011b6a0008db4e0b16c77ececc3981f9008201cea5939869d648e59a09bd2094b1196ff61126bffb626153deed2563e1745436247c94a85d2947756b606d67633781c99d7",\

@ -1,6 +1,6 @@
defmodule EthereumJSONRPC.Block.ByHash do
@moduledoc """
Block format as returned by [`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbyhash)
Block format as returned by [`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbyhash)
"""
def request(%{id: id, hash: hash}, hydrated \\ true) do

@ -1,6 +1,6 @@
defmodule EthereumJSONRPC.Block.ByNephew do
@moduledoc """
Block format as returned by [`eth_getUncleByBlockHashAndIndex`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getUncleByBlockHashAndIndex)
Block format as returned by [`eth_getUncleByBlockHashAndIndex`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getunclebyblockhashandindex)
"""
import EthereumJSONRPC, only: [integer_to_quantity: 1]

@ -1,6 +1,6 @@
defmodule EthereumJSONRPC.Block.ByNumber do
@moduledoc """
Block format as returned by [`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbyhash)
Block format as returned by [`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbyhash)
"""
import EthereumJSONRPC, only: [integer_to_quantity: 1]

@ -1,7 +1,7 @@
defmodule EthereumJSONRPC.Blocks do
@moduledoc """
Blocks format as returned by [`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbyhash)
and [`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbynumber) from batch requests.
Blocks format as returned by [`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbyhash)
and [`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbynumber) from batch requests.
"""
alias EthereumJSONRPC.{Block, Transactions, Transport, Uncles, Withdrawals}

@ -1,7 +1,7 @@
defmodule EthereumJSONRPC.Log do
@moduledoc """
Log included in return from
[`eth_getTransactionReceipt`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gettransactionreceipt).
[`eth_getTransactionReceipt`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_gettransactionreceipt).
"""
import EthereumJSONRPC, only: [quantity_to_integer: 1]

@ -1,7 +1,7 @@
defmodule EthereumJSONRPC.Logs do
@moduledoc """
Collection of logs included in return from
[`eth_getTransactionReceipt`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gettransactionreceipt).
[`eth_getTransactionReceipt`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_gettransactionreceipt).
"""
alias EthereumJSONRPC.Log

@ -1,7 +1,7 @@
defmodule EthereumJSONRPC.Receipt do
@moduledoc """
Receipts format as returned by
[`eth_getTransactionReceipt`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gettransactionreceipt).
[`eth_getTransactionReceipt`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_gettransactionreceipt).
"""
import EthereumJSONRPC, only: [quantity_to_integer: 1]

@ -1,7 +1,7 @@
defmodule EthereumJSONRPC.Receipts do
@moduledoc """
Receipts format as returned by
[`eth_getTransactionReceipt`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gettransactionreceipt) from batch
[`eth_getTransactionReceipt`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_gettransactionreceipt) from batch
requests.
"""

@ -1,11 +1,11 @@
defmodule EthereumJSONRPC.Transaction do
@moduledoc """
Transaction format included in the return of
[`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbyhash)
and [`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbynumber) and returned by
[`eth_getTransactionByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gettransactionbyhash),
[`eth_getTransactionByBlockHashAndIndex`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gettransactionbyblockhashandindex),
and [`eth_getTransactionByBlockNumberAndIndex`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gettransactionbyblocknumberandindex)
[`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbyhash)
and [`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbynumber) and returned by
[`eth_getTransactionByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_gettransactionbyhash),
[`eth_getTransactionByBlockHashAndIndex`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_gettransactionbyblockhashandindex),
and [`eth_getTransactionByBlockNumberAndIndex`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_gettransactionbyblocknumberandindex)
"""
import EthereumJSONRPC, only: [quantity_to_integer: 1, integer_to_quantity: 1, request: 1]

@ -1,8 +1,8 @@
defmodule EthereumJSONRPC.Transactions do
@moduledoc """
List of transactions format as included in return from
[`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbyhash) and
[`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getblockbynumber).
[`eth_getBlockByHash`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbyhash) and
[`eth_getBlockByNumber`](https://github.com/ethereum/wiki/wiki/JSON-RPC/e8e0771b9f3677693649d945956bc60e886ceb2b#eth_getblockbynumber).
"""
alias EthereumJSONRPC.Transaction

@ -1,6 +1,6 @@
defmodule EthereumJSONRPC.Uncle do
@moduledoc """
[Uncle](https://github.com/ethereum/wiki/wiki/Glossary#ethereum-blockchain).
[Uncle](https://ethereum.org/en/glossary).
An uncle is a block that didn't make the main chain due to them being validated slightly behind what became the main
chain.

@ -1,6 +1,6 @@
defmodule EthereumJSONRPC.Uncles do
@moduledoc """
List of [uncles](https://github.com/ethereum/wiki/wiki/Glossary#ethereum-blockchain). Uncles are blocks that didn't
List of [uncles](https://ethereum.org/en/glossary). Uncles are blocks that didn't
make the main chain due to them being validated slightly behind what became the main chain.
"""

Loading…
Cancel
Save