@maci-protocol/website 0.0.0-ci.26f28d6

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 (406) hide show
  1. package/.eslintrc.js +157 -0
  2. package/CHANGELOG.md +566 -0
  3. package/LICENSE +22 -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/assets/MACI_Bob_SignUp_1.png +0 -0
  27. package/blog/assets/MACI_Bob_SignUp_2.png +0 -0
  28. package/blog/assets/MACI_Complex_Message.png +0 -0
  29. package/blog/assets/MACI_Contracts.png +0 -0
  30. package/blog/assets/MACI_Sign_Up.png +0 -0
  31. package/blog/assets/MACI_Simple_Message.png +0 -0
  32. package/blog/assets/MACI_Verifier_1.png +0 -0
  33. package/blog/authors.yml +5 -0
  34. package/docusaurus.config.ts +213 -0
  35. package/package.json +65 -0
  36. package/src/components/ActionCard/index.tsx +30 -0
  37. package/src/components/ActionCard/styles.module.css +96 -0
  38. package/src/components/HomepageFeatures/index.tsx +91 -0
  39. package/src/components/HomepageFeatures/styles.module.css +17 -0
  40. package/src/components/ProjectCard/index.tsx +74 -0
  41. package/src/components/ProjectCard/styles.module.css +77 -0
  42. package/src/components/ProjectList/index.tsx +218 -0
  43. package/src/components/ProjectList/styles.module.css +180 -0
  44. package/src/content/projects.json +294 -0
  45. package/src/css/card.module.css +130 -0
  46. package/src/css/custom.css +91 -0
  47. package/src/icons/IconDiscord.tsx +16 -0
  48. package/src/icons/IconGithub.tsx +16 -0
  49. package/src/icons/IconWebsite.tsx +16 -0
  50. package/src/pages/blogs.tsx +58 -0
  51. package/src/pages/index.module.css +152 -0
  52. package/src/pages/index.tsx +66 -0
  53. package/src/pages/projects.tsx +44 -0
  54. package/src/pages/roadmap.md +150 -0
  55. package/src/pages/typedoc.tsx +11 -0
  56. package/src/plugins/blog-plugin/index.ts +86 -0
  57. package/src/react-app-env.d.ts +1 -0
  58. package/src/scripts/setupSolidityDocs.ts +67 -0
  59. package/src/scripts/setupTypedoc.ts +112 -0
  60. package/src/scripts/utils.ts +115 -0
  61. package/src/utils/getProjectsByFilter.ts +40 -0
  62. package/static/.nojekyll +0 -0
  63. package/static/audit_reports/20210922_Hashcloak_audit_report.pdf +0 -0
  64. package/static/audit_reports/202220930_Hashcloak_audit_report.pdf +0 -0
  65. package/static/audit_reports/20240223_PSE_Audit_audit_report.pdf +0 -0
  66. package/static/audit_reports/20240731_PSE_Audit_audit_report.pdf +0 -0
  67. package/static/fonts/DM_Sans.woff2 +0 -0
  68. package/static/fonts/Share_Tech_Mono.woff2 +0 -0
  69. package/static/img/box.png +0 -0
  70. package/static/img/box_dark.png +0 -0
  71. package/static/img/chain.png +0 -0
  72. package/static/img/chain_dark.png +0 -0
  73. package/static/img/chart.png +0 -0
  74. package/static/img/chart_dark.png +0 -0
  75. package/static/img/circuits/MACI-Circuits.excalidraw +39652 -0
  76. package/static/img/circuits/calculateTotal.svg +21 -0
  77. package/static/img/circuits/ecdh.svg +21 -0
  78. package/static/img/circuits/messageToCommand.svg +21 -0
  79. package/static/img/circuits/messageValidator.svg +21 -0
  80. package/static/img/circuits/poseidonHasher13.svg +21 -0
  81. package/static/img/circuits/privToPubkey.svg +21 -0
  82. package/static/img/circuits/processMessages.svg +21 -0
  83. package/static/img/circuits/processMessagesInputHasher.svg +21 -0
  84. package/static/img/circuits/processMessages_2_0.svg +21 -0
  85. package/static/img/circuits/processOne.svg +21 -0
  86. package/static/img/circuits/processTopup.svg +21 -0
  87. package/static/img/circuits/processingAfterPollEnds.svg +21 -0
  88. package/static/img/circuits/quinBatchLeavesExists.svg +21 -0
  89. package/static/img/circuits/quinCheckRoot.svg +21 -0
  90. package/static/img/circuits/quinGeneratePathIndices.svg +21 -0
  91. package/static/img/circuits/quinSelector.svg +21 -0
  92. package/static/img/circuits/resultsCommitmentVerifier.svg +21 -0
  93. package/static/img/circuits/splicer.svg +21 -0
  94. package/static/img/circuits/tallyInputHasher.svg +21 -0
  95. package/static/img/circuits/tallyVotes.svg +21 -0
  96. package/static/img/circuits/unpackElement.svg +21 -0
  97. package/static/img/circuits/verifySignature.svg +21 -0
  98. package/static/img/completingAPoll.svg +4 -0
  99. package/static/img/contracts.svg +16 -0
  100. package/static/img/coordinatorComponents.svg +21 -0
  101. package/static/img/favicon.ico +0 -0
  102. package/static/img/generateProofs.svg +4 -0
  103. package/static/img/hero.svg +9 -0
  104. package/static/img/maci-card.png +0 -0
  105. package/static/img/maci-rpgf-design.jpg +0 -0
  106. package/static/img/messageProcessingLocal.svg +21 -0
  107. package/static/img/offlineProcessing.svg +21 -0
  108. package/static/img/pse-logo-round.png +0 -0
  109. package/static/img/tallyCommitments.svg +4 -0
  110. package/static/img/voteTallyingLocal.svg +21 -0
  111. package/tsconfig.json +34 -0
  112. package/versioned_docs/version-v0.x/circuits.md +22 -0
  113. package/versioned_docs/version-v0.x/contract.md +186 -0
  114. package/versioned_docs/version-v0.x/faq.md +67 -0
  115. package/versioned_docs/version-v0.x/introduction.md +119 -0
  116. package/versioned_docs/version-v0.x/quadratic-vote-tallying-circuit.md +138 -0
  117. package/versioned_docs/version-v0.x/state-root-transition-circuit.md +230 -0
  118. package/versioned_docs/version-v1.2/audit.md +160 -0
  119. package/versioned_docs/version-v1.2/ci-pipeline.md +38 -0
  120. package/versioned_docs/version-v1.2/circuits.md +508 -0
  121. package/versioned_docs/version-v1.2/cli.md +689 -0
  122. package/versioned_docs/version-v1.2/contracts.md +445 -0
  123. package/versioned_docs/version-v1.2/contributing/code-of-conduct.md +91 -0
  124. package/versioned_docs/version-v1.2/contributing/contributing.md +129 -0
  125. package/versioned_docs/version-v1.2/coordinator-processing.md +46 -0
  126. package/versioned_docs/version-v1.2/deployment.md +122 -0
  127. package/versioned_docs/version-v1.2/installation.md +175 -0
  128. package/versioned_docs/version-v1.2/integrating.md +200 -0
  129. package/versioned_docs/version-v1.2/introduction.md +94 -0
  130. package/versioned_docs/version-v1.2/key-change.md +182 -0
  131. package/versioned_docs/version-v1.2/overview.md +47 -0
  132. package/versioned_docs/version-v1.2/poll-types.md +68 -0
  133. package/versioned_docs/version-v1.2/primitives.md +216 -0
  134. package/versioned_docs/version-v1.2/project-ideas.md +14 -0
  135. package/versioned_docs/version-v1.2/purpose.md +62 -0
  136. package/versioned_docs/version-v1.2/solidity-docs/MACI.md +345 -0
  137. package/versioned_docs/version-v1.2/solidity-docs/MessageProcessor.md +266 -0
  138. package/versioned_docs/version-v1.2/solidity-docs/MessageProcessorFactory.md +26 -0
  139. package/versioned_docs/version-v1.2/solidity-docs/Poll.md +381 -0
  140. package/versioned_docs/version-v1.2/solidity-docs/PollFactory.md +50 -0
  141. package/versioned_docs/version-v1.2/solidity-docs/SignUpToken.md +27 -0
  142. package/versioned_docs/version-v1.2/solidity-docs/Subsidy.md +218 -0
  143. package/versioned_docs/version-v1.2/solidity-docs/SubsidyFactory.md +27 -0
  144. package/versioned_docs/version-v1.2/solidity-docs/Tally.md +311 -0
  145. package/versioned_docs/version-v1.2/solidity-docs/TallyFactory.md +27 -0
  146. package/versioned_docs/version-v1.2/solidity-docs/TallyNonQv.md +296 -0
  147. package/versioned_docs/version-v1.2/solidity-docs/TallyNonQvFactory.md +27 -0
  148. package/versioned_docs/version-v1.2/solidity-docs/TopupCredit.md +61 -0
  149. package/versioned_docs/version-v1.2/solidity-docs/VkRegistry.md +457 -0
  150. package/versioned_docs/version-v1.2/solidity-docs/benchmarks/HasherBenchmarks.md +44 -0
  151. package/versioned_docs/version-v1.2/solidity-docs/crypto/Hasher.md +125 -0
  152. package/versioned_docs/version-v1.2/solidity-docs/crypto/IVerifier.md +11 -0
  153. package/versioned_docs/version-v1.2/solidity-docs/crypto/MockVerifier.md +17 -0
  154. package/versioned_docs/version-v1.2/solidity-docs/crypto/Pairing.md +85 -0
  155. package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT3.md +9 -0
  156. package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT4.md +9 -0
  157. package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT5.md +9 -0
  158. package/versioned_docs/version-v1.2/solidity-docs/crypto/PoseidonT6.md +9 -0
  159. package/versioned_docs/version-v1.2/solidity-docs/crypto/SnarkCommon.md +16 -0
  160. package/versioned_docs/version-v1.2/solidity-docs/crypto/SnarkConstants.md +40 -0
  161. package/versioned_docs/version-v1.2/solidity-docs/crypto/Verifier.md +61 -0
  162. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/EASGatekeeper.md +121 -0
  163. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/FreeForAllSignUpGatekeeper.md +40 -0
  164. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/SignUpGatekeeper.md +26 -0
  165. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/SignUpTokenGatekeeper.md +93 -0
  166. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/hatsGatekeepers/HatsGatekeeperBase.md +79 -0
  167. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/hatsGatekeepers/HatsGatekeeperMultiple.md +48 -0
  168. package/versioned_docs/version-v1.2/solidity-docs/gatekeepers/hatsGatekeepers/HatsGatekeeperSingle.md +42 -0
  169. package/versioned_docs/version-v1.2/solidity-docs/index.md +4 -0
  170. package/versioned_docs/version-v1.2/solidity-docs/initialVoiceCreditProxy/ConstantInitialVoiceCreditProxy.md +40 -0
  171. package/versioned_docs/version-v1.2/solidity-docs/initialVoiceCreditProxy/InitialVoiceCreditProxy.md +26 -0
  172. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IEAS.md +40 -0
  173. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IHats.md +103 -0
  174. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IMPFactory.md +26 -0
  175. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IMessageProcessor.md +31 -0
  176. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IPoll.md +217 -0
  177. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IPollFactory.md +29 -0
  178. package/versioned_docs/version-v1.2/solidity-docs/interfaces/ITallyFactory.md +28 -0
  179. package/versioned_docs/version-v1.2/solidity-docs/interfaces/ITallySubsidyFactory.md +27 -0
  180. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IVerifier.md +25 -0
  181. package/versioned_docs/version-v1.2/solidity-docs/interfaces/IVkRegistry.md +70 -0
  182. package/versioned_docs/version-v1.2/solidity-docs/mocks/MockHatsProtocol.md +133 -0
  183. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueue.md +464 -0
  184. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueBinary.md +60 -0
  185. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueBinary0.md +40 -0
  186. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueBinaryMaci.md +34 -0
  187. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinary.md +75 -0
  188. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinary0.md +40 -0
  189. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinaryBlankSl.md +40 -0
  190. package/versioned_docs/version-v1.2/solidity-docs/trees/AccQueueQuinaryMaci.md +40 -0
  191. package/versioned_docs/version-v1.2/solidity-docs/trees/EmptyBallotRoots.md +13 -0
  192. package/versioned_docs/version-v1.2/solidity-docs/utilities/CommonUtilities.md +25 -0
  193. package/versioned_docs/version-v1.2/solidity-docs/utilities/DomainObjs.md +40 -0
  194. package/versioned_docs/version-v1.2/solidity-docs/utilities/Params.md +36 -0
  195. package/versioned_docs/version-v1.2/solidity-docs/utilities/Utilities.md +79 -0
  196. package/versioned_docs/version-v1.2/spec.md +944 -0
  197. package/versioned_docs/version-v1.2/testing-in-detail.md +209 -0
  198. package/versioned_docs/version-v1.2/testing.md +472 -0
  199. package/versioned_docs/version-v1.2/topup.md +43 -0
  200. package/versioned_docs/version-v1.2/troubleshooting.md +51 -0
  201. package/versioned_docs/version-v1.2/trusted-setup.md +76 -0
  202. package/versioned_docs/version-v1.2/typedoc/cli/.nojekyll +1 -0
  203. package/versioned_docs/version-v1.2/typedoc/cli/index.md +15 -0
  204. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/AirdropArgs.md +89 -0
  205. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/DeployArgs.md +154 -0
  206. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/DeployPollArgs.md +154 -0
  207. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/DeployedContracts.md +130 -0
  208. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/GenLocalStateArgs.md +168 -0
  209. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/GenProofsArgs.md +388 -0
  210. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/IGenKeypairArgs.md +37 -0
  211. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/IRegisteredUserArgs.md +63 -0
  212. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/MergeMessagesArgs.md +76 -0
  213. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/MergeSignupsArgs.md +76 -0
  214. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/PollContracts.md +53 -0
  215. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/ProveOnChainArgs.md +128 -0
  216. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/PublishArgs.md +154 -0
  217. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/SignupArgs.md +89 -0
  218. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/SubsidyData.md +73 -0
  219. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/TallyData.md +166 -0
  220. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/TopupArgs.md +89 -0
  221. package/versioned_docs/version-v1.2/typedoc/cli/interfaces/VerifyArgs.md +128 -0
  222. package/versioned_docs/version-v1.2/typedoc/cli/modules.md +556 -0
  223. package/versioned_docs/version-v1.2/typedoc/core/.nojekyll +1 -0
  224. package/versioned_docs/version-v1.2/typedoc/core/classes/MaciState.md +295 -0
  225. package/versioned_docs/version-v1.2/typedoc/core/classes/Poll.md +1098 -0
  226. package/versioned_docs/version-v1.2/typedoc/core/index.md +110 -0
  227. package/versioned_docs/version-v1.2/typedoc/core/interfaces/BatchSizes.md +50 -0
  228. package/versioned_docs/version-v1.2/typedoc/core/interfaces/IJsonMaciState.md +77 -0
  229. package/versioned_docs/version-v1.2/typedoc/core/interfaces/IProcessMessagesCircuitInputs.md +242 -0
  230. package/versioned_docs/version-v1.2/typedoc/core/interfaces/ISubsidyCircuitInputs.md +198 -0
  231. package/versioned_docs/version-v1.2/typedoc/core/interfaces/ITallyCircuitInputs.md +231 -0
  232. package/versioned_docs/version-v1.2/typedoc/core/interfaces/MaxValues.md +37 -0
  233. package/versioned_docs/version-v1.2/typedoc/core/interfaces/TreeDepths.md +63 -0
  234. package/versioned_docs/version-v1.2/typedoc/core/modules.md +289 -0
  235. package/versioned_docs/version-v1.2/typedoc/crypto/.nojekyll +1 -0
  236. package/versioned_docs/version-v1.2/typedoc/crypto/classes/AccQueue.md +770 -0
  237. package/versioned_docs/version-v1.2/typedoc/crypto/classes/G1Point.md +115 -0
  238. package/versioned_docs/version-v1.2/typedoc/crypto/classes/G2Point.md +140 -0
  239. package/versioned_docs/version-v1.2/typedoc/crypto/classes/IncrementalQuinTree.md +470 -0
  240. package/versioned_docs/version-v1.2/typedoc/crypto/index.md +44 -0
  241. package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/Keypair.md +33 -0
  242. package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/PoseidonFuncs.md +115 -0
  243. package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/Queue.md +33 -0
  244. package/versioned_docs/version-v1.2/typedoc/crypto/interfaces/Signature.md +37 -0
  245. package/versioned_docs/version-v1.2/typedoc/crypto/modules.md +913 -0
  246. package/versioned_docs/version-v1.2/typedoc/domainobjs/.nojekyll +1 -0
  247. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/Ballot.md +274 -0
  248. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/Keypair.md +181 -0
  249. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/Message.md +244 -0
  250. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/PCommand.md +409 -0
  251. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/PrivKey.md +206 -0
  252. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/PubKey.md +289 -0
  253. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/StateLeaf.md +340 -0
  254. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/TCommand.md +200 -0
  255. package/versioned_docs/version-v1.2/typedoc/domainobjs/classes/VerifyingKey.md +240 -0
  256. package/versioned_docs/version-v1.2/typedoc/domainobjs/index.md +81 -0
  257. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/ICommand.md +104 -0
  258. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IG1ContractParams.md +31 -0
  259. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IG2ContractParams.md +31 -0
  260. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonBallot.md +42 -0
  261. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonCommand.md +32 -0
  262. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonKeyPair.md +31 -0
  263. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonPCommand.md +111 -0
  264. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonStateLeaf.md +42 -0
  265. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IJsonTCommand.md +67 -0
  266. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IMessageContractParams.md +31 -0
  267. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IStateLeaf.md +39 -0
  268. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IStateLeafContractParams.md +42 -0
  269. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IVkContractParams.md +64 -0
  270. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/IVkObjectParams.md +108 -0
  271. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/Proof.md +46 -0
  272. package/versioned_docs/version-v1.2/typedoc/domainobjs/interfaces/VoteOptionTreeLeaf.md +24 -0
  273. package/versioned_docs/version-v1.2/typedoc/domainobjs/modules.md +110 -0
  274. package/versioned_docs/version-v1.2/typedoc/index.md +4 -0
  275. package/versioned_docs/version-v1.2/versioning.md +94 -0
  276. package/versioned_docs/version-v1.2/workflow.md +142 -0
  277. package/versioned_docs/version-v2.x/case-studies.md +35 -0
  278. package/versioned_docs/version-v2.x/contributing/_category_.json +4 -0
  279. package/versioned_docs/version-v2.x/contributing/code-of-conduct.md +92 -0
  280. package/versioned_docs/version-v2.x/contributing/contributing.md +149 -0
  281. package/versioned_docs/version-v2.x/contributing/project-ideas.md +78 -0
  282. package/versioned_docs/version-v2.x/core-concepts/_category_.json +4 -0
  283. package/versioned_docs/version-v2.x/core-concepts/ballot.md +19 -0
  284. package/versioned_docs/version-v2.x/core-concepts/coordinator-processing.md +46 -0
  285. package/versioned_docs/version-v2.x/core-concepts/hashing-and-encryption.md +45 -0
  286. package/versioned_docs/version-v2.x/core-concepts/key-change.md +179 -0
  287. package/versioned_docs/version-v2.x/core-concepts/maci-keys.md +84 -0
  288. package/versioned_docs/version-v2.x/core-concepts/maci-messages.md +44 -0
  289. package/versioned_docs/version-v2.x/core-concepts/merkle-trees.md +23 -0
  290. package/versioned_docs/version-v2.x/core-concepts/poll-types.md +106 -0
  291. package/versioned_docs/version-v2.x/core-concepts/spec.md +883 -0
  292. package/versioned_docs/version-v2.x/core-concepts/state-leaf.md +42 -0
  293. package/versioned_docs/version-v2.x/core-concepts/workflow.md +142 -0
  294. package/versioned_docs/version-v2.x/getting-started.md +313 -0
  295. package/versioned_docs/version-v2.x/guides/_category_.json +4 -0
  296. package/versioned_docs/version-v2.x/guides/compile-circuits.md +163 -0
  297. package/versioned_docs/version-v2.x/guides/frontend.md +99 -0
  298. package/versioned_docs/version-v2.x/guides/integrating.md +73 -0
  299. package/versioned_docs/version-v2.x/guides/maciWrapper.md +173 -0
  300. package/versioned_docs/version-v2.x/guides/subgraph.md +79 -0
  301. package/versioned_docs/version-v2.x/guides/testing/_category_.json +4 -0
  302. package/versioned_docs/version-v2.x/guides/testing/testing-in-detail.md +203 -0
  303. package/versioned_docs/version-v2.x/guides/testing/testing.md +163 -0
  304. package/versioned_docs/version-v2.x/guides/troubleshooting.md +161 -0
  305. package/versioned_docs/version-v2.x/introduction.md +146 -0
  306. package/versioned_docs/version-v2.x/processes/_category_.json +4 -0
  307. package/versioned_docs/version-v2.x/processes/ci-pipeline.md +38 -0
  308. package/versioned_docs/version-v2.x/processes/versioning.md +94 -0
  309. package/versioned_docs/version-v2.x/resources.md +33 -0
  310. package/versioned_docs/version-v2.x/security/_category_.json +4 -0
  311. package/versioned_docs/version-v2.x/security/audit.md +167 -0
  312. package/versioned_docs/version-v2.x/security/trusted-setup.md +166 -0
  313. package/versioned_docs/version-v2.x/supported-networks/_category_.json +4 -0
  314. package/versioned_docs/version-v2.x/supported-networks/deployed-contracts.md +1108 -0
  315. package/versioned_docs/version-v2.x/supported-networks/supported-networks.md +47 -0
  316. package/versioned_docs/version-v2.x/technical-references/_category_.json +4 -0
  317. package/versioned_docs/version-v2.x/technical-references/smart-contracts/AccQueue.md +21 -0
  318. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Gatekeepers.md +40 -0
  319. package/versioned_docs/version-v2.x/technical-references/smart-contracts/MACI.md +152 -0
  320. package/versioned_docs/version-v2.x/technical-references/smart-contracts/MessageProcessor.md +13 -0
  321. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Params.md +32 -0
  322. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Poll.md +104 -0
  323. package/versioned_docs/version-v2.x/technical-references/smart-contracts/PollFactory.md +43 -0
  324. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Tally.md +45 -0
  325. package/versioned_docs/version-v2.x/technical-references/smart-contracts/VkRegistry.md +57 -0
  326. package/versioned_docs/version-v2.x/technical-references/smart-contracts/VoiceCreditProxy.md +18 -0
  327. package/versioned_docs/version-v2.x/technical-references/smart-contracts/_category_.json +8 -0
  328. package/versioned_docs/version-v2.x/technical-references/technical-references.md +47 -0
  329. package/versioned_docs/version-v2.x/technical-references/typescript-code/_category_.json +4 -0
  330. package/versioned_docs/version-v2.x/technical-references/typescript-code/cli.md +699 -0
  331. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/_category_.json +4 -0
  332. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/processMessages.md +107 -0
  333. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/setup.md +101 -0
  334. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/tallyVotes.md +79 -0
  335. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/utilities.md +131 -0
  336. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/zk-snark-circuits.md +37 -0
  337. package/versioned_docs/version-v2.x/use-cases/_category_.json +4 -0
  338. package/versioned_docs/version-v2.x/use-cases/governance.md +18 -0
  339. package/versioned_docs/version-v2.x/use-cases/polling.md +10 -0
  340. package/versioned_docs/version-v2.x/use-cases/public-goods.md +65 -0
  341. package/versioned_docs/version-v3.x/case-studies.md +35 -0
  342. package/versioned_docs/version-v3.x/contributing/_category_.json +4 -0
  343. package/versioned_docs/version-v3.x/contributing/code-of-conduct.md +92 -0
  344. package/versioned_docs/version-v3.x/contributing/contributing.md +149 -0
  345. package/versioned_docs/version-v3.x/contributing/project-ideas.md +78 -0
  346. package/versioned_docs/version-v3.x/core-concepts/_category_.json +4 -0
  347. package/versioned_docs/version-v3.x/core-concepts/ballot.md +19 -0
  348. package/versioned_docs/version-v3.x/core-concepts/coordinator-processing.md +46 -0
  349. package/versioned_docs/version-v3.x/core-concepts/hashing-and-encryption.md +45 -0
  350. package/versioned_docs/version-v3.x/core-concepts/key-change.md +179 -0
  351. package/versioned_docs/version-v3.x/core-concepts/maci-keys.md +84 -0
  352. package/versioned_docs/version-v3.x/core-concepts/maci-messages.md +44 -0
  353. package/versioned_docs/version-v3.x/core-concepts/merkle-trees.md +16 -0
  354. package/versioned_docs/version-v3.x/core-concepts/poll-types.md +58 -0
  355. package/versioned_docs/version-v3.x/core-concepts/polls.md +81 -0
  356. package/versioned_docs/version-v3.x/core-concepts/spec.md +883 -0
  357. package/versioned_docs/version-v3.x/core-concepts/state-leaf.md +42 -0
  358. package/versioned_docs/version-v3.x/core-concepts/workflow.md +143 -0
  359. package/versioned_docs/version-v3.x/guides/_category_.json +4 -0
  360. package/versioned_docs/version-v3.x/guides/compile-circuits.md +175 -0
  361. package/versioned_docs/version-v3.x/guides/integrating.md +137 -0
  362. package/versioned_docs/version-v3.x/guides/subgraph.md +79 -0
  363. package/versioned_docs/version-v3.x/guides/testing/_category_.json +4 -0
  364. package/versioned_docs/version-v3.x/guides/testing/testing-in-detail.md +191 -0
  365. package/versioned_docs/version-v3.x/guides/testing/testing-introduction.md +158 -0
  366. package/versioned_docs/version-v3.x/guides/troubleshooting.md +161 -0
  367. package/versioned_docs/version-v3.x/introduction.md +153 -0
  368. package/versioned_docs/version-v3.x/processes/_category_.json +4 -0
  369. package/versioned_docs/version-v3.x/processes/ci-pipeline.md +38 -0
  370. package/versioned_docs/version-v3.x/processes/versioning.md +94 -0
  371. package/versioned_docs/version-v3.x/quick-start.md +318 -0
  372. package/versioned_docs/version-v3.x/resources.md +33 -0
  373. package/versioned_docs/version-v3.x/security/_category_.json +4 -0
  374. package/versioned_docs/version-v3.x/security/audit.md +167 -0
  375. package/versioned_docs/version-v3.x/security/trusted-setup.md +172 -0
  376. package/versioned_docs/version-v3.x/supported-networks/_category_.json +4 -0
  377. package/versioned_docs/version-v3.x/supported-networks/deployed-contracts.md +112 -0
  378. package/versioned_docs/version-v3.x/supported-networks/supported-networks.md +53 -0
  379. package/versioned_docs/version-v3.x/technical-references/_category_.json +4 -0
  380. package/versioned_docs/version-v3.x/technical-references/smart-contracts/MACI.md +160 -0
  381. package/versioned_docs/version-v3.x/technical-references/smart-contracts/MessageProcessor.md +13 -0
  382. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Params.md +33 -0
  383. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Policies.md +39 -0
  384. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Poll.md +170 -0
  385. package/versioned_docs/version-v3.x/technical-references/smart-contracts/PollFactory.md +33 -0
  386. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Tally.md +43 -0
  387. package/versioned_docs/version-v3.x/technical-references/smart-contracts/VkRegistry.md +62 -0
  388. package/versioned_docs/version-v3.x/technical-references/smart-contracts/VoiceCreditProxy.md +18 -0
  389. package/versioned_docs/version-v3.x/technical-references/smart-contracts/_category_.json +8 -0
  390. package/versioned_docs/version-v3.x/technical-references/technical-references.md +48 -0
  391. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/_category_.json +4 -0
  392. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/joinPoll.md +53 -0
  393. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/processMessages.md +106 -0
  394. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/setup.md +96 -0
  395. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/tallyVotes.md +79 -0
  396. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/utilities.md +131 -0
  397. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/zk-snark-circuits.md +42 -0
  398. package/versioned_docs/version-v3.x/use-cases/_category_.json +4 -0
  399. package/versioned_docs/version-v3.x/use-cases/governance.md +18 -0
  400. package/versioned_docs/version-v3.x/use-cases/polling.md +10 -0
  401. package/versioned_docs/version-v3.x/use-cases/public-goods.md +65 -0
  402. package/versioned_sidebars/version-v0.x-sidebars.json +8 -0
  403. package/versioned_sidebars/version-v1.2-sidebars.json +8 -0
  404. package/versioned_sidebars/version-v2.x-sidebars.json +8 -0
  405. package/versioned_sidebars/version-v3.x-sidebars.json +8 -0
  406. package/versions.json +1 -0
