alphabill

Build

Run make to test and build the application. Executable will be built to build/alphabill.

Build dependencies

• golang version 1.18. (https://go.dev/doc/install)
• protoc version 3 or newer. (https://grpc.io/docs/protoc-installation)
• protoc-gen-go (https://grpc.io/docs/languages/go/quickstart/)

Money Partition

1. Run script start-money.sh to start a root chain and 3 money partition nodes.
2. Run script stop.sh to stop the root chain and partition nodes.

start-money.sh generates rootchain and partition node keys, genesis files, and starts nodes. Node configuration files are located in testab directory.

Configuration

It's possible to define the configuration values from (in the order of precedence):

• Command line flags (e.g. --address="/ip4/127.0.0.1/tcp/26652")
• Environment (Prefix 'AB' must be used. E.g. AB_ADDRESS="/ip4/127.0.0.1/tcp/26652")
• Configuration file (properties file) (E.g. address="/ip4/127.0.0.1/tcp/26652")
• Default values

The default location of configuration file is $AB_HOME/config.props

The default $AB_HOME is $HOME/.alphabill

Verifiable Data Partition

1. Run script start-vd.sh to start a root chain and 3 VD partition nodes.
2. Run script stop.sh to stop the root chain and partition nodes.

start-vd.sh generates rootchain and partition node keys, genesis files, and starts nodes. Node configuration files are located in testab directory.

Logging configuration

Logging can be configured through a yaml configuration file. See cli/alphabill/config/logger-config.yaml for example.

Default location of the logger configuration file is $AB_HOME/logger-config.yaml

The location can be changed through --logger-config configuration key. If it's relative URL, then it's relative to $AB_HOME.

Wallet Logging Configuration

Wallet logging can be configured only through CLI parameters.

./alphabill wallet --log-file=<path/to/my/file> --log-level=INFO

Default log output is stderr and default log level is INFO.

Possible log level values: ERROR, WARNING, NOTICE, INFO, DEBUG

Set up autocompletion

To use autocompletion (supported with bash, fish, powershell and zsh), run the following commands after building (this is bash example):

• ./alphabill completion bash > /tmp/completion
• source /tmp/completion

CI setup

See gitlab-ci.yml for details.

GitLab runs the CI job inside docker container defined in deployments/gitlab.