Merge pull request #171 from ethereum/fjl/content-fixes-1

Fixes from content review
This commit is contained in:
Corwin Smith 2022-12-18 22:36:02 -07:00 committed by GitHub
commit 23d5653d53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 11 additions and 82 deletions

View File

@ -3,8 +3,6 @@ title: Geth fundamentals
description: Documentation for foundational Geth topics 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 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. This is where you will find information about how to manage a Geth node and understand how it functions.

View File

@ -3,7 +3,7 @@ title: Welcome to go-ethereum
description: Documentation for the go-ethereum client 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. These documentation pages are intended to help users download, install and use Geth.
## Where to go from here {#where-to-go} ## 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} ## 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} ## More resources {#more-resources}

View File

@ -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": []
}
```

View File

@ -181,7 +181,12 @@ const redirects = [
}, },
{ {
source: '/docs/rpc/objects', 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 permanent: true
}, },
{ {

View File

@ -22,7 +22,7 @@
to: /docs/fundamentals/sync-modes to: /docs/fundamentals/sync-modes
- id: Account management - id: Account management
to: /docs/fundamentals/account-management to: /docs/fundamentals/account-management
- id: Backup restore - id: 'Backup & restore'
to: /docs/fundamentals/backup-restore to: /docs/fundamentals/backup-restore
- id: Logs - id: Logs
to: /docs/fundamentals/logs to: /docs/fundamentals/logs
@ -66,8 +66,6 @@
to: /docs/interacting-with-geth/rpc/ns-personal to: /docs/interacting-with-geth/rpc/ns-personal
- id: txpool Namespace - id: txpool Namespace
to: /docs/interacting-with-geth/rpc/ns-txpool to: /docs/interacting-with-geth/rpc/ns-txpool
- id: Objects
to: /docs/interacting-with-geth/rpc/objects
- id: Real-time Events - id: Real-time Events
to: /docs/interacting-with-geth/rpc/pubsub to: /docs/interacting-with-geth/rpc/pubsub
- id: JavaScript Console - id: JavaScript Console
@ -142,7 +140,7 @@
to: /docs/tools/clef/clique-signing to: /docs/tools/clef/clique-signing
- id: puppeth - id: puppeth
to: /docs/tools/puppeth to: /docs/tools/puppeth
- id: Abigen - id: abigen
to: /docs/tools/abigen to: /docs/tools/abigen
- id: devp2p - id: devp2p
to: /docs/tools/devp2p to: /docs/tools/devp2p

View File

@ -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-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-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/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/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/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/,page deleted,n/a https://geth.ethereum.org/docs/developers/issue-handling-workflow,https://geth.ethereum.org/,page deleted,n/a

1 OLD Geth website URLS Equivalent NEW website URLs Notes
38 https://geth.ethereum.org/docs/rpc/ns-net https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-net n/a
39 https://geth.ethereum.org/docs/rpc/ns-personal https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-personal n/a
40 https://geth.ethereum.org/docs/rpc/ns-txpool https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-txpool n/a
41 https://geth.ethereum.org/docs/rpc/objects https://geth.ethereum.org/docs/interacting-with-geth/rpc/objects https://geth.ethereum.org/ page deleted n/a
42 https://geth.ethereum.org/docs/developers/dev-guide https://geth.ethereum.org/docs/developers/geth-developer/dev-guide n/a
43 https://geth.ethereum.org/docs/developers/code-review-guidelines https://geth.ethereum.org/docs/developers/geth-developer/code-review-guidelines n/a
44 https://geth.ethereum.org/docs/developers/issue-handling-workflow https://geth.ethereum.org/ page deleted n/a