From 0378ccbe808b97fe6c03557c7d1879dc0be5b41e Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Thu, 15 Dec 2022 12:54:30 +0100 Subject: [PATCH 01/10] docs: remove interacting-with-geth/rpc/objects --- docs/interacting-with-geth/rpc/objects.md | 72 ----------------------- src/data/documentation-links.yaml | 2 - 2 files changed, 74 deletions(-) delete mode 100644 docs/interacting-with-geth/rpc/objects.md diff --git a/docs/interacting-with-geth/rpc/objects.md b/docs/interacting-with-geth/rpc/objects.md deleted file mode 100644 index 5b7c2dd069..0000000000 --- a/docs/interacting-with-geth/rpc/objects.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Objects -description: Data structures used for RPC methods ---- - -The following are data structures which are used for various RPC methods. - -## Transaction call object {#transaction-call-object} - -The _transaction call object_ contains all the necessary parameters for executing an EVM contract method. - -| Field | Type | Bytes | Optional | Description | -| :--------------------- | :----------- | :---- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `from` | `Address` | 20 | Yes | Address the transaction is simulated to have been sent from. Defaults to first account in the local keystore or the `0x00..0` address if no local accounts are available. | -| `to` | `Address` | 20 | No | Address the transaction is sent to. | -| `gas` | `Quantity` | <8 | Yes | Maximum gas allowance for the code execution to avoid infinite loops. Defaults to `2^63` or whatever value the node operator specified via `--rpc.gascap`. | -| `gasPrice` | `Quantity` | <32 | Yes | Number of `wei` to simulate paying for each unit of gas during execution. Defaults to `1 gwei`. | -| `maxFeePerGas` | `Quantity` | <32 | Yes | Maximum fee per gas the transaction should pay in total. Relevant for type-2 transactions. | -| `maxPriorityFeePerGas` | `Quantity` | <32 | Yes | Maximum tip per gas that's given directly to the miner. Relevant for type-2 transactions. | -| `value` | `Quantity` | <32 | Yes | Amount of `wei` to simulate sending along with the transaction. Defaults to `0`. | -| `nonce` | `Quantity` | <8 | Yes | Nonce of sender account. | -| `input` | `Binary` | any | Yes | Binary data to send to the target contract. Generally the 4 byte hash of the method signature followed by the ABI encoded parameters. For details please see the [Ethereum Contract ABI](https://docs.soliditylang.org/en/v0.7.0/abi-spec.html). This field was previously called `data`. | -| `accessList` | `AccessList` | any | Yes | A list of addresses and storage keys that the transaction plans to access. Used in non-legacy, i.e. type 1 and 2 transactions. | -| `chainId` | `Quantity` | <32 | Yes | Transaction only valid on networks with this chain ID. Used in non-legacy, i.e. type 1 and 2 transactions. | - -Example for a legacy transaction: - -```json -{ - "from": "0xd9c9cd5f6779558b6e0ed4e6acf6b1947e7fa1f3", - "to": "0xebe8efa441b9302a0d7eaecc277c09d20d684540", - "gas": "0x1bd7c", - "data": "0xd459fc46000000000000000000000000000000000000000000000000000000000046c650dbb5e8cb2bac4d2ed0b1e6475d37361157738801c494ca482f96527eb48f9eec488c2eba92d31baeccfb6968fad5c21a3df93181b43b4cf253b4d572b64172ef000000000000000000000000000000000000000000000000000000000000008c00000000000000000000000000000000000000000000000000000000000000e0000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000001a00000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000000000000000000000000000000000000000001c0000000000000000000000000000000000000000000000000000000000000002b85c0c828d7a98633b4e1b65eac0c017502da909420aeade9a280675013df36bdc71cffdf420cef3d24ba4b3f9b980bfbb26bd5e2dcf7795b3519a3fd22ffbb2000000000000000000000000000000000000000000000000000000000000000238fb6606dc2b5e42d00c653372c153da8560de77bd9afaba94b4ab6e4aa11d565d858c761320dbf23a94018d843772349bd9d92301b0ca9ca983a22d86a70628" -} -``` - -Example for a type-1 transaction: - -```json -{ - "from": "0xd9c9cd5f6779558b6e0ed4e6acf6b1947e7fa1f3", - "to": "0xebe8efa441b9302a0d7eaecc277c09d20d684540", - "gas": "0x1bd7c", - "data": "0xd459fc46000000000000000000000000000000000000000000000000000000000046c650dbb5e8cb2bac4d2ed0b1e6475d37361157738801c494ca482f96527eb48f9eec488c2eba92d31baeccfb6968fad5c21a3df93181b43b4cf253b4d572b64172ef000000000000000000000000000000000000000000000000000000000000008c00000000000000000000000000000000000000000000000000000000000000e0000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000001a00000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000000000000000000000000000000000000000001c0000000000000000000000000000000000000000000000000000000000000002b85c0c828d7a98633b4e1b65eac0c017502da909420aeade9a280675013df36bdc71cffdf420cef3d24ba4b3f9b980bfbb26bd5e2dcf7795b3519a3fd22ffbb2000000000000000000000000000000000000000000000000000000000000000238fb6606dc2b5e42d00c653372c153da8560de77bd9afaba94b4ab6e4aa11d565d858c761320dbf23a94018d843772349bd9d92301b0ca9ca983a22d86a70628", - "chainId": "0x1", - "accessList": [ - { - "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - "storageKeys": ["0xda650992a54ccb05f924b3a73ba785211ba39a8912b6d270312f8e2c223fb9b1", "0x10d6a54a4754c8869d6886b5f5d7fbfa5b4 - 522237ea5c60d11bc4e7a1ff9390b"] - }, { - "address": "0xa2327a938febf5fec13bacfb16ae10ecbc4cbdcf", - "storageKeys": [] - }, - ] -} -``` - -Example for a type-2 transaction: - -```json -{ - "from": "0xd9c9cd5f6779558b6e0ed4e6acf6b1947e7fa1f3", - "to": "0xebe8efa441b9302a0d7eaecc277c09d20d684540", - "gas": "0x1bd7c", - "maxFeePerGas": "0x6b44b0285", - "maxPriorityFeePerGas": "0x6b44b0285", - "data": "0xd459fc46000000000000000000000000000000000000000000000000000000000046c650dbb5e8cb2bac4d2ed0b1e6475d37361157738801c494ca482f96527eb48f9eec488c2eba92d31baeccfb6968fad5c21a3df93181b43b4cf253b4d572b64172ef000000000000000000000000000000000000000000000000000000000000008c00000000000000000000000000000000000000000000000000000000000000e0000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000001a00000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000000000000000000000000000000000000000001c0000000000000000000000000000000000000000000000000000000000000002b85c0c828d7a98633b4e1b65eac0c017502da909420aeade9a280675013df36bdc71cffdf420cef3d24ba4b3f9b980bfbb26bd5e2dcf7795b3519a3fd22ffbb2000000000000000000000000000000000000000000000000000000000000000238fb6606dc2b5e42d00c653372c153da8560de77bd9afaba94b4ab6e4aa11d565d858c761320dbf23a94018d843772349bd9d92301b0ca9ca983a22d86a70628", - "chainId": "0x1", - "accessList": [] -} -``` diff --git a/src/data/documentation-links.yaml b/src/data/documentation-links.yaml index f889d4cc6f..fc7f966bc3 100644 --- a/src/data/documentation-links.yaml +++ b/src/data/documentation-links.yaml @@ -64,8 +64,6 @@ to: /docs/interacting-with-geth/rpc/ns-personal - id: txpool Namespace to: /docs/interacting-with-geth/rpc/ns-txpool - - id: Objects - to: /docs/interacting-with-geth/rpc/objects - id: Real-time Events to: /docs/interacting-with-geth/rpc/pubsub - id: JavaScript Console From 1b3640a8392e5003fed0a5991e2b33ef8226ffaf Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Thu, 15 Dec 2022 12:54:57 +0100 Subject: [PATCH 02/10] docs: fix typos on index page --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 27ec898fff..4c3508aeb5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,7 +3,7 @@ title: Welcome to go-ethereum description: Documentation for the go-ethereum client --- -Go-ethereum (aka Geth) is an Ethereum client built in [Golang](https://go.dev). It is one of the original and most popular Ethereum clients. +Go-ethereum (aka Geth) is an Ethereum client built in [Go](https://go.dev). It is one of the original and most popular Ethereum clients. These documentation pages are intended to help users download, install and use Geth. ## Where to go from here {#where-to-go} @@ -18,7 +18,7 @@ More advanced topics are also available - explore them using the sidebar! ## Developers and contributors {#developers-and-contributors} -If you want to help develop Geth or build decentralized apps on top of it, head to our [Developers](/docs/developers) documentation. +If you want to help develop Geth or build decentralized apps on top of it, head to our [Developer](/docs/developers) documentation. ## More resources {#more-resources} From 72935be0ebf4da19f79b7b94d6729fff2804c2b8 Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Thu, 15 Dec 2022 12:55:11 +0100 Subject: [PATCH 03/10] docs: remove extra heading in fundamentals/index --- docs/fundamentals/index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/fundamentals/index.md b/docs/fundamentals/index.md index 2468dc0d71..5f2e4ad59e 100644 --- a/docs/fundamentals/index.md +++ b/docs/fundamentals/index.md @@ -3,8 +3,6 @@ title: Geth fundamentals description: Documentation for foundational Geth topics --- -## Geth fundamentals {#geth-fundamentals} - This section includes documentation for foundational topics in Geth. The pages here will help you to understand how Geth works from a user perspective and under the hood. This is where you will find information about how to manage a Geth node and understand how it functions. From ebe8093a63e15b5e8c9339a03ee3041aff0e8fe7 Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Thu, 15 Dec 2022 12:55:28 +0100 Subject: [PATCH 04/10] src/data: update some doc link names --- src/data/documentation-links.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/data/documentation-links.yaml b/src/data/documentation-links.yaml index fc7f966bc3..b92d847458 100644 --- a/src/data/documentation-links.yaml +++ b/src/data/documentation-links.yaml @@ -22,7 +22,7 @@ to: /docs/fundamentals/sync-modes - id: Account management to: /docs/fundamentals/account-management - - id: Backup restore + - id: 'Backup & Restore' to: /docs/fundamentals/backup-restore - id: Logs to: /docs/fundamentals/logs @@ -142,7 +142,7 @@ to: /docs/tools/clef/clique-signing - id: puppeth to: /docs/tools/puppeth - - id: Abigen + - id: abigen to: /docs/tools/abigen - id: devp2p to: /docs/tools/devp2p From 39fd2d41c63fbf407a73ca9187dad0bb47f9b38c Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Thu, 15 Dec 2022 13:01:38 +0100 Subject: [PATCH 05/10] update url-list.csv --- url-list.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/url-list.csv b/url-list.csv index 5ada9306bd..0ce87bb455 100644 --- a/url-list.csv +++ b/url-list.csv @@ -38,7 +38,7 @@ https://geth.ethereum.org/docs/rpc/ns-miner,https://geth.ethereum.org/docs/inter https://geth.ethereum.org/docs/rpc/ns-net,https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-net,,n/a https://geth.ethereum.org/docs/rpc/ns-personal,https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-personal,,n/a https://geth.ethereum.org/docs/rpc/ns-txpool,https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-txpool,,n/a -https://geth.ethereum.org/docs/rpc/objects,https://geth.ethereum.org/docs/interacting-with-geth/rpc/objects,,n/a +https://geth.ethereum.org/docs/rpc/objects,https://geth.ethereum.org/,page deleted,n/a https://geth.ethereum.org/docs/developers/dev-guide,https://geth.ethereum.org/docs/developers/geth-developer/dev-guide,,n/a https://geth.ethereum.org/docs/developers/code-review-guidelines,https://geth.ethereum.org/docs/developers/geth-developer/code-review-guidelines,,n/a https://geth.ethereum.org/docs/developers/issue-handling-workflow,https://geth.ethereum.org/docs/developers/geth-developer/issue-handling-workflow,,n/a From 2eb6e9417410a63085c0545f1fef2cc9d0073439 Mon Sep 17 00:00:00 2001 From: Paul Wackerow <54227730+wackerow@users.noreply.github.com> Date: Thu, 15 Dec 2022 14:18:57 -0800 Subject: [PATCH 06/10] redirect removed page to /docs landing updates old redirect to /docs as well --- redirects.js | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/redirects.js b/redirects.js index 83ecd6fbc2..91f2bb8799 100644 --- a/redirects.js +++ b/redirects.js @@ -171,7 +171,12 @@ const redirects = [ }, { source: '/docs/rpc/objects', - destination: '/docs/interacting-with-geth/rpc/objects', + destination: '/docs', + permanent: true + }, + { + source: '/docs/interacting-with-geth/rpc/objects', + destination: '/docs', permanent: true }, { From ff733d8c7399666d53c3bab3d516a7d5ea8ea072 Mon Sep 17 00:00:00 2001 From: Paul Wackerow <54227730+wackerow@users.noreply.github.com> Date: Thu, 15 Dec 2022 14:21:03 -0800 Subject: [PATCH 07/10] redirect rpc/objects path to root --- redirects.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/redirects.js b/redirects.js index 91f2bb8799..47b1da7246 100644 --- a/redirects.js +++ b/redirects.js @@ -171,12 +171,12 @@ const redirects = [ }, { source: '/docs/rpc/objects', - destination: '/docs', + destination: '/', permanent: true }, { source: '/docs/interacting-with-geth/rpc/objects', - destination: '/docs', + destination: '/', permanent: true }, { From fef80d6cfb3ce21ac35b01e9dee700c53ff335d9 Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Sat, 17 Dec 2022 00:06:59 +0100 Subject: [PATCH 08/10] Update src/data/documentation-links.yaml Co-authored-by: Corwin Smith --- src/data/documentation-links.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/data/documentation-links.yaml b/src/data/documentation-links.yaml index b92d847458..8f293855ec 100644 --- a/src/data/documentation-links.yaml +++ b/src/data/documentation-links.yaml @@ -22,7 +22,7 @@ to: /docs/fundamentals/sync-modes - id: Account management to: /docs/fundamentals/account-management - - id: 'Backup & Restore' + - id: 'Backup & restore' to: /docs/fundamentals/backup-restore - id: Logs to: /docs/fundamentals/logs From d890f75db87b63701b0e35c28232f6af310cca14 Mon Sep 17 00:00:00 2001 From: Corwin Smith Date: Sun, 18 Dec 2022 22:35:27 -0700 Subject: [PATCH 09/10] Update redirects.js --- redirects.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/redirects.js b/redirects.js index 47b1da7246..2febbd621c 100644 --- a/redirects.js +++ b/redirects.js @@ -171,7 +171,7 @@ const redirects = [ }, { source: '/docs/rpc/objects', - destination: '/', + destination: '/docs', permanent: true }, { From b66312d87e2010e488d4e534e60506b81361c41e Mon Sep 17 00:00:00 2001 From: Corwin Smith Date: Sun, 18 Dec 2022 22:35:36 -0700 Subject: [PATCH 10/10] Update redirects.js --- redirects.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/redirects.js b/redirects.js index 2febbd621c..91f2bb8799 100644 --- a/redirects.js +++ b/redirects.js @@ -176,7 +176,7 @@ const redirects = [ }, { source: '/docs/interacting-with-geth/rpc/objects', - destination: '/', + destination: '/docs', permanent: true }, {