isabella232 / safe-infrastructure

One `docker-compose.yml` file to rule them all

Safe Services Main Docker

This repository contains the minimum viable local setup for our backend services. The setup presented here, assumes that only L2 safes will be used. Additionally, we have tested this setup with the following versions:

• CFG_VERSION=v2.12.0
• CGW_VERSION=v3.19.1
• TXS_VERSION=v4.2.8

You can change them to the version you are interested available in docker-hub but be aware that not all versions of our services are compatible with each other, so do so at your own risk.

Step 0: docker crash course (optional)

Building and running the whole setup can be done with the following commands:

docker compose build --force-rm
docker compose up

• Accessing bash in your web containers can be achieved by:

docker exec -it safe-infrastructure_cfg-web_1 bash
docker exec -it safe-infrastructure_txs-web_1 bash

Ctrl+d will end interactive mode.

• Accessing redis-cli in either redis can be achieved like so"

docker exec -it safe-infrastructure_cgw-redis_1 redis-cli
docker exec -it safe-infrastructure_txs-redis_1 redis-cli

• Accessing postgres. The Safe Config and Safe transaction services share the same instance

docker exec -it safe-infrastructure_db_1 psql -U postgres

Step 1: setup your .env

We recommend using what is available in the .env.sample file as it contains versions of our services guaranteed to be compatible with each other:

cp .env.sample .env

Simply, edit your .env and set RPC_NODE_URL to the chain you want the services running against. Important Note: Only L2 safes are supported in the setup provided. Change this at your own risk.

Step 2: Setup djando superusers

You will need to identify the ID or name of the containers using docker ps. To create the default super user for the Safe Config Service, we run the following command:

docker exec safe-infrastructure_cfg-web_1 python src/manage.py createsuperuser --noinput

You can now access http://localhost:8000/cfg/admin/ and login using the credentials root/admin.

To achieve the same for the Safe Transaction service:

docker exec safe-infrastructure_txs-web_1 python manage.py createsuperuser --noinput

Note 1: note that the path to manage.py is different. In case you need to run other commands.

Note 2: remember to replace your container ID or name.

Step 3: Add your ChainInfo

We need to be able to define a ChainInfo object in the Safe Config service so that the Client Gateway knows the URL of the Safe Transaction service instance it needs to request against for a given safe.

You can do this in the admin interface of the Safe Config service: http://localhost:8000/cfg/admin/chains/chain/add/

You can verify that your ChainInfo was successfully added by going to http://localhost:8000/cfg/api/v1/chains.

Step 4: Add your webhooks

Our services invalidate the caches of the client gateway using webhooks. Both the Config and Transaction service need to be configured. For the Config service, unless you've changed the values in cgw.env and cfg.env then you don't need to do anything, otherwise:

# Inside the file "container_env_files/cfg.env"
#...
CGW_URL=http://nginx:8000/cgw
CGW_FLUSH_TOKEN=some_random_token

# Inside the file "container_env_files/cgw.env"
WEBHOOK_TOKEN=some_random_token

WEBHOOK_TOKEN and CGW_FLUSH_TOKEN must be the same.

For the Transactions service open a terminal in the container:

docker exec -it safe-infrastructure_txs-web_1 bash

Then use manage.py and the custom command for adding a webhook like so:

python manage.py add_webhook --url=http://nginx:8000/cgw/v1/hook/update/some_random_token

4. Access the UI You can then access to the Gnosis Safe Web UI at http://localhost:8080. Port can be configured on .env