From fd40bc6d2b725a4994a9352100de04ee7c9eb1cd Mon Sep 17 00:00:00 2001 From: Ng Wei Han Date: Tue, 31 Jan 2023 14:13:12 +0800 Subject: [PATCH 1/3] docs: minor fix on geth links # Conflicts: # README.md --- .github/CONTRIBUTING.md | 2 +- README.md | 6 +++--- cmd/checkpoint-admin/README.md | 2 +- cmd/devp2p/README.md | 2 +- cmd/geth/consolecmd.go | 6 +++--- docs/parlia/README-BEP-127.md | 4 ++-- docs/postmortems/2021-08-22-split-postmortem.md | 2 +- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a08542df25..24225830ed 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -35,6 +35,6 @@ and help. ## Configuration, dependencies, and tests -Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide) +Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers) for more details on configuring your environment, managing project dependencies and testing procedures. diff --git a/README.md b/README.md index e658e2ec24..b60bdf1215 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ BNB will be used to: Many of the below are the same as or similar to go-ethereum. -For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/install-and-build/installing-geth). +For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth). Building `geth` requires both a Go (version 1.18 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run @@ -92,7 +92,7 @@ directory. ## Running `geth` Going through all the possible command line flags is out of scope here (please consult our -[CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)), +[CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)), but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own `geth` instance. @@ -252,7 +252,7 @@ Please make sure your contributions adhere to our coding guidelines: * Commit messages should be prefixed with the package(s) they modify. * E.g. "eth, rpc: make trace configs optional" -Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide) +Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers) for more details on configuring your environment, managing project dependencies, and testing procedures. diff --git a/cmd/checkpoint-admin/README.md b/cmd/checkpoint-admin/README.md index 43e3785ec2..52d29a3f60 100644 --- a/cmd/checkpoint-admin/README.md +++ b/cmd/checkpoint-admin/README.md @@ -46,7 +46,7 @@ Deploy checkpoint oracle contract. `--signers` indicates the specified trusted s checkpoint-admin deploy --rpc --clef --signer --signers --threshold 1 ``` -It is worth noting that checkpoint-admin only supports clef as a signer for transactions and plain text(checkpoint). For more clef usage, please see the clef [tutorial](https://geth.ethereum.org/docs/clef/tutorial) . +It is worth noting that checkpoint-admin only supports clef as a signer for transactions and plain text(checkpoint). For more clef usage, please see the clef [tutorial](https://geth.ethereum.org/docs/tools/clef/tutorial) . #### Sign diff --git a/cmd/devp2p/README.md b/cmd/devp2p/README.md index 7f816b602e..7b90bbeb80 100644 --- a/cmd/devp2p/README.md +++ b/cmd/devp2p/README.md @@ -135,6 +135,6 @@ replacing `` with the enode of the geth node: ``` [eth]: https://github.com/ethereum/devp2p/blob/master/caps/eth.md -[dns-tutorial]: https://geth.ethereum.org/docs/developers/dns-discovery-setup +[dns-tutorial]: https://geth.ethereum.org/docs/developers/geth-developer/dns-discovery-setup [discv4]: https://github.com/ethereum/devp2p/tree/master/discv4.md [discv5]: https://github.com/ethereum/devp2p/tree/master/discv5/discv5.md diff --git a/cmd/geth/consolecmd.go b/cmd/geth/consolecmd.go index 7a0135b9a1..ded7f5db83 100644 --- a/cmd/geth/consolecmd.go +++ b/cmd/geth/consolecmd.go @@ -41,7 +41,7 @@ var ( Description: ` The Geth console is an interactive shell for the JavaScript runtime environment which exposes a node admin interface as well as the Ðapp JavaScript API. -See https://geth.ethereum.org/docs/interface/javascript-console.`, +See https://geth.ethereum.org/docs/interacting-with-geth/javascript-console.`, } attachCommand = cli.Command{ @@ -54,7 +54,7 @@ See https://geth.ethereum.org/docs/interface/javascript-console.`, Description: ` The Geth console is an interactive shell for the JavaScript runtime environment which exposes a node admin interface as well as the Ðapp JavaScript API. -See https://geth.ethereum.org/docs/interface/javascript-console. +See https://geth.ethereum.org/docs/interacting-with-geth/javascript-console. This command allows to open a console on a running geth node.`, } @@ -67,7 +67,7 @@ This command allows to open a console on a running geth node.`, Category: "CONSOLE COMMANDS", Description: ` The JavaScript VM exposes a node admin interface as well as the Ðapp -JavaScript API. See https://geth.ethereum.org/docs/interface/javascript-console`, +JavaScript API. See https://geth.ethereum.org/docs/interacting-with-geth/javascript-console`, } ) diff --git a/docs/parlia/README-BEP-127.md b/docs/parlia/README-BEP-127.md index f79b07141f..636ad1ba99 100644 --- a/docs/parlia/README-BEP-127.md +++ b/docs/parlia/README-BEP-127.md @@ -19,10 +19,10 @@ $ geth attach geth.ipc ``` This command will: -* Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console), +* Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interacting-with-geth/javascript-console), (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/en/) (note: the `web3` version bundled within `geth` is very old, and not up to date with official docs), - as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server). + as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc). ### enter maintenance diff --git a/docs/postmortems/2021-08-22-split-postmortem.md b/docs/postmortems/2021-08-22-split-postmortem.md index 429f22d70a..89b6bb28c9 100644 --- a/docs/postmortems/2021-08-22-split-postmortem.md +++ b/docs/postmortems/2021-08-22-split-postmortem.md @@ -87,7 +87,7 @@ The blocks on the 'bad' chain were investigated, and Tim Beiko reached out to th ### Disclosure decision -The geth-team have an official policy regarding [vulnerability disclosure](https://geth.ethereum.org/docs/vulnerabilities/vulnerabilities). +The geth-team have an official policy regarding [vulnerability disclosure](https://geth.ethereum.org/docs/developers/geth-developer/disclosures). > The primary goal for the Geth team is the health of the Ethereum network as a whole, and the decision whether or not to publish details about a serious vulnerability boils down to minimizing the risk and/or impact of discovery and exploitation. From 3607a3a6a17bd4046e3e653f4214fb994c7ceedd Mon Sep 17 00:00:00 2001 From: Ng Wei Han Date: Tue, 31 Jan 2023 14:13:12 +0800 Subject: [PATCH 2/3] docs: minor fix on geth links # Conflicts: # README.md --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b60bdf1215..6f3817f113 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,7 @@ BNB will be used to: Many of the below are the same as or similar to go-ethereum. +For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth). For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth). Building `geth` requires both a Go (version 1.18 or later) and a C compiler. You can install @@ -93,6 +94,7 @@ directory. Going through all the possible command line flags is out of scope here (please consult our [CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)), +[CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)), but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own `geth` instance. @@ -151,13 +153,16 @@ t=2022-09-08T13:00:29+0000 lvl=info msg="Imported new chain segment" t=2022-09-08T13:00:33+0000 lvl=info msg="Imported new chain segment" blocks=1 txs=197 mgas=19.364 elapsed=34.663ms mgasps=558.632 number=21,153,431 hash=0x0c7872b698f28cb5c36a8a3e1e315b1d31bda6109b15467a9735a12380e2ad14 dirty="0.00 B" ``` -#### 6. Interact with fullnode -Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console), -(via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/en/) -(note: the `web3` version bundled within `geth` is very old, and not up to date with official docs), -as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server). -This tool is optional and if you leave it out you can always attach to an already running -`geth` instance with `geth attach`. +This command will: + * Start `geth` in fast sync mode (default, can be changed with the `--syncmode` flag), + causing it to download more data in exchange for avoiding processing the entire history + of the Binance Smart Chain network, which is very CPU intensive. + * Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interacting-with-geth/javascript-console), + (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/) + (note: the `web3` version bundled within `geth` is very old, and not up to date with official docs), + as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc). + This tool is optional and if you leave it out you can always attach to an already running + `geth` instance with `geth attach`. #### 7. More @@ -188,6 +193,9 @@ $ geth --your-favourite-flags dumpconfig ### Programmatically interfacing `geth` nodes As a developer, sooner rather than later you'll want to start interacting with `geth` and the +Binance Smart Chain network via your own programs and not manually through the console. To aid +this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://eth.wiki/json-rpc/API) +and [`geth` specific APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc)). BSC network via your own programs and not manually through the console. To aid this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://ethereum.github.io/execution-apis/api-documentation/) and [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)). @@ -252,6 +260,7 @@ Please make sure your contributions adhere to our coding guidelines: * Commit messages should be prefixed with the package(s) they modify. * E.g. "eth, rpc: make trace configs optional" +Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers) Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers) for more details on configuring your environment, managing project dependencies, and testing procedures. From 49553ae962ec8596f5338d2f9384ec635ebfcb3d Mon Sep 17 00:00:00 2001 From: Ng Wei Han Date: Tue, 31 Jan 2023 17:34:30 +0800 Subject: [PATCH 3/3] docs: fix duplicate merge error --- README.md | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 6f3817f113..9b6c28f247 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,6 @@ BNB will be used to: Many of the below are the same as or similar to go-ethereum. -For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth). For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth). Building `geth` requires both a Go (version 1.18 or later) and a C compiler. You can install @@ -94,7 +93,6 @@ directory. Going through all the possible command line flags is out of scope here (please consult our [CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)), -[CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)), but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own `geth` instance. @@ -153,16 +151,13 @@ t=2022-09-08T13:00:29+0000 lvl=info msg="Imported new chain segment" t=2022-09-08T13:00:33+0000 lvl=info msg="Imported new chain segment" blocks=1 txs=197 mgas=19.364 elapsed=34.663ms mgasps=558.632 number=21,153,431 hash=0x0c7872b698f28cb5c36a8a3e1e315b1d31bda6109b15467a9735a12380e2ad14 dirty="0.00 B" ``` -This command will: - * Start `geth` in fast sync mode (default, can be changed with the `--syncmode` flag), - causing it to download more data in exchange for avoiding processing the entire history - of the Binance Smart Chain network, which is very CPU intensive. - * Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interacting-with-geth/javascript-console), - (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/) - (note: the `web3` version bundled within `geth` is very old, and not up to date with official docs), - as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc). - This tool is optional and if you leave it out you can always attach to an already running - `geth` instance with `geth attach`. +#### 6. Interact with fullnode +Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console), +(via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/en/) +(note: the `web3` version bundled within `geth` is very old, and not up to date with official docs), +as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server). +This tool is optional and if you leave it out you can always attach to an already running +`geth` instance with `geth attach`. #### 7. More @@ -193,12 +188,9 @@ $ geth --your-favourite-flags dumpconfig ### Programmatically interfacing `geth` nodes As a developer, sooner rather than later you'll want to start interacting with `geth` and the -Binance Smart Chain network via your own programs and not manually through the console. To aid -this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://eth.wiki/json-rpc/API) -and [`geth` specific APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc)). BSC network via your own programs and not manually through the console. To aid this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://ethereum.github.io/execution-apis/api-documentation/) -and [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)). +and [`geth` specific APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc)). These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based platforms, and named pipes on Windows). @@ -260,7 +252,6 @@ Please make sure your contributions adhere to our coding guidelines: * Commit messages should be prefixed with the package(s) they modify. * E.g. "eth, rpc: make trace configs optional" -Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers) Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers) for more details on configuring your environment, managing project dependencies, and testing procedures.