Skip to content
Go implementation of the Metadium project.
Branch: master
Clone or download
Pull request Compare This branch is 412 commits ahead, 587 commits behind ethereum:master.
sadoci Merged in coinplugin/go-metadium (pull request ethereum#20)
Master

Approved-by: Uh Sado <sadoc@metadium.com>
Latest commit 95ee424 Apr 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github github: remove swarm github codeowners (ethereum#18412) Jan 8, 2019
accounts added offline ledger and trezor support. upgraded trezor doesn't work… Apr 5, 2019
build Merged release/1.8 Mar 1, 2019
cmd changed client identifier to gmet from geth Mar 21, 2019
common common/fdlimit: fix windows build (ethereum#19068) Feb 19, 2019
consensus header.Fees is big.Int now, not uint64 to avoid overflow Mar 18, 2019
console added offline wallet support for better scripting Apr 5, 2019
containers/docker Dockerfile and docker-compose.yml Aug 21, 2018
contracts contracts/*: golint updates for this or self warning Feb 19, 2019
core updated embedded mainnet genesis Mar 18, 2019
crypto vendor, crypto, swarm: switch over to upstream sha3 package Jan 4, 2019
dashboard dashboard: append to proper slice (ethereum#17266) Jul 30, 2018
eth made handleMsg non-blocking Mar 21, 2019
ethclient added SendRawTransactions() api Apr 5, 2019
ethdb Merged release/1.8 Mar 1, 2019
ethstats ethstats: comment minor correction (ethereum#17102) Jun 29, 2018
event event/filter: delete unused package (ethereum#18063) Nov 8, 2018
internal for offline wallet path, default scheme, i.e. missing scheme, is keys… Apr 5, 2019
les cmd/geth, core, eth: implement Constantinople override flag (ethereum… Dec 11, 2018
light light: fix duplicated argument in bytes.Equal call Dec 10, 2018
log internal/debug: support color terminal for cygwin/msys2 (ethereum#17740) Sep 29, 2018
metadium added password option to governance initialization command Apr 5, 2019
metrics Merged release/1.8 Mar 1, 2019
miner updating pending block upon receiving a block Apr 5, 2019
mobile mobile: added constructor for BigInts (ethereum#17828) Nov 29, 2018
node changed client identifier to gmet from geth Mar 21, 2019
p2p Merged release/1.8 Mar 1, 2019
params Version now is 1.9.4 Apr 5, 2019
rlp rlp: fix comment typo (ethereum#17640) Sep 11, 2018
rpc rpc: Warn the user when the path name is too long for the Unix ipc en… Jan 2, 2019
signer signer/core: Fixes typo of method name in comment. (ethereum#18222) Dec 2, 2018
swarm params, swarm: release Geth v1.8.23, Swarm v0.3.11 Feb 20, 2019
tests core, cmd/puppeth: implement constantinople fix, disable EIP-1283 (et… Jan 29, 2019
trie trie: fix error in node decoding (ethereum#19111) Feb 19, 2019
vendor fixed merge error in vendor.json Mar 16, 2019
whisper whisperv6: remove duplicated code (ethereum#18015) Dec 3, 2018
.dockerignore dockerignore, internal/build: forward correct git folder Nov 12, 2017
.gitattributes .gitattributes: enable solidity highlighting on github (ethereum#16425) Apr 3, 2018
.gitignore incorporated a new governance contract Mar 16, 2019
.gitmodules tests: update tests and implement general state tests (ethereum#14734) Jul 11, 2017
.mailmap all: update license information (ethereum#16089) Feb 14, 2018
.travis.yml travis.yml: add launchpad SSH public key (ethereum#19115) Feb 19, 2019
AUTHORS all: switch out defunct set library to different one (ethereum#16873) Jul 16, 2018
COPYING all: update license information Jul 7, 2015
COPYING.LESSER all: update license information Jul 7, 2015
Dockerfile travis, Dockerfile, appveyor, build: bump to Go 1.11 Sep 19, 2018
Dockerfile.alltools travis, Dockerfile, appveyor, build: bump to Go 1.11 Sep 19, 2018
Makefile removed '-it' option in 'gmet-linux' target for non-interactive build Apr 5, 2019
README.md Update README.md Mar 20, 2019
appveyor.yml travis, appveyor: bump to Go 1.11.5 (ethereum#18947) Jan 29, 2019
circle.yml circleci: enable docker based hive testing Jul 15, 2016
interfaces.go ethereum: fix typo in interfaces.go (ethereum#18266) Dec 10, 2018

README.md

Go Metadium

Golang implementation of the Metadium project.

Building

geth has been renamed to gmet. Building it is the same as go-ethereum.

make gmet

For the convenience of installation, other targets have been added to the default target.

make

will build logrot (log rotator) and metadium.tar.gz in build directory, in addtion. metadium.tar.gz has the following files.

bin/gmet
bin/gmet.sh
bin/solc.sh
bin/logrot
conf/MetadiumGovernance.js
conf/genesis-template.json
conf/config.json.example

Build For Ubuntu with a Docker Image

As we use rocksdb C implementation for better performance, library dependency becomes an issue. To mitigate that, we use a docker image to build our official image.

make gmet-linux

will build gmet for ubuntu.

Build with LevelDB instead of Rocksdb

To avoid library dependency issue, one can forgo rocksdb with

make USE_ROCKSDB=NO

This is default behavior in non-linux environment, e.g. in MacOS X.

Join the Metadium Mainnet or Testnet

One can use the following command lines to join the Metadium networks. Note that the default RPC port for gmet is 8588, and p2p port is 8589. As with geth, if --datadir is missing, ~/.metadium is the data directory.

Metadium Mainnet

gmet --syncmode full --datadir {data_folder} --rpc --rpcaddr 0.0.0.0

Metadium Testnet

gmet --testnet</b> --syncmode full --datadir {data_folder} --rpc --rpcaddr 0.0.0.0

Setting Up a New Network

One can use gmet.sh script to make setup process a little easier. gmet.sh assumes metadium data directory to be /opt/<node-name>

Initial Network

First create data directory in /opt/, say /opt/meta. Then, unpack metadium.tar.gz in the directory.

mkdir /opt/meta
cd /opt/meta
tar xvfz <dir>/metadium.tar.gz

Once initial members / accounts and nodes are determined (at least one member / account and node are required), create a configuration file using conf/config.json.example as a template, say config.json. A member designated as bootnode has a special meaning. Only that account can create the governance contracts, and only that node is allowed to generate blocks before governance contracts are established. These are recorded in the genesis block as the coinbase and the last 64 bytes of the extraData.

Account and Node IDs

One can reuse existing accounts and nodes. Account files are in keystore directory, and geth/nodekey is the node key / id file. Or one can use gmet to create accounts and node keys, and copy them to data directory.

To create a new account file, run the following.

bin/gmet metadium new-account --out <account-file-name>

To create a new node key,

bin/gmet metadium new-nodekey --out <node-key-file-name>

To get node id, which is the public key of a nodekey.

bin/gmet metadium nodeid <node-key-file-name>

idv5 is the one that should be used in config.json file.

First Node & Governance Contract Initialization

If you are to use existing or pre-created node key, copy the file to geth directory.

mkdir geth
cp <node-key-file> geth/nodekey

The same for accounts

mkdir keystore
chmod 0700 keystore
cp <account-files> keystore/

Running the following command generates genesis.json.

bin/gmet.sh init <node-name> config.json

e.g.

bin/gmet.sh init meta config.json

Copy the newly created genesis.json to other nodes's data directories.

Now start gmet.

bin/gmet.sh start

It's time to initialize governance contracts. Here we'll do a simple one-stop setup. Note that this is just for test. The real governance setup is a multi step process involving several proposals and votes. We'll prepare detailed governance setup documents later. Fow now, just do the following is enough.

bin/gmet.sh init-gov meta config.json <account-file>

Now start the console, and check if governance contracts are set up or not.

bin/gmet.sh console
> admin.metadiumInfo

If this shows nodes as configured in config.json, it's time to initialize etcd.

> admin.etcdInit()

Check if etcd is configured successfully.

> admin.metadiumInfo.etcd

Other Initial Nodes

Set up the data directory and copy the genesis file as follows.

mkdir /opt/meta
cd /opt/meta
mkdir geth
cp <node-key-file> geth/nodekey
mkdir keystore
chmod 0700 keystore
cp <account-files> keystore/
tar xvfz <dir>/metadium.tar.gz
# copy genesis.json
bin/gmet.sh start

Once these nodes are setup, the first node will automatically connect and chain synchronization will follow.

Metadium Info

bin/gmet.sh console
...
> admin.metadiumInfo

Starting & Stopping Nodes

To start or stop a single node

bin/gmet.sh start
bin/gmet.sh stop

Starting Non-mining Nodes

First download genesis.json from existing nodes to a data directory.

bin/gmet metadium download-genesis --url http://<ip> --out genesis.json

After getting enodes of mining nodes, run gmet as follows.

bin/gmet --syncmode full --datadir <data-directory> --bootnodes <enodes> --rpc --rpcaddr 0.0.0.0

The original go-ethereum README follows...

Go Ethereum

Official golang implementation of the Ethereum protocol.

API Reference Go Report Card Travis Discord

Automated builds are available for stable releases and the unstable master branch. Binary archives are published at https://geth.ethereum.org/downloads/.

Building the source

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

Building geth 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

or, to build the full suite of utilities:

make all

Executables

The go-ethereum 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 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 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).
gethrpctest Developer utility tool to support our ethereum/rpc-test test suite which validates baseline conformity to the Ethereum JSON RPC specs. Please see the test suite's readme for details.
rlpdump Developer utility tool to convert binary RLP (Recursive Length Prefix) 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).
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 geth

Going through all the possible command line flags is out of scope here (please consult our CLI Wiki page), 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.

Full node on the main Ethereum network

By far the most common scenario is people wanting to simply interact with the Ethereum network: create accounts; transfer funds; deploy and interact with contracts. For this particular use-case the user doesn't care about years-old historical data, so we can fast-sync quickly to the current state of the network. To do so:

$ geth console

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 Ethereum network, which is very CPU intensive.
  • Start up Geth's built-in interactive JavaScript console, (via the trailing console subcommand) through which you can invoke all official web3 methods as well as Geth's own 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.

Full node on the Ethereum test network

Transitioning towards developers, if you'd like to play around with creating Ethereum 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-Ether only.

$ geth --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 Geth instance a bit:

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

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, Geth will by default correctly 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 (operated by members of the community). This network is lighter, more secure, but is only supported by go-ethereum.

$ geth --rinkeby console

Configuration

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

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

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

Docker quick start

One of the quickest ways to get Ethereum up and running on your machine is by using Docker:

docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \
           -p 8545:8545 -p 30303:30303 \
           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.

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.

Programatically interfacing Geth nodes

As a developer, sooner rather than later you'll want to start interacting with Geth and the Ethereum 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 and Geth 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 Geth, 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:

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

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

Running a private miner

Mining on the public Ethereum network is a complex task as it's only feasible using GPUs, requiring an OpenCL or CUDA enabled ethminer instance. For information on such a setup, please consult the EtherMining subreddit and the Genoil miner repository.

In a private network setting however, a single CPU miner instance is more than enough for practical purposes as it can produce a stable stream of blocks at the correct intervals without needing heavy resources (consider running on a single thread, no need for multiple ones either). To start a Geth instance for mining, run it with all your usual flags, extended by:

$ geth <usual-flags> --mine --minerthreads=1 --etherbase=0x0000000000000000000000000000000000000000

Which will start mining blocks and transactions on a single CPU thread, crediting all proceedings to the account specified by --etherbase. You can further tune the mining by changing the default gas limit blocks converge to (--targetgaslimit) and the price transactions are accepted at (--gasprice).

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 go-ethereum, 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 master 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 go-ethereum 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 go-ethereum 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.

You can’t perform that action at this time.