README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

[![CircleCI](https://circleci.com/gh/dexon-foundation/dexon-consensus-core.svg?style=svg&circle-token=faed911ec07618dfbd6868b09181aa2046b550d8)](https://circleci.com/gh/dexon-foundation/dexon-consensus-core)

DEXON Consensus Core
====================

## Getting Started
### Prerequisites

- [Go 1.10](https://golang.org/dl/) or a newer version
- [dep](https://github.com/golang/dep#installation) as dependency management

### Installation

1. Clone the repo
    ```
    git clone https://github.com/dexon-foundation/dexon-consensus-core.git
    cd dexon-consensus-core
    ```

2. Install go dependency management tool
   ```
   ./bin/install_tools.sh
   ```

3. Install all dependencies
   ```
   dep ensure
   ```

4. Setup GOAPTH, the GOPATH could be anywhere in the system. Here we use `$HOME/go`:
   ```
   export GOPATH=$HOME/go
   export PATH=$GOPATH/bin:$PATH
   ```
   You should write these settings to your `.bashrc` file.

### Run Unit Tests

```
make pre-submit
```

## Simulation

1. Setup the configuration under `./test.toml`
2. Compile and install the cmd `dexon-simulation`

```
make
```

4. Run simulation:

```
dexcon-simulation -config test.toml -init
```