Personal Blockchain

---

Overview

A powerful tool tailored for Cardano developers to efficiently set up and oversee their individual Cardano environments throughout the entire development cycle, enabling seamless development, deployment, and testing of dApps.

High-level design system architecture: link

Quickstart

To run a local blockchain on your machine, follow these steps:

1. Install and Run the Controller Service

As described in the High-Level Design (HLD) documentation, we expose the services of the local blockchain network through the Controller Service. This service is responsible for managing the lifecycle of the local blockchain network you create. For more details, please refer to the Controller Service documentation: link.

Setting up via Docker

You can use Docker to download the Controller service image. For example, to pull the image, use the following command:

docker pull chien28201/cardano-local-blockchain:latest
docker run -d \
  -p 8888:8888 \
  -p 3000:3000 \
  -p 8090:8090 \
  --env NODE_ENV=development \
  --env BLOCKFROST=http://host.docker.internal:3000 \
  --env CARDANO_WALLET=http://host.docker.internal:8090 \
  --add-host "host.docker.internal:host-gateway" \
  --privileged \
  chien28201/cardano-local-blockchain:latest

To stop the service:

docker stop chien28201/cardano-local-blockchain
docker remove chien28201/cardano-local-blockchain

Alternatively, you can use the Docker Compose configuration defined in our project. To do this, follow these steps:

1. Navigate to the directory where the Personal Blockchain project is located:

cd /path/to/persional-blockchain-project

2. Run the Controller service using Docker Compose with the following command:

docker compose up -d

3. Stop service:

docker compose stop

Manual Setup

You can also run the Controller service manually by following the guide at the link.

2. Running blockchain cluster with Custom Configuration

Currently, we allow customization of certain configurations for the local blockchain network. These configurations include:

• Epoch Size: The number of slots in one epoch.
• Slot Length: The duration of one slot.
• Tx Size: The maximum number of bytes per transaction.

You can initialize a blockchain cluster network using the following methods:

Direct API Call to the Controller Service

You can initialize a blockchain cluster by making an API call to the Controller service:

curl -X POST http://localhost:3000/workspace \
     -d '{"epochLength": <epochSize>, "slotLength": <slotLength>, "txSize": <txSize>}' \
     -H "Content-Type: application/json"

UI-based Network Creation

To create a local blockchain network through the UI, first, follow the instructions to set up the UI service at link.

Once the UI service is running, you can create the local blockchain network through the following screen: UI Screenshot