docs: ensure that it's clear that num signups account for empty leaf

privacy-scaling-explorations · Jun 14, 2024 · 772e85c · 772e85c
1 parent 507e60a
commit 772e85c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/...versioned_docs/version-v2.0_alpha/developers-references/smart-contracts/MACI.md b/...versioned_docs/version-v2.0_alpha/developers-references/smart-contracts/MACI.md
@@ -147,3 +147,7 @@ Polls require the following information:
 - `verifier`: the address of the zk-SNARK verifier contract
 - `vkRegistry`: the address of the vk registry contract
 - `mode`: the mode of the poll, to set whether it supports quadratic voting or non quadratic voting
+
+:::info
+Please be advised that the number of signups in the MACI contract (number of leaves in the merkle tree holding MACI's state) considers the initial zero leaf as one signup. For this reason, when accounting for the real users signed up to MACI, you should subtract one from the value returned from the `numSignUps` function.
+:::
diff --git a/...versioned_docs/version-v2.0_alpha/developers-references/smart-contracts/Poll.md b/...versioned_docs/version-v2.0_alpha/developers-references/smart-contracts/Poll.md
@@ -94,3 +94,7 @@ At the same time, the coordinator can merge the message accumulator queue and ge
 
 - `mergeMessageAqSubRoots` - merges the Poll's messages tree subroot
 - `mergeMessageAq` - merges the Poll's messages tree
+
+:::info
+Please be advised that the number of signups in this case includes the zero leaf. For this reason, when accounting for the real users signed up to the Poll, you should subtract one from the value stored in the Poll contract.
+:::