@maci-protocol/website 0.0.0-ci.9342f07 → 0.0.0-ci.9819a21

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 (100) hide show
  1. package/LICENSE +1 -2
  2. package/blog/2024-02-28-maci-v1.2.0.md +2 -2
  3. package/blog/2024-08-10-maci-v2.md +1 -1
  4. package/blog/2025-03-21-roadmap-2025.md +1 -1
  5. package/blog/2025-08-18-maci-aragon-plugin.md +107 -0
  6. package/docusaurus.config.ts +9 -3
  7. package/package.json +16 -15
  8. package/src/pages/roadmap.md +39 -80
  9. package/static/img/circuits/MACI-Circuits.excalidraw +79 -79
  10. package/static/img/circuits/ecdh.svg +1 -1
  11. package/static/img/circuits/messageToCommand.svg +1 -1
  12. package/static/img/circuits/messageValidator.svg +1 -1
  13. package/static/img/circuits/privToPubkey.svg +1 -1
  14. package/static/img/circuits/processMessages.svg +1 -1
  15. package/static/img/circuits/processMessagesInputHasher.svg +1 -1
  16. package/static/img/circuits/processMessages_2_0.svg +1 -1
  17. package/static/img/circuits/processOne.svg +1 -1
  18. package/static/img/circuits/processTopup.svg +1 -1
  19. package/static/img/circuits/quinBatchLeavesExists.svg +1 -1
  20. package/static/img/circuits/quinCheckRoot.svg +1 -1
  21. package/static/img/circuits/quinGeneratePathIndices.svg +1 -1
  22. package/static/img/circuits/quinSelector.svg +1 -1
  23. package/static/img/circuits/resultsCommitmentVerifier.svg +1 -1
  24. package/static/img/circuits/splicer.svg +1 -1
  25. package/static/img/circuits/tallyInputHasher.svg +1 -1
  26. package/static/img/circuits/tallyVotes.svg +1 -1
  27. package/static/img/circuits/verifySignature.svg +1 -1
  28. package/versioned_docs/version-v0.x/introduction.md +0 -4
  29. package/versioned_docs/version-v0.x/quadratic-vote-tallying-circuit.md +16 -16
  30. package/versioned_docs/version-v1.2/circuits.md +8 -8
  31. package/versioned_docs/version-v1.2/contributing/contributing.md +4 -4
  32. package/versioned_docs/version-v1.2/deployment.md +1 -1
  33. package/versioned_docs/version-v1.2/integrating.md +1 -1
  34. package/versioned_docs/version-v1.2/key-change.md +1 -1
  35. package/versioned_docs/version-v1.2/poll-types.md +1 -1
  36. package/versioned_docs/version-v1.2/testing-in-detail.md +3 -3
  37. package/versioned_docs/version-v1.2/testing.md +1 -1
  38. package/versioned_docs/version-v1.2/topup.md +1 -1
  39. package/versioned_docs/version-v1.2/typedoc/core/index.md +2 -2
  40. package/versioned_docs/version-v1.2/versioning.md +3 -3
  41. package/versioned_docs/version-v1.2/workflow.md +1 -1
  42. package/versioned_docs/version-v2.x/contributing/contributing.md +4 -4
  43. package/versioned_docs/version-v2.x/core-concepts/key-change.md +1 -1
  44. package/versioned_docs/version-v2.x/core-concepts/merkle-trees.md +1 -1
  45. package/versioned_docs/version-v2.x/core-concepts/poll-types.md +1 -1
  46. package/versioned_docs/version-v2.x/core-concepts/workflow.md +1 -1
  47. package/versioned_docs/version-v2.x/guides/integrating.md +1 -1
  48. package/versioned_docs/version-v2.x/guides/testing/testing-in-detail.md +3 -3
  49. package/versioned_docs/version-v2.x/guides/testing/testing.md +1 -1
  50. package/versioned_docs/version-v2.x/processes/versioning.md +3 -3
  51. package/versioned_docs/version-v2.x/supported-networks/deployed-contracts.md +7 -7
  52. package/versioned_docs/version-v2.x/technical-references/smart-contracts/AccQueue.md +1 -1
  53. package/versioned_docs/version-v2.x/technical-references/smart-contracts/MACI.md +1 -1
  54. package/versioned_docs/version-v2.x/technical-references/smart-contracts/MessageProcessor.md +1 -1
  55. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Params.md +1 -1
  56. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Poll.md +1 -1
  57. package/versioned_docs/version-v2.x/technical-references/smart-contracts/PollFactory.md +1 -1
  58. package/versioned_docs/version-v2.x/technical-references/smart-contracts/Tally.md +1 -1
  59. package/versioned_docs/version-v2.x/technical-references/smart-contracts/VkRegistry.md +1 -1
  60. package/versioned_docs/version-v2.x/technical-references/smart-contracts/VoiceCreditProxy.md +1 -1
  61. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/processMessages.md +4 -4
  62. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/tallyVotes.md +2 -2
  63. package/versioned_docs/version-v2.x/technical-references/zk-snark-circuits/zk-snark-circuits.md +3 -3
  64. package/versioned_docs/version-v3.x/contributing/contributing.md +11 -5
  65. package/versioned_docs/version-v3.x/core-concepts/key-change.md +29 -29
  66. package/versioned_docs/version-v3.x/core-concepts/maci-keys.md +1 -1
  67. package/versioned_docs/version-v3.x/core-concepts/poll-types.md +33 -9
  68. package/versioned_docs/version-v3.x/core-concepts/polls.md +34 -10
  69. package/versioned_docs/version-v3.x/core-concepts/spec.md +40 -106
  70. package/versioned_docs/version-v3.x/core-concepts/workflow.md +2 -2
  71. package/versioned_docs/version-v3.x/guides/compile-circuits.md +36 -20
  72. package/versioned_docs/version-v3.x/guides/integrating.md +10 -10
  73. package/versioned_docs/version-v3.x/guides/sdk.md +121 -0
  74. package/versioned_docs/version-v3.x/guides/testing/testing-in-detail.md +4 -4
  75. package/versioned_docs/version-v3.x/guides/testing/testing-introduction.md +38 -6
  76. package/versioned_docs/version-v3.x/guides/troubleshooting.md +64 -19
  77. package/versioned_docs/version-v3.x/processes/versioning.md +3 -3
  78. package/versioned_docs/version-v3.x/quick-start.md +29 -21
  79. package/versioned_docs/version-v3.x/resources.md +1 -0
  80. package/versioned_docs/version-v3.x/security/audit.md +2 -2
  81. package/versioned_docs/version-v3.x/security/trusted-setup.md +36 -36
  82. package/versioned_docs/version-v3.x/supported-networks/costs.md +725 -0
  83. package/versioned_docs/version-v3.x/supported-networks/deployed-contracts.md +9 -9
  84. package/versioned_docs/version-v3.x/supported-networks/supported-networks.md +16 -0
  85. package/versioned_docs/version-v3.x/technical-references/smart-contracts/MACI.md +7 -7
  86. package/versioned_docs/version-v3.x/technical-references/smart-contracts/MessageProcessor.md +1 -1
  87. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Params.md +2 -2
  88. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Policies.md +1 -1
  89. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Poll.md +8 -8
  90. package/versioned_docs/version-v3.x/technical-references/smart-contracts/PollFactory.md +1 -1
  91. package/versioned_docs/version-v3.x/technical-references/smart-contracts/Tally.md +4 -4
  92. package/versioned_docs/version-v3.x/technical-references/smart-contracts/VkRegistry.md +8 -8
  93. package/versioned_docs/version-v3.x/technical-references/smart-contracts/VoiceCreditProxy.md +1 -1
  94. package/versioned_docs/version-v3.x/technical-references/technical-references.md +8 -8
  95. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/joinPoll.md +4 -4
  96. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/processMessages.md +81 -17
  97. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/setup.md +3 -3
  98. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/tallyVotes.md +6 -6
  99. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/utilities.md +9 -9
  100. package/versioned_docs/version-v3.x/technical-references/zk-snark-circuits/zk-snark-circuits.md +3 -3
