diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 61 |
1 files changed, 30 insertions, 31 deletions
@@ -1,16 +1,15 @@ -## Go Ethereum +## Dexon -Official golang implementation of the Ethereum protocol. +Official golang implementation of the DEXON fullnode. [](https://godoc.org/github.com/dexon-foundation/dexon) [](https://goreportcard.com/report/github.com/dexon-foundation/dexon) -[](https://travis-ci.org/ethereum/go-ethereum) -[](https://discord.gg/nthXNEv) +[](https://travis-ci.org/dexon-foundation/dexon) Automated builds are available for stable releases and the unstable master branch. -Binary archives are published at https://geth.ethereum.org/downloads/. +Binary archives are published at https://gdex.ethereum.org/downloads/. ## Building the source @@ -18,11 +17,11 @@ For prerequisites and detailed build instructions please read the [Installation Instructions](https://github.com/dexon-foundation/dexon/wiki/Building-Ethereum) on the wiki. -Building geth requires both a Go (version 1.9 or later) and a C compiler. +Building gdex requires both a Go (version 1.9 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run - make geth + make gdex or, to build the full suite of utilities: @@ -30,11 +29,11 @@ or, to build the full suite of utilities: ## Executables -The go-ethereum project comes with several wrappers/executables found in the `cmd` directory. +The dexon project comes with several wrappers/executables found in the `cmd` directory. | Command | Description | |:----------:|-------------| -| **`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 Wiki page](https://github.com/dexon-foundation/dexon/wiki/Command-Line-Options) for command line options. | +| **`gdex`** | 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. `gdex --help` and the [CLI Wiki page](https://github.com/dexon-foundation/dexon/wiki/Command-Line-Options) for command line options. | | `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://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI) 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://github.com/dexon-foundation/dexon/wiki/Native-DApps:-Go-bindings-to-Ethereum-contracts) wiki page for details. | | `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. | | `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`). | @@ -43,7 +42,7 @@ The go-ethereum project comes with several wrappers/executables found in the `cm | `swarm` | Swarm daemon and tools. This is the entrypoint for the Swarm network. `swarm --help` for command line options and subcommands. See [Swarm README](https://github.com/dexon-foundation/dexon/tree/master/swarm) for more information. | | `puppeth` | a CLI wizard that aids in creating a new Ethereum network. | -## Running geth +## Running gdex Going through all the possible command line flags is out of scope here (please consult our [CLI Wiki page](https://github.com/dexon-foundation/dexon/wiki/Command-Line-Options)), but we've @@ -58,19 +57,19 @@ the user doesn't care about years-old historical data, so we can fast-sync quick state of the network. To do so: ``` -$ geth console +$ gdex console ``` This command will: - * Start geth in fast sync mode (default, can be changed with the `--syncmode` flag), causing it to + * Start gdex 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 Ethereum network, which is very CPU intensive. * Start up Geth's built-in interactive [JavaScript console](https://github.com/dexon-foundation/dexon/wiki/JavaScript-Console), (via the trailing `console` subcommand) through which you can invoke all official [`web3` methods](https://github.com/ethereum/wiki/wiki/JavaScript-API) as well as Geth's own [management APIs](https://github.com/dexon-foundation/dexon/wiki/Management-APIs). This tool is optional and if you leave it out you can always attach to an already running Geth instance - with `geth attach`. + with `gdex attach`. ### Full node on the Ethereum test network @@ -80,7 +79,7 @@ entire system. In other words, instead of attaching to the main network, you wan network with your node, which is fully equivalent to the main network, but with play-Ether only. ``` -$ geth --testnet console +$ gdex --testnet console ``` The `console` subcommand have the exact same meaning as above and they are equally useful on the @@ -91,8 +90,8 @@ Specifying the `--testnet` flag however will reconfigure your Geth instance a bi * Instead of using the default data directory (`~/.ethereum` on Linux for example), Geth will nest itself one level deeper into a `testnet` subfolder (`~/.ethereum/testnet` on Linux). Note, on OSX and Linux this also means that attaching to a running testnet node requires the use of a custom - endpoint since `geth attach` will try to attach to a production node endpoint by default. E.g. - `geth attach <datadir>/testnet/geth.ipc`. Windows users are not affected by this. + endpoint since `gdex attach` will try to attach to a production node endpoint by default. E.g. + `gdex attach <datadir>/testnet/gdex.ipc`. Windows users are not affected by this. * Instead of connecting the main Ethereum network, the client will connect to the test network, which uses different P2P bootnodes, different network IDs and genesis states. @@ -103,27 +102,27 @@ separate the two networks and will not make any accounts available between them. ### Full node on the Rinkeby test network -The above test network is a cross client one based on the ethash proof-of-work consensus algorithm. As such, it has certain extra overhead and is more susceptible to reorganization attacks due to the network's low difficulty / security. Go Ethereum also supports connecting to a proof-of-authority based test network called [*Rinkeby*](https://www.rinkeby.io) (operated by members of the community). This network is lighter, more secure, but is only supported by go-ethereum. +The above test network is a cross client one based on the ethash proof-of-work consensus algorithm. As such, it has certain extra overhead and is more susceptible to reorganization attacks due to the network's low difficulty / security. Go Ethereum also supports connecting to a proof-of-authority based test network called [*Rinkeby*](https://www.rinkeby.io) (operated by members of the community). This network is lighter, more secure, but is only supported by dexon. ``` -$ geth --rinkeby console +$ gdex --rinkeby console ``` ### Configuration -As an alternative to passing the numerous flags to the `geth` binary, you can also pass a configuration file via: +As an alternative to passing the numerous flags to the `gdex` binary, you can also pass a configuration file via: ``` -$ geth --config /path/to/your_config.toml +$ gdex --config /path/to/your_config.toml ``` To get an idea how the file should look like you can use the `dumpconfig` subcommand to export your existing configuration: ``` -$ geth --your-favourite-flags dumpconfig +$ gdex --your-favourite-flags dumpconfig ``` -*Note: This works only with geth v1.6.0 and above.* +*Note: This works only with gdex v1.6.0 and above.* #### Docker quick start @@ -135,9 +134,9 @@ docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \ ethereum/client-go ``` -This will start geth in fast-sync mode with a DB memory allowance of 1GB just as the above command does. It will also create a persistent volume in your home directory for saving your blockchain as well as map the default ports. There is also an `alpine` tag available for a slim version of the image. +This will start gdex in fast-sync mode with a DB memory allowance of 1GB just as the above command does. It will also create a persistent volume in your home directory for saving your blockchain as well as map the default ports. There is also an `alpine` tag available for a slim version of the image. -Do not forget `--rpcaddr 0.0.0.0`, if you want to access RPC from other containers and/or hosts. By default, `geth` binds to the local interface and RPC endpoints is not accessible from the outside. +Do not forget `--rpcaddr 0.0.0.0`, if you want to access RPC from other containers and/or hosts. By default, `gdex` binds to the local interface and RPC endpoints is not accessible from the outside. ### Programatically interfacing Geth nodes @@ -222,7 +221,7 @@ With the genesis state defined in the above JSON file, you'll need to initialize with it prior to starting it up to ensure all blockchain parameters are correctly set: ``` -$ geth init path/to/genesis.json +$ gdex init path/to/genesis.json ``` #### Creating the rendezvous point @@ -251,7 +250,7 @@ via the `--bootnodes` flag. It will probably also be desirable to keep the data private network separated, so do also specify a custom `--datadir` flag. ``` -$ geth --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> +$ gdex --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> ``` *Note: Since your network will be completely cut off from the main and test networks, you'll also @@ -270,7 +269,7 @@ resources (consider running on a single thread, no need for multiple ones either instance for mining, run it with all your usual flags, extended by: ``` -$ geth <usual-flags> --mine --minerthreads=1 --etherbase=0x0000000000000000000000000000000000000000 +$ gdex <usual-flags> --mine --minerthreads=1 --etherbase=0x0000000000000000000000000000000000000000 ``` Which will start mining blocks and transactions on a single CPU thread, crediting all proceedings to @@ -282,9 +281,9 @@ limit blocks converge to (`--targetgaslimit`) and the price transactions are acc Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes! -If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request +If you'd like to contribute to dexon, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more -complex changes though, please check up with the core devs first on [our gitter channel](https://gitter.im/ethereum/go-ethereum) +complex changes though, please check up with the core devs first on [our gitter channel](https://gitter.im/ethereum/dexon) to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple. @@ -302,10 +301,10 @@ for more details on configuring your environment, managing project dependencies ## License -The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the +The dexon library (i.e. all code outside of the `cmd` directory) is licensed under the [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), also included in our repository in the `COPYING.LESSER` file. -The go-ethereum binaries (i.e. all code inside of the `cmd` directory) is licensed under the +The dexon binaries (i.e. all code inside of the `cmd` directory) is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also included in our repository in the `COPYING` file. |