Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(diagram): add contract architecture diagram #1305

Merged
merged 1 commit into from
Apr 30, 2024
Merged

docs(diagram): add contract architecture diagram #1305

merged 1 commit into from
Apr 30, 2024

Conversation

wiasliaw
Copy link
Contributor

Description

close #1202.

Confirmation

@netlify Netlify
Copy link

netlify bot commented Mar 17, 2024 •
edited
Loading

✅ Deploy Preview for maci-typedoc ready!

Name Link
🔨 Latest commit e7d346c
🔍 Latest deploy log https://app.netlify.com/sites/maci-typedoc/deploys/65f852829fa6ee0008f688e7
😎 Deploy Preview https://deploy-preview-1305--maci-typedoc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ctrlc03 ctrlc03 force-pushed the wiasliaw/contracts-svg branch from c652cb7 to e7d346c Compare March 18, 2024 14:41
ctrlc03
ctrlc03 reviewed Mar 18, 2024
View reviewed changes
Copy link
Collaborator

@ctrlc03 ctrlc03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you like to add diagrams for all other contracts interactions? Like the Poll contract, Tally, MessageProcessor, and how they fit within the architecture?

kittybest
kittybest reviewed Mar 18, 2024
View reviewed changes
Copy link
Collaborator

@kittybest kittybest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since genProof is also done by the coordinator, maybe the arrow should look like decrypt? (start from the coordinator)

@ctrlc03 ctrlc03 force-pushed the wiasliaw/contracts-svg branch from e7d346c to 45093ac Compare March 21, 2024 15:47
@vercel Vercel
Copy link

vercel bot commented Mar 21, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
maci-website ✅ Ready (Inspect) Visit Preview Apr 30, 2024 5:17pm

@ctrlc03 ctrlc03 force-pushed the wiasliaw/contracts-svg branch from 45093ac to 8289cd1 Compare March 21, 2024 17:01
@kittybest
Copy link
Collaborator

IMG_0655
Thinking about something like this? How do you think?

@ctrlc03 ctrlc03 force-pushed the wiasliaw/contracts-svg branch from 8289cd1 to 829ae56 Compare March 25, 2024 13:26
@kittybest
Copy link
Collaborator

If adding more contracts on this diagram to make it clearer (based on ctrl03’s comment)
5983784D-64DE-46A3-9B49-5BE10FDFC502

looks a little bit messy, need to be arranged properly

@ctrlc03 ctrlc03 force-pushed the wiasliaw/contracts-svg branch from 829ae56 to 8ca3dc8 Compare April 4, 2024 19:27
@kittybest
Copy link
Collaborator

@wiasliaw do you have time to revise this PR? or could you give us the original diagram file that we could modify? thanks a lot!

@wiasliaw wiasliaw force-pushed the wiasliaw/contracts-svg branch from 8ca3dc8 to 44345c0 Compare April 19, 2024 10:10
@wiasliaw
Copy link
Contributor Author

@kittybest and @ctrlc03
I had updated the new svg. And here is the edit link of the source file.

https://www.tldraw.com/r/cdVS7WgJZpKs21TXoiWsd?v=-1274,-1268,4897,3431&p=FUBKca68HYLYZLHOIybOd

kittybest
kittybest approved these changes Apr 19, 2024
View reviewed changes
Copy link
Collaborator

@kittybest kittybest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@kittybest
Copy link
Collaborator

@wiasliaw could you fix the conflicts? Thanks a lot!

@wiasliaw
Copy link
Contributor Author

@kittybest NP! Done!

@wiasliaw wiasliaw force-pushed the wiasliaw/contracts-svg branch from 1ff21a3 to 0b9e4b0 Compare April 24, 2024 17:38
ctrlc03
ctrlc03 approved these changes Apr 24, 2024
View reviewed changes
Copy link
Collaborator

@ctrlc03 ctrlc03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very neat diagram, thanks very much

@ctrlc03 ctrlc03 enabled auto-merge April 24, 2024 17:47
@ctrlc03 ctrlc03 force-pushed the wiasliaw/contracts-svg branch from a7d3d21 to 0b1b5ba Compare April 25, 2024 15:15
@ctrlc03 ctrlc03 force-pushed the wiasliaw/contracts-svg branch from 0b1b5ba to ec5e036 Compare April 30, 2024 17:12
@ctrlc03 ctrlc03 merged commit 58a6ed5 into privacy-scaling-explorations:dev Apr 30, 2024
20 checks passed
@gitpoap-bot gitpoap-bot
Copy link

gitpoap-bot bot commented Apr 30, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 MACI Contributor:

GitPOAP: 2024 MACI Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

@wiasliaw wiasliaw deleted the wiasliaw/contracts-svg branch May 4, 2024 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ctrlc03 ctrlc03 ctrlc03 approved these changes

@kittybest kittybest kittybest approved these changes

@0xmad 0xmad Awaiting requested review from 0xmad 0xmad is a code owner

@samajammin samajammin Awaiting requested review from samajammin

@crisgarner crisgarner Awaiting requested review from crisgarner crisgarner is a code owner

Assignees

@kittybest kittybest

@wiasliaw wiasliaw

Labels
None yet
Projects
MACI
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: create smart contract architecture diagrams
3 participants
@wiasliaw @kittybest @ctrlc03