@@ -7,7 +7,7 @@ sidebar_position: 5
7
7
 
8
8
  #### Process Messages Input Hasher
9
9
 
10
- A utility circuit used by the main `processMessages` circuit to hash its inputs.
10
+ A utility circuit used by the main `MessageProcessor` circuit to hash its inputs.
11
11
 
12
12
  ![ProcessMessagesInputHasher](/img/circuits/processMessagesInputHasher.svg)
13
13
 
@@ -15,7 +15,7 @@ It outputs one field element, which is the SHA256 hash of the following inputs:
15
15
 
16
16
  1. `packedVals`
17
17
  2. `pollEndTimestamp`
18
- 3. `msgRoot`
18
+ 3. `messageRoot`
19
19
  4. `coordinatorPubKeyHash`
20
20
  5. `newSbCommitment`
21
21
  6. `currentSbCommitment`
@@ -35,15 +35,15 @@ It outputs one field element, which is the SHA256 hash of the following inputs:
35
35
 
36
36
  #### ResultsCommitmentVerifier
37
37
 
38
- A utility circuit used by the main `tallyVotes` circuit to verify that the results commitment is correct.
38
+ A utility circuit used by the main `VoteTally` circuit to verify that the results commitment is correct.
39
39
 
40
40
  ![ResultsCommitmentVerifier](/img/circuits/resultsCommitmentVerifier.svg)
