✨ Add Docker Support

[fredrik0x]

🕓 Changelog

This PR adds a complete Docker setup, allowing the script to be run in a containerised environment. It includes a hardened compose.yaml file for easy, secure, and reproducible runs.

Building the Docker Image

Build the Docker image using Docker Compose:

docker-compose build

Basic Usage

To run the script using Docker Compose, use the compose.yaml file provided in the repository. The container is named safe-tx-hashes-util.

Example displaying help:

docker-compose run --rm safe-tx-hashes-util --help

Example calculating the Safe transaction hashes:

docker-compose run --rm safe-tx-hashes-util --network arbitrum --address 0x111CEEee040739fD91D29C34C33E6B3E112F2177 --nonce 234

Using Message Files

When calculating off-chain message hashes, you need to provide a local directory containing your message file. The included compose.yaml configuration mounts the ./data directory by default.

# First, create a `data` directory and add your message file.
~$ mkdir -p data
~$ echo "Your message content here" > data/message.txt

# Run the container with the mounted directory.
~$ docker-compose run --rm safe-tx-hashes-util \
  --network sepolia \
  --address 0x657ff0D4eC65D82b2bC1247b0a558bcd2f80A0f1 \
  --message /data/message.txt

With Environment Variables

You can pass environment variables directly via Docker Compose:

# Disable all formatting.
docker-compose run --rm -e NO_COLOR=true safe-tx-hashes-util \
  --network arbitrum \
  --address 0x111CEEee040739fD91D29C34C33E6B3E112F2177 \
  --nonce 234

[pcaversaccio]

Refactored in 1e78d2f to use Docker Compose. Let me know how you think about it. The docker-compose.yml file is hardened with respect to permissions.

[pcaversaccio]

Simplified the files a bit further and added the following additional security configurations (the last two configurations):

security_opt:
  - no-new-privileges:true # Prevent privilege escalation.
  - apparmor=docker-default # Set the `AppArmor` profile for Ubuntu/Debian/openSUSE (restrict file/network access).
  - label=type:container_t # Set the `SELinux` profile for RHEL/CentOS/Fedora (provide mandatory access control).