aBFT Consensus platform for distributed applications.

Documentation.

Building lachesis requires both a Go (version 1.13 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

go build -o ./build/lachesis ./cmd/lachesis

The build output is build/lachesis executable.

Do not clone the project into $GOPATH, due to the Go Modules. Instead, use any other location.

Going through all the possible command line flags is out of scope here, but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own lachesis instance.

As an alternative to passing the numerous flags to the lachesis binary, you can also pass a configuration file via:

$ lachesis --config /path/to/your_config.toml

To get an idea how the file should look like you can use the dumpconfig subcommand to export your existing configuration:

$ lachesis --your-favourite-flags dumpconfig

One of the quickest ways to get Lachesis up and running on your machine is by using Docker:

cd docker/
make
docker run -d --name lachesis-node -v /home/alice/lachesis:/root \
           -p 5050:5050 \
          "lachesis" \
          --port 5050 \
          --nat=extip:YOUR_IP

This will start lachesis with --port 5050 --nat=extip:YOUR_IP arguments, with DB files inside /home/alice/lachesis/.lachesis

Do not forget --rpcaddr 0.0.0.0, if you want to access RPC from other containers and/or hosts. By default, lachesis binds to the local interface and RPC endpoints is not accessible from the outside.

To find out your enode ID, use:

docker exec -i lachesis-node /lachesis --exec "admin.nodeInfo.enode" attach

To get the logs:

docker logs lachesis-node

Lachesis has extensive unit-testing. Use the Go tool to run tests:

go test ./...

If everything goes well, it should output something along these lines:

?       github.com/Fantom-foundation/go-lachesis/event_check/basic_check    [no test files]
?       github.com/Fantom-foundation/go-lachesis/event_check/epoch_check    [no test files]
?       github.com/Fantom-foundation/go-lachesis/event_check/heavy_check    [no test files]
?       github.com/Fantom-foundation/go-lachesis/event_check/parents_check  [no test files]
ok      github.com/Fantom-foundation/go-lachesis/evm_core   (cached)
ok      github.com/Fantom-foundation/go-lachesis/gossip (cached)
?       github.com/Fantom-foundation/go-lachesis/gossip/fetcher [no test files]
?       github.com/Fantom-foundation/go-lachesis/gossip/occuredtxs [no test files]
ok      github.com/Fantom-foundation/go-lachesis/gossip/ordering    (cached)
ok      github.com/Fantom-foundation/go-lachesis/gossip/packsdownloader    (cached)

Maintaining your own private network is more involved as a lot of configurations taken for granted in the official networks need to be manually set up.

To run the fakenet with just one validator, use:

$ lachesis --fakenet 1/1

To run the fakenet with 5 validators, run the command for each validator:

$ lachesis --fakenet 1/5 # first node, use 2/5 for second node

After that, you have to connect your nodes. Either connect them statically, or specify a bootnode:

$ lachesis --fakenet 1/5 --bootnodes "enode:https://ade7067fe5495db3d9f44dfda710a2873f339f9288c02941c80b1a7ede16f1d1ceef97736c6680d163f04be7f706dabca01e697e1e7290dfc7c07d1eacb47c54@172.20.0.3:38051"

For the testing purposes, the full demo may be launched using:

cd docker/
make # build docker image
./start.sh # start the containers
./stop.sh # stop the demo

The full demo doesn't spin up very fast. To avoid the full docker image building, you may run the integration test instead:

go test -v ./integration/...

Adjust test duration, number of nodes and logs verbosity in the test source code.