Official golang DEXON fullnode implementation
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Change import go github.com/dexon-foundation/dexon Nov 29, 2018
accounts Change import go github.com/dexon-foundation/dexon Nov 29, 2018
build Change import go github.com/dexon-foundation/dexon Nov 29, 2018
cmd monkey: increase amount and send random amount (#70) Nov 30, 2018
common Change import go github.com/dexon-foundation/dexon Nov 29, 2018
consensus core: fix blockReward serialization Nov 29, 2018
console core: fix tests (#65) Nov 29, 2018
containers/docker Change import go github.com/dexon-foundation/dexon Nov 29, 2018
contracts Change import go github.com/dexon-foundation/dexon Nov 29, 2018
core core: governance interface should return correct DKG master public ke… Dec 12, 2018
crypto Change import go github.com/dexon-foundation/dexon Nov 29, 2018
dashboard Change import go github.com/dexon-foundation/dexon Nov 29, 2018
dex dex: Pull blocks from blockdb if cache miss (#84) Dec 11, 2018
eth api: allow sending batch of raw transactions Nov 29, 2018
ethclient api: allow sending batch of raw transactions Nov 29, 2018
ethdb Change import go github.com/dexon-foundation/dexon Nov 29, 2018
ethstats Change import go github.com/dexon-foundation/dexon Nov 29, 2018
event Change import go github.com/dexon-foundation/dexon Nov 29, 2018
internal internal/ethapi: add transactionHash in blockreceipts (#58) Nov 29, 2018
les les: fix tests Nov 29, 2018
light core: validate DKG set with correct nodeset in round-2 (#19) Nov 29, 2018
log Change import go github.com/dexon-foundation/dexon Nov 29, 2018
metrics Change import go github.com/dexon-foundation/dexon Nov 29, 2018
miner miner: fix test Nov 29, 2018
mobile Remove reference of Rinkeby network. Nov 29, 2018
node node: fix tests Nov 29, 2018
p2p Fix lint Nov 29, 2018
params core: fix tests (#65) Nov 29, 2018
rlp rlp: fix comment typo (#17640) Sep 11, 2018
rpc Change import go github.com/dexon-foundation/dexon Nov 29, 2018
signer Change import go github.com/dexon-foundation/dexon Nov 29, 2018
swarm Change import go github.com/dexon-foundation/dexon Nov 29, 2018
test test: improve keygen.go (#62) Nov 29, 2018
tests tests: updates testadata Nov 29, 2018
trie Change import go github.com/dexon-foundation/dexon Nov 29, 2018
vendor vendor: sync to latest core and fix conflict (#79) Dec 6, 2018
whisper Change import go github.com/dexon-foundation/dexon Nov 29, 2018
.dockerignore dockerignore, internal/build: forward correct git folder Nov 12, 2017
.gitattributes .gitattributes: enable solidity highlighting on github (#16425) Apr 3, 2018
.gitignore misc: ignore files in test Nov 29, 2018
.gitmodules tests: updates testadata Nov 29, 2018
.mailmap all: update license information (#16089) Feb 14, 2018
.travis.yml travis-ci: disable builders (#64) Nov 29, 2018
AUTHORS all: switch out defunct set library to different one (#16873) Jul 16, 2018
COPYING all: update license information Jul 7, 2015
COPYING.LESSER all: update license information Jul 7, 2015
Dockerfile Dockerfile: fix path and dependency (#80) Dec 6, 2018
Dockerfile.alltools travis, Dockerfile, appveyor, build: bump to Go 1.11 Sep 19, 2018
Makefile Makefile: add libbls to test target dependencies (#57) Nov 29, 2018
README.md Update README.md (#83) Dec 7, 2018
appveyor.yml travis, appveyor: bump to Go 1.11.1 (#17820) Oct 3, 2018
circle.yml circleci: enable docker based hive testing Jul 15, 2016
interfaces.go Change import go github.com/dexon-foundation/dexon Nov 29, 2018

README.md

DEXON

Official golang implementation of the DEXON fullnode.

DEXON implementation is based-on the go-ethereum project. The consensus layer is replaced with the DEXON consensus implementation.

API Reference Go Report Card Travis Gitter chat

Building the source

For prerequisites and detailed build instructions please read the Installation Instructions on the wiki.

Building gdex requires both a Go (version 1.10 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

make gdex

or, to build the full suite of utilities:

make all

Executables

The dexon project comes with several wrappers/executables found in the cmd directory.

Command Description
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.
abigen Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain Contract ABIs 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 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).
rlpdump Developer utility tool to convert binary RLP dumps (data encoding used by the DEXON protocol both network as well as consensus wise) to user friendlier hierarchical representation (e.g. rlpdump --hex CE0183FFFFFFC4C304050583616263).
swarm Swarm daemon and tools. This is the entrypoint for the Swarm network. swarm --help for command line options and subcommands. See Swarm README for more information.
puppeth a CLI wizard that aids in creating a new Ethereum network.

Running gdex

Going through all the possible command line flags is out of scope here , but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own Gdex instance.

Full node on the DEXON test network

Transitioning towards developers, if you'd like to play around with creating DEXON contracts, you almost certainly would like to do that without any real money involved until you get the hang of the entire system. In other words, instead of attaching to the main network, you want to join the test network with your node, which is fully equivalent to the main network, but with play-DEX only.

$ gdex --testnet console

The console subcommand have the exact same meaning as above and they are equally useful on the testnet too. Please see above for their explanations if you've skipped to here.

Specifying the --testnet flag however will reconfigure your Gdex instance a bit:

  • Instead of using the default data directory (~/.dexon on Linux for example), Gdex will nest itself one level deeper into a testnet subfolder (~/.dexon/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 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 DEXON network, the client will connect to the test network, which uses different P2P bootnodes, different network IDs and genesis states.

Note: Although there are some internal protective measures to prevent transactions from crossing over between the main network and test network, you should make sure to always use separate accounts for play-money and real-money. Unless you manually move accounts, Gdex will by default correctly separate the two networks and will not make any accounts available between them.

Configuration

As an alternative to passing the numerous flags to the gdex binary, you can also pass a configuration file via:

$ 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:

$ gdex --your-favourite-flags dumpconfig

Note: This works only with gdex v1.6.0 and above.

Programatically interfacing Gdex nodes

As a developer, sooner rather than later you'll want to start interacting with Gdex and the DEXON network via your own programs and not manually through the console. To aid this, Gdex has built-in support for a JSON-RPC based APIs which are ethereum-compatible (standard APIs and Gdex specific APIs). These can be exposed via HTTP, WebSockets and IPC (unix sockets on unix based platforms, and named pipes on Windows).

The IPC interface is enabled by default and exposes all the APIs supported by Gdex, whereas the HTTP and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. These can be turned on/off and configured as you'd expect.

HTTP based JSON-RPC API options:

  • --rpc Enable the HTTP-RPC server
  • --rpcaddr HTTP-RPC server listening interface (default: "localhost")
  • --rpcport HTTP-RPC server listening port (default: 8545)
  • --rpcapi API's offered over the HTTP-RPC interface (default: "eth,net,web3")
  • --rpccorsdomain Comma separated list of domains from which to accept cross origin requests (browser enforced)
  • --ws Enable the WS-RPC server
  • --wsaddr WS-RPC server listening interface (default: "localhost")
  • --wsport WS-RPC server listening port (default: 8546)
  • --wsapi API's offered over the WS-RPC interface (default: "eth,net,web3")
  • --wsorigins Origins from which to accept websockets requests
  • --ipcdisable Disable the IPC-RPC server
  • --ipcapi API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3")
  • --ipcpath Filename for IPC socket/pipe within the datadir (explicit paths escape it)

You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect via HTTP, WS or IPC to a Geth node configured with the above flags and you'll need to speak JSON-RPC on all transports. You can reuse the same connection for multiple requests!

Note: Please understand the security implications of opening up an HTTP/WS based transport before doing so! Hackers on the internet are actively trying to subvert Ethereum nodes with exposed APIs! Further, all browser tabs can access locally running webservers, so malicious webpages could try to subvert locally available APIs!

Operating a private network

Maintaining your own private network is more involved as a lot of configurations taken for granted in the official networks need to be manually set up.

Defining the private genesis state

First, you'll need to create the genesis state of your networks, which all nodes need to be aware of and agree upon. This consists of a small JSON file (e.g. call it genesis.json):

{
  "config": {
        "chainId": 0,
        "homesteadBlock": 0,
        "eip155Block": 0,
        "eip158Block": 0
    },
  "alloc"      : {},
  "coinbase"   : "0x0000000000000000000000000000000000000000",
  "difficulty" : "0x20000",
  "extraData"  : "",
  "gasLimit"   : "0x2fefd8",
  "nonce"      : "0x0000000000000042",
  "mixhash"    : "0x0000000000000000000000000000000000000000000000000000000000000000",
  "parentHash" : "0x0000000000000000000000000000000000000000000000000000000000000000",
  "timestamp"  : "0x00"
}

The above fields should be fine for most purposes, although we'd recommend changing the nonce to some random value so you prevent unknown remote nodes from being able to connect to you. If you'd like to pre-fund some accounts for easier testing, you can populate the alloc field with account configs:

"alloc": {
  "0x0000000000000000000000000000000000000001": {"balance": "111111111"},
  "0x0000000000000000000000000000000000000002": {"balance": "222222222"}
}

With the genesis state defined in the above JSON file, you'll need to initialize every Geth node with it prior to starting it up to ensure all blockchain parameters are correctly set:

$ gdex init path/to/genesis.json

Creating the rendezvous point

With all nodes that you want to run initialized to the desired genesis state, you'll need to start a bootstrap node that others can use to find each other in your network and/or over the internet. The clean way is to configure and run a dedicated bootnode:

$ bootnode --genkey=boot.key
$ bootnode --nodekey=boot.key

With the bootnode online, it will display an enode URL that other nodes can use to connect to it and exchange peer information. Make sure to replace the displayed IP address information (most probably [::]) with your externally accessible IP to get the actual enode URL.

Note: You could also use a full fledged Geth node as a bootnode, but it's the less recommended way.

Starting up your member nodes

With the bootnode operational and externally reachable (you can try telnet <ip> <port> to ensure it's indeed reachable), start every subsequent Geth node pointed to the bootnode for peer discovery via the --bootnodes flag. It will probably also be desirable to keep the data directory of your private network separated, so do also specify a custom --datadir flag.

$ 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 need to configure a miner to process transactions and create new blocks for you.

Contribution

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 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 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.

Please make sure your contributions adhere to our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Pull requests need to be based on and opened against the dev branch.
  • Commit messages should be prefixed with the package(s) they modify.
    • E.g. "eth, rpc: make trace configs optional"

Please see the Developers' Guide for more details on configuring your environment, managing project dependencies and testing procedures.

License

The dexon library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The dexon binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.