From 5ac91d1d887a87c026dba2364b6dae5cc51f469e Mon Sep 17 00:00:00 2001 From: PolyMa <151764357+polymaer@users.noreply.github.com> Date: Fri, 24 May 2024 22:40:47 +0800 Subject: [PATCH] [website]: update docs (#29835) update docs --- docs/developers/dapp-developer/native-accounts.md | 4 ++-- docs/developers/evm-tracing/custom-tracer.md | 2 +- docs/fundamentals/private-network.md | 2 +- docs/fundamentals/pruning.md | 2 +- docs/getting-started/index.md | 8 ++++---- docs/getting-started/installing-geth.md | 2 +- docs/interacting-with-geth/rpc/ns-debug.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/developers/dapp-developer/native-accounts.md b/docs/developers/dapp-developer/native-accounts.md index 3238cbcbf1..30d785bc65 100644 --- a/docs/developers/dapp-developer/native-accounts.md +++ b/docs/developers/dapp-developer/native-accounts.md @@ -12,7 +12,7 @@ Geth provides a simple, yet thorough accounts package that includes all the tool Access keys to Ethereum accounts should never be stored in plain-text. Instead, they should be stored encrypted so that even if the mobile device is accessed by a malicious third party the keys are still hidden under an additional layer of security. Geth provides a keystore that enables developers to store keys securely. The Geth keystore uses [Scrypt](https://pkg.go.dev/golang.org/x/crypto/scrypt) to store keys that are encoded using the [`secp256k1`](https://www.secg.org/sec2-v2.pdf) elliptic curve. Accounts are stored on disk in the [Web3 Secret Storage](https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition) format. Developers should be aware of these implementation details but are not required to deeply understand the cryptographic primitives in order to use the keystore. -One thing that should be understood, though, is that the cryptographic primitives underpinning the keystore can operate in light or standard mode.Light mode is computationally cheaper, while standard mode has extra security. Light mode is appropriate for mobile devices, but developers should be aware that there is a security trade-off. +One thing that should be understood, though, is that the cryptographic primitives underpinning the keystore can operate in light or standard mode. Light mode is computationally cheaper, while standard mode has extra security. Light mode is appropriate for mobile devices, but developers should be aware that there is a security trade-off. - standard needs 256MB memory and 1 second processing on a modern CPU to access a key - light needs 4MB memory and 100 millisecond processing on a modern CPU to access a key @@ -39,7 +39,7 @@ The last two arguments of [`keystore.NewKeyStore`](https://godoc.org/github.com/ ## Account lifecycle {#account-lifecycle} -Once an encrypted keystore for Ethereum accounts exists it, it can be used to manage accounts for the entire account lifecycle requirements of a Go native application. This includes the basic functionality of creating new accounts and deleting existing ones as well as updating access credentials, exporting existing accounts, and importing them on other devices. +Once an encrypted keystore for Ethereum accounts exists, it can be used to manage accounts for the entire account lifecycle requirements of a Go native application. This includes the basic functionality of creating new accounts and deleting existing ones as well as updating access credentials, exporting existing accounts, and importing them on other devices. Although the keystore defines the encryption strength it uses to store accounts, there is no global master password that can grant access to all of them. Rather each account is maintained individually, and stored on disk in its [encrypted format](https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition) individually, ensuring a much cleaner and stricter separation of credentials. diff --git a/docs/developers/evm-tracing/custom-tracer.md b/docs/developers/evm-tracing/custom-tracer.md index 79366fd271..f85e883581 100644 --- a/docs/developers/evm-tracing/custom-tracer.md +++ b/docs/developers/evm-tracing/custom-tracer.md @@ -91,7 +91,7 @@ To test out this tracer the source is first compiled with `make geth`. Then in t Transaction traces include the complete status of the EVM at every point during the transaction execution, which can be a very large amount of data. Often, users are only interested in a small subset of that data. Javascript trace filters are available to isolate the useful information. -Specifying the `tracer` option in one of the tracing methods (see list in [reference](/docs/interacting-with-geth/rpc/ns-debug)) enables JavaScript-based tracing. In this mode, `tracer` is interpreted as a JavaScript expression that is expected to evaluate to an object which must expose the `result` and `fault` methods. There exist 4 additional methods, namely: `setup`, `step`, `enter`, and `exit`. `enter` and `exit` must be present or omitted together. +Specifying the `tracer` option in one of the tracing methods (see list in [reference](/docs/interacting-with-geth/rpc/ns-debug)) enables JavaScript-based tracing. In this mode, `tracer` is interpreted as a JavaScript expression that is expected to evaluate an object which must expose the `result` and `fault` methods. There exist 4 additional methods, namely: `setup`, `step`, `enter`, and `exit`. `enter` and `exit` must be present or omitted together. ### Setup diff --git a/docs/fundamentals/private-network.md b/docs/fundamentals/private-network.md index 085d7f167d..b2dc471f6c 100644 --- a/docs/fundamentals/private-network.md +++ b/docs/fundamentals/private-network.md @@ -23,7 +23,7 @@ geth --networkid 12345 ### Choosing A Consensus Algorithm {#choosing-a-consensus-mechanism} -While the main network uses proof-of-stake (PoS) to secure the blockchain, Geth also supports the the 'Clique' proof-of-authority (PoA) consensus algorithm and the Ethash proof-of-work algorithm as alternatives for private networks. Clique is strongly recommended for private testnets because PoA is far less resource-intensive than PoW. The key differences between the consensus algorithms available in Geth are: +While the main network uses proof-of-stake (PoS) to secure the blockchain, Geth also supports the 'Clique' proof-of-authority (PoA) consensus algorithm and the Ethash proof-of-work algorithm as alternatives for private networks. Clique is strongly recommended for private testnets because PoA is far less resource-intensive than PoW. The key differences between the consensus algorithms available in Geth are: #### Ethash {#ethash} diff --git a/docs/fundamentals/pruning.md b/docs/fundamentals/pruning.md index d639fb0949..5f7582ce01 100644 --- a/docs/fundamentals/pruning.md +++ b/docs/fundamentals/pruning.md @@ -34,7 +34,7 @@ There may be a period of >1 hour during the Compacting Database stage with no lo ## Pruning command {#pruning-command} -For a normal Geth node, Geth should be stopped and the following command executed to start a offline state prune: +For a normal Geth node, Geth should be stopped and the following command executed to start an offline state prune: ```sh geth snapshot prune-state diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index a073f3b8c8..df8e67367b 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -18,7 +18,7 @@ In order to get the most value from the tutorials on this page, the following sk - Basic knowledge about HTTP and JavaScript - Basic knowledge of node architecture and consensus clients -Users that need to revisit these fundamentals can find helpful resources relating to the command line [here](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Understanding_client-side_tools/Command_line), Ethereum and its testnets [here](https://ethereum.org/en/developers/tutorials/), http [here](https://developer.mozilla.org/en-US/docs/Web/HTTP) and Javascript [here](https://www.javascript.com/learn). Information on node architecture can be found [here](/docs/fundamentals/node-architecture) and our guide for configuring Geth to connect to a +Users that need to revisit these fundamentals can find helpful resources relating to the command line [here](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Understanding_client-side_tools/Command_line), Ethereum and its testnets [here](https://ethereum.org/en/developers/tutorials/), [here](https://developer.mozilla.org/en-US/docs/Web/HTTP) and Javascript [here](https://www.javascript.com/learn). Information on node architecture can be found [here](/docs/fundamentals/node-architecture) and our guide for configuring Geth to connect to a consensus client is [here](/docs/getting-started/consensus-clients). If Geth was installed from source on Linux, `make` saves the binaries for Geth and the associated tools in `/build/bin`. To run these programs it is convenient to move them to the top level project directory (e.g. running `mv ./build/bin/* ./`) from `/go-ethereum`. Then `./` must be prepended to the commands in the code snippets in order to execute a particular program, e.g. `./geth` instead of simply `geth`. If the executables are not moved then either navigate to the `bin` directory to run them (e.g. `cd ./build/bin` and `./geth`) or provide their path (e.g. `./build/bin/geth`). These instructions can be ignored for other installations. @@ -143,7 +143,7 @@ INFO [02-10|13:59:06.997] IPC endpoint opened url=/.../geth INFO [02-10|13:59:06.998] HTTP server started endpoint=127.0.0.1:8545 prefix= cors= vhosts=localhost ``` -By default, Geth uses snap-sync which download blocks sequentially from a relatively recent block, not the genesis block. It saves the data in files in `/go-ethereum/geth-tutorial/geth/chaindata/`. One the sequence of headers has been verified, Geth downloads the block bodies and state data before starting the "state healing" phase to update the state for newly arriving data. This is confirmed by the logs printed to the terminal. There should be a rapidly-growing sequence of logs in the terminal with the following syntax: +By default, Geth uses snap-sync which download blocks sequentially from a relatively recent block, not the genesis block. It saves the data in files in `/go-ethereum/geth-tutorial/geth/chaindata/`. Once the sequence of headers has been verified, Geth downloads the block bodies and state data before starting the "state healing" phase to update the state for newly arriving data. This is confirmed by the logs printed to the terminal. There should be a rapidly-growing sequence of logs in the terminal with the following syntax: ```terminal INFO [04-29][15:54:09.238] Looking for peers peercount=2 tried=0 static=0 @@ -299,7 +299,7 @@ Approve? [y/N]: Please enter the password for account 0xca57F3b40B42FCce3c37B8D18aDBca5260ca72EC ``` -After approving the transaction, the following confirmation screen in displayed in the Clef terminal: +After approving the transaction, the following confirmation screen is displayed in the Clef terminal: ```terminal ----------------------- @@ -371,7 +371,7 @@ Up to this point this tutorial has interacted with Geth using the convenience li ### Checking account balance {#checking-balance} -The command below returns the balance of the given account. This is a HTTP POST request to the local port 8545. The `-H` flag is for header information. It is used here to define the format of the incoming payload, which is JSON. The `--data` flag defines the content of the payload, which is a JSON object. That JSON object contains four fields: `jsonrpc` defines the spec version for the JSON-RPC API, `method` is the specific function being invoked, `params` are the function arguments, and `id` is used for ordering transactions. The two arguments passed to `eth_getBalance` are the account address whose balance to check and the block to query (here `latest` is used to check the balance in the most recently mined block). +The command below returns the balance of the given account. This is an HTTP POST request to the local port 8545. The `-H` flag is for header information. It is used here to define the format of the incoming payload, which is JSON. The `--data` flag defines the content of the payload, which is a JSON object. That JSON object contains four fields: `jsonrpc` defines the spec version for the JSON-RPC API, `method` is the specific function being invoked, `params` are the function arguments, and `id` is used for ordering transactions. The two arguments passed to `eth_getBalance` are the account address whose balance to check and the block to query (here `latest` is used to check the balance in the most recently mined block). ```sh curl -X POST http://127.0.0.1:8545 \ diff --git a/docs/getting-started/installing-geth.md b/docs/getting-started/installing-geth.md index 9be5bf5c45..26bf787948 100644 --- a/docs/getting-started/installing-geth.md +++ b/docs/getting-started/installing-geth.md @@ -159,7 +159,7 @@ The standalone bundles can be downloaded from the [Geth Downloads](/downloads) p ## Docker container {#docker-container} -A Docker image with recent snapshot builds from our `develop` branch is maintained on DockerHub to support users who prefer to run containerized processes. There four different Docker images available for running the latest stable or development versions of Geth. +A Docker image with recent snapshot builds from our `develop` branch is maintained on DockerHub to support users who prefer to run containerized processes. There are four different Docker images available for running the latest stable or development versions of Geth. - `ethereum/client-go:latest` is the latest development version of Geth (default) - `ethereum/client-go:stable` is the latest stable version of Geth diff --git a/docs/interacting-with-geth/rpc/ns-debug.md b/docs/interacting-with-geth/rpc/ns-debug.md index 0ce5bf6eb8..a4ddb87756 100644 --- a/docs/interacting-with-geth/rpc/ns-debug.md +++ b/docs/interacting-with-geth/rpc/ns-debug.md @@ -593,7 +593,7 @@ TraceCallConfig is a superset of [TraceConfig](#traceconfig), providing addition - `stateOverrides`: `StateOverride`. Overrides for the state data (accounts/storage) for the call, see [StateOverride](/docs/developers/evm-tracing/built-in-tracers#state-overrides) for more details. - `blockOverrides`: `BlockOverrides`. Overrides for the block data (number, timestamp etc) for the call, see [BlockOverrides](/docs/developers/evm-tracing/built-in-tracers#block-overrides) for more details. -- `txIndex`: `NUMBER`. If set, the state at the the given transaction index will be used to tracing (default = the last transaction index in the block). +- `txIndex`: `NUMBER`. If set, the state at the given transaction index will be used to tracing (default = the last transaction index in the block). **Example:**