This repository contains the setup and instructions to run the MACI Relayer service along with MongoDB using Docker.
For more details on how to use and integrate the offchain relayer service into your application, please refer to this guide.
Below is a high-level diagram illustrating the flow of the Relayer Service:
The Relayer serves as an intermediary between users and the MACI system. It performs the following tasks:
- Allows users to send messages without having to pay gas fees by processing these messages off-chain.
- Receives user messages.
- Prepare messages batches and upload it to IPFS
- Submits the message hashes to the Poll contract with IPFS hash of the batch.
This process ensures that user actions are recorded on-chain without compromising their privacy.
By verifying the zero-knowledge proofs, the Relayer ensures that only authorized users can send messages. Users must know the pre-image to a state leaf in the poll state tree.
It's recommended that the coordinator only runs this service for now. That is because if the service malfunctions and batch hashes are pushed on chain without the messages actually being stored on ipfs, then polls can't be finalized.
The Relayer interacts with other components of the MACI system, such as the Coordinator and the on-chain smart contracts:
- The Coordinator fetches all the messages stored in IPFS and uses them as regular on-chain messages.
- This ensures that user messages are properly processed and recorded, contributing to the overall functionality and security of the voting protocol.
Make sure you have the following tools installed on your system:
- Docker: Install Docker
- Docker Compose: Install Docker Compose
Follow these steps to run the MACI Relayer service using Docker.
First, clone the repository to your local machine.
git clone https://github.com/privacy-scaling-explorations/maci
cd maciThe .env file contains sensitive configuration values that will be injected into the Docker containers at runtime. To set them up:
- Copy the
.env.examplefile to.env.
cp .env.example .env- Edit the
.envfile and configure the variables.
Now that your environment is set up, it's time to build and run the Docker containers.
Run the following command from the root directory of your project:
docker-compose up --buildThis command does the following:
- Builds the Docker images based on the Dockerfile and
docker-compose.ymlfiles. - Starts the service container (the MACI relayer application) and the mongodb container.
The MACI Relayer service will be available on port 3000 by default (you can modify this in the .env file).
Once the containers are up and running, you can access the relayer service at:
http://localhost:3000
Additionally, the Swagger UI documentation for the Relayer service API can be accessed at:
http://localhost:3000/api
You can interact with the API through the Swagger interface, which provides a convenient way to test endpoints and view the API methods.
To view the logs from the containers and troubleshoot any issues, run:
docker-compose logsThis will display logs from both the service (relayer) and mongodb containers.
To stop the containers and remove the containers (but keep the volumes), use the following command:
docker-compose downThis will stop and remove the containers but retain the volumes (like MongoDB data). To also remove the volumes, run:
docker-compose down --volumesMongoDB data is persisted using Docker volumes (mongodb-data). Even if you remove and recreate the MongoDB container, the data will persist.
This ensures that any data stored in the MongoDB database is not lost even if the container is restarted or removed.
If you'd like to remove the persisted data as well, you can remove the volume by running:
docker volume rm your-repo_mongodb-dataThis will delete the volume, along with all the data stored in MongoDB.
For more details, you can read the following post on EthResearch: