anychaindb

README

AnychainDB

Branch	Tests
master
develop

AnychainDB - secure, fast and open blockchain database. AnychainDB uses the modern technologies not only from blockchain world. Let's take a look at them:

• MongoDB - the high-performable database with full-text search
• Tendermint - the heart of blockchain platform
• Docker - all components of platform wrapps in containers for fast deploy and ease to use
• MsgPack - transport between messages in platform
• Golang - fast and beautiful language

Installation

Officially we provide the easiest way of installation using docker and docker-compose tools.

Prerequirements

Installed docker ver. 17+ and docker-compose tools. Good manual are this and this

Choose your type of node

AnychainDB has two type of nodes:

• Validator node can validate transactions, configured once and need have better hardware than non-validator nodes.
• Non-validator node keeps the state and sends the transactions to validator nodes. The can be ease connected to the network because this type is not validates transaction.

Configure network

If you want to connect to existing network, then all you need is genesis.json and config.toml files from the ran network. Place in to config folder and follow to the next section. Configure a new network is little more sophisticated. Firstly you need to deploy a validator nodes, then join non-validator nodes to network. About this we will discuss later... (todo)

Examples of network configs placed here.

Deploy network

Deploy a network with the shell script:

sh deploy.sh --type=${JOB_TYPE} --node_ip=${NODE_IP} --config=${CONFIG_PATH}

Parameters:

• type - type of job for script. You can choose from node, node-dev, update, update-dev, clean types
• node_ip - ip address of node. Default script uses dig with OpenDNS as resolver. Example: 127.0.0.1
• config - full path to config folder. Example: /home/ubuntu/CONFIG_FOLDER
• clean_all - clean all cache and reset anychaindb state. Default: true
• db_port - port for communication with MongoDB container. Default: 27017
• p2p_port - port for communication between nodes. Default: 46656
• grpc_port - port for RPC client. Default: 46657
• abci_port - port for ABCI application. Default: 46658
• api_port - port for AnychainDB REST API. Default: 8889
• node_args - additional arguments for node. If you connect to existing network, you maybe need to set boot nodes addresses, like: --node_args="--p2p.persistent_peers=id@host:port"

By default script creates AnychainDB directory in home folder of user, where keeps all data from state. Do not remove it. You may change it by setting another value in ${DATA_ROOT} script variable.

Additional docs

• AnychainDB REST API - REST API for AnychainDB client
• Tendermint Docs - Tendermint documentation

License

Apache 2.0