41
41
 
42
- #### QuinCheckRoot
42
+ #### QuinaryCheckRoot
43
43
 
44
44
  Utility circuit that given a quin Merkle root and a list of leaves, check if the root is the correct result of inserting all the leaves into the tree in the given order.
45
45
 
46
- ![QuinCheckRoot](/img/circuits/quinCheckRoot.svg)
46
+ ![QuinaryCheckRoot](/img/circuits/quinCheckRoot.svg)
47
47
 
48
48
  #### CalculateTotal
49
49
 
@@ -100,11 +100,11 @@ Utility circuit used to unpack an input element.
100
100
 
101
101
  ![UnpackElement](/img/circuits/unpackElement.svg)
102
102
 
103
- #### QuinSelector
103
+ #### QuinarySelector
104
104
 
105
105
  Utility circuit used to select one element from an array of n elements at a given index.
106
106
 
107
- ![QuinSelector](/img/circuits/quinSelector.svg)
107
+ ![QuinarySelector](/img/circuits/quinSelector.svg)
108
108
 
109
109
  #### Splicer
110
110
 
@@ -118,11 +118,11 @@ Utility circuit used to check if a batch of leaves exists in a quinary tree.
118
118
 
119
119
  ![QuinBatchLeavesExists](/img/circuits/quinBatchLeavesExists.svg)
120
120
 
121
- #### QuinGeneratePathIndices
121
+ #### QuinaryGeneratePathIndices
122
122
 
123
123
  Utility circuit used to generate the indices needed to traverse the tree until we find the leaf we are looking for.
124
124
 
125
- ![QuinGeneratePathIndices](/img/circuits/quinGeneratePathIndices.svg)
125
+ ![QuinaryGeneratePathIndices](/img/circuits/quinGeneratePathIndices.svg)
126
126
 
127
127
  #### ProcessOne
128
128
 
@@ -5,10 +5,10 @@ sidebar_label: zk-SNARK Circuits
5
5
  sidebar_position: 1
6
6
  ---
7
7
 
8
- MACI has three main zk-SNARK [circuits](https://github.com/privacy-scaling-explorations/maci/tree/dev/circuits):
8
+ MACI has three main zk-SNARK [circuits](https://github.com/privacy-scaling-explorations/maci/tree/main/packages/circuits):
9
9
 
10
- 1. ProcessMessages.circom, which takes a batch of encrypted messages, decrypts them, and generates a proof that the coordinator's local processing was performed correctly. [QV](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/circom/core/qv/processMessages.circom) and [non-QV](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/circom/core/non-qv/processMessages.circom) versions are available.
11
- 2. TallyVotes.circom, which counts votes from users' ballots, batch by batch. [QV](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/circom/core/qv/tallyVotes.circom) and [non-QV](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/circom/core/non-qv/tallyVotes.circom) versions are available.
10
+ 1. ProcessMessages.circom, which takes a batch of encrypted messages, decrypts them, and generates a proof that the coordinator's local processing was performed correctly. [QV](https://github.com/privacy-scaling-explorations/maci/blob/main/circuits/circom/coordinator/qv/MessageProcessor.circom), [non-QV](https://github.com/privacy-scaling-explorations/maci/blob/main/circuits/circom/coordinator/non-qv/MessageProcessor.circom), [Full](https://github.com/privacy-scaling-explorations/maci/blob/main/circuits/circom/coordinator/full/MessageProcessor.circom) versions are available.
11
+ 2. TallyVotes.circom, which counts votes from users' ballots, batch by batch. [QV](https://github.com/privacy-scaling-explorations/maci/blob/main/circuits/circom/coordinator/qv/VoteTally.circom) and [non-QV](https://github.com/privacy-scaling-explorations/maci/blob/main/circuits/circom/coordinator/non-qv/VoteTally.circom) versions are available.
12
12
  3. PollJoining.circom, which allows users to prove they know a private key for a public key signed up to the MACI smart contract, and to register to a specific poll.
13
13
 
14
14
  The rest of the circuits are utilities templates that are required for the main circuits to work correctly. These include utilities such as float math, conversion of private keys, and Poseidon hashing/encryption.