From ec5e036fd9fc7d37cd7e334aa64c839228542104 Mon Sep 17 00:00:00 2001 From: wiasliaw Date: Mon, 18 Mar 2024 02:08:57 +0800 Subject: [PATCH] docs(diagram): add contract architecture diagram --- website/static/img/contracts.svg | 16 ++++++++++++++++ website/versioned_docs/version-v1.2/contracts.md | 2 ++ 2 files changed, 18 insertions(+) create mode 100644 website/static/img/contracts.svg diff --git a/website/static/img/contracts.svg b/website/static/img/contracts.svg new file mode 100644 index 000000000..27c386d41 --- /dev/null +++ b/website/static/img/contracts.svg @@ -0,0 +1,16 @@ +useruserMACIMACIcoordinatorcoordinator1. deploy maci1. deploy maciencrypted  +messageencrypted  +messagePoll 1Poll 13. deploy Poll3. deploy Poll4. vote4. voteresultsresultsdecrypted  +messagedecrypted  +message5. decrypt5. decrypt6. process & tally6. process & tallyGate KeeperGate Keeper2. signUp2. signUpProofProof7. genProof7. genProofVoice Credit ProxyVoice Credit Proxyencrypted  +messageencrypted  +messagePoll 1Poll 1TallyTally8. submit8. submitMessage  +ProcessorMessage  +Processor8. submit8. submitstake holderstake holdercontractcontractonchain operationonchain operationoffchain operationoffchain operationdatadata diff --git a/website/versioned_docs/version-v1.2/contracts.md b/website/versioned_docs/version-v1.2/contracts.md index a89a4958b..6de5c83b6 100644 --- a/website/versioned_docs/version-v1.2/contracts.md +++ b/website/versioned_docs/version-v1.2/contracts.md @@ -11,6 +11,8 @@ MACI is composed of multiple smart contracts, which together with the zk-SNARK c The main contracts are presented and explained below. +![contracts](/img/contracts.svg) + ## MACI.sol `MACI.sol` is the core contract of the project, as it provides the base layer for user signups and Polls to be created.