Swisstronik Blockchain

Swisstronik is an identity-based hybrid layer-1 blockchain ecosystem. It lets Web 3.0 and traditional companies build KYC, AML and DPR compliant applications with enhanced data privacy

Build

Prerequisites

Install submodules by running

make init

Build `swisstronikd` to run the node

To build swisstronikd binary, which can be used to run node and interact with SGX-dependent functionality, use the following command:

make build

This command will build binary with SGX in hardware mode (your hardware should support SGX to run binary in this mode) and will put enclave file (enclave.signed.so) to $HOME/.swisstronik-enclave directory.

If you want to setup local node for testing purposes without possibility to connect to Swisstronik testnet as full node, you can build swisstronikd in simulation mode using the following command:

SGX_MODE=SW make build

Also, if you want to put enclave file (enclave.signed.so) to other directory, you can specify ENCLAVE_HOME env variable. For example:

ENCLAVE_HOME=/tmp/enclave-directory make build

Build `swisstronikdcli`

If your OS / hardware doesn't support SGX even in simulation mode, you can build CLI which will allow you:

sending queries
transactions
manage your keys
debug commands, such as address conversion

Below you can see table with build commands for each OS / CPU

OS / arch	command
linux amd64	`make build-linux-cli-amd`
linux arm64	`make build-macos-cli-arm`
macos with M1 chip	`make build-macos-cli-arm`
macos with Intel chip	`make build-macos-cli-amd`
windows	`make build-windows-cli`

Docker

Local development node

Before building ensure that you initialized all submodules. You can do that by running:

make init

To build a Docker image, that contains binary for local Swisstronik node, run the following command:

make build-docker-local

This will create an image with the name swisstronik and latest version tag. Now it is possible to run the swisstronikd binary in the container, e.g. checking stored keys:

docker run -it --rm swisstronik swisstronikd keys list

Local testnet

To setup local test network with multiple validators, run:

swisstronikd testnet init-config --starting-ip-address 192.167.10.1 --chain-id swisstronik_1291-1

Then run:

docker-compose -f local-network.yml up

Monitoring

Enable monitoring

To enable monitoring for your node, first check if prometheus is enabled (prometheus = true) in config.toml, located at $HOME/.swisstronik/config by default. To enable it, simply run:

sed -i 's/prometheus = false/prometheus = true/g' <YOUR-NODE-HOMEDIR>/config/config.toml

Also, you need to enable telemetry in app.toml. To enable it, change enabled to true

[telemetry]
  enable-hostname = false
  enable-hostname-label = false
  enable-service-label = false
  enabled = false 
  global-labels = []
  prometheus-retention-time = 0
  service-name = ""

Then you need to restart your node. After that you should be able to access the tendermint metrics (default port is 26660)

Configure Prometheus Targets

Update target with address of your node in monitoring/prometheus.yml. This will tell prometheus from where it should obtain metrics

Setup Prometheus and Grafana

You can start docker containers with prometheus and grafana using docker-compose. To do it, run:

docker-compose run up -d

License

GNU GPL v3, except for "x/compliance" module - please see separate included LICENSE file in "x/compliance" folder for details.

About