@maci-protocol/website 0.0.0-ci.00107eb

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (420) hide show
  1. package/.eslintrc.js +157 -0
  2. package/CHANGELOG.md +566 -0
  3. package/LICENSE +21 -0
  4. package/README.md +58 -0
  5. package/babel.config.js +3 -0
  6. package/blog/2021-10-12-maci-v1.md +100 -0
  7. package/blog/2022-09-22-maci-v1-technical-introduction.md +180 -0
  8. package/blog/2023-01-18-maci-v1.1.1.md +121 -0
  9. package/blog/2024-01-18-roadmap.md +106 -0
  10. package/blog/2024-02-28-maci-v1.2.0.md +121 -0
  11. package/blog/2024-04-10-roadmap-q2.md +96 -0
  12. package/blog/2024-05-08-ethdam.md +169 -0
  13. package/blog/2024-05-22-the-origins-of-maci.md +38 -0
  14. package/blog/2024-05-28-upcoming-grants.md +85 -0
  15. package/blog/2024-06-17-understanding-maci.md +63 -0
  16. package/blog/2024-06-21-deciphering-maci.md +48 -0
  17. package/blog/2024-06-28-revolusioning-public-goods-funding.md +32 -0
  18. package/blog/2024-07-23-q2-review.md +72 -0
  19. package/blog/2024-07-30-roadmap-q3.md +61 -0
  20. package/blog/2024-08-10-maci-v2.md +102 -0
  21. package/blog/2024-08-29-anonymous-poll-joining.md +47 -0
  22. package/blog/2024-10-29-q3-review.md +63 -0
  23. package/blog/2024-11-20-maci-platform.md +93 -0
  24. package/blog/2024-12-01-maci-getting-started.md +294 -0
  25. package/blog/2025-03-21-roadmap-2025.md +112 -0
  26. package/blog/2025-08-18-maci-aragon-plugin.md +107 -0
  27. package/blog/2025-09-05-maci-coordinator-service.md +167 -0
  28. package/blog/assets/MACI_Bob_SignUp_1.png +0 -0
  29. package/blog/assets/MACI_Bob_SignUp_2.png +0 -0
  30. package/blog/assets/MACI_Complex_Message.png +0 -0
  31. package/blog/assets/MACI_Contracts.png +0 -0
  32. package/blog/assets/MACI_Sign_Up.png +0 -0
  33. package/blog/assets/MACI_Simple_Message.png +0 -0
  34. package/blog/assets/MACI_Verifier_1.png +0 -0
  35. package/blog/authors.yml +5 -0
  36. package/docusaurus.config.ts +219 -0
  37. package/package.json +66 -0
  38. package/src/components/ActionCard/index.tsx +30 -0
  39. package/src/components/ActionCard/styles.module.css +96 -0
  40. package/src/components/HomepageFeatures/index.tsx +91 -0
  41. package/src/components/HomepageFeatures/styles.module.css +17 -0
  42. package/src/components/ProjectCard/index.tsx +74 -0
  43. package/src/components/ProjectCard/styles.module.css +77 -0
  44. package/src/components/ProjectList/index.tsx +218 -0
  45. package/src/components/ProjectList/styles.module.css +180 -0
  46. package/src/content/projects.json +294 -0
  47. package/src/css/card.module.css +130 -0
  48. package/src/css/custom.css +91 -0
  49. package/src/icons/IconDiscord.tsx +16 -0
  50. package/src/icons/IconGithub.tsx +16 -0
  51. package/src/icons/IconWebsite.tsx +16 -0
  52. package/src/pages/blogs.tsx +58 -0
  53. package/src/pages/index.module.css +152 -0
  54. package/src/pages/index.tsx +66 -0
  55. package/src/pages/projects.tsx +44 -0
  56. package/src/pages/roadmap.md +109 -0
  57. package/src/pages/typedoc.tsx +11 -0
  58. package/src/plugins/blog-plugin/index.ts +86 -0
  59. package/src/react-app-env.d.ts +1 -0
  60. package/src/scripts/setupSolidityDocs.ts +67 -0
  61. package/src/scripts/setupTypedoc.ts +112 -0
  62. package/src/scripts/utils.ts +115 -0
  63. package/src/utils/getProjectsByFilter.ts +40 -0
  64. package/static/.nojekyll +0 -0
  65. package/static/audit_reports/20210922_Hashcloak_audit_report.pdf +0 -0
  66. package/static/audit_reports/202220930_Hashcloak_audit_report.pdf +0 -0
  67. package/static/audit_reports/20240223_PSE_Audit_audit_report.pdf +0 -0
  68. package/static/audit_reports/20240731_PSE_Audit_audit_report.pdf +0 -0
  69. package/static/fonts/DM_Sans.woff2 +0 -0
  70. package/static/fonts/Share_Tech_Mono.woff2 +0 -0
  71. package/static/img/box.png +0 -0
  72. package/static/img/box_dark.png +0 -0
  73. package/static/img/chain.png +0 -0
  74. package/static/img/chain_dark.png +0 -0
  75. package/static/img/chart.png +0 -0
  76. package/static/img/chart_dark.png +0 -0
  77. package/static/img/circuits/MACI-Circuits.excalidraw +39652 -0
  78. package/static/img/circuits/calculateTotal.svg +21 -0
  79. package/static/img/circuits/ecdh.svg +21 -0
  80. package/static/img/circuits/messageToCommand.svg +21 -0
  81. package/static/img/circuits/messageValidator.svg +21 -0
  82. package/static/img/circuits/poseidonHasher13.svg +21 -0
  83. package/static/img/circuits/privToPubkey.svg +21 -0
  84. package/static/img/circuits/processMessages.svg +21 -0
  85. package/static/img/circuits/processMessagesInputHasher.svg +21 -0
  86. package/static/img/circuits/processMessages_2_0.svg +21 -0
  87. package/static/img/circuits/processOne.svg +21 -0
  88. package/static/img/circuits/processTopup.svg +21 -0
  89. package/static/img/circuits/processingAfterPollEnds.svg +21 -0
  90. package/static/img/circuits/quinBatchLeavesExists.svg +21 -0
  91. package/static/img/circuits/quinCheckRoot.svg +21 -0
  92. package/static/img/circuits/quinGeneratePathIndices.svg +21 -0
  93. package/static/img/circuits/quinSelector.svg +21 -0
  94. package/static/img/circuits/resultsCommitmentVerifier.svg +21 -0
  95. package/static/img/circuits/splicer.svg +21 -0
  96. package/static/img/circuits/tallyInputHasher.svg +21 -0
  97. package/static/img/circuits/tallyVotes.svg +21 -0
  98. package/static/img/circuits/unpackElement.svg +21 -0
  99. package/static/img/circuits/verifySignature.svg +21 -0
  100. package/static/img/completingAPoll.svg +4 -0
  101. package/static/img/contracts.svg +16 -0
  102. package/static/img/coordinatorComponents.svg +21 -0
  103. package/static/img/favicon.ico +0 -0
  104. package/static/img/generateProofs.svg +4 -0
  105. package/static/img/hero.svg +9 -0
  106. package/static/img/maci-card.png +0 -0
  107. package/static/img/maci-rpgf-design.jpg +0 -0
  108. package/static/img/messageProcessingLocal.svg +21 -0
  109. package/static/img/offlineProcessing.svg +21 -0
  110. package/static/img/pse-logo-round.png +0 -0
  111. package/static/img/relayer-diagram.png +0 -0
  112. package/static/img/tallyCommitments.svg +4 -0
  113. package/static/img/voteTallyingLocal.svg +21 -0
  114. package/tsconfig.json +34 -0
  115. package/versioned_docs/version-v0.x/circuits.md +22 -0
  116. package/versioned_docs/version-v0.x/contract.md +186 -0
  117. package/versioned_docs/version-v0.x/faq.md +67 -0
  118. package/versioned_docs/version-v0.x/introduction.md +115 -0
  119. package/versioned_docs/version-v0.x/quadratic-vote-tallying-circuit.md +138 -0
  120. package/versioned_docs/version-v0.x/state-root-transition-circuit.md +230 -0
  121. package/versioned_docs/version-v1.2/audit.md +160 -0
  122. package/versioned_docs/version-v1.2/ci-pipeline.md +38 -0
  123. package/versioned_docs/version-v1.2/circuits.md +508 -0
  124. package/versioned_docs/version-v1.2/cli.md +689 -0
  125. package/versioned_docs/version-v1.2/contracts.md +445 -0
  126. package/versioned_docs/version-v1.2/contributing/code-of-conduct.md +91 -0
  127. package/versioned_docs/version-v1.2/contributing/contributing.md +129 -0
  128. package/versioned_docs/version-v1.2/coordinator-processing.md +46 -0
  129. package/versioned_docs/version-v1.2/deployment.md +122 -0
  130. package/versioned_docs/version-v1.2/installation.md +175 -0
  131. package/versioned_docs/version-v1.2/integrating.md +200 -0
  132. package/versioned_docs/version-v1.2/introduction.md +94 -0
  133. package/versioned_docs/version-v1.2/key-change.md +182 -0
  134. package/versioned_docs/version-v1.2/overview.md +47 -0
  135. package/versioned_docs/version-v1.2/poll-types.md +68 -0
  136. package/versioned_docs/version-v1.2/primitives.md +216 -0
  137. package/versioned_docs/version-v1.2/project-ideas.md +14 -0
  138. package/versioned_docs/version-v1.2/purpose.md +62 -0
  139. package/versioned_docs/version-v1.2/solidity-docs/MACI.md +345 -0
  140. package/versioned_docs/version-v1.2/solidity-docs/MessageProcessor.md +266 -0
  141. package/versioned_docs/version-v1.2/solidity-docs/MessageProcessorFactory.md +26 -0
  142. package/versioned_docs/version-v1.2/solidity-docs/Poll.md +381 -0
  143. package/versioned_docs/version-v1.2/solidity-docs/PollFactory.md +50 -0
  144. package/versioned_docs/version-v1.2/solidity-docs/SignUpToken.md +27 -0
  145. package/versioned_docs/version-v1.2/solidity-docs/Subsidy.md +218 -0
  146. package/versioned_docs/version-v1.2/solidity-docs/SubsidyFactory.md +27 -0
  147. package/versioned_docs/version-v1.2/solidity-docs/Tally.md +311 -0
  148. package/versioned_docs/version-v1.2/solidity-docs/TallyFactory.md +27 -0
  149. package/versioned_docs/version-v1.2/solidity-docs/TallyNonQv.md +296 -0
  150. package/versioned_docs/version-v1.2/solidity-docs/TallyNonQvFactory.md +27 -0
  151. package/versioned_docs/version-v1.2/solidity-docs/TopupCredit.md +61 -0
  152. package/versioned_docs/version-v1.2/solidity-docs/VkRegistry.md +457 -0
  153. package/versioned_docs/version-v1.2/solidity-docs/benchmarks/HasherBenchmarks.md +44 -0
  154. package/versioned_docs/version-v1.2/solidity-docs/crypto/Hasher.md +125 -0
  155. package/versioned_docs/version-v1.2/solidity-docs/crypto/IVerifier.md +11 -0
  156. package/versioned_docs/version-v1.2/solidity-docs/crypto/MockVerifier.md +17 -0
  157. package/versioned_docs/version-v1.2/solidity-docs/crypto/Pairing.md +85 -0
  158. package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT3.md +9 -0
  159. package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT4.md +9 -0
  160. package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT5.md +9 -0
  161. package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT6.md +9 -0
  162. package/versioned_docs/version-v1.2/solidity-docs/crypto/SnarkCommon.md +16 -0
  163. package/versioned_docs/version-v1.2/solidity-docs/crypto/SnarkConstants.md +40 -0
  164. package/versioned_docs/version-v1.2/solidity-docs/crypto/Verifier.md +61 -0
  165. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/EASGatekeeper.md +121 -0
  166. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/FreeForAllSignUpGatekeeper.md +40 -0
  167. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/SignUpGatekeeper.md +26 -0
  168. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/SignUpTokenGatekeeper.md +93 -0
  169. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/hatsGatekeepers/HatsGatekeeperBase.md +79 -0
  170. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/hatsGatekeepers/HatsGatekeeperMultiple.md +48 -0
  171. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/hatsGatekeepers/HatsGatekeeperSingle.md +42 -0
  172. package/versioned_docs/version-v1.2/solidity-docs/index.md +4 -0
  173. package/versioned_docs/version-v1.2/solidity-docs/initialVoiceCreditProxy/ConstantInitialVoiceCreditProxy.md +40 -0
  174. package/versioned_docs/version-v1.2/solidity-docs/initialVoiceCreditProxy/InitialVoiceCreditProxy.md +26 -0
  175. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IEAS.md +40 -0
  176. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IHats.md +103 -0
  177. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IMPFactory.md +26 -0
  178. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IMessageProcessor.md +31 -0
  179. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IPoll.md +217 -0
  180. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IPollFactory.md +29 -0
  181. package/versioned_docs/version-v1.2/solidity-docs/interfaces/ITallyFactory.md +28 -0
  182. package/versioned_docs/version-v1.2/solidity-docs/interfaces/ITallySubsidyFactory.md +27 -0
  183. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IVerifier.md +25 -0
  184. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IVkRegistry.md +70 -0
  185. package/versioned_docs/version-v1.2/solidity-docs/mocks/MockHatsProtocol.md +133 -0
  186. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueue.md +464 -0
  187. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueBinary.md +60 -0
  188. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueBinary0.md +40 -0
  189. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueBinaryMaci.md +34 -0
  190. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinary.md +75 -0
  191. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinary0.md +40 -0
  192. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinaryBlankSl.md +40 -0
  193. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinaryMaci.md +40 -0
  194. package/versioned_docs/version-v1.2/solidity-docs/trees/EmptyBallotRoots.md +13 -0
  195. package/versioned_docs/version-v1.2/solidity-docs/utilities/CommonUtilities.md +25 -0
  196. package/versioned_docs/version-v1.2/solidity-docs/utilities/DomainObjs.md +40 -0
  197. package/versioned_docs/version-v1.2/solidity-docs/utilities/Params.md +36 -0
  198. package/versioned_docs/version-v1.2/solidity-docs/utilities/Utilities.md +79 -0
  199. package/versioned_docs/version-v1.2/spec.md +944 -0
  200. package/versioned_docs/version-v1.2/testing-in-detail.md +209 -0
  201. package/versioned_docs/version-v1.2/testing.md +472 -0
  202. package/versioned_docs/version-v1.2/topup.md +43 -0
  203. package/versioned_docs/version-v1.2/troubleshooting.md +51 -0
  204. package/versioned_docs/version-v1.2/trusted-setup.md +76 -0
  205. package/versioned_docs/version-v1.2/typedoc/cli/.nojekyll +1 -0
  206. package/versioned_docs/version-v1.2/typedoc/cli/index.md +15 -0
  207. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/AirdropArgs.md +89 -0
  208. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/DeployArgs.md +154 -0
  209. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/DeployPollArgs.md +154 -0
  210. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/DeployedContracts.md +130 -0
  211. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/GenLocalStateArgs.md +168 -0
  212. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/GenProofsArgs.md +388 -0
  213. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/IGenKeypairArgs.md +37 -0
  214. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/IRegisteredUserArgs.md +63 -0
  215. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/MergeMessagesArgs.md +76 -0
  216. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/MergeSignupsArgs.md +76 -0
  217. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/PollContracts.md +53 -0
  218. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/ProveOnChainArgs.md +128 -0
  219. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/PublishArgs.md +154 -0
  220. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/SignupArgs.md +89 -0
  221. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/SubsidyData.md +73 -0
  222. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/TallyData.md +166 -0
  223. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/TopupArgs.md +89 -0
  224. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/VerifyArgs.md +128 -0
  225. package/versioned_docs/version-v1.2/typedoc/cli/modules.md +556 -0
  226. package/versioned_docs/version-v1.2/typedoc/core/.nojekyll +1 -0
  227. package/versioned_docs/version-v1.2/typedoc/core/classes/MaciState.md +295 -0
  228. package/versioned_docs/version-v1.2/typedoc/core/classes/Poll.md +1098 -0
  229. package/versioned_docs/version-v1.2/typedoc/core/index.md +110 -0
  230. package/versioned_docs/version-v1.2/typedoc/core/interfaces/BatchSizes.md +50 -0
  231. package/versioned_docs/version-v1.2/typedoc/core/interfaces/IJsonMaciState.md +77 -0
  232. package/versioned_docs/version-v1.2/typedoc/core/interfaces/IProcessMessagesCircuitInputs.md +242 -0
  233. package/versioned_docs/version-v1.2/typedoc/core/interfaces/ISubsidyCircuitInputs.md +198 -0
  234. package/versioned_docs/version-v1.2/typedoc/core/interfaces/ITallyCircuitInputs.md +231 -0
  235. package/versioned_docs/version-v1.2/typedoc/core/interfaces/MaxValues.md +37 -0
  236. package/versioned_docs/version-v1.2/typedoc/core/interfaces/TreeDepths.md +63 -0
  237. package/versioned_docs/version-v1.2/typedoc/core/modules.md +289 -0
  238. package/versioned_docs/version-v1.2/typedoc/crypto/.nojekyll +1 -0
  239. package/versioned_docs/version-v1.2/typedoc/crypto/classes/AccQueue.md +770 -0
  240. package/versioned_docs/version-v1.2/typedoc/crypto/classes/G1Point.md +115 -0
  241. package/versioned_docs/version-v1.2/typedoc/crypto/classes/G2Point.md +140 -0
  242. package/versioned_docs/version-v1.2/typedoc/crypto/classes/IncrementalQuinTree.md +470 -0
  243. package/versioned_docs/version-v1.2/typedoc/crypto/index.md +44 -0
  244. package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/Keypair.md +33 -0
  245. package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/PoseidonFuncs.md +115 -0
  246. package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/Queue.md +33 -0
  247. package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/Signature.md +37 -0
  248. package/versioned_docs/version-v1.2/typedoc/crypto/modules.md +913 -0
  249. package/versioned_docs/version-v1.2/typedoc/domainobjs/.nojekyll +1 -0
  250. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/Ballot.md +274 -0
  251. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/Keypair.md +181 -0
  252. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/Message.md +244 -0
  253. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/PCommand.md +409 -0
  254. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/PrivKey.md +206 -0
  255. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/PubKey.md +289 -0
  256. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/StateLeaf.md +340 -0
  257. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/TCommand.md +200 -0
  258. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/VerifyingKey.md +240 -0
  259. package/versioned_docs/version-v1.2/typedoc/domainobjs/index.md +81 -0
  260. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/ICommand.md +104 -0
  261. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IG1ContractParams.md +31 -0
  262. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IG2ContractParams.md +31 -0
  263. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonBallot.md +42 -0
  264. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonCommand.md +32 -0
  265. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonKeyPair.md +31 -0
  266. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonPCommand.md +111 -0
  267. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonStateLeaf.md +42 -0
  268. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonTCommand.md +67 -0
  269. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IMessageContractParams.md +31 -0
  270. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IStateLeaf.md +39 -0
  271. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IStateLeafContractParams.md +42 -0
  272. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IVkContractParams.md +64 -0
  273. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IVkObjectParams.md +108 -0
  274. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/Proof.md +46 -0
  275. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/VoteOptionTreeLeaf.md +24 -0
  276. package/versioned_docs/version-v1.2/typedoc/domainobjs/modules.md +110 -0
  277. package/versioned_docs/version-v1.2/typedoc/index.md +4 -0
  278. package/versioned_docs/version-v1.2/versioning.md +94 -0
  279. package/versioned_docs/version-v1.2/workflow.md +142 -0
  280. package/versioned_docs/version-v2.x/case-studies.md +35 -0
  281. package/versioned_docs/version-v2.x/contributing/_category_.json +4 -0
  282. package/versioned_docs/version-v2.x/contributing/code-of-conduct.md +92 -0
  283. package/versioned_docs/version-v2.x/contributing/contributing.md +149 -0
  284. package/versioned_docs/version-v2.x/contributing/project-ideas.md +78 -0
  285. package/versioned_docs/version-v2.x/core-concepts/_category_.json +4 -0
  286. package/versioned_docs/version-v2.x/core-concepts/ballot.md +19 -0
  287. package/versioned_docs/version-v2.x/core-concepts/coordinator-processing.md +46 -0
  288. package/versioned_docs/version-v2.x/core-concepts/hashing-and-encryption.md +45 -0
  289. package/versioned_docs/version-v2.x/core-concepts/key-change.md +179 -0
  290. package/versioned_docs/version-v2.x/core-concepts/maci-keys.md +84 -0
  291. package/versioned_docs/version-v2.x/core-concepts/maci-messages.md +44 -0
  292. package/versioned_docs/version-v2.x/core-concepts/merkle-trees.md +23 -0
  293. package/versioned_docs/version-v2.x/core-concepts/poll-types.md +106 -0
  294. package/versioned_docs/version-v2.x/core-concepts/spec.md +883 -0
  295. package/versioned_docs/version-v2.x/core-concepts/state-leaf.md +42 -0
  296. package/versioned_docs/version-v2.x/core-concepts/workflow.md +142 -0
  297. package/versioned_docs/version-v2.x/getting-started.md +313 -0
  298. package/versioned_docs/version-v2.x/guides/_category_.json +4 -0
  299. package/versioned_docs/version-v2.x/guides/compile-circuits.md +163 -0
  300. package/versioned_docs/version-v2.x/guides/frontend.md +99 -0
  301. package/versioned_docs/version-v2.x/guides/integrating.md +73 -0
  302. package/versioned_docs/version-v2.x/guides/maciWrapper.md +173 -0
  303. package/versioned_docs/version-v2.x/guides/subgraph.md +79 -0
  304. package/versioned_docs/version-v2.x/guides/testing/_category_.json +4 -0
  305. package/versioned_docs/version-v2.x/guides/testing/testing-in-detail.md +203 -0
  306. package/versioned_docs/version-v2.x/guides/testing/testing.md +163 -0
  307. package/versioned_docs/version-v2.x/guides/troubleshooting.md +161 -0
  308. package/versioned_docs/version-v2.x/introduction.md +146 -0
  309. package/versioned_docs/version-v2.x/processes/_category_.json +4 -0
  310. package/versioned_docs/version-v2.x/processes/ci-pipeline.md +38 -0
  311. package/versioned_docs/version-v2.x/processes/versioning.md +94 -0
  312. package/versioned_docs/version-v2.x/resources.md +33 -0
  313. package/versioned_docs/version-v2.x/security/_category_.json +4 -0
  314. package/versioned_docs/version-v2.x/security/audit.md +167 -0
  315. package/versioned_docs/version-v2.x/security/trusted-setup.md +166 -0
  316. package/versioned_docs/version-v2.x/supported-networks/_category_.json +4 -0
  317. package/versioned_docs/version-v2.x/supported-networks/deployed-contracts.md +1108 -0
  318. package/versioned_docs/version-v2.x/supported-networks/supported-networks.md +47 -0
  319. package/versioned_docs/version-v2.x/technical-references/_category_.json +4 -0
  320. package/versioned_docs/version-v2.x/technical-references/smart-contracts/AccQueue.md +21 -0
  321. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Gatekeepers.md +40 -0
  322. package/versioned_docs/version-v2.x/technical-references/smart-contracts/MACI.md +152 -0
  323. package/versioned_docs/version-v2.x/technical-references/smart-contracts/MessageProcessor.md +13 -0
  324. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Params.md +32 -0
  325. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Poll.md +104 -0
  326. package/versioned_docs/version-v2.x/technical-references/smart-contracts/PollFactory.md +43 -0
  327. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Tally.md +45 -0
  328. package/versioned_docs/version-v2.x/technical-references/smart-contracts/VkRegistry.md +57 -0
  329. package/versioned_docs/version-v2.x/technical-references/smart-contracts/VoiceCreditProxy.md +18 -0
  330. package/versioned_docs/version-v2.x/technical-references/smart-contracts/_category_.json +8 -0
  331. package/versioned_docs/version-v2.x/technical-references/technical-references.md +47 -0
  332. package/versioned_docs/version-v2.x/technical-references/typescript-code/_category_.json +4 -0
  333. package/versioned_docs/version-v2.x/technical-references/typescript-code/cli.md +699 -0
  334. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/_category_.json +4 -0
  335. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/processMessages.md +107 -0
  336. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/setup.md +101 -0
  337. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/tallyVotes.md +79 -0
  338. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/utilities.md +131 -0
  339. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/zk-snark-circuits.md +37 -0
  340. package/versioned_docs/version-v2.x/use-cases/_category_.json +4 -0
  341. package/versioned_docs/version-v2.x/use-cases/governance.md +18 -0
  342. package/versioned_docs/version-v2.x/use-cases/polling.md +10 -0
  343. package/versioned_docs/version-v2.x/use-cases/public-goods.md +65 -0
  344. package/versioned_docs/version-v3.x/case-studies.md +35 -0
  345. package/versioned_docs/version-v3.x/contributing/_category_.json +4 -0
  346. package/versioned_docs/version-v3.x/contributing/code-of-conduct.md +92 -0
  347. package/versioned_docs/version-v3.x/contributing/contributing.md +155 -0
  348. package/versioned_docs/version-v3.x/contributing/project-ideas.md +78 -0
  349. package/versioned_docs/version-v3.x/core-concepts/_category_.json +4 -0
  350. package/versioned_docs/version-v3.x/core-concepts/ballot.md +19 -0
  351. package/versioned_docs/version-v3.x/core-concepts/coordinator-processing.md +46 -0
  352. package/versioned_docs/version-v3.x/core-concepts/coordinator-service.md +16 -0
  353. package/versioned_docs/version-v3.x/core-concepts/hashing-and-encryption.md +45 -0
  354. package/versioned_docs/version-v3.x/core-concepts/key-change.md +179 -0
  355. package/versioned_docs/version-v3.x/core-concepts/maci-keys.md +84 -0
  356. package/versioned_docs/version-v3.x/core-concepts/maci-messages.md +44 -0
  357. package/versioned_docs/version-v3.x/core-concepts/merkle-trees.md +16 -0
  358. package/versioned_docs/version-v3.x/core-concepts/offchain-voting.md +14 -0
  359. package/versioned_docs/version-v3.x/core-concepts/poll-types.md +82 -0
  360. package/versioned_docs/version-v3.x/core-concepts/polls.md +105 -0
  361. package/versioned_docs/version-v3.x/core-concepts/spec.md +817 -0
  362. package/versioned_docs/version-v3.x/core-concepts/state-leaf.md +42 -0
  363. package/versioned_docs/version-v3.x/core-concepts/workflow.md +149 -0
  364. package/versioned_docs/version-v3.x/guides/_category_.json +4 -0
  365. package/versioned_docs/version-v3.x/guides/compile-circuits.md +191 -0
  366. package/versioned_docs/version-v3.x/guides/integrating.md +137 -0
  367. package/versioned_docs/version-v3.x/guides/sdk.md +121 -0
  368. package/versioned_docs/version-v3.x/guides/subgraph.md +79 -0
  369. package/versioned_docs/version-v3.x/guides/testing/_category_.json +4 -0
  370. package/versioned_docs/version-v3.x/guides/testing/testing-in-detail.md +191 -0
  371. package/versioned_docs/version-v3.x/guides/testing/testing-introduction.md +190 -0
  372. package/versioned_docs/version-v3.x/guides/troubleshooting.md +206 -0
  373. package/versioned_docs/version-v3.x/introduction.md +153 -0
  374. package/versioned_docs/version-v3.x/processes/_category_.json +4 -0
  375. package/versioned_docs/version-v3.x/processes/ci-pipeline.md +38 -0
  376. package/versioned_docs/version-v3.x/processes/versioning.md +94 -0
  377. package/versioned_docs/version-v3.x/quick-start.md +326 -0
  378. package/versioned_docs/version-v3.x/resources.md +34 -0
  379. package/versioned_docs/version-v3.x/security/_category_.json +4 -0
  380. package/versioned_docs/version-v3.x/security/audit.md +167 -0
  381. package/versioned_docs/version-v3.x/security/trusted-setup.md +172 -0
  382. package/versioned_docs/version-v3.x/supported-networks/_category_.json +4 -0
  383. package/versioned_docs/version-v3.x/supported-networks/costs.md +725 -0
  384. package/versioned_docs/version-v3.x/supported-networks/deployed-contracts.md +112 -0
  385. package/versioned_docs/version-v3.x/supported-networks/supported-networks.md +69 -0
  386. package/versioned_docs/version-v3.x/technical-references/_category_.json +4 -0
  387. package/versioned_docs/version-v3.x/technical-references/coordinator-service/_category_.json +8 -0
  388. package/versioned_docs/version-v3.x/technical-references/coordinator-service/index.md +24 -0
  389. package/versioned_docs/version-v3.x/technical-references/coordinator-service/installation.md +15 -0
  390. package/versioned_docs/version-v3.x/technical-references/coordinator-service/usage.md +64 -0
  391. package/versioned_docs/version-v3.x/technical-references/offchain-relayer/_category_.json +8 -0
  392. package/versioned_docs/version-v3.x/technical-references/offchain-relayer/index.md +51 -0
  393. package/versioned_docs/version-v3.x/technical-references/offchain-relayer/installation.md +109 -0
  394. package/versioned_docs/version-v3.x/technical-references/smart-contracts/MACI.md +160 -0
  395. package/versioned_docs/version-v3.x/technical-references/smart-contracts/MessageProcessor.md +13 -0
  396. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Params.md +33 -0
  397. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Policies.md +39 -0
  398. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Poll.md +170 -0
  399. package/versioned_docs/version-v3.x/technical-references/smart-contracts/PollFactory.md +33 -0
  400. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Tally.md +43 -0
  401. package/versioned_docs/version-v3.x/technical-references/smart-contracts/VkRegistry.md +62 -0
  402. package/versioned_docs/version-v3.x/technical-references/smart-contracts/VoiceCreditProxy.md +18 -0
  403. package/versioned_docs/version-v3.x/technical-references/smart-contracts/_category_.json +8 -0
  404. package/versioned_docs/version-v3.x/technical-references/technical-references.md +48 -0
  405. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/_category_.json +4 -0
  406. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/joinPoll.md +52 -0
  407. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/processMessages.md +170 -0
  408. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/setup.md +96 -0
  409. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/tallyVotes.md +79 -0
  410. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/utilities.md +131 -0
  411. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/zk-snark-circuits.md +42 -0
  412. package/versioned_docs/version-v3.x/use-cases/_category_.json +4 -0
  413. package/versioned_docs/version-v3.x/use-cases/governance.md +18 -0
  414. package/versioned_docs/version-v3.x/use-cases/polling.md +10 -0
  415. package/versioned_docs/version-v3.x/use-cases/public-goods.md +65 -0
  416. package/versioned_sidebars/version-v0.x-sidebars.json +8 -0
  417. package/versioned_sidebars/version-v1.2-sidebars.json +8 -0
  418. package/versioned_sidebars/version-v2.x-sidebars.json +8 -0
  419. package/versioned_sidebars/version-v3.x-sidebars.json +8 -0
  420. package/versions.json +1 -0
