gitee.com/liu-zhao234568/cntest@v1.0.0/README.md (about)

     1  ## Go Ethereum
     2  
     3  Official Golang implementation of the Ethereum protocol.
     4  
     5  [![API Reference](
     6  https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667
     7  )](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc)
     8  [![Go Report Card](https://goreportcard.com/badge/github.com/ethereum/go-ethereum)](https://goreportcard.com/report/github.com/ethereum/go-ethereum)
     9  [![Travis](https://travis-ci.com/ethereum/go-ethereum.svg?branch=master)](https://travis-ci.com/ethereum/go-ethereum)
    10  [![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/nthXNEv)
    11  
    12  Automated builds are available for stable releases and the unstable master branch. Binary
    13  archives are published at https://geth.ethereum.org/downloads/.
    14  
    15  ## Building the source
    16  
    17  For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/install-and-build/installing-geth).
    18  
    19  Building `geth` requires both a Go (version 1.14 or later) and a C compiler. You can install
    20  them using your favourite package manager. Once the dependencies are installed, run
    21  
    22  ```shell
    23  make geth
    24  ```
    25  
    26  or, to build the full suite of utilities:
    27  
    28  ```shell
    29  make all
    30  ```
    31  
    32  ## Executables
    33  
    34  The go-ethereum project comes with several wrappers/executables found in the `cmd`
    35  directory.
    36  
    37  |    Command    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    38  | :-----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    39  |  **`geth`**   | Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `geth --help` and the [CLI page](https://geth.ethereum.org/docs/interface/command-line-options) for command line options.          |
    40  |   `clef`    | Stand-alone signing tool, which can be used as a backend signer for `geth`.  |
    41  |   `devp2p`    | Utilities to interact with nodes on the networking layer, without running a full blockchain. |
    42  |   `abigen`    | Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain [Ethereum contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html) with expanded functionality if the contract bytecode is also available. However, it also accepts Solidity source files, making development much more streamlined. Please see our [Native DApps](https://geth.ethereum.org/docs/dapp/native-bindings) page for details. |
    43  |  `bootnode`   | Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks.                                                                                                                                                                                                                                                                 |
    44  |     `evm`     | Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow isolated, fine-grained debugging of EVM opcodes (e.g. `evm --code 60ff60ff --debug run`).                                                                                                                                                                                                                                                                     |
    45  |   `rlpdump`   | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://eth.wiki/en/fundamentals/rlp)) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`).                                                                                                                                                                                                                                 |
    46  |   `puppeth`   | a CLI wizard that aids in creating a new Ethereum network.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    47  
    48  ## Running `geth`
    49  
    50  Going through all the possible command line flags is out of scope here (please consult our
    51  [CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)),
    52  but we've enumerated a few common parameter combos to get you up to speed quickly
    53  on how you can run your own `geth` instance.
    54  
    55  ### Full node on the main Ethereum network
    56  
    57  By far the most common scenario is people wanting to simply interact with the Ethereum
    58  network: create accounts; transfer funds; deploy and interact with contracts. For this
    59  particular use-case the user doesn't care about years-old historical data, so we can
    60  fast-sync quickly to the current state of the network. To do so:
    61  
    62  ```shell
    63  $ geth console
    64  ```
    65  
    66  This command will:
    67   * Start `geth` in fast sync mode (default, can be changed with the `--syncmode` flag),
    68     causing it to download more data in exchange for avoiding processing the entire history
    69     of the Ethereum network, which is very CPU intensive.
    70   * Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console),
    71     (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/en/) 
    72     (note: the `web3` version bundled within `geth` is very old, and not up to date with official docs),
    73     as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server).
    74     This tool is optional and if you leave it out you can always attach to an already running
    75     `geth` instance with `geth attach`.
    76  
    77  ### A Full node on the Görli test network
    78  
    79  Transitioning towards developers, if you'd like to play around with creating Ethereum
    80  contracts, you almost certainly would like to do that without any real money involved until
    81  you get the hang of the entire system. In other words, instead of attaching to the main
    82  network, you want to join the **test** network with your node, which is fully equivalent to
    83  the main network, but with play-Ether only.
    84  
    85  ```shell
    86  $ geth --goerli console
    87  ```
    88  
    89  The `console` subcommand has the exact same meaning as above and they are equally
    90  useful on the testnet too. Please, see above for their explanations if you've skipped here.
    91  
    92  Specifying the `--goerli` flag, however, will reconfigure your `geth` instance a bit:
    93  
    94   * Instead of connecting the main Ethereum network, the client will connect to the Görli
    95     test network, which uses different P2P bootnodes, different network IDs and genesis
    96     states.
    97   * Instead of using the default data directory (`~/.ethereum` on Linux for example), `geth`
    98     will nest itself one level deeper into a `goerli` subfolder (`~/.ethereum/goerli` on
    99     Linux). Note, on OSX and Linux this also means that attaching to a running testnet node
   100     requires the use of a custom endpoint since `geth attach` will try to attach to a
   101     production node endpoint by default, e.g.,
   102     `geth attach <datadir>/goerli/geth.ipc`. Windows users are not affected by
   103     this.
   104  
   105  *Note: Although there are some internal protective measures to prevent transactions from
   106  crossing over between the main network and test network, you should make sure to always
   107  use separate accounts for play-money and real-money. Unless you manually move
   108  accounts, `geth` will by default correctly separate the two networks and will not make any
   109  accounts available between them.*
   110  
   111  ### Full node on the Rinkeby test network
   112  
   113  Go Ethereum also supports connecting to the older proof-of-authority based test network
   114  called [*Rinkeby*](https://www.rinkeby.io) which is operated by members of the community.
   115  
   116  ```shell
   117  $ geth --rinkeby console
   118  ```
   119  
   120  ### Full node on the Ropsten test network
   121  
   122  In addition to Görli and Rinkeby, Geth also supports the ancient Ropsten testnet. The
   123  Ropsten test network is based on the Ethash proof-of-work consensus algorithm. As such,
   124  it has certain extra overhead and is more susceptible to reorganization attacks due to the
   125  network's low difficulty/security.
   126  
   127  ```shell
   128  $ geth --ropsten console
   129  ```
   130  
   131  *Note: Older Geth configurations store the Ropsten database in the `testnet` subdirectory.*
   132  
   133  ### Configuration
   134  
   135  As an alternative to passing the numerous flags to the `geth` binary, you can also pass a
   136  configuration file via:
   137  
   138  ```shell
   139  $ geth --config /path/to/your_config.toml
   140  ```
   141  
   142  To get an idea how the file should look like you can use the `dumpconfig` subcommand to
   143  export your existing configuration:
   144  
   145  ```shell
   146  $ geth --your-favourite-flags dumpconfig
   147  ```
   148  
   149  *Note: This works only with `geth` v1.6.0 and above.*
   150  
   151  #### Docker quick start
   152  
   153  One of the quickest ways to get Ethereum up and running on your machine is by using
   154  Docker:
   155  
   156  ```shell
   157  docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \
   158             -p 8545:8545 -p 30303:30303 \
   159             ethereum/client-go
   160  ```
   161  
   162  This will start `geth` in fast-sync mode with a DB memory allowance of 1GB just as the
   163  above command does.  It will also create a persistent volume in your home directory for
   164  saving your blockchain as well as map the default ports. There is also an `alpine` tag
   165  available for a slim version of the image.
   166  
   167  Do not forget `--http.addr 0.0.0.0`, if you want to access RPC from other containers
   168  and/or hosts. By default, `geth` binds to the local interface and RPC endpoints is not
   169  accessible from the outside.
   170  
   171  ### Programmatically interfacing `geth` nodes
   172  
   173  As a developer, sooner rather than later you'll want to start interacting with `geth` and the
   174  Ethereum network via your own programs and not manually through the console. To aid
   175  this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://eth.wiki/json-rpc/API)
   176  and [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)).
   177  These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based
   178  platforms, and named pipes on Windows).
   179  
   180  The IPC interface is enabled by default and exposes all the APIs supported by `geth`,
   181  whereas the HTTP and WS interfaces need to manually be enabled and only expose a
   182  subset of APIs due to security reasons. These can be turned on/off and configured as
   183  you'd expect.
   184  
   185  HTTP based JSON-RPC API options:
   186  
   187    * `--http` Enable the HTTP-RPC server
   188    * `--http.addr` HTTP-RPC server listening interface (default: `localhost`)
   189    * `--http.port` HTTP-RPC server listening port (default: `8545`)
   190    * `--http.api` API's offered over the HTTP-RPC interface (default: `eth,net,web3`)
   191    * `--http.corsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced)
   192    * `--ws` Enable the WS-RPC server
   193    * `--ws.addr` WS-RPC server listening interface (default: `localhost`)
   194    * `--ws.port` WS-RPC server listening port (default: `8546`)
   195    * `--ws.api` API's offered over the WS-RPC interface (default: `eth,net,web3`)
   196    * `--ws.origins` Origins from which to accept websockets requests
   197    * `--ipcdisable` Disable the IPC-RPC server
   198    * `--ipcapi` API's offered over the IPC-RPC interface (default: `admin,debug,eth,miner,net,personal,shh,txpool,web3`)
   199    * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it)
   200  
   201  You'll need to use your own programming environments' capabilities (libraries, tools, etc) to
   202  connect via HTTP, WS or IPC to a `geth` node configured with the above flags and you'll
   203  need to speak [JSON-RPC](https://www.jsonrpc.org/specification) on all transports. You
   204  can reuse the same connection for multiple requests!
   205  
   206  **Note: Please understand the security implications of opening up an HTTP/WS based
   207  transport before doing so! Hackers on the internet are actively trying to subvert
   208  Ethereum nodes with exposed APIs! Further, all browser tabs can access locally
   209  running web servers, so malicious web pages could try to subvert locally available
   210  APIs!**
   211  
   212  ### Operating a private network
   213  
   214  Maintaining your own private network is more involved as a lot of configurations taken for
   215  granted in the official networks need to be manually set up.
   216  
   217  #### Defining the private genesis state
   218  
   219  First, you'll need to create the genesis state of your networks, which all nodes need to be
   220  aware of and agree upon. This consists of a small JSON file (e.g. call it `genesis.json`):
   221  
   222  ```json
   223  {
   224    "config": {
   225      "chainId": <arbitrary positive integer>,
   226      "homesteadBlock": 0,
   227      "eip150Block": 0,
   228      "eip155Block": 0,
   229      "eip158Block": 0,
   230      "byzantiumBlock": 0,
   231      "constantinopleBlock": 0,
   232      "petersburgBlock": 0,
   233      "istanbulBlock": 0,
   234      "berlinBlock": 0
   235    },
   236    "alloc": {},
   237    "coinbase": "0x0000000000000000000000000000000000000000",
   238    "difficulty": "0x20000",
   239    "extraData": "",
   240    "gasLimit": "0x2fefd8",
   241    "nonce": "0x0000000000000042",
   242    "mixhash": "0x0000000000000000000000000000000000000000000000000000000000000000",
   243    "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
   244    "timestamp": "0x00"
   245  }
   246  ```
   247  
   248  The above fields should be fine for most purposes, although we'd recommend changing
   249  the `nonce` to some random value so you prevent unknown remote nodes from being able
   250  to connect to you. If you'd like to pre-fund some accounts for easier testing, create
   251  the accounts and populate the `alloc` field with their addresses.
   252  
   253  ```json
   254  "alloc": {
   255    "0x0000000000000000000000000000000000000001": {
   256      "balance": "111111111"
   257    },
   258    "0x0000000000000000000000000000000000000002": {
   259      "balance": "222222222"
   260    }
   261  }
   262  ```
   263  
   264  With the genesis state defined in the above JSON file, you'll need to initialize **every**
   265  `geth` node with it prior to starting it up to ensure all blockchain parameters are correctly
   266  set:
   267  
   268  ```shell
   269  $ geth init path/to/genesis.json
   270  ```
   271  
   272  #### Creating the rendezvous point
   273  
   274  With all nodes that you want to run initialized to the desired genesis state, you'll need to
   275  start a bootstrap node that others can use to find each other in your network and/or over
   276  the internet. The clean way is to configure and run a dedicated bootnode:
   277  
   278  ```shell
   279  $ bootnode --genkey=boot.key
   280  $ bootnode --nodekey=boot.key
   281  ```
   282  
   283  With the bootnode online, it will display an [`enode` URL](https://eth.wiki/en/fundamentals/enode-url-format)
   284  that other nodes can use to connect to it and exchange peer information. Make sure to
   285  replace the displayed IP address information (most probably `[::]`) with your externally
   286  accessible IP to get the actual `enode` URL.
   287  
   288  *Note: You could also use a full-fledged `geth` node as a bootnode, but it's the less
   289  recommended way.*
   290  
   291  #### Starting up your member nodes
   292  
   293  With the bootnode operational and externally reachable (you can try
   294  `telnet <ip> <port>` to ensure it's indeed reachable), start every subsequent `geth`
   295  node pointed to the bootnode for peer discovery via the `--bootnodes` flag. It will
   296  probably also be desirable to keep the data directory of your private network separated, so
   297  do also specify a custom `--datadir` flag.
   298  
   299  ```shell
   300  $ geth --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above>
   301  ```
   302  
   303  *Note: Since your network will be completely cut off from the main and test networks, you'll
   304  also need to configure a miner to process transactions and create new blocks for you.*
   305  
   306  #### Running a private miner
   307  
   308  Mining on the public Ethereum network is a complex task as it's only feasible using GPUs,
   309  requiring an OpenCL or CUDA enabled `ethminer` instance. For information on such a
   310  setup, please consult the [EtherMining subreddit](https://www.reddit.com/r/EtherMining/)
   311  and the [ethminer](https://github.com/ethereum-mining/ethminer) repository.
   312  
   313  In a private network setting, however a single CPU miner instance is more than enough for
   314  practical purposes as it can produce a stable stream of blocks at the correct intervals
   315  without needing heavy resources (consider running on a single thread, no need for multiple
   316  ones either). To start a `geth` instance for mining, run it with all your usual flags, extended
   317  by:
   318  
   319  ```shell
   320  $ geth <usual-flags> --mine --miner.threads=1 --miner.etherbase=0x0000000000000000000000000000000000000000
   321  ```
   322  
   323  Which will start mining blocks and transactions on a single CPU thread, crediting all
   324  proceedings to the account specified by `--miner.etherbase`. You can further tune the mining
   325  by changing the default gas limit blocks converge to (`--miner.targetgaslimit`) and the price
   326  transactions are accepted at (`--miner.gasprice`).
   327  
   328  ## Contribution
   329  
   330  Thank you for considering to help out with the source code! We welcome contributions
   331  from anyone on the internet, and are grateful for even the smallest of fixes!
   332  
   333  If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request
   334  for the maintainers to review and merge into the main code base. If you wish to submit
   335  more complex changes though, please check up with the core devs first on [our Discord Server](https://discord.gg/invite/nthXNEv)
   336  to ensure those changes are in line with the general philosophy of the project and/or get
   337  some early feedback which can make both your efforts much lighter as well as our review
   338  and merge procedures quick and simple.
   339  
   340  Please make sure your contributions adhere to our coding guidelines:
   341  
   342   * Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting)
   343     guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
   344   * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary)
   345     guidelines.
   346   * Pull requests need to be based on and opened against the `master` branch.
   347   * Commit messages should be prefixed with the package(s) they modify.
   348     * E.g. "eth, rpc: make trace configs optional"
   349  
   350  Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide)
   351  for more details on configuring your environment, managing project dependencies, and
   352  testing procedures.
   353  
   354  ## License
   355  
   356  The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the
   357  [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html),
   358  also included in our repository in the `COPYING.LESSER` file.
   359  
   360  The go-ethereum binaries (i.e. all code inside of the `cmd` directory) is licensed under the
   361  [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also
   362  included in our repository in the `COPYING` file.