Skip to content
Snippets Groups Projects
README.md 6.96 KiB
Newer Older
Zach Ramsay's avatar
Zach Ramsay committed
|[![GoDoc](https://godoc.org/github.com/eris-db?status.png)](https://godoc.org/github.com/eris-ltd/eris-db) | Linux |
|---|-------|
Zach Ramsay's avatar
Zach Ramsay committed
| Master | [![Circle CI](https://circleci.com/gh/eris-ltd/eris-db/tree/master.svg?style=svg)](https://circleci.com/gh/eris-ltd/eris-db/tree/master) |
| Develop | [![Circle CI (develop)](https://circleci.com/gh/eris-ltd/eris-db/tree/develop.svg?style=svg)](https://circleci.com/gh/eris-ltd/eris-db/tree/develop) |
Androlo's avatar
Androlo committed
# Eris-DB (Alpha)

androlo's avatar
androlo committed
`eris-db` is Eris' blockchain-client. It consists of a [Tendermint](http://tendermint.com/) node wrapped by a simple server. The server allows requests to be made over HTTP - either using JSON-RPC 2.0 or a RESTlike web-api - and websocket (JSON-RPC 2.0). The web-APIs are documented in `api.md`. We also have javascript bindings for the RPC methods in [eris-db.js](https://github.com/eris-ltd/eris-db.js).
Ethan Buchman's avatar
Ethan Buchman committed

# TMSP-TODO

- second genesis file
- get tests working
- eris-cli wrapping



Androlo's avatar
Androlo committed
## Installation
Zach Ramsay's avatar
Zach Ramsay committed
There are no pre-built releases other than the docker images.
androlo's avatar
androlo committed

Zach Ramsay's avatar
Zach Ramsay committed
The recommended way of working with eris-db is through [eris-cli](https://github.com/eris-ltd/eris-cli). See the [eris-db documentation](https://erisindustries.com/components/erisdb/) for more information.
Androlo's avatar
Androlo committed

### Building from source
Androlo's avatar
.  
Androlo committed
#### Ubuntu 14.04 (OSX ?)
Androlo's avatar
.  
Androlo committed
Make sure you have the proper [Go](https://golang.org/) distribution for your OS and architecture. The recommended version is `1.4.2`. Follow the instructions on how to set up GOROOT and GOPATH.
Andreas Olofsson's avatar
Andreas Olofsson committed
You will also need the following libraries: `git, libgmp3-dev`
Andreas Olofsson's avatar
Andreas Olofsson committed
On Ubuntu: `sudo apt-get install git libgmp3-dev`

On Mac: `brew install git gmp`
Androlo's avatar
Androlo committed
Next you pull in the code:
Androlo's avatar
Androlo committed
`go get github.com/eris-ltd/eris-db/cmd/erisdb`
Androlo's avatar
Androlo committed
This will build and install the `erisdb` executable and put it in `$GOPATH/bin`, which should be on your PATH. If not, then add it.
Androlo's avatar
Androlo committed

To run `erisdb`, just type `$ erisdb /path/to/working/folder`

Androlo's avatar
.  
Androlo committed
This will start the node using the provided folder as working dir. If the path is omitted it defaults to `~/.erisdb` 
Androlo's avatar
.  
Androlo committed
#### Docker

androlo's avatar
androlo committed
It is best to use [eris-cli](https://github.com/eris-ltd/eris-cli) which will help setting up and running eris-db (and individual chains) through docker.
androlo's avatar
androlo committed
##### Others

Tendermint officially supports only 64 bit Ubuntu. 
Androlo's avatar
.  
Androlo committed

Androlo's avatar
Androlo committed
### Usage

androlo's avatar
androlo committed
####Native

Androlo's avatar
Androlo committed
The simplest way to get started is by simply running `$ erisdb`. That will start a fresh node with `~/.erisdb` as the working directory, and the default settings. You will be asked to type in a hostname, which could be anything. `anonymous` is a commonly used one.

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://github.com/eris-ltd/erisdb-js), but it is possible to connect directly via HTTP or websocket. The JSON-RPC and web-api reference can be found [here](https://github.com/eris-ltd/erisdb/blob/master/api.md).

### Configuration

There will be more info on how to set up a private net when this is added to Tendermint. That would include information about the various different fields in `config.toml`, `genesis.json`, and `priv_validator.json`.

#### server_conf.toml

The server configuration file looks like this:

```
[bind]
  address= <string>
  port= <number>
[TLS]
  tls= <boolean>
  cert_path= <string>
  key_path= <string>
[CORS]
  enable            <boolean>
  allow_origins     <[]string>
  allow_credentials <boolean>
  allow_methods     <[]string>
  allow_headers     <[]string>
  expose_headers    <[]string>
  max_age           <number>
[HTTP]
  json_rpc_endpoint= <string>
[web_socket]
  websocket_endpoint= <string>
  max_websocket_sessions= <number>
  read_buffer_size = <number>
  write_buffer_size = <number>
Androlo's avatar
Androlo committed
[logging]
  console_log_level= <string>
  file_log_level= <string>
  log_file= <string>
```

Androlo's avatar
Androlo committed
**NOTE**: **CORS** and **TLS** are not yet fully implemented, and cannot be used. CORS is implemented through [gin middleware](https://github.com/tommy351/gin-cors), and TLS through the standard Go http package via the [graceful library](https://github.com/tylerb/graceful).
Androlo's avatar
Androlo committed

##### Bind

- `address` is the address.
- `port` is the port number

##### TLS

- `tls` is used to enable/disable TLS
- `cert_path` is the absolute path to the certificate file.
- `key_path` is the absolute path to the key file.

##### CORS

- `enable` is whether or not the CORS middleware should be added at all. 

Details about the other fields and how this is implemented can be found [here](https://github.com/tommy351/gin-cors).

##### HTTP

- `json_rpc_endpoint` is the name of the endpoint used for JSON-RPC (2.0) over HTTP.

##### web_socket

- `websocket_endpoint` is the name of the endpoint that is used to establish a websocket connection.
- `max_websocket_connections` is the maximum number of websocket connections that is allowed at the same time.
- `read_buffer_size` is the size of the read buffer for each socket in bytes.
- `read_buffer_size` is the size of the write buffer for each socket in bytes.
Androlo's avatar
Androlo committed

##### logging

- `console_log_level` is the logging level used for the console.
- `file_log_level` is the logging level used for the log file.
- `log_file` is the path to the log file. Leaving this empty means file logging will not be used.

The possible log levels are these: `crit`, `error`, `warn`, `info`, `debug`.

The server log level will override the log level set in the Tendermint `config.toml`.

##### example server_conf.toml file

```
[bind]
address="0.0.0.0"
port=1337
[TLS]
tls=false
cert_path=""
key_path=""
[CORS]
enable=false
allow_origins=[]
allow_credentials=false
allow_methods=[]
allow_headers=[]
expose_headers=[]
max_age=0
[HTTP]
json_rpc_endpoint="/rpc"
[web_socket]
websocket_endpoint="/socketrpc"
max_websocket_sessions=50
read_buffer_size = 4096
write_buffer_size = 4096
Androlo's avatar
Androlo committed
[logging]
console_log_level="info"
Androlo's avatar
Androlo committed
file_log_level="warn"
log_file=""
```

### Server-server

androlo's avatar
androlo committed
**NOTE: This feature is being deprecated in favor of `eris-cli` generation of configurable throw-away chains.**

Androlo's avatar
Androlo committed
The library includes a "server-server". This server accepts POST requests with some chain data (such as priv_validator.json and genesis.json), and will use that to create a new working directory in the temp folder, write the data, deploy a new node in that folder, generate a port, use it to serve that node and then pass the url back in the response. It will also manage all the servers and shut them down as they become inactive. 

Androlo's avatar
Androlo committed
NOTE: This is not safe in production, as it requires private keys to be passed over a network, but it is useful when doing tests. If the same chain data is used, then each node is  guaranteed to give the same output (for the same input) when calling the methods.
Androlo's avatar
.  
Androlo committed
To start one up, just run `go install` in the `erisdb/cmd/erisdbss` directory, then run `erisdbss`. It takes no parameters. There are many examples on how to call it in the javascript library, and if people find it useful there will be a  tutorial.
Androlo's avatar
Androlo committed

### Testing

androlo's avatar
androlo committed
In root: `go test ./...`
Androlo's avatar
Androlo committed

### Benchmarking

Andreas Olofsson's avatar
Andreas Olofsson committed
As of `0.11.0`, there are no benchmarks. We aim to have a framework built before `1.0`.