diff --git a/README.md b/README.md index 63c6e77..0ce896f 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ This project uses the following tools: ## Principle of operation +### Modules + The protocol is organized in several modules: - `cyKlone-mutipool-V0` => main module, manages most stuffs - `poseidon-hash-v1` and `poseidon-constants-v1` => Compute the Poseidon Hash @@ -36,9 +38,16 @@ There are 2 helpers modules: - `cyKlone-work-gas-station` => Gas station to pay gas for the `(work)` transactions. - `cyKlone-relay-v0` => Gas station and intermediate account to let users withdraw while paying gas anonymously. +![image info](./doc/img/cyKlone_modules.png) + + +### Deposits/Withdrawal flow + ![image info](./doc/img/cyKlone_diagram.png) + + ## TODO - Create a web UI - Organize a safe setup for the ZK keys. diff --git a/doc/img/cyKlone_modules.png b/doc/img/cyKlone_modules.png new file mode 100644 index 0000000..169bbdb Binary files /dev/null and b/doc/img/cyKlone_modules.png differ