diff --git a/apps/docs/docusaurus.config.ts b/apps/docs/docusaurus.config.ts index 34b5c2c1..cb6c4dde 100644 --- a/apps/docs/docusaurus.config.ts +++ b/apps/docs/docusaurus.config.ts @@ -67,7 +67,7 @@ const config: Config = { announcementBar: { id: "semaphore-v4-beta", content: - 'Semaphore V4-beta is out 🎉 Try it out and contribute to the Trusted Setup ceremony. Let us know for any feedback on Discord or Github!', + 'Semaphore V4 is out 🎉 Try it out and let us know if you have any feedback on Discord or Github!', backgroundColor: "#dde6fc", textColor: "#000000" }, diff --git a/apps/docs/versioned_docs/version-V4-beta/trusted-setup.md b/apps/docs/versioned_docs/version-V4-beta/trusted-setup.md deleted file mode 100644 index afb80e7f..00000000 --- a/apps/docs/versioned_docs/version-V4-beta/trusted-setup.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Trusted Setup - -gm, everyone 😎 we are excited to announce the upcoming Multi-Party Computation (MPC) Phase 2 Trusted Setup ceremony for the Semaphore V4 circuit - this is crucial for establishing a robust security foundation for the cryptographic protocol 🎉 - -The ceremony will take place from **June 10** to **July 10**. If all goes to plan, finalization should take place on **July 15** with the announcement of the final beacon on **July 12**. - -## Securing Semaphore V4 - -To contribute to this ceremony, you will just need your browser! - -1. Visit [ceremony.pse.dev](https://ceremony.pse.dev/projects/Semaphore%20V4%20Ceremony). -2. Login and associate your **Github** account. -3. Hit the `contribute` button and wait for your turn. - -nb. you will find your contribution certificate on your GitHub gists - and, if all goes wrong or you feel lost, there are instructions on site or post a message on Semaphore / PSE discord. - -## What You Need to Know About the Ceremony - -### Your Role - -Many zero-knowledge proof systems, including those based on the Groth16 scheme, require this layer of randomness, often referred to as "toxic waste” which must remain unknown to anyone to maintain the integrity of the zero-knowledge proof system. Trusted setups rely on a 1 of N honest participant assumption. As long as just one participant actually discards their “toxic waste”, the proof system will be secure. You can be that one participant by providing your unique entropy with your contribution, making the ceremony unpredictable and unbiased, safeguarding the entire process against potential vulnerabilities. - -### Why It Matters - -Trusted setups are crucial as they generate a set of parameters necessary to initiate SNARK-based systems. Through a series of computations performed by various participants. This sequence involves downloading previous contributions, adding generated randomness, and uploading the results of your contribution. These contributions are then integrated into the final artifacts crucial for proof generation/verification. - -### Semaphore Circuit - -The [Semaphore circuit](https://github.com/semaphore-protocol/semaphore/blob/main/packages/circuits/src/semaphore.circom) centered around the creation of the _Semaphore identity_ and _identity commitment_, includes verification processes, and facilitates the generation of the _nullifier_. We are going to support `MAX_DEPTH` from 1 to 32 - therefore you will have to contribute to 32 variants of the same circuit. Since the constraints will range from 2k to less than 10k with very small artifacts size (≤ 8mb x contribution), the waiting and contribution time shouldn’t be much! - -### Transparency and Fairness - -We are committed to transparency on ceremony setup, execution, finalization, and later verification. Our primary goal is to **engage as many contributors as possible** to ensure the circuit is **secure** and **production-ready**. To this end, the ceremony is designed to _maximize contributor inclusion_, monitor & troubleshoot whenever is needed, _lower the entry barriers_, _making contributiong as effortless as possible_. A key step towards achieving these goals is running the ceremony w/ [p0tion](https://github.com/privacy-scaling-explorations/p0tion): an in-house developed, open-source, battle-tested tool that is fully equipped to meet our needs. - -### Ceremony Settings - -To protect the ceremony from sybils, in order to contribute you must have a GitHub account such that you have: 1 public repository, at least 1 follower, following at least 5 other accounts and, your account is at least 1 month old. While to protect from fake contributors or people hanging due to connection/machine resources, we are going to set a 10 minutes time-window on contributions (+ 1 hour verification) - after this amount of time, you will be kicked out and will have to wait **1 day** before you can contribute again. - -## Troubleshooting - -- If you have been idle longer than expected, it may be that the current contributor has been blocked for some reason. Do not worry, the maximum wait in this case is one hour, after which you will be able to continue contributing. - -### Learn more about Trusted Setups - -- [How Do Trusted Setups Work? - Vitalik](https://vitalik.eth.limo/general/2022/03/14/trustedsetup.html) -- [p0tion FAQs](https://p0tion.super.site/faqs#block-cebca23ebb514c2ea096ad44d4833356) diff --git a/apps/docs/versioned_docs/version-V4-beta/credits.md b/apps/docs/versioned_docs/version-V4/credits.md similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/credits.md rename to apps/docs/versioned_docs/version-V4/credits.md diff --git a/apps/docs/versioned_docs/version-V4-beta/deployed-contracts.mdx b/apps/docs/versioned_docs/version-V4/deployed-contracts.mdx similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/deployed-contracts.mdx rename to apps/docs/versioned_docs/version-V4/deployed-contracts.mdx diff --git a/apps/docs/versioned_docs/version-V4-beta/faq.md b/apps/docs/versioned_docs/version-V4/faq.md similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/faq.md rename to apps/docs/versioned_docs/version-V4/faq.md diff --git a/apps/docs/versioned_docs/version-V4-beta/getting-started.mdx b/apps/docs/versioned_docs/version-V4/getting-started.mdx similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/getting-started.mdx rename to apps/docs/versioned_docs/version-V4/getting-started.mdx diff --git a/apps/docs/versioned_docs/version-V4-beta/glossary.md b/apps/docs/versioned_docs/version-V4/glossary.md similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/glossary.md rename to apps/docs/versioned_docs/version-V4/glossary.md diff --git a/apps/docs/versioned_docs/version-V4-beta/guides/_category_.json b/apps/docs/versioned_docs/version-V4/guides/_category_.json similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/guides/_category_.json rename to apps/docs/versioned_docs/version-V4/guides/_category_.json diff --git a/apps/docs/versioned_docs/version-V4-beta/guides/groups.mdx b/apps/docs/versioned_docs/version-V4/guides/groups.mdx similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/guides/groups.mdx rename to apps/docs/versioned_docs/version-V4/guides/groups.mdx diff --git a/apps/docs/versioned_docs/version-V4-beta/guides/identities.mdx b/apps/docs/versioned_docs/version-V4/guides/identities.mdx similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/guides/identities.mdx rename to apps/docs/versioned_docs/version-V4/guides/identities.mdx diff --git a/apps/docs/versioned_docs/version-V4-beta/guides/proofs.mdx b/apps/docs/versioned_docs/version-V4/guides/proofs.mdx similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/guides/proofs.mdx rename to apps/docs/versioned_docs/version-V4/guides/proofs.mdx diff --git a/apps/docs/versioned_docs/version-V4-beta/resources.mdx b/apps/docs/versioned_docs/version-V4/resources.mdx similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/resources.mdx rename to apps/docs/versioned_docs/version-V4/resources.mdx diff --git a/apps/docs/versioned_docs/version-V4-beta/subgraph.mdx b/apps/docs/versioned_docs/version-V4/subgraph.mdx similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/subgraph.mdx rename to apps/docs/versioned_docs/version-V4/subgraph.mdx diff --git a/apps/docs/versioned_docs/version-V4-beta/technical-reference/_category_.json b/apps/docs/versioned_docs/version-V4/technical-reference/_category_.json similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/technical-reference/_category_.json rename to apps/docs/versioned_docs/version-V4/technical-reference/_category_.json diff --git a/apps/docs/versioned_docs/version-V4-beta/technical-reference/circuits.md b/apps/docs/versioned_docs/version-V4/technical-reference/circuits.md similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/technical-reference/circuits.md rename to apps/docs/versioned_docs/version-V4/technical-reference/circuits.md diff --git a/apps/docs/versioned_docs/version-V4-beta/technical-reference/contracts.md b/apps/docs/versioned_docs/version-V4/technical-reference/contracts.md similarity index 100% rename from apps/docs/versioned_docs/version-V4-beta/technical-reference/contracts.md rename to apps/docs/versioned_docs/version-V4/technical-reference/contracts.md diff --git a/apps/docs/versioned_docs/version-V4-beta/troubleshooting.md b/apps/docs/versioned_docs/version-V4/troubleshooting.md similarity index 61% rename from apps/docs/versioned_docs/version-V4-beta/troubleshooting.md rename to apps/docs/versioned_docs/version-V4/troubleshooting.md index 6ea4eabe..c0b6025e 100644 --- a/apps/docs/versioned_docs/version-V4-beta/troubleshooting.md +++ b/apps/docs/versioned_docs/version-V4/troubleshooting.md @@ -9,12 +9,6 @@ import TabItem from "@theme/TabItem" If these suggestions do not work, feel free to ask for more help and support on [Github Discussions](https://github.com/semaphore-protocol/semaphore/discussions) or [Discord](https://semaphore.pse.dev/discord) ("dev-chat" channel). -## Creating a Group - -When you create a group and the transaction is reverted, make sure that the group id you are using does not exist on the network you are using. - -To check that, you can use the [Semaphore CLI](https://github.com/semaphore-protocol/semaphore/tree/main/packages/cli) with the command `get-groups` and the network you are using and then, make sure that your group id is not part of that list. You can also use the [Semaphore explorer](https://explorer.semaphore.pse.dev/). - ## Transaction reverted when using the same nullifier When you generate a proof using the same [scope](/glossary#scope) you used to validate a proof before, the transaction will be reverted because that scope (and thus the [nullifier](/glossary#nullifier)) has already been used. If you want to send and validate several proofs from the same identity, you need to use a different scope for each time you generate a proof. diff --git a/apps/docs/versioned_docs/version-V4-beta/what-is-semaphore.md b/apps/docs/versioned_docs/version-V4/what-is-semaphore.md similarity index 89% rename from apps/docs/versioned_docs/version-V4-beta/what-is-semaphore.md rename to apps/docs/versioned_docs/version-V4/what-is-semaphore.md index d31eb926..c783aae8 100644 --- a/apps/docs/versioned_docs/version-V4-beta/what-is-semaphore.md +++ b/apps/docs/versioned_docs/version-V4/what-is-semaphore.md @@ -38,6 +38,10 @@ In addition to circuits, Semaphore provides [Solidity contracts](https://github.com/semaphore-protocol/semaphore/tree/main/packages/contracts) and [JavaScript libraries](https://github.com/semaphore-protocol/semaphore/tree/main#-packages) that allow developers to generate zero-knowledge proofs and verify them with minimal effort. +## Trusted Setup Ceremony + +The [secure parameters](https://snark-artifacts.pse.dev) for generating valid proofs with Semaphore circuits were generated in a [Trusted Setup Ceremony](https://ceremony.pse.dev/projects/Semaphore%20V4%20Ceremony) that was completed with over 400 participants on [13 July 2024](https://etherscan.io/block/20300394). + ### Audits | Version | Auditors | Report | Scope | @@ -46,7 +50,3 @@ and [JavaScript libraries](https://github.com/semaphore-protocol/semaphore/tree/ | v2.5.0 | [PSE](https://pse.dev/) | [Semaphore_2.5.0_Audit.pdf](https://semaphore.pse.dev/Semaphore_2.5.0_Audit.pdf) | `contracts`, `libraries` | | v3.0.0 | [Veridise](https://veridise.com/) | [Semaphore_3.0.0_Audit.pdf](https://semaphore.pse.dev/Semaphore_3.0.0_Audit.pdf) | `circuits`, `contracts` | | v4.0.0 | [PSE](https://pse.dev/) | [Semaphore_4.0.0_Audit.pdf](https://semaphore.pse.dev/Semaphore_4.0.0_Audit.pdf) | `circuits`, `contracts`, `libraries` | - -:::caution -Semaphore V4 is in early testing and might have bugs. Please, don't use it in production. -::: diff --git a/apps/docs/versioned_sidebars/version-V4-beta-sidebars.json b/apps/docs/versioned_sidebars/version-V4-sidebars.json similarity index 100% rename from apps/docs/versioned_sidebars/version-V4-beta-sidebars.json rename to apps/docs/versioned_sidebars/version-V4-sidebars.json diff --git a/apps/docs/versions.json b/apps/docs/versions.json index b69f062e..5731a3b4 100644 --- a/apps/docs/versions.json +++ b/apps/docs/versions.json @@ -1 +1 @@ -["V4-beta", "V3", "V2", "V1"] +["V4", "V3", "V2", "V1"]