This project encapsulates the Multichain implementation for Trubudget. It can be seen as the data tier in Trubudget

The easiest way to get started is to use docker compose. (that means you need to install Docker).

Navigate to the docker-compose folder under the project.

cd ../docker-compose

Copy the contents of the .env.example file into .env file.

cp .env.example .env

Then run the following docker compose command to start the blockchain:

docker compose --project-directory . -f blockchain/docker-compose.alphanode.yml up

This command would start the blockchain container, using the image version specified under TAG in the .env file, which is main when using the default .env.example file.

Copy the contents of the .env.example file into .env file.

cp .env.example .env

Then run the following docker compose command to start a local build of the blockchain:

docker compose --project-directory . -f blockchain/docker-compose.alphanode.yml -f blockchain/local-build.docker-compose.yml up

For more information about docker compose and starting whole Trubudget as an application, checkout the Docker Compose documentation.

Enjoy!

As described before: The Trubudget Blockchain is created by an alpha, then grants betas access on demand.

1. Start Alpha-Node of Trubudget Blockchain (Alpha sets chain configurations for network and has admit privileges)
2. Start API (Alpha-API)
3. API will set up Alpha-Node for Trubudget (creating Admin-Streams)
4. Start beta-Node(s)
5. Beta-Node will try to join the network by connection to the alpha-node
   1. If mutual authentication is enabled, the blockchain can only request to access the network when providing a valid certificate. In case the certificate is not valid, the Alpha API will reject the node immediately
6. Beta-Node attempt to access the network will be rejected because they have not been granted access
7. Beta-Node requests to be granted access to the network by sending its blockchain-address and information about the Organization operating the node to the Alpha-API
8. Eventually, Alpha-API grants read/write (not admin) access to the network for the supplied address
9. Beta-Node retries to join the network
10. Beta-Node is granted access and synchronized blockchain data

Trubudget is a private Blockchain (BC) network. That means an Alpha need to give new nodes (betas) a one-time grant in order to access the network. The decision if I want to spawn an Alpha or a Beta node is simple:

• Alpha node: I want to create a new network
• Beta node: I want to participate on an existing network

Mutual Authentication is a feature that ensures that only nodes with a valid certificate can access the network. A node, which wants to access the network, has to authenticate itself against the Alpha API with a valid certificate. If the certificate is not valid, the API will reject the request. If the certificate is valid, the API will accept the connection and the user can approve the connection. More information about mutual authentication can be found here.

The Blockchain node is fully configured through environment variables.

In TruBudget, we use different environment variables to set credentials as well as configurations of the TruBudget services. The environment variables used in the Blockchain can be seen here Environment Variables