Merge branch 'main' into main

semaphore-protocol · Sep 21, 2023 · daf5589 · daf5589
2 parents 09e062d + 715b1f8
commit daf5589
Show file tree

Hide file tree

Showing 49 changed files with 230 additions and 315 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -40,7 +40,5 @@ jobs:
               uses: crazy-max/[email protected]
               with:
                   build_dir: docs
-                  jekyll: false
-                  fqdn: js.semaphore.appliedzkp.org
               env:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -63,9 +63,7 @@ node_modules/
 # Production
 build
 dist
-docs/*
-!docs/CNAME
-!docs/index.html
+docs
 
 # Hardhat
 artifacts

diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
       <picture>
         <source media="(prefers-color-scheme: dark)" srcset="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon-dark.svg">
         <source media="(prefers-color-scheme: light)" srcset="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon.svg">
-        <img width="40" alt="Semaphore icon." src="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon.svg">
+        <img width="40" alt="Semaphore icon" src="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon.svg">
       </picture>
       Semaphore
     </h1>
@@ -52,7 +52,7 @@
             🔎 Issues
         </a>
         <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
-        <a href="https://semaphore.appliedzkp.org/discord">
+        <a href="https://semaphore.pse.dev/discord">
             🗣️ Chat &amp; Support
         </a>
     </h4>
@@ -61,7 +61,7 @@
 | Semaphore is a protocol, designed to be a simple and generic privacy layer for Ethereum DApps. Using zero knowledge, Ethereum users can prove their membership of a group and send signals such as votes or endorsements without revealing their original identity. |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
-The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/scheme.png). However Semaphore also provides [Solidity contracts](/packages/contracts) and JavaScript libraries to make the steps for offchain proof creation and onchain verification easier. To learn more about Semaphore visit [semaphore.appliedzkp.org](https://semaphore.appliedzkp.org).
+The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/scheme.png). However Semaphore also provides [Solidity contracts](/packages/contracts) and JavaScript libraries to make the steps for offchain proof creation and onchain verification easier. To learn more about Semaphore visit [semaphore.pse.dev](https://semaphore.pse.dev).
 
 ## 📦 Packages
 
@@ -94,7 +94,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/identity">
                     @semaphore-protocol/identity
                 </a>
-                <a href="https://js.semaphore.appliedzkp.org/identity">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_identity">
                     (docs)
                 </a>
             </td>
@@ -116,7 +116,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/group">
                     @semaphore-protocol/group
                 </a>
-                <a href="https://js.semaphore.appliedzkp.org/group">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_group">
                     (docs)
                 </a>
             </td>
@@ -138,7 +138,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/proof">
                     @semaphore-protocol/proof
                 </a>
-                <a href="https://js.semaphore.appliedzkp.org/proof">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_proof">
                     (docs)
                 </a>
             </td>
@@ -160,7 +160,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/data">
                     @semaphore-protocol/data
                 </a>
-                <a href="https://js.semaphore.appliedzkp.org/data">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_data">
                     (docs)
                 </a>
             </td>
@@ -220,7 +220,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/heyauthn">
                     @semaphore-protocol/heyauthn
                 </a>
-                <a href="https://js.semaphore.appliedzkp.org/heyauthn">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_heyauthn">
                     (docs)
                 </a>
             </td>
@@ -269,7 +269,7 @@ The following are some of the internal and external projects that use Semaphore.
         </tr>
         <tr>
             <td>
-                <a href="https://explorer.semaphore.appliedzkp.org">
+                <a href="https://explorer.semaphore.pse.dev">
                     Semaphore Explorer
                 </a>
             </td>
@@ -280,7 +280,7 @@ The following are some of the internal and external projects that use Semaphore.
                 <a href="https://github.com/semaphore-protocol/explorer">
                     Github
                 </a>|
-                <a href="https://semaphore.appliedzkp.org/discord">
+                <a href="https://semaphore.pse.dev/discord">
                     Discord
                 </a>
             </td>
@@ -298,7 +298,7 @@ The following are some of the internal and external projects that use Semaphore.
                 <a href="https://github.com/semaphore-protocol/discord-bot">
                     Github
                 </a>|
-                <a href="https://semaphore.appliedzkp.org/discord">
+                <a href="https://semaphore.pse.dev/discord">
                     Discord
                 </a>
             </td>

diff --git a/docs/index.html b/docs/index.html
diff --git a/package.json b/package.json
@@ -17,7 +17,7 @@
         "lint": "eslint . --ext .js,.ts && yarn workspace contracts lint",
         "prettier": "prettier -c .",
         "prettier:write": "prettier -w .",
-        "docs": "yarn workspaces foreach --no-private run docs",
+        "docs": "typedoc --cname js.semaphore.pse.dev --githubPages true",
         "version:bump": "yarn workspaces foreach --no-private version -d ${0} && yarn version apply --all && git commit -am \"chore: v${0}\" && git tag v${0}",
         "version:publish": "yarn build:libraries && yarn remove:template-files && yarn workspaces foreach --no-private npm publish --tolerate-republish --access public",
         "version:release": "changelogithub",
@@ -77,6 +77,7 @@
         "rollup": "^2.64.0",
         "ts-node": "^10.4.0",
         "tslib": "^2.3.1",
+        "typedoc": "^0.25.1",
         "typescript": "^4.7.0"
     },
     "config": {

diff --git a/packages/circuits/README.md b/packages/circuits/README.md
@@ -28,10 +28,10 @@
             🔎 Issues
         </a>
         <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
-        <a href="https://semaphore.appliedzkp.org/discord">
+        <a href="https://semaphore.pse.dev/discord">
             🗣️ Chat &amp; Support
         </a>
     </h4>
 </div>
 
-To learn more about circuits visit [semaphore.appliedzkp.org](https://semaphore.appliedzkp.org/docs/technical-reference/circuits).
+To learn more about circuits visit [semaphore.pse.dev](https://semaphore.pse.dev/docs/technical-reference/circuits).
diff --git a/packages/cli-template-contracts-hardhat/README.md b/packages/cli-template-contracts-hardhat/README.md
@@ -48,7 +48,7 @@ yarn deploy --semaphore <semaphore-address> --group <group-id> --network goerli
 ```
 
 > **Note**  
-> Check the Semaphore contract addresses [here](https://semaphore.appliedzkp.org/docs/deployed-contracts#semaphore).
+> Check the Semaphore contract addresses [here](https://semaphore.pse.dev/docs/deployed-contracts#semaphore).
 
 > **Warning**  
 > The group id is a number!
diff --git a/packages/cli-template-contracts-hardhat/package.json b/packages/cli-template-contracts-hardhat/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@semaphore-protocol/cli-template-contracts-hardhat",
-    "version": "3.11.0",
+    "version": "3.11.1",
     "description": "Semaphore Hardhat template.",
     "license": "Unlicense",
     "files": [
@@ -36,10 +36,10 @@
         "@nomicfoundation/hardhat-toolbox": "^2.0.0",
         "@nomiclabs/hardhat-ethers": "^2.0.0",
         "@nomiclabs/hardhat-etherscan": "^3.0.0",
-        "@semaphore-protocol/group": "3.11.0",
-        "@semaphore-protocol/hardhat": "3.11.0",
-        "@semaphore-protocol/identity": "3.11.0",
-        "@semaphore-protocol/proof": "3.11.0",
+        "@semaphore-protocol/group": "3.11.1",
+        "@semaphore-protocol/hardhat": "3.11.1",
+        "@semaphore-protocol/identity": "3.11.1",
+        "@semaphore-protocol/proof": "3.11.1",
         "@typechain/ethers-v5": "^10.1.0",
         "@typechain/hardhat": "^6.1.2",
         "@types/chai": "^4.2.0",
@@ -58,7 +58,7 @@
         "typescript": ">=4.5.0"
     },
     "dependencies": {
-        "@semaphore-protocol/contracts": "3.11.0"
+        "@semaphore-protocol/contracts": "3.11.1"
     },
     "config": {
         "solidity": {

diff --git a/packages/cli-template-monorepo-ethers/README.md b/packages/cli-template-monorepo-ethers/README.md
@@ -33,7 +33,7 @@ yarn deploy --semaphore <semaphore-address> --group <group-id> --network arbitru
 3. Copy your contract artifacts from `apps/contracts/build/contracts/contracts` folder to `apps/web-app/contract-artifacts` folders manually. Or run `yarn copy:contract-artifacts` in the project root to do it automatically.
 
 > **Note**  
-> Check the Semaphore contract addresses [here](https://semaphore.appliedzkp.org/docs/deployed-contracts).
+> Check the Semaphore contract addresses [here](https://semaphore.pse.dev/docs/deployed-contracts).
 
 > **Warning**  
 > The group id is a number!

diff --git a/packages/cli-template-monorepo-ethers/apps/contracts/package.json b/packages/cli-template-monorepo-ethers/apps/contracts/package.json
@@ -18,10 +18,10 @@
         "@nomicfoundation/hardhat-chai-matchers": "^1.0.5",
         "@nomiclabs/hardhat-ethers": "^2.0.0",
         "@nomiclabs/hardhat-etherscan": "^3.1.7",
-        "@semaphore-protocol/group": "3.11.0",
-        "@semaphore-protocol/hardhat": "3.11.0",
-        "@semaphore-protocol/identity": "3.11.0",
-        "@semaphore-protocol/proof": "3.11.0",
+        "@semaphore-protocol/group": "3.11.1",
+        "@semaphore-protocol/hardhat": "3.11.1",
+        "@semaphore-protocol/identity": "3.11.1",
+        "@semaphore-protocol/proof": "3.11.1",
         "@typechain/ethers-v5": "^10.0.0",
         "@typechain/hardhat": "^6.0.0",
         "@types/chai": "^4.3.1",
@@ -40,7 +40,7 @@
         "typechain": "^8.0.0"
     },
     "dependencies": {
-        "@semaphore-protocol/contracts": "3.11.0"
+        "@semaphore-protocol/contracts": "3.11.1"
     },
     "config": {
         "solidity": {

diff --git a/packages/cli-template-monorepo-ethers/apps/web-app/package.json b/packages/cli-template-monorepo-ethers/apps/web-app/package.json
@@ -10,10 +10,10 @@
     },
     "dependencies": {
         "@next/font": "13.0.3",
-        "@semaphore-protocol/data": "3.11.0",
-        "@semaphore-protocol/group": "3.11.0",
-        "@semaphore-protocol/identity": "3.11.0",
-        "@semaphore-protocol/proof": "3.11.0",
+        "@semaphore-protocol/data": "3.11.1",
+        "@semaphore-protocol/group": "3.11.1",
+        "@semaphore-protocol/identity": "3.11.1",
+        "@semaphore-protocol/proof": "3.11.1",
         "@types/react": "18.0.25",
         "@types/react-dom": "18.0.8",
         "dotenv": "^16.0.3",

diff --git a/packages/cli-template-monorepo-ethers/apps/web-app/src/pages/groups.tsx b/packages/cli-template-monorepo-ethers/apps/web-app/src/pages/groups.tsx
@@ -84,7 +84,7 @@ export default function GroupsPage() {
             <p>
                 Semaphore{" "}
                 <a
-                    href="https://semaphore.appliedzkp.org/docs/guides/groups"
+                    href="https://semaphore.pse.dev/docs/guides/groups"
                     target="_blank"
                     rel="noreferrer noopener nofollow"
                 >

diff --git a/packages/cli-template-monorepo-ethers/apps/web-app/src/pages/index.tsx b/packages/cli-template-monorepo-ethers/apps/web-app/src/pages/index.tsx
@@ -40,7 +40,7 @@ export default function IdentitiesPage() {
             <p>
                 Users interact with the protocol using a Semaphore{" "}
                 <a
-                    href="https://semaphore.appliedzkp.org/docs/guides/identities"
+                    href="https://semaphore.pse.dev/docs/guides/identities"
                     target="_blank"
                     rel="noreferrer noopener nofollow"
                 >

diff --git a/packages/cli-template-monorepo-ethers/apps/web-app/src/pages/proofs.tsx b/packages/cli-template-monorepo-ethers/apps/web-app/src/pages/proofs.tsx
@@ -112,7 +112,7 @@ export default function ProofsPage() {
             <p>
                 Semaphore members can anonymously{" "}
                 <a
-                    href="https://semaphore.appliedzkp.org/docs/guides/proofs"
+                    href="https://semaphore.pse.dev/docs/guides/proofs"
                     target="_blank"
                     rel="noreferrer noopener nofollow"
                 >

diff --git a/packages/cli-template-monorepo-ethers/package.json b/packages/cli-template-monorepo-ethers/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@semaphore-protocol/cli-template-monorepo-ethers",
-    "version": "3.11.0",
+    "version": "3.11.1",
     "description": "Semaphore Hardhat + Next.js + SemaphoreEthers template.",
     "license": "Unlicense",
     "files": [