@@ -0,0 +1,294 @@
1
+ ---
2
+ slug: getting-started-with-maci
3
+ title: Getting Started with MACI
4
+ description: Guide to use MACI
5
+ authors:
6
+ name: Crisgarner
7
+ title: MACI team contributor
8
+ url: https://x.com/crisgarner
9
+ image_url: https://avatars.githubusercontent.com/u/578688?v=4
10
+ tags: [voting, security, anonymity, roadmap, community, MACI, development]
11
+ excerpt: "Get Started with MACI"
12
+ ---
13
+
14
+ Hey folks! We’re thrilled to kick off a series of tutorials covering everything you need to know about MACI. This guide will focus on installing MACI and deploying the contracts to a testnet. Let’s get started!
15
+
16
+ ## Understanding Roles
17
+
18
+ MACI protocol has two main roles, User (Voter) and Coordinator. A simplified version would be to say that the coordinator is in charge of deploying the MACI smart contracts, initiating the polls, tallying the final results of a vote, and finalizing polls by publishing the final results on-chain. Usually the contract deployer is the coordinator, but this can be a separate entity.
19
+
20
+ ## Requirements
21
+
22
+ Let's install the required tools first:
23
+
24
+ - Node.js: use a JS toolchain manager like [`nvm`](https://github.com/nvm-sh/nvm) or [`volta`](https://volta.sh/) to install Node.js. We recommend using Node 20 or above.
25
+ - [pnpm](https://pnpm.io/installation): Fast, disk space efficient package manager.
26
+
27
+ ## Installation
28
+
29
+ Now you can run the following commands to install MACI locally:
30
+
31
+ ```bash
32
+ git clone https://github.com/privacy-scaling-explorations/maci.git && \
33
+ cd maci && \
34
+ git checkout v2.5.0 && \
35
+ pnpm i && \
36
+ pnpm run build
37
+ ```
38
+
39
+ :::note
40
+ Unless you are looking to contribute to the MACI codebase, we suggest you use the latest released version. You can check all the releases [here](https://github.com/privacy-scaling-explorations/maci/releases).
41
+ :::
42
+
43
+ ### Download the zero knowledge artifacts
44
+
45
+ MACI has two main zk-SNARK circuits, and each of them is parameterized. There should be one `.zkey` file for each circuit and set of parameters.
46
+
47
+ Unless you wish to generate a fresh set of `.zkey` files, you should obtain
48
+ them from someone who has performed a multi-party trusted setup for said
49
+ circuits. For more details on which artifacts have undergone a trusted setup, please refer to the [Trusted Setup](/docs/security/trusted-setup) page.
50
+
51
+ :::important
52
+ Note the locations of the `.zkey` files cause you will need it when deploying contracts. (put in the deploy-config.json)
53
+ :::
54
+
55
+ #### Download test artifacts
56
+
57
+ For all but production use cases, we suggest using the test artifacts, with the latest dev code, you can download them by running:
58
+
59
+ ```bash
60
+ pnpm download-zkeys:test
61
+ ```
62
+
63
+ #### Download ceremony artifacts
64
+
65
+ For production you need to use the ceremony artifacts which have undergone a trusted setup, you can download them with the command:
66
+
67
+ ```bash
68
+ pnpm download-zkeys:ceremony
69
+ ```
70
+
71
+ :::info
72
+ Currently, the ceremony artifacts work with MACI version up to 2.x
73
+ :::
74
+
75
+ ## Deploy Contracts
76
+
77
+ Before deploying the contracts we need to do some final configurations to our repository.
78
+
79
+ ### Set the environment variables
80
+
81
+ Head to the `packages/contracts` folder and copy the `.env.example` file.
82
+
83
+ ```bash
84
+ cd packages/contracts && \
85
+ cp .env.example .env
86
+ ```
87
+
88
+ Make sure to include a mnemonic and RPC url (make sure to replace NETWORK with the network you want to use).
89
+
90
+ ```js
91
+ MNEMONIC = "your ethereum secret key";
92
+ NETWORK_RPC_URL = "the eth provider url";
93
+ NETWORK_ETHERSCAN_API_KEY = "etherscan api key";
94
+ ```
95
+
96
+ ### Generate Coordinator Keys
97
+
98
+ In order to run MACI polls, a coordinator is required to publish their MACI public key. You will need to generate a MACI keypair, and treat the private key just as your ethereum private keys. Please store them in a safe place as you won't be able to finish a round if you lose access, or if compromised a bad actor could decrypt the vote and publish them online. You can generate a new key pair using maci-cli by running the following commands:
99
+
100
+ ```bash
101
+ cd packages/cli && \
102
+ node build/ts/index.js genMaciKeyPair
103
+ ```
104
+
105
+ ### Set the configuration file
106
+
107
+ :::note
108
+ There are already some deployed contracts that could be reused. More information can be found in the (incremental documentation page)[docs/getting-started#deploy-maci-contracts].
109
+ :::
110
+
111
+ Head back to the contracts folder and copy the config example and update the fields as necessary:
112
+
113
+ ```bash
114
+ cd ../contracts && \
115
+ cp deploy-config-example.json deploy-config.json
116
+ ```
117
+
118
+ #### ConstantInitialVoiceCreditProxy
119
+
120
+ Defines how many credits will get each voter.
121
+
122
+ #### Gatekeeper
123
+
124
+ MACI uses a "gatekeeper" contract to configure and enforce the eligibility criteria of voters who can participate in MACI polls. In other words, it is a way to allowlist signups to the system to protect against sybil attacks. Please refer to the [gatekeeper page in the documentation](/docs/technical-references/smart-contracts/Gatekeepers) for more information on the supported Gatekeepers.
125
+
126
+ :::important
127
+ For testing we suggest using the **FreeForAllGatekeeper** as it allows anyone to signup on MACI.
128
+ :::
129
+
130
+ #### MACI
131
+
132
+ This property defines which Gatekeeper and stateTreeDepth MACI is going to use. The stateTreeDepth defines how many users the system supports.
133
+
134
+ :::important
135
+ The stateTreeDepth value for test artifacts is: **10**. For ceremony keys: **14**.
136
+ :::
137
+
138
+ #### VkRegistry
139
+
140
+ The VkRegistry hold the verifying keys used to verify the proofs, on the zkeys field we define the path to the zero knowledge artifacts we downloaded in the previous steps.
141
+
142
+ :::important
143
+ The values for test keys are: **10-1-2-2-1**. For ceremony keys: **14-5-9-3-2**.
144
+ :::
145
+
146
+ #### Poll
147
+
148
+ Configures the poll duration in seconds, determines whether quadratic voting is enabled, and sets the public key of the Coordinator.
149
+
150
+ ### Deploy MACI Contracts
151
+
152
+ To deploy the MACI contracts to a specific network you can append `:network` to the deployment commands, e.g. `pnpm deploy:sepolia` - please refer to the [supported networks](/docs/supported-networks/) documentation page to see all available networks.
153
+
154
+ ```bash
155
+ pnpm deploy:NETWORK
156
+ ```
157
+
158
+ ## Deploy Poll
159
+
160
+ Before deploying a Poll, make sure you have set the coordinator MACI public key to which you own the private key. To deploy your first Poll you can run the following command:
161
+
162
+ ```sh
163
+ pnpm deploy-poll:NETWORK
164
+ ```
165
+
166
+ :::important
167
+ Starting another poll doesn't require deploying MACI contracts again, you can run `pnpm deploy-poll:NETWORK` command and then use the new poll-id.
168
+ :::
169
+
170
+ ## Poll Finalization
171
+
172
+ As a coordinator, first you need to merge signups and messages (votes). Messages are stored in a queue so when the poll is over, the coordinator needs to create the merkle tree from the queue ([AccQueue](/docs/v2.x/core-concepts/merkle-trees#accumulator-queue)). This optimization is needed to reduce gas cost for voters. Then the coordinator generates proofs for the message processing, and tally calculations. This allows to publish the poll results on-chain and then everyone can verify the results when the poll is over. You run a merge with:
173
+
174
+ ```bash
175
+ pnpm merge:[network] --poll [poll-id]
176
+ ```
177
+
178
+ Then you need to generate the proofs with the following command:
179
+
180
+ ```bash
181
+ pnpm run prove:[network] --poll [poll-id] \
182
+ --coordinator-private-key [coordinator-maci-private-key] \
183
+ --tally-file ../proofs/tally.json \
184
+ --output-dir ../proofs/proofs/ \
185
+ --start-block [block-number] \
186
+ --blocks-per-batch [number-of-blocks]
187
+ ```
188
+
189
+ :::important
190
+ You can reduce the time of the proving by including more blocks per batch, you can try with 500.
191
+ :::
192
+
193
+ #### Submit On-chain
194
+
195
+ Now it's time to submit the poll results on-chain so that everyone can verify the results:
196
+
197
+ ```bash
198
+ pnpm submitOnChain:[network] --poll [poll-id] \
199
+ --output-dir proofs/ \
200
+ --tally-file proofs/tally.json
201
+ ```
202
+
203
+ #### Tally
204
+
205
+ Once the proofs are generated, and results tallied, the results (Tally) are written to a file. Let's take a look at one:
206
+
207
+ ```json
208
+ {
209
+ "maci": "0xd54b47F8e6A1b97F3A84f63c867286272b273b7C",
210
+ "pollId": "0",
211
+ "network": "localhost",
212
+ "chainId": "31337",
213
+ "isQuadratic": true,
214
+ "tallyAddress": "0xD4fbAF1dFe100d07f8Ef73d8c92e93d0Bcf7b45D",
215
+ "newTallyCommitment": "0x2f55cc85f7f141098ba791a9f6a646f8773b9bb4f5852ccc33b5a28e7b0756e5",
216
+ "results": {
217
+ "tally": [
218
+ "9",
219
+ "0",
220
+ "0",
221
+ "0",
222
+ "0",
223
+ "0",
224
+ "0",
225
+ "0",
226
+ "0",
227
+ "0",
228
+ "0",
229
+ "0",
230
+ "0",
231
+ "0",
232
+ "0",
233
+ "0",
234
+ "0",
235
+ "0",
236
+ "0",
237
+ "0",
238
+ "0",
239
+ "0",
240
+ "0",
241
+ "0",
242
+ "0"
243
+ ],
244
+ "salt": "0x2e9cd240b86cf456fa4deced8e7420c45e3c16941d2dcec308f8b6d48264dda3",
245
+ "commitment": "0x296eac2a7289974f23497bebd39e86599d0b7032796fb84dcc1f6bbda38262ca"
246
+ },
247
+ "totalSpentVoiceCredits": {
248
+ "spent": "81",
249
+ "salt": "0x24f57b75c227987727c13d1e83409d70478b42bdc12a4a4df8129c72fbaf5aaf",
250
+ "commitment": "0xb4ebe68b0da828c0b978ddee86ba934b8e215499ac766491f236ad85fd606de"
251
+ },
252
+ "perVOSpentVoiceCredits": {
253
+ "tally": [
254
+ "81",
255
+ "0",
256
+ "0",
257
+ "0",
258
+ "0",
259
+ "0",
260
+ "0",
261
+ "0",
262
+ "0",
263
+ "0",
264
+ "0",
265
+ "0",
266
+ "0",
267
+ "0",
268
+ "0",
269
+ "0",
270
+ "0",
271
+ "0",
272
+ "0",
273
+ "0",
274
+ "0",
275
+ "0",
276
+ "0",
277
+ "0",
278
+ "0"
279
+ ],
280
+ "salt": "0x2590434ea2d600f7bd2396ba7fa454ad4c975c29424ee481561d9786538a5e48",
281
+ "commitment": "0x54ec996599886da21c4b07c25d1de544292a8b7c38b79726995c869c9e95db"
282
+ }
283
+ }
284
+ ```
285
+
286
+ We observe an array named results, which holds the aggregated votes for each option. Each option corresponds to an index in the array. In the example above, the first option (index 0) received a total of 9 votes, while all other options received no votes
287
+
288
+ The `totalSpentVoiceCredits` object contains the total amount of voice credits spent in the poll. This is the sum of all voice credits spent by all voters, and in quadratic voting, is the sum of the squares of all votes.
289
+
290
+ The `perVOSpentVoiceCredits` will contain the amount of voice credits spent per vote option. In this case, the first option received 81 voice credits, and every other option received 0 voice credits. This is because there was only one valid vote casted, with a weight of 9. Given the quadratic voting formula, the total amount of voice credits spent is 81.
291
+
292
+ ---
293
+
294
+ That should be all for this tutorial, feel free to join [our discord](https://discord.gg/pse) for any questions or recommendations, and feel free to read [our documentation](https://maci.pse.dev/docs/introduction) for more in depth resources.
@@ -0,0 +1,112 @@
1
+ ---
2
+ slug: 2025-Roadmap
3
+ title: 2025 High Level Roadmap and recap
4
+ description: High level roadmap for 2025
5
+ authors:
6
+ name: ctrlc03
7
+ title: MACI team lead
8
+ url: https://x.com/ctrlc03
9
+ image_url: https://avatars.githubusercontent.com/u/93448202?v=4
10
+ tags: [voting, security, anonymity, roadmap, community, MACI, development]
11
+ excerpt: "High level roadmap for 2025"
12
+ ---
13
+
14
+ Greetings anon, it’s been a while.
15
+
16
+ We’re excited to share with you what we're planning to build over 2025. Yes, we know it’s already March, so let’s start with a recap of what the team has been up to in the recent months, before moving to what’s up next.
17
+
18
+ ### MACI Coordinator service
19
+
20
+ We are happy to announce that we completed the work on developing a service to automate MACI coordinator functionality. This includes:
21
+
22
+ - Contract deployment
23
+ - Subgraph deploying
24
+ - Proof generation
25
+ - Proof and results submission
26
+
27
+ This server exposes a REST API, as well as some Websocket endpoints (for proof generation only). We soon will publish a detailed guide on how to use, and how to integrate it via its SDK -stay tuned for a separate blog post.
28
+
29
+ For anyone interested in the code, you can find it [here](https://github.com/privacy-scaling-explorations/maci/tree/main/apps/coordinator).
30
+
31
+ ### MACI Offchain voting support
32
+
33
+ After [Vitalik’s post](https://ethresear.ch/t/maci-with-mostly-off-chain-happy-path/19527) original idea, the team worked on an implementation of offchain voting for MACI. This comes in the form of a relayer service, which can be run by the coordinator to support offchain vote submission, effectively reducing the cost for users to only the signup transaction.
34
+
35
+ In the future we plan to research how to extend support to signups too.
36
+
37
+ In a nutshell, the service exposes a REST API that allows voters to submit MACI messages, they only need to prove that they are signed up by posting a zk proof to avoid spam on the service. The coordinator will wait for batches of n messages to be collected, then post the hashes of the messages to the Poll smart contract, alongside an IPFS hash where these messages are stored. This allows to keep costs down for coordinators, as they would only need to post the message hashes compared to relaying message by message and hashing them on-chain. At the same time, users can vote for free, and if they do believe they have been censored, for instance they do not see their vote on the IPFS file, they can go directly on-chain and use MACI as normal.
38
+
39
+ It should be noted that at this time, using this feature might result in failure if either of the two are true:
40
+
41
+ - The coordinator calls relayMessagesBatch with invalid message hashes (there is no corresponding message on IPFS or local relayer storage)
42
+ - The coordinator posts message hashes on chain before they are stored on IPFS and local storage is lost
43
+
44
+ While both of these result in a liveness issue, MACI does not provide liveness guarantees either way, as in its current form the coordinator could choose to not complete a poll, and no one else would be able to process votes on their behalf. We will be looking to improve on this guarantees in out future work.
45
+
46
+ ### MACI v3
47
+
48
+ We are very close to completing a new version of MACI - v3. This new version comes with features that have been requested in the past, such as polls being more customisable, in terms of voice credits assigned to voters, and gatekeeping mechanisms.
49
+
50
+ At a high level, the new features/improvements are:
51
+
52
+ 1. Custom voice credits per poll
53
+ 2. Custom gatekeeping per poll
54
+ 3. Replacement of vote merkle trees for more efficient hash-chains
55
+
56
+ Up until now, MACI has not prioritised reusability of the smart contracts. More often than not, production votes using MACI relied on deploying new instances of the main MACI smart contract, resulting in users joining with a new set of keys every time. This by consequence results in these keys not holding more value than a single vote, thus enabling key selling. With this new version, we envision a single MACI smart contract to be the entry point for several polls, where voters are “forced” to signup to individual polls with the same key that they used to signup to the main smart contract. In production use cases, this could be follow this script:
57
+
58
+ 1. The main MACI contract is set to gatekeep access using a very strong sybil mechanism, such as proof of passport
59
+ 2. Users signup by proving they are human
60
+ 3. For each poll that is created, voters can join with the same key if they wish to participate and if they can pass the specific poll gatekeeping requirements. For instance a specific poll might allow only Indian voters, thus use a Anon Adhaar policy to gate access
61
+
62
+ ### User research
63
+
64
+ In order to inform MACI’s future roadmap and which use cases to tackle, we started to conduct user research. MACI has been historically used only in public goods funding, via protocols such as [clr.fund](https://clr.fund), [QFI](https://github.com/quadratic-gardens/qfi), [Gitcoin’s Allo stack](https://github.com/gitcoinco/MACI_QF), and [MACI Platform](https://github.com/privacy-scaling-explorations/maci-platform). As we see a diminished interest and need for private voting in public goods funding, we decided to focus on a new use case which clearly has a larger demand for MACI - governance.
65
+
66
+ While still in the early discovery phase, we identified demand for MACI to be integrated into DAO governance protocol stacks like [Aragon’s OSX](https://github.com/aragon/osx) in the form of a plugin. We are aiming to build a [demo plugin](https://github.com/privacy-scaling-explorations/maci-voting-plugin) and showcase it to Aragon in the coming months.
67
+
68
+ We hope to partner with several governance providers to enhance your voting offerings through modules/plugins.
69
+
70
+ ## 2025 - What will we focus the rest of the year
71
+
72
+ For this year, we plan to tackle a few different epics:
73
+
74
+ 1. Release of MACI v3
75
+ 2. Begin work to decentralize the coordinator using either homomorphic encryption or collaborative SNARKs
76
+ 3. Integrate MACI into Aragon OSX’s stack
77
+ 4. Continue with user research
78
+
79
+ **MACI v3**
80
+
81
+ We have just talked about MACI v3, so what is left to add is that we will be looking to complete the documentation updates, clean up the code and release it as soon as possible. Get ready for an even better version of MACI, and please reach out if you would like to integrate v3, we are here to support.
82
+
83
+ **What about coordinator decentralisation?**
84
+
85
+ That sounds interesting.. Let’s talk about that.
86
+
87
+ One of MACI long standing issues has been the privileges that the coordinator role has. They are able to see all of the votes in cleartext, which allows them to collude with bribers themselves, as well as voters. As we look to tackle use cases such as DAO governance where lot of money is involved in proposals, we need to ensure that collusion between the coordinator and voters/bribers is reduced. This can be accomplished in several ways:
88
+
89
+ - Use Multi Party Computation (MPC)
90
+ - Use Homomorphic Encryption (HE)
91
+ - Use a Trusted Execution Environment (TEE)
92
+
93
+ Without going into much details here (keep an eye out for a separate post), to actually decentralise the coordinator role we will need either MPC (in the forms of co-SNARKs) or HE. The team is researching the available technologies to come up with a proposal on how to tackle this problem. We are very excited to improve MACI’s security and bring an even better primitive to projects that want private and secure voting.
94
+
95
+ **Integrating MACI into the Aragon OSX stack**
96
+
97
+ After some discussion with Aragon, we decided to build a demo to showcase how MACI could be used in DAOs created using [Aragon’s](https://www.aragon.org/) OSX stack.
98
+
99
+ The goal is to get a working demo in the coming months that allow to create new voting proposals where DAO token holders can vote Yes, No, or Abstain. At this time, we will be making a very simple integration, and in the future we plan to integrate some features into the MACI protocol which would make it more suited for DAO governance, such as:
100
+
101
+ - Have a custom type of polls where one can only vote with all of their voting power (currently there is no option to restrict this and voters can allocate their voting power as they prefer across several available options)
102
+ - Count the number of votes for each option (currently this is not possible, the coordinator would need to provide this information, without a way to prove its correctness)
103
+
104
+ Once the demo is out and some DAOs test it out, we look forward to preparing this to be production ready and target running some DAO voting, from a supportive perspective.
105
+
106
+ You can track progress of development on this [repo](https://github.com/privacy-scaling-explorations/maci-voting-plugin).
107
+
108
+ **Continue with user research**
109
+
110
+ While we have identified a new use case to tackle, governance, we still want to continue speaking with different projects and individuals to learn even more where can provide value in the short, and long term.
111
+
112
+ We have identified some projects that we want to chat with, however are open to suggestion - know anyone that is interested in private and anti collusion voting? Introduce them to us to help us understand how we can help democracy thrive.
@@ -0,0 +1,107 @@
1
+ ---
2
+ slug: maci-aragon-plugin
3
+ title: MACI Aragon Plugin
4
+ description: A MACI plugin for Aragon OSx to enable private voting in DAOs
5
+ authors:
6
+ - name: ctrlc03
7
+ title: MACI former team lead
8
+ url: https://x.com/ctrlc03
9
+ image_url: https://avatars.githubusercontent.com/u/93448202?v=4
10
+ - name: John Guilding
11
+ title: MACI team lead
12
+ url: https://x.com/john_guilding
13
+ image_url: https://pbs.twimg.com/profile_images/1629144990914945024/C6_xsK78_400x400.jpg
14
+ - name: NicoSerranoP
15
+ title: MACI team member
16
+ url: https://x.com/NicoSerranoP
17
+ image_url: https://avatars.githubusercontent.com/u/38594836?v=4
18
+ tags: [voting, security, anonymity, Aragon, MACI, development]
19
+ excerpt: "A MACI plugin for Aragon OSx to enable private voting in DAOs"
20
+ ---
21
+
22
+ Hey Anon,
23
+
24
+ Welcome to another MACI blogpost. Today we are going to be looking at a voting plugin we have been developing to work with the [Aragon OSx stack](https://www.aragon.org/osx).
25
+
26
+ As mentioned in our [latest roadmap blog post](https://maci.pse.dev/blog/2025-Roadmap#2025---what-will-we-focus-the-rest-of-the-year), our team decided to focus on supporting governance projects by integrating with tooling providers such as [Aragon](https://www.aragon.org/). Look out for further announcements over the next month. We're working on some exciting additions to the roadmap to accelerate private governance on Ethereum.
27
+
28
+ So why integrate MACI with Aragon OSx? Our thesis is simple: \***\*private voting will increase voter participation and protect those voting. It will also lead to more honest and accurate outcomes as people can vote more honestly.\*\***
29
+
30
+ Current public voting systems create barriers to honest participation. Voters face social pressure, fear of retaliation, and concerns about how their choices might affect future opportunities. Private voting removes these barriers, enabling DAOs to capture the true preferences of their communities.
31
+
32
+ We chose to integrate with Aragon because their OSx platform provides an excellent foundation for custom DAO governance, and as a reputable team building in the open, they're the perfect partner for this integration.
33
+
34
+ ### The real cost of public voting
35
+
36
+ While transparency is often celebrated in crypto, public voting creates serious barriers to honest participation that threaten the legitimacy of DAO governance.
37
+
38
+ **Fear of retaliation keeps voters silent.** Large token holders can pressure smaller voters by threatening to exclude them from future opportunities, airdrops, or partnerships. When voting records are public, retaliation becomes easy to execute, leading many to abstain rather than risk consequences.
39
+
40
+ **Social pressure distorts genuine preferences.** Voters often wait to see how others vote before casting their own ballot, leading to herding behavior that doesn't reflect genuine preferences. Some even [say](https://x.com/LefterisJP/status/1921562225333916094) governance voting has devolved into a game of politics. The "follow the whale" mentality and politics involved undermine the democratic ideals DAOs strive for.
41
+
42
+ **Vote verification enables problematic markets.** When votes are public, it also creates conditions where governance power can be openly [traded](https://www.tronweekly.com/arbitrum-vote-buying-scandal-how-5-eth-shook/), as buyers can verify they received what they paid for.
43
+
44
+ **Public real time results can enable whales intervention.** If the votes are public and visible in real time while the voting period is happening, whales (or users through token loans) could influence the decision by using their voting power to overpower the community decision.
45
+
46
+ ### Why MACI
47
+
48
+ MACI (Minimal Anti Collusion Infrastructure) is a private voting protocol that aims to reduce collusion and coercion with receipt freeness - this makes it the logical next step for DAOs that really care about the problems highlighted above.
49
+
50
+ In more detail, every vote is encrypted and can only be decrypted for tallying, by a trusted entity referred to as the coordinator. Voters can override their votes at any point during the voting period, and thus without a clear receipt for their vote, they are not able to prove beyond reasonable doubt that they actually voted for an option. This discourages bribers from buying votes and other voters from attempting to collude.
51
+
52
+ While the coordinator can decrypt votes, they cannot produce an incorrect tally or censor votes, thanks to zero knowledge proofs and smart contracts.
53
+
54
+ For more details about MACI and how it works, we recommend reading our other blogposts such as this introductory [article](https://maci.pse.dev/blog/maci-for-beginners) and our comprehensive documentation [website](https://maci.pse.dev/docs/introduction).
55
+
56
+ ### How does Aragon OSx work
57
+
58
+ Aragon OSx is a smart contract framework that works on EVM compatible chains. DAOs can easily deploy custom governance stacks using Aragon OSx, and can benefit from several plugins to extend their functionality over time. This plugin architecture allows DAOs to customise their governance without rebuilding from scratch.
59
+
60
+ A plugin is a smart contract with custom governance logic, limited in scope, and with single-purpose logic that can be used to extend OSx-based organisations. Examples include [token voting](https://docs.aragon.org/token-voting/1.x/index.html) and [multisig](https://docs.aragon.org/multisig/1.x/index.html), and now.. privacy-preserving voting through MACI.
61
+
62
+ ### How does the MACI plugin work
63
+
64
+ The plugin allows DAO members to create new proposals by calling a smart contract function: `createProposal`. The function checks that the caller has enough governance tokens - this minimum amount is set by the DAO at deployment time. The plugin creates a new MACI poll that hosts the encrypted private votes for that particular proposal.
65
+
66
+ The plugin then captures the current block number (minus one) as a snapshot to determine voter eligibility. Once they decide to vote, they can register their interest to vote via their DAO frontend (in MACI's context we call this process _join a poll_), and their voting power is determined by their token balance at the time of proposal creation. Voters can use their real wallet holding their tokens to register themselves by publishing a MACI public key created on their devices. After that, the voter can use any wallet to submit an encrypted message containing the registered public key and their selected option.
67
+
68
+ Voters are then able to vote using their full voting power by choosing one of the options available, which at this time are Yes, No or Abstain. Voting is completely handled by MACI’s smart contracts, therefore voters do not actually ever interact with the DAO plugin.
69
+
70
+ Once the proposal ends, MACI’s backend service (the [coordinator service](https://github.com/privacy-scaling-explorations/maci/tree/dev/apps/coordinator)), starts processing the votes, and generate zk-SNARK proofs to be validated on chain. Voters can be sure of the correct execution thanks to those proofs verifying on chain. Finally, the results are uploaded and the proposal execution can be triggered.
71
+
72
+ The full flow can be observed in the diagram below:
73
+
74
+ ![new-flow-maci](https://hackmd.io/_uploads/Sktza18Xge.png)
75
+
76
+ A proposal execution can range from transferring funds, calling a function on the DAO smart contract itself, calling out an external contract (for instance to initiate a token swap), or setting up a new plugin.
77
+
78
+ An example proposal shown below, with a proposal requesting users to vote on whether they are happy to convert part of the DAOs USDC reserves to ETH.
79
+
80
+ ![dao1](https://hackmd.io/_uploads/rk7C3dHXll.png)
81
+
82
+ The familiar voting interface makes privacy seamless - voters simply select their choice without needing to understand the cryptography running behind the scenes.
83
+
84
+ ![voting1](https://hackmd.io/_uploads/H1TR3OHXxg.png)
85
+
86
+ ### Implementation Considerations
87
+
88
+ - **Network Support:** Currently compatible with all EVM chains such as Ethereum, Arbitrum, Optimism, and some zkEVM networks such as Scroll and Linea. [Here](https://maci.pse.dev/docs/supported-networks/) is a list of all compatible networks.
89
+ - **Timeline:** Vote processing is not immediate due to the need to process votes offchain and to generate zk-SNARK proofs of correct execution. The time it takes to process votes can be reduced by using more powerful hardware.
90
+ - **Reliance on trusted coordinator:** MACI in its current form relies on a trusted coordinator entity which can decrypt the votes - this is an automated piece of software that can run on a server or a Trusted Execution Environment for more security. The team is working on decentralising the coordinator entity and will soon begin working on an upgraded version that uses homomorphic encryption and threshold encryption to distribute the responsibilities across multiple entities. Please note that while the coordinator can see the votes, they cannot censor users nor provide incorrect results.
91
+ - **Costs:** Using MACI can be more costly than traditional blockchain-based voting. While these costs are negligible in layer 2 networks, costs can increase in Ethereum mainnet. Please refer to our [costs](https://maci.pse.dev/docs/supported-networks/costs) section in the documentation website for more details on current benchmarks.
92
+
93
+ ### Next steps
94
+
95
+ As DAOs evolve from experimental communities to serious organisations managing significant resources, governance systems must evolve too. The current landscape presents an ideal opportunity for DAOs to pioneer MACI, thus we are looking for forward-thinking DAOs to pilot MACI’s governance plugin - especially those facing challenges around voter participation, sensitive decision-making, or community pressure. Ready to be among the first? Reach out at [maci@pse.dev](mailto:maci@pse.dev) or join our [Discord](https://discord.com/invite/sF5CT5rzrR). Governance on Ethereum needs a privacy shake up, stay in the loop if you're interested in hearing what else the team has been working on.
96
+
97
+ ### References and resources
98
+
99
+ - [MACI repo](https://github.com/privacy-scaling-explorations/maci)
100
+ - [MACI voting plugin](https://github.com/privacy-scaling-explorations/maci-voting-plugin-aragon)
101
+ - [MACI -Aragon sample frontend](https://github.com/privacy-scaling-explorations/maci-aragon-osx-gov-app)
102
+ - [Aragon OSx](https://github.com/aragon/osx)
103
+ - [Aragon docs](https://docs.aragon.org/)
104
+
105
+ ## Acknowledgements
106
+
107
+ Thanks to the Aragon team for review.