README
¶
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
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
- Install go
- Ensure you have
gmpinstalled (sudo apt-get install libgmp3-dev || brew install gmp) - 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, but it is possible to connect directly via HTTP or websocket. The JSON-RPC and web-api reference can be found here.
Configuration
A commented template config will be written as part of the eris chains make process and can be edited prior to the eris chains start process.
Contribute
See the eris platform contributing file here.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
types
Blockchain is part of the pipe for ErisMint and provides the implementation for the pipe to call into the ErisMint application
|
Blockchain is part of the pipe for ErisMint and provides the implementation for the pipe to call into the ErisMint application |
|
Websocket client implementation.
|
Websocket client implementation. |
|
common
|
|
|
config defines simple types in a separate package to avoid cyclical imports
|
config defines simple types in a separate package to avoid cyclical imports |
|
config.go keeps explicit structures on the runtime configuration of Eris-DB and all modules.
|
config.go keeps explicit structures on the runtime configuration of Eris-DB and all modules. |
|
types
TODO: [ben] this is poorly constructed but copied over from eris-db/erisdb/pipe/types to make incremental changes and allow for a discussion around the proper defintion of the needed types.
|
TODO: [ben] this is poorly constructed but copied over from eris-db/erisdb/pipe/types to make incremental changes and allow for a discussion around the proper defintion of the needed types. |
|
Package event implements an event multiplexer.
|
Package event implements an event multiplexer. |
|
filter
Package filter implements event filters.
|
Package filter implements event filters. |
|
Cross-platform file utils.
|
Cross-platform file utils. |
|
eris-mint
Accounts is part of the pipe for ErisMint and provides the implementation for the pipe to call into the ErisMint application
|
Accounts is part of the pipe for ErisMint and provides the implementation for the pipe to call into the ErisMint application |
|
eris-mint/evm/sha3
Package sha3 implements the SHA3 hash algorithm (formerly called Keccak) chosen by NIST in 2012.
|
Package sha3 implements the SHA3 hash algorithm (formerly called Keccak) chosen by NIST in 2012. |
|
permission
|
|
|
v0/shared
Net is part of the pipe for ErisMint and provides the implementation for the pipe to call into the ErisMint application
|
Net is part of the pipe for ErisMint and provides the implementation for the pipe to call into the ErisMint application |
|
test
|
|