driconrikus / webchaind

Official Go language implementation of the MintMe Coin daemon.

Webchaind

Official Go language implementation of the MintMe.com Coin daemon.

Install Webchaind

🎁 Official Releases

Regular releases will be published on the release page. Binaries will be provided for all releases that are considered fairly stable.

🔨 Building the source

If your heart is set on the bleeding edge, install from source. However, please be advised that you may encounter some strange things, and we can't prioritize support beyond the release versions. Recommended for developers only.

Dependencies

Building webchaind requires both Go >=1.12 and a C compiler; building with SputnikVM additionally requires Rust. On Linux systems, a C compiler can, for example, be installed with sudo apt-get install build-essential. On Mac: xcode-select --install. For Rust, please use Rustup by executing curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh.

Build using make

With Go modules, dependencies will be downloaded and cached when running build or test commands automatically.

Clone the repository:

git clone https://github.com/webchain-network/webchaind.git && cd webchaind

Build all executables:

make build

Build just webchaind:

make cmd/webchaind

For further make information, use make help to see a list and description of available make commands.

Build using go

The following commands work starting with Go version 1.12+; for Go version 1.11, prepend the commands with GO111MODULE=on to enable Go modules. Older Go versions are no longer supported.

mkdir -p ./bin

go build -o ./bin/webchaind -ldflags "-X main.Version="`git describe --tags` -tags="netgo" ./cmd/geth
go build -o ./bin/abigen ./cmd/abigen
go build -o ./bin/bootnode ./cmd/bootnode
go build -o ./bin/disasm ./cmd/disasm
go build -o ./bin/ethtest ./cmd/ethtest
go build -o ./bin/evm ./cmd/evm
go build -o ./bin/gethrpctest ./cmd/gethrpctest
go build -o ./bin/rlpdump ./cmd/rlpdump

📺 Executables

This repository includes several wrappers/executables found in the cmd directory.

