Skip to content

Latest commit

 

History

History
162 lines (114 loc) · 4.37 KB

README.md

File metadata and controls

162 lines (114 loc) · 4.37 KB
Raw

Conclave

Scaling Bitcoin Simply.

http://conclave.network

Disclaimer

This software is under heavy development and comes with ABSOLUTELY NO WARRANTY. Any Bitcoin or cryptocurrency lost through use of this software is not refundable. The authors of this software assume ABSOLUTELY NO LIABILITY for any form of loss as a result of the use of this software.

Building

Linux

Conclave is built using CMake out-of-source build. To build, change into the root directory and type:

make

This will build and run tests. To just run tests:

make test

To run individual test(s), regexs work too:

make test test=id_test

If you're developing the Conclave codebase, the dev build target will run the server locally with valgrind:

make dev

To install Conclave on your local system (under /usr/local):

sudo make install

This will install the Conclave binaries to /usr/local/bin and the config files to /usr/local/etc.

Running the Daemon

Once it's installed, run conclaved by typing:

conclaved

Or with a custom config file:

conclaved --config-file <config file>

To get help and see command line options:

conclaved --help

Docker

Docker images are based on Ubuntu 18.04.

To build all stages (make take some time):

docker build -t conclave .

The daemon may then be run in a container with:

docker run conclave

Docker Multi-Stage

dev and run docker stages are provided for development and deployment, respectively. The images may be built with:

docker build -t conclave:dev --target dev .
docker build -t conclave:run --target run .

A development container can be created and started with:

docker create -it --name my-conclave-dev-container conclave:dev /bin/bash
docker start -ai my-conclave-dev-container

Then from within the container:

root@4c86d1846f6a:/usr/src/conclave# make
mkdir -p cmake-build-debug
cd cmake-build-debug && cmake -D INCLUDE_SRC:bool=YES ..
-- The CXX compiler identification is GNU 7.5.0
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ - works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
...

A daemonized production container can be created and started with:

docker create --init -p 8008:8008 -it --name my-conclave-instance conclave:run
docker start my-conclave-instance

More work still needs to be done on configuring a bind mount and SSH server so Conclave can be developed in-container using external tools such as CLion. This kind of setup allows Conclave to be developed on non-Linux OSes such as Windows and MacOS without the need for VMs.

Configuration

The Conclave daemon's default configuration file, conclaved-config.json resides in the etc directory. The Configuration has a nested structure which matches the structure of the codebase. Most of the configuration keys should be self-explanatory, but here is a quick breakdown of the most important ones:

Key Description
/PrivateKey Master private key for the node. Do not use the default value.
/DisplayName The name of your Conclave node. Clashes may happen.
/RPC/NumProcessors How many RPC processors to spin up on startup. Each processor has a thread.
/RPC/Acceptor/IPAddress IP Address the RPC acceptor listens on.
/RPC/Acceptor/Port Port the RPC acceptor listens on.

Example RPC Commands

These are some example RPC commands to get you started. cURL is recommended. If you don't have cURL on your system, anything that can perform a HTTP POST should work.

Get some info on the node:

curl -v -X POST -d '{"method": "NodeInfo"}' http://127.0.0.1:8008/

Get balance of an address:

curl -v -X POST -d '{"method": "GetAddressBalance", "params": {"address": "1FeexV6bAHb8ybZjqQMjJrcCrHGW9sb6uF"}}' http://127.0.0.1:8008/

Full RPC Reference can be found here