github/semaphore
1
1
Fork 0
mirror of https://github.com/semaphore-protocol/semaphore.git synced 2026-04-28 03:00:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

chore(website): update semaphore code and links

Browse Source 
re #658


Former-commit-id: 2466e9b5c0
This commit is contained in:
cedoor
2024-02-26 12:29:34 +00:00
parent 4634be1ba5
commit f2be01ecdd
2 changed files with 27 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
apps/website/src/app/learn/page.tsx
View File

@@ -95,27 +95,32 @@ export default function Learn() {
{
title: "Semaphore identities",
description:
"Given to all Semaphore group members, it is comprised of three parts - identity commitment, trapdoor, and nullifier.",
"A Semaphore identity is an EdDSA key-pair plus the commitment (i.e. the hash of the public key), which is used as the public value of the Semaphore group members.",
linkText: "Create Semaphore identities",
linkUrl: "https://docs.semaphore.pse.dev/guides/identities",
codeText: `import { Identity } from "@semaphore-protocol/identity"
const { trapdoor, nullifier, commitment } = new Identity()`,
// Random identity.
const identity1 = new Identity()
// Passing a secret.
const identity2 = new Identity("secret")
`,
itemList: [
{
icon: <IconEyelash w="24px" h="24px" color="primary.600" />,
heading: "Private values",
body: "Trapdoor and nullifier values are the private values of the Semaphore identity. To avoid fraud, the owner must keep both values secret."
body: "The private key is a secret that identity owners must keep private. It can be both generated randomly or passed as a parameter."
},
{
icon: <IconEye w="24px" h="24px" color="primary.600" />,
heading: "Public values",
body: "Semaphore uses the Poseidon hash function to create the identity commitment from the identity private values. Identity commitments can be made public, similarly to Ethereum addresses."
body: "Semaphore uses the Poseidon hash function to derive the identity commitment from the identity public key. Identity commitments can be made public, similarly to Ethereum addresses."
},
{
icon: <IconUser w="24px" h="24px" color="primary.600" />,
heading: "Generate identities",
body: "Semaphore identities can be generated deterministically or randomly. Deterministic identities can be generated from the hash of a secret message."
heading: "Storing identities",
body: "Building a system to save or recover secret values of Semaphore identities is nontrivial. You may choose to delegate such functionality to existing wallets such as Metamask."
}
]
},
@@ -127,45 +132,41 @@ const { trapdoor, nullifier, commitment } = new Identity()`,
linkUrl: "https://docs.semaphore.pse.dev/guides/groups",
codeText: `import { Group } from "@semaphore-protocol/group"
const group = new Group(1)
const members = [identity1.commitment, identity2.commitment]
group.addMember(commitment)`,
const group = new Group(members)
`,
itemList: [
{
icon: <IconTree w="24px" h="24px" color="primary.600" />,
heading: "Merkle trees",
body: "Each leaf contains an identity commitment for a user. The identity commitment proves that the user is a group member without revealing the private identity of the user."
body: "Each leaf contains an identity commitment for a user. The structure of Merkle trees ensures that it can be efficiently proved that an identity commitment is a member of the group."
},
{
icon: <IconGroup w="24px" h="24px" color="primary.600" />,
heading: "Types of groups",
body: "Groups can be created and managed in a decentralized fashion with Semaphore contracts or off-chain with our JavaScript libraries."
body: "Groups can be created and managed in a decentralized fashion with Semaphore contracts or off-chain with the JavaScript libraries."
},
{
icon: <IconManageUsers w="24px" h="24px" color="primary.600" />,
heading: "Group management",
body: "Users can join and leave groups by themselves, or an admin can add and remove them. Admins can be centralized authorities, Ethereum accounts, multi-sig wallets or smart contracts."
body: "Users could join and leave groups by themselves, or an admin could add and remove them. Admins can be centralized authorities, Ethereum accounts, multi-sig wallets or smart contracts."
}
]
},
{
title: "Semaphore proofs",
description:
"Semaphore group members can anonymously prove that they are part of a group and that they are generating their own proofs and signals.",
description: "Semaphore group members can prove that they are part of a group and send anonymous messages.",
linkText: "Generate Semaphore proofs",
linkUrl: "https://docs.semaphore.pse.dev/guides/proofs",
codeText: `import { generateProof, verifyProof } from "@semaphore-protocol/proof"
import { utils } from "ethers"
const externalNullifier = utils.formatBytes32String("Topic")
const signal = utils.formatBytes32String("Hello world")
const scope = "Semaphore"
const message = "Hello world"
const fullProof = await generateProof(identity, group, externalNullifier, signal, {
zkeyFilePath: "./semaphore.zkey",
wasmFilePath: "./semaphore.wasm"
})
const proof = await generateProof(identity1, group, scope, message)
await verifyProof(fullProof, group.depth)`,
await verifyProof(proof)`,
itemList: [
{
icon: <IconBadge w="24px" h="24px" color="primary.600" />,
@@ -174,13 +175,13 @@ await verifyProof(fullProof, group.depth)`,
},
{
icon: <IconFlag w="24px" h="24px" color="primary.600" />,
heading: "Signals",
body: "Group users can anonymously broadcast signals such as votes or endorsements without revealing their original identity."
heading: "Messages",
body: "Group users can anonymously share messages such as votes or endorsements without revealing their original identity."
},
{
icon: <IconCheck w="24px" h="24px" color="primary.600" />,
heading: "Verifiers",
body: "Semaphore proofs can be verified with our contracts or off-chain with our JavaScript libraries."
heading: "Proof verification",
body: "Semaphore proofs can be verified both on-chain with the Semaphore contracts, or off-chain with the JavaScript libraries."
}
]
}

2
apps/website/src/app/page.tsx
View File

@@ -45,7 +45,7 @@ export default function Home() {
</VStack>
<Stack direction={{ base: "column", sm: "row" }} spacing="6" align="center">
<Link href="https://docs.semaphore.pse.dev/quick-setup" isExternal>
<Link href="https://docs.semaphore.pse.dev/getting-started" isExternal>
<Button size={{ base: "md", md: "lg" }}>Get Started</Button>
</Link>
<Link href="https://demo.semaphore.pse.dev" isExternal>