Command	Description
webchaind	The main MintMe Coin command-line client. It is the entry point into the MintMe Coin network (main-, test-, or private networks), capable of running as a full node (default) archive node (retaining all historical states) or a light node (retrieving data live). It can be used by other processes as a gateway into the MintMe Coin via JSON-RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transport layers. Please see our Command Line Options wiki page for details.
abigen	Source code generator to convert MintMe Coin 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 MintMe Coin 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.
disasm	Bytecode disassembler to convert EVM (Ethereum Virtual Machine) bytecode into more user friendly assembly-like opcodes (e.g. `echo "6001"
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 insolated, fine graned 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).

📗 Getting started with MintMe Coin

Data directory

By default, webchaind will store all node and blockchain data in a parent directory depending on your OS:

• Linux: $HOME/.webchain/
• Mac: $HOME/Library/Webchain/
• Windows: $HOME/AppData/Roaming/Webchain/

You can specify this directory with --data-dir=$HOME/id/rather/put/it/here.

Within this parent directory, webchaind will use a /subdirectory to hold data for each network you run. The defaults are:

• /mainnet for the Mainnet
• /morden for the Morden Testnet

Run a full node

$ webchaind

It's that easy! This will establish a WEB blockchain node, download, and verify the full blocks for the entirety of the WEB blockchain. However, before you go ahead with plain ol' webchaind, we would encourage reviewing the following section.

🚤 Fast Synchronization

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

$ webchaind --fast

Using webchaind in fast sync mode causes it to download only block state data -- leaving out bulky transaction records -- which avoids a lot of CPU and memory intensive processing.

Fast sync will be automatically disabled (and full sync enabled) when:

• your chain database contains any full blocks
• your node has synced up to the current head of the network blockchain

In case of using --mine together with --fast, webchaind will operate as described; syncing in fast mode up to the head, and then begin mining once it has synced its first full block at the head of the chain.

Note: To further increase webchaind performace, you can use a --cache=2054 flag to bump the memory allowance of the database (e.g. 2054MB) which can significantly improve sync times, especially for HDD users. This flag is optional and you can set it as high or as low as you'd like, though we'd recommend the 1GB - 2GB range.

Create and manage accounts

Webchaind is able to create, import, update, unlock, and otherwise manage your private (encrypted) key files. Key files are in JSON format and, by default, stored in the respective chain folder's /keystore directory; you can specify a custom location with the --keystore flag.

$ webchaind account new

This command will create a new account and prompt you to enter a passphrase to protect your account. It will return output similar to:

Address: {52a8029355231d78099667a95d5875fab0d4fc4d}

So your address is: 0x52a8029355231d78099667a95d5875fab0d4fc4d

Other account subcommands include:

SUBCOMMANDS:

        list    print account addresses
        new     create a new account
        update  update an existing account
        import  import a private key into a new account

Learn more at the Accounts Wiki Page. If you're interested in using webchaind to manage a lot (~100,000+) of accounts, please visit the Indexing Accounts Wiki page.

Fast synchronisation

Webchaind syncs with the network automatically after start. However, this method is very slow. Alternatively, you can download blockchain file here: https://webchain.network/blockchain.raw and import it by executing:

$ webchaind --fakepow import <path where you downloaded the blockchain>/blockchain.raw

Interact with the Javascript console

$ webchaind console

This command will start up webchaind built-in interactive JavaScript console, through which you can invoke all official web3 methods as well as webchaind own management APIs. This too is optional and if you leave it out you can always attach to an already running webchaind instance with webchaind attach.

Learn more at the Javascript Console Wiki page.

And so much more!

For a comprehensive list of command line options, please consult our CLI Wiki page.

📙 Webchaind: developing and advanced useage

Morden Testnet

If you'd like to play around with creating Webchain 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-WEB only.

$ webchaind --chain=morden --fast console

The --fast flag and 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 --chain=morden flag will reconfigure your webchaind instance a bit:

• As mentioned above, webchaind will host its testnet data in a morden subfolder (~/.webchain/morden).
• Instead of connecting the main Webchain network, the client will connect to the test network, which uses different P2P bootnodes, different network IDs and genesis states.

You may also optionally use --testnet or --chain=testnet to enable this configuration.

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

Programatically interfacing webchaind nodes

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

The IPC interface is enabled by default and exposes all the APIs supported by webchaind, 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
• --rpc-addr HTTP-RPC server listening interface (default: "localhost")
• --rpc-port HTTP-RPC server listening port (default: 8545)
• --rpc-api API's offered over the HTTP-RPC interface (default: "eth,net,web3")
• --rpc-cors-domain Comma separated list of domains from which to accept cross origin requests (browser enforced)
• --ws Enable the WS-RPC server
• --ws-addr WS-RPC server listening interface (default: "localhost")
• --ws-port WS-RPC server listening port (default: 8546)
• --ws-api API's offered over the WS-RPC interface (default: "eth,net,web3")
• --ws-origins Origins from which to accept websockets requests
• --ipc-disable Disable the IPC-RPC server
• --ipc-api API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3")
• --ipc-path 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 webchaind 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! Further, all browser tabs can access locally running webservers, so malicious webpages could try to subvert locally available APIs!*

Operating a private/custom network

You are now able to configure a private chain by specifying an external chain configuration JSON file, which includes necessary genesis block data as well as feature configurations for protocol forks, bootnodes, and chainID.

Please find full example external configuration files representing the Mainnet and Morden Testnet specs in the /config subdirectory of this repo. You can use either of these files as a starting point for your own customizations.

It is important for a private network that all nodes use compatible chains. In the case of custom chain configuration, the chain configuration file (chain.json) should be equivalent for each node.

Define external chain configuration

Specifying an external chain configuration file will allow fine-grained control over a custom blockchain/network configuration, including the genesis state and extending through bootnodes and fork-based protocol upgrades.

$ webchaind --chain=morden dump-chain-config <datadir>/customnet/chain.json
$ sed s/mainnet/customnet/ <datadir>/customnet/chain.json
$ vi <datadir>/customnet/chain.json # make your custom edits
$ webchaind --chain=customnet [--flags] [command]

The external chain configuration file specifies valid settings for the following top-level fields:

JSON Key	Notes
chainID	Chain identity. Determines local /subdir for chain data, with required chain.json located in it. It is required, but must not be identical for each node. Please note that this is not the chainID validation introduced in EIP-155; that is configured as a protocal upgrade within forks.features.
name	Optional. Human readable name, ie Webchain Mainnet, Morden Testnet.
state.startingNonce	Optional. Initialize state db with a custom nonce.
network	Determines Network ID to identify valid peers.
consensus	Optional. Proof of work algorithm to use, either "lyra2v2"
genesis	Determines genesis state. If running the node for the first time, it will write the genesis block. If configuring an existing chain database with a different genesis block, it will overwrite it.
chainConfig	Determines configuration for fork-based protocol upgrades, ie EIP-150, EIP-155, EIP-160, ECIP-1010, etc ;-). Subkeys are forks and badHashes.
bootstrap	Optional. Determines bootstrap nodes in enode format.
include	Optional. Other configuration files to include. Paths can be relative (to the config file with include field, or absolute). Each of configuration files has the same structure as "main" configuration. Included files are processed after the "main" configuration in the same order as specified in the array; values processed later overwrite the previously defined ones.

Fields name, state.startingNonce, and consensus are optional. Webchaind will panic if any required field is missing, invalid, or in conflict with another flag. This renders --chain incompatible with --testnet. It remains compatible with --data-dir.

To learn more about external chain configuration, please visit the External Command Line Options Wiki page.

Create the rendezvous point

Once all participating nodes have been 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 Webchaind node as a bootnode, but it's the less recommended way.

To learn more about enodes and enode format, visit the Enode Wiki page.

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 webchaind node pointed to the bootnode for peer discovery via the --bootnodes flag. It will probably be desirable to keep private network data separate from defaults; to do so, specify a custom --datadir and/or --chain flag.

$ webchaind --datadir=path/to/custom/data/folder \
       --chain=kittynet \
       --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

In a private network setting, 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 webchaind instance for mining, run it with all your usual flags, extended by:

$ webchaind <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).

For more information about managing accounts, please see the Managing Accounts Wiki page.

💪 Contribution

Thank you for considering to help out with the source code!

The core values of democratic engagement, transparency, and integrity run deep with us. We welcome contributions from everyone, and are grateful for even the smallest of fixes. 👏

If you'd like to contribute to webchaind, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base.

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

💌 License

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