Eris DB

	Linux
Master
Develop

Eris DB is Eris' blockchain client. It includes a permissions layer, an implementation of the Ethereum Virtual Machine, and uses Tendermint Consensus. Most functionality is provided by eris chains, exposed through eris-cli, the entry point for the Eris Platform.

Table of Contents

• Background
• Installation
• Usage
  • Security
• Contribute
• License

Background

See the eris-db documentation for more information.

Installation

eris-db is intended to be used by the eris chains command via eris-cli. Available commands such as make | start | stop | logs | inspect | update are used for chain lifecycle management.

For Developers

Dependency management for eris-db is managed with glide, and you can build eris-db from source by following

1. Install go
2. Ensure you have gmp installed (sudo apt-get install libgmp3-dev || brew install gmp)
3. and execute following commands in a terminal:

go get github.com/Masterminds/glide
go get -d github.com/eris-ltd/eris-db
REPO=$($GOPATH/src/github.com/eris-ltd/eris-db)
cd $REPO && glide install
cd $REPO/cmd/eris-db && go install```


To run `eris-db`, just type `$ eris-db serve --work-dir <path to chain directory>`, where the chain directory needs to contain the configuration files as generated by `eris chains make`.

This will start the node using the provided folder as working dir. If the path is omitted it defaults to `~/.erisdb`


## Usage

Once the server has started, it will begin syncing up with the network. At that point you may begin using it. The preferred way is through our [javascript api](https://monax.io/docs/documentation/db.js/), but it is possible to connect directly via HTTP or websocket. The JSON-RPC and web-api reference can be found [here](https://monax.io/docs/documentation/db/latest/specifications/api/).

## Configuration

A commented template config will be written as part of the `eris chains make` [process](https://monax.io/docs/documentation/cli/latest/eris_chains_make/) and can be edited prior to the `eris chains start` [process](https://monax.io/docs/documentation/cli/latest/eris_chains_start/).

## Contribute

See the [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more details.

## License

[GPL-3](license.md)