Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 4.63 KB

README.md

File metadata and controls

103 lines (72 loc) · 4.63 KB
Raw

Black CircleCi Black

Trustlines Blockchain

The Trustlines Blockchain is a component of the Trustlines Protocol. The Trustlines Protocol is a set of rules to allow the transfer of value on top of existing trust relationships stored on a trustless infrastructure, here a blockchain.

This repository is a mono-repository containing multiple different packages related to the Trustlines Blockchain (tlbc) considered as the mainnet for Trustlines, and to Laika, considered as the testnet for Trustlines.

It contains:

  • blockchain client configurations and dockerfiles for tlbc and laika, found in ./chain/
  • contracts implementation of the Trustlines auction, the bridge, the validator set, and the Trustlines Network Token found in ./contracts/
  • python packages for deploying these contracts via cli found in the ./deploy-tools/ folder: auction-deploy, bridge-deploy, and validator-set-deploy
  • the bridge client ran by bridge validators found in ./bridge/
  • the quickstart package used to easily set up a tlbc or Laika node found in ./quickstart/

Get Up and Running

To quickly get a tlbc or Laika node running, we advise you to use the quickstart script. It will guide you through the step of setting up a node and optional components such as the bridge, a chain monitor, and a netstats client.

You will need to have Docker and docker-compose installed and configured. You must have at least version 1.18.0 of docker-compose. Please refer to the official documentation and make sure your user is added to the docker user group if you cannot access root permissions to run containers.

To fetch and run the most recent version of the quickstart script for tlbc, execute the following command on your machine:

bash <(curl -L quickstart.tlbc.trustlines.foundation)

If you want a quickstart setup for the Laika testnet, use the following command instead:

bash <(curl -L quickstart.laika.trustlines.foundation)

For more information about the quickstart script and options see its readme.

Public Laika Node

The Trustlines Foundation hosts a publically accessible node for the Laika Testnet.

You can access it via the following URL: https://access.laika.trustlines.foundation

Start Developing

We refer you to the different readmes of the components you want to start developing on.

You can however install all the components of this repository if you have python 3.6 or up and pip by using the command make install. This will create a virtual environment and install the requirements as well as each components. You will need to activate the virtual environment with for example source venv/bin/activate from the root directory.

Contributing

Contributions are highly appreciated, but please check our contributing guidelines.

Pre-commit hooks

You should consider initializing the pre-commit hooks. The installed git pre-commit hooks run flake8 and black among other things when committing changes to the git repository. Install them with pre-commit install. You can run them on all files with pre-commit run -a.

Changlogs

We only keep a changelog for each chain, tlbc, and Laika as well as for the bridge.

Read more

To learn more about the Trustlines Blockchain infrastructure or how to run a blockchain node, refer to the Trustlines Blockchain documentation

You can also learn more about the contracts, the quickstart, the bridge, the auction-deploy tool, the bridge-deploy tool, the validator-set-deploy tool, by reading their corresponding readmes.

Installation

An installation of all the components of this repository will require python 3.6 or up and pip.

This repository contains a Makefile at its root and multiple different Makefiles in each component's directory. You can install all the components in one command by running make install from the root directory.