@@ -0,0 +1,42 @@
1
+ ---
2
+ title: IJsonBallot
3
+ sidebar_label: IJsonBallot
4
+ ---
5
+
6
+ ## Table of contents
7
+
8
+ ### Properties
9
+
10
+ - [nonce](IJsonBallot.md#nonce)
11
+ - [voteOptionTreeDepth](IJsonBallot.md#voteoptiontreedepth)
12
+ - [votes](IJsonBallot.md#votes)
13
+
14
+ ## Properties
15
+
16
+ ### nonce
17
+
18
+ • **nonce**: `BigNumberish`
19
+
20
+ #### Defined in
21
+
22
+ [types.ts:88](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L88)
23
+
24
+ ---
25
+
26
+ ### voteOptionTreeDepth
27
+
28
+ • **voteOptionTreeDepth**: `BigNumberish`
29
+
30
+ #### Defined in
31
+
32
+ [types.ts:89](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L89)
33
+
34
+ ---
35
+
36
+ ### votes
37
+
38
+ • **votes**: `BigNumberish`[]
39
+
40
+ #### Defined in
41
+
42
+ [types.ts:87](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L87)
@@ -0,0 +1,32 @@
1
+ ---
2
+ title: IJsonCommand
3
+ sidebar_label: IJsonCommand
4
+ ---
5
+
6
+ **`Notice`**
7
+
8
+ An interface representing a generic json command
9
+
10
+ ## Hierarchy
11
+
12
+ - **`IJsonCommand`**
13
+
14
+ ↳ [`IJsonTCommand`](IJsonTCommand.md)
15
+
16
+ ↳ [`IJsonPCommand`](IJsonPCommand.md)
17
+
18
+ ## Table of contents
19
+
20
+ ### Properties
21
+
22
+ - [cmdType](IJsonCommand.md#cmdtype)
23
+
24
+ ## Properties
25
+
26
+ ### cmdType
27
+
28
+ • **cmdType**: `string`
29
+
30
+ #### Defined in
31
+
32
+ [commands/types.ts:15](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L15)
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: IJsonKeyPair
3
+ sidebar_label: IJsonKeyPair
4
+ ---
5
+
6
+ ## Table of contents
7
+
8
+ ### Properties
9
+
10
+ - [privKey](IJsonKeyPair.md#privkey)
11
+ - [pubKey](IJsonKeyPair.md#pubkey)
12
+
13
+ ## Properties
14
+
15
+ ### privKey
16
+
17
+ • **privKey**: `string`
18
+
19
+ #### Defined in
20
+
21
+ [types.ts:29](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L29)
22
+
23
+ ---
24
+
25
+ ### pubKey
26
+
27
+ • **pubKey**: `string`
28
+
29
+ #### Defined in
30
+
31
+ [types.ts:30](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L30)
@@ -0,0 +1,111 @@
1
+ ---
2
+ title: IJsonPCommand
3
+ sidebar_label: IJsonPCommand
4
+ ---
5
+
6
+ **`Notice`**
7
+
8
+ An interface representing a json P command
9
+
10
+ ## Hierarchy
11
+
12
+ - [`IJsonCommand`](IJsonCommand.md)
13
+
14
+ ↳ **`IJsonPCommand`**
15
+
16
+ ## Table of contents
17
+
18
+ ### Properties
19
+
20
+ - [cmdType](IJsonPCommand.md#cmdtype)
21
+ - [newPubKey](IJsonPCommand.md#newpubkey)
22
+ - [newVoteWeight](IJsonPCommand.md#newvoteweight)
23
+ - [nonce](IJsonPCommand.md#nonce)
24
+ - [pollId](IJsonPCommand.md#pollid)
25
+ - [salt](IJsonPCommand.md#salt)
26
+ - [stateIndex](IJsonPCommand.md#stateindex)
27
+ - [voteOptionIndex](IJsonPCommand.md#voteoptionindex)
28
+
29
+ ## Properties
30
+
31
+ ### cmdType
32
+
33
+ • **cmdType**: `string`
34
+
35
+ #### Inherited from
36
+
37
+ [IJsonCommand](IJsonCommand.md).[cmdType](IJsonCommand.md#cmdtype)
38
+
39
+ #### Defined in
40
+
41
+ [commands/types.ts:15](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L15)
42
+
43
+ ---
44
+
45
+ ### newPubKey
46
+
47
+ • **newPubKey**: `string`
48
+
49
+ #### Defined in
50
+
51
+ [commands/types.ts:32](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L32)
52
+
53
+ ---
54
+
55
+ ### newVoteWeight
56
+
57
+ • **newVoteWeight**: `string`
58
+
59
+ #### Defined in
60
+
61
+ [commands/types.ts:34](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L34)
62
+
63
+ ---
64
+
65
+ ### nonce
66
+
67
+ • **nonce**: `string`
68
+
69
+ #### Defined in
70
+
71
+ [commands/types.ts:35](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L35)
72
+
73
+ ---
74
+
75
+ ### pollId
76
+
77
+ • **pollId**: `string`
78
+
79
+ #### Defined in
80
+
81
+ [commands/types.ts:36](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L36)
82
+
83
+ ---
84
+
85
+ ### salt
86
+
87
+ • **salt**: `string`
88
+
89
+ #### Defined in
90
+
91
+ [commands/types.ts:37](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L37)
92
+
93
+ ---
94
+
95
+ ### stateIndex
96
+
97
+ • **stateIndex**: `string`
98
+
99
+ #### Defined in
100
+
101
+ [commands/types.ts:31](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L31)
102
+
103
+ ---
104
+
105
+ ### voteOptionIndex
106
+
107
+ • **voteOptionIndex**: `string`
108
+
109
+ #### Defined in
110
+
111
+ [commands/types.ts:33](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L33)
@@ -0,0 +1,42 @@
1
+ ---
2
+ title: IJsonStateLeaf
3
+ sidebar_label: IJsonStateLeaf
4
+ ---
5
+
6
+ ## Table of contents
7
+
8
+ ### Properties
9
+
10
+ - [pubKey](IJsonStateLeaf.md#pubkey)
11
+ - [timestamp](IJsonStateLeaf.md#timestamp)
12
+ - [voiceCreditBalance](IJsonStateLeaf.md#voicecreditbalance)
13
+
14
+ ## Properties
15
+
16
+ ### pubKey
17
+
18
+ • **pubKey**: `string`
19
+
20
+ #### Defined in
21
+
22
+ [types.ts:38](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L38)
23
+
24
+ ---
25
+
26
+ ### timestamp
27
+
28
+ • **timestamp**: `string`
29
+
30
+ #### Defined in
31
+
32
+ [types.ts:40](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L40)
33
+
34
+ ---
35
+
36
+ ### voiceCreditBalance
37
+
38
+ • **voiceCreditBalance**: `string`
39
+
40
+ #### Defined in
41
+
42
+ [types.ts:39](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L39)
@@ -0,0 +1,67 @@
1
+ ---
2
+ title: IJsonTCommand
3
+ sidebar_label: IJsonTCommand
4
+ ---
5
+
6
+ **`Notice`**
7
+
8
+ An interface representing a json T command
9
+
10
+ ## Hierarchy
11
+
12
+ - [`IJsonCommand`](IJsonCommand.md)
13
+
14
+ ↳ **`IJsonTCommand`**
15
+
16
+ ## Table of contents
17
+
18
+ ### Properties
19
+
20
+ - [amount](IJsonTCommand.md#amount)
21
+ - [cmdType](IJsonTCommand.md#cmdtype)
22
+ - [pollId](IJsonTCommand.md#pollid)
23
+ - [stateIndex](IJsonTCommand.md#stateindex)
24
+
25
+ ## Properties
26
+
27
+ ### amount
28
+
29
+ • **amount**: `string`
30
+
31
+ #### Defined in
32
+
33
+ [commands/types.ts:23](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L23)
34
+
35
+ ---
36
+
37
+ ### cmdType
38
+
39
+ • **cmdType**: `string`
40
+
41
+ #### Inherited from
42
+
43
+ [IJsonCommand](IJsonCommand.md).[cmdType](IJsonCommand.md#cmdtype)
44
+
45
+ #### Defined in
46
+
47
+ [commands/types.ts:15](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L15)
48
+
49
+ ---
50
+
51
+ ### pollId
52
+
53
+ • **pollId**: `string`
54
+
55
+ #### Defined in
56
+
57
+ [commands/types.ts:24](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L24)
58
+
59
+ ---
60
+
61
+ ### stateIndex
62
+
63
+ • **stateIndex**: `string`
64
+
65
+ #### Defined in
66
+
67
+ [commands/types.ts:22](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/commands/types.ts#L22)
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: IMessageContractParams
3
+ sidebar_label: IMessageContractParams
4
+ ---
5
+
6
+ ## Table of contents
7
+
8
+ ### Properties
9
+
10
+ - [data](IMessageContractParams.md#data)
11
+ - [msgType](IMessageContractParams.md#msgtype)
12
+
13
+ ## Properties
14
+
15
+ ### data
16
+
17
+ • **data**: `BigNumberish`[]
18
+
19
+ #### Defined in
20
+
21
+ [types.ts:83](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L83)
22
+
23
+ ---
24
+
25
+ ### msgType
26
+
27
+ • **msgType**: `string`
28
+
29
+ #### Defined in
30
+
31
+ [types.ts:82](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L82)
@@ -0,0 +1,39 @@
1
+ ---
2
+ title: IStateLeaf
3
+ sidebar_label: IStateLeaf
4
+ ---
5
+
6
+ **`Notice`**
7
+
8
+ An interface representing a MACI state leaf
9
+
10
+ ## Implemented by
11
+
12
+ - [`StateLeaf`](../classes/StateLeaf.md)
13
+
14
+ ## Table of contents
15
+
16
+ ### Properties
17
+
18
+ - [pubKey](IStateLeaf.md#pubkey)
19
+ - [voiceCreditBalance](IStateLeaf.md#voicecreditbalance)
20
+
21
+ ## Properties
22
+
23
+ ### pubKey
24
+
25
+ • **pubKey**: [`PubKey`](../classes/PubKey.md)
26
+
27
+ #### Defined in
28
+
29
+ [types.ts:17](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L17)
30
+
31
+ ---
32
+
33
+ ### voiceCreditBalance
34
+
35
+ • **voiceCreditBalance**: `bigint`
36
+
37
+ #### Defined in
38
+
39
+ [types.ts:18](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L18)
@@ -0,0 +1,42 @@
1
+ ---
2
+ title: IStateLeafContractParams
3
+ sidebar_label: IStateLeafContractParams
4
+ ---
5
+
6
+ ## Table of contents
7
+
8
+ ### Properties
9
+
10
+ - [pubKey](IStateLeafContractParams.md#pubkey)
11
+ - [timestamp](IStateLeafContractParams.md#timestamp)
12
+ - [voiceCreditBalance](IStateLeafContractParams.md#voicecreditbalance)
13
+
14
+ ## Properties
15
+
16
+ ### pubKey
17
+
18
+ • **pubKey**: [`IG1ContractParams`](IG1ContractParams.md)
19
+
20
+ #### Defined in
21
+
22
+ [types.ts:76](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L76)
23
+
24
+ ---
25
+
26
+ ### timestamp
27
+
28
+ • **timestamp**: `BigNumberish`
29
+
30
+ #### Defined in
31
+
32
+ [types.ts:78](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L78)
33
+
34
+ ---
35
+
36
+ ### voiceCreditBalance
37
+
38
+ • **voiceCreditBalance**: `BigNumberish`
39
+
40
+ #### Defined in
41
+
42
+ [types.ts:77](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L77)
@@ -0,0 +1,64 @@
1
+ ---
2
+ title: IVkContractParams
3
+ sidebar_label: IVkContractParams
4
+ ---
5
+
6
+ ## Table of contents
7
+
8
+ ### Properties
9
+
10
+ - [alpha1](IVkContractParams.md#alpha1)
11
+ - [beta2](IVkContractParams.md#beta2)
12
+ - [delta2](IVkContractParams.md#delta2)
13
+ - [gamma2](IVkContractParams.md#gamma2)
14
+ - [ic](IVkContractParams.md#ic)
15
+
16
+ ## Properties
17
+
18
+ ### alpha1
19
+
20
+ • **alpha1**: [`IG1ContractParams`](IG1ContractParams.md)
21
+
22
+ #### Defined in
23
+
24
+ [types.ts:56](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L56)
25
+
26
+ ---
27
+
28
+ ### beta2
29
+
30
+ • **beta2**: [`IG2ContractParams`](IG2ContractParams.md)
31
+
32
+ #### Defined in
33
+
34
+ [types.ts:57](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L57)
35
+
36
+ ---
37
+
38
+ ### delta2
39
+
40
+ • **delta2**: [`IG2ContractParams`](IG2ContractParams.md)
41
+
42
+ #### Defined in
43
+
44
+ [types.ts:59](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L59)
45
+
46
+ ---
47
+
48
+ ### gamma2
49
+
50
+ • **gamma2**: [`IG2ContractParams`](IG2ContractParams.md)
51
+
52
+ #### Defined in
53
+
54
+ [types.ts:58](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L58)
55
+
56
+ ---
57
+
58
+ ### ic
59
+
60
+ • **ic**: [`IG1ContractParams`](IG1ContractParams.md)[]
61
+
62
+ #### Defined in
63
+
64
+ [types.ts:60](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L60)
@@ -0,0 +1,108 @@
1
+ ---
2
+ title: IVkObjectParams
3
+ sidebar_label: IVkObjectParams
4
+ ---
5
+
6
+ ## Table of contents
7
+
8
+ ### Properties
9
+
10
+ - [IC](IVkObjectParams.md#ic)
11
+ - [curve](IVkObjectParams.md#curve)
12
+ - [nPublic](IVkObjectParams.md#npublic)
13
+ - [protocol](IVkObjectParams.md#protocol)
14
+ - [vk_alpha_1](IVkObjectParams.md#vk_alpha_1)
15
+ - [vk_alphabeta_12](IVkObjectParams.md#vk_alphabeta_12)
16
+ - [vk_beta_2](IVkObjectParams.md#vk_beta_2)
17
+ - [vk_delta_2](IVkObjectParams.md#vk_delta_2)
18
+ - [vk_gamma_2](IVkObjectParams.md#vk_gamma_2)
19
+
20
+ ## Properties
21
+
22
+ ### IC
23
+
24
+ • **IC**: `BigNumberish`[][]
25
+
26
+ #### Defined in
27
+
28
+ [types.ts:72](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L72)
29
+
30
+ ---
31
+
32
+ ### curve
33
+
34
+ • **curve**: `BigNumberish`
35
+
36
+ #### Defined in
37
+
38
+ [types.ts:65](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L65)
39
+
40
+ ---
41
+
42
+ ### nPublic
43
+
44
+ • **nPublic**: `BigNumberish`
45
+
46
+ #### Defined in
47
+
48
+ [types.ts:66](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L66)
49
+
50
+ ---
51
+
52
+ ### protocol
53
+
54
+ • **protocol**: `BigNumberish`
55
+
56
+ #### Defined in
57
+
58
+ [types.ts:64](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L64)
59
+
60
+ ---
61
+
62
+ ### vk_alpha_1
63
+
64
+ • **vk_alpha_1**: `BigNumberish`[]
65
+
66
+ #### Defined in
67
+
68
+ [types.ts:67](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L67)
69
+
70
+ ---
71
+
72
+ ### vk_alphabeta_12
73
+
74
+ • **vk_alphabeta_12**: `BigNumberish`[][][]
75
+
76
+ #### Defined in
77
+
78
+ [types.ts:71](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L71)
79
+
80
+ ---
81
+
82
+ ### vk_beta_2
83
+
84
+ • **vk_beta_2**: `BigNumberish`[][]
85
+
86
+ #### Defined in
87
+
88
+ [types.ts:68](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L68)
89
+
90
+ ---
91
+
92
+ ### vk_delta_2
93
+
94
+ • **vk_delta_2**: `BigNumberish`[][]
95
+
96
+ #### Defined in
97
+
98
+ [types.ts:70](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L70)
99
+
100
+ ---
101
+
102
+ ### vk_gamma_2
103
+
104
+ • **vk_gamma_2**: `BigNumberish`[][]
105
+
106
+ #### Defined in
107
+
108
+ [types.ts:69](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L69)
@@ -0,0 +1,46 @@
1
+ ---
2
+ title: Proof
3
+ sidebar_label: Proof
4
+ ---
5
+
6
+ **`Notice`**
7
+
8
+ An interface representing a zk-SNARK proof
9
+
10
+ ## Table of contents
11
+
12
+ ### Properties
13
+
14
+ - [a](Proof.md#a)
15
+ - [b](Proof.md#b)
16
+ - [c](Proof.md#c)
17
+
18
+ ## Properties
19
+
20
+ ### a
21
+
22
+ • **a**: `G1Point`
23
+
24
+ #### Defined in
25
+
26
+ [types.ts:8](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L8)
27
+
28
+ ---
29
+
30
+ ### b
31
+
32
+ • **b**: `G2Point`
33
+
34
+ #### Defined in
35
+
36
+ [types.ts:9](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L9)
37
+
38
+ ---
39
+
40
+ ### c
41
+
42
+ • **c**: `G1Point`
43
+
44
+ #### Defined in
45
+
46
+ [types.ts:10](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L10)
@@ -0,0 +1,24 @@
1
+ ---
2
+ title: VoteOptionTreeLeaf
3
+ sidebar_label: VoteOptionTreeLeaf
4
+ ---
5
+
6
+ **`Notice`**
7
+
8
+ An interface representing a MACI vote option leaf
9
+
10
+ ## Table of contents
11
+
12
+ ### Properties
13
+
14
+ - [votes](VoteOptionTreeLeaf.md#votes)
15
+
16
+ ## Properties
17
+
18
+ ### votes
19
+
20
+ • **votes**: `bigint`
21
+
22
+ #### Defined in
23
+
24
+ [types.ts:25](https://github.com/privacy-scaling-explorations/maci/blob/6a905de08/domainobjs/ts/types.ts#L25)