Skip to content

Commit

Permalink
Add safe-events-service documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
moisses89 committed Oct 4, 2023
1 parent 41b4c05 commit e56fcba
Show file tree
Hide file tree
Showing 6 changed files with 2,254 additions and 11 deletions.
1 change: 1 addition & 0 deletions .env.sample
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ CFG_VERSION=latest
CGW_VERSION=latest
TXS_VERSION=latest
UI_VERSION=latest
EVS_VERSION=latest

RPC_NODE_URL=http://url.to.node
5 changes: 2 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: "3.8"
volumes:
nginx-shared-txs:
nginx-shared-cfg:

x-healthcheck-db-template: &pghealthcheck
healthcheck:
test: ["CMD-SHELL", "pg_isready -U postgres"]
Expand Down Expand Up @@ -162,7 +162,6 @@ services:
ports:
- "${REVERSE_PROXY_UI_PORT}:8080"


general-rabbitmq:
image: rabbitmq:alpine
healthcheck:
Expand All @@ -173,7 +172,7 @@ services:
start_period: 15s

evs-web:
image: docker.io/library/safe-events-service-web
image: safeglobal/safe-events-service:${EVS_VERSION}
env_file:
- container_env_files/evs.env
depends_on:
Expand Down
5 changes: 4 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Safe Infrastructure

![Safe Infrastructure Diagram](https://user-images.githubusercontent.com/6909403/231760296-afaa126c-db04-4f62-b996-c53b1d884247.png)
**Safe infrastructure diagram**
<figure><img src="./diagrams/safe-infrastructure-diagram.png" width="100%" alt="" /></figure>

- **Tx Service** is the core of the Safe. It indexes multisig transactions, module transactions, token transfers, collects signatures... There must be **1 Tx Service per Chain**, with different workers, PostgreSQL, Redis and RabbitMQ.
- **Config Service** holds configuration for every Chain (blockexplorer, tx service url, apps enabled, wallets enabled...). **1 instance of the Config Service supports multiple Chains**
- **Client Gateway** provides an API optimized for clients (web ui, android, ios...). **1 instance of the Client Gateway supports multiple Chains**
- **Safe Events Service** handle Safe indexing events from Transaction Service and deliver as HTTP webhooks.

## Setup

Expand All @@ -16,6 +18,7 @@ CFG_VERSION=v2.60.0
CGW_VERSION=v0.4.1
TXS_VERSION=v4.6.1
UI_VERSION=v1.2.0
EVS_VERSION=v0.5.0
```

You can change them to the version you are interested available in [docker-hub](https://hub.docker.com/u/safeglobal) but be aware that not all versions of our services are compatible with each other, so do so **at your own risk.**
Expand Down
Loading

0 comments on commit e56fcba

Please sign in to comment.