@maci-protocol/website 0.0.0-ci.00107eb

package/src/pages/index.module.css

@@ -0,0 +1,152 @@
+/**
+ * CSS files with the .module.css suffix will be treated as CSS modules
+ * and scoped locally.
+ */
+
+.heroBanner {
+  position: relative;
+  height: 427px;
+  overflow: hidden;
+  background-image:
+    linear-gradient(to bottom, rgba(0, 0, 0, 0.3) 0%, rgba(0, 0, 0, 0.3) 100%), url("../../static/img/hero.svg");
+  background-position: 0% 75%;
+  background-repeat: no-repeat;
+  background-size: cover;
+  flex-direction: column;
+  justify-content: center;
+  align-items: start;
+  padding: 8rem;
+  color: var(--ifm-color-hero);
+  font-family: ShareTechMono;
+  gap: 1rem;
+}
+
+.heroTitle {
+  border: 2px solid white;
+  border-radius: 4px;
+  padding: 0rem 0.75rem;
+  font-size: 2.5rem;
+  line-height: 3.5rem;
+  letter-spacing: -0.1rem;
+}
+
+.heroTagline {
+  font-size: 4.5rem;
+  line-height: 5rem;
+}
+
+.buttons {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+
+.introduction {
+  display: flex;
+  align-items: center;
+  padding: 4rem;
+  width: 100%;
+  font-size: 1.1rem;
+}
+
+.blue {
+  color: var(--ifm-link-color);
+}
+
+.borderBlue {
+  text-decoration: underline;
+  text-decoration-color: var(--ifm-link-color);
+  text-underline-offset: 0.5rem;
+  margin-bottom: 1rem;
+}
+
+.projectsPage {
+  width: 100%;
+}
+
+.heroSection {
+  padding-top: 170px;
+  padding-bottom: 56px;
+  width: 100%;
+  position: relative;
+  display: flex;
+  justify-content: flex-end;
+  align-items: flex-start;
+}
+
+.backgroundImage {
+  position: absolute;
+  top: 0;
+  left: 50%;
+  transform: translateX(-50%);
+  width: 100vw;
+  height: 100%;
+  overflow: hidden;
+  z-index: -1;
+}
+
+.backgroundImage img {
+  width: 100%;
+  height: 100%;
+  object-fit: cover;
+}
+
+.heroContent {
+  padding-bottom: 64px;
+}
+
+.heroContent h1 {
+  font-size: 72px;
+  margin-bottom: 16px;
+}
+
+.heroContent p {
+  font-size: 20px;
+}
+
+.actionSection {
+  margin-top: 128px;
+  margin-bottom: 128px;
+}
+
+/* Responsive styles */
+@media (max-width: 768px) {
+  .heroContent h1 {
+    font-size: 46px;
+  }
+
+  .heroContent p {
+    font-size: 18px;
+  }
+}
+
+@media (max-width: 480px) {
+  .heroContent h1 {
+    font-size: 40px;
+  }
+
+  .heroContent p {
+    font-size: 16px;
+  }
+}
+
+@media screen and (max-width: 996px) {
+  .heroBanner {
+    padding: 1.5rem;
+  }
+
+  .introduction {
+    padding: 1.5rem;
+  }
+
+  .heroTitle {
+    font-size: 1.5rem;
+    line-height: 2.25rem;
+    padding: 0rem 0.5rem;
+  }
+
+  .heroTagline {
+    font-size: 2.5rem;
+    line-height: 3rem;
+  }
+}

package/src/pages/index.tsx

@@ -0,0 +1,66 @@
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import Layout from "@theme/Layout";
+import LayoutProvider from "@theme/Layout/Provider";
+import clsx from "clsx";
+
+import type { ReactElement } from "react";
+
+import HomepageFeatures from "../components/HomepageFeatures";
+
+import styles from "./index.module.css";
+
+interface HomepageHeaderProps {
+  tagline: string;
+  title: string;
+}
+
+const HomepageHeader = ({ tagline, title }: HomepageHeaderProps) => (
+  <header className={clsx("hero hero--dark", styles.heroBanner)}>
+    <div className={styles.heroTitle}>{title}</div>
+
+    <div className={styles.heroTagline}>
+      {tagline}
+
+      <span className={styles.blue}>.</span>
+    </div>
+  </header>
+);
+
+const Home = (): ReactElement => {
+  const { siteConfig } = useDocusaurusContext();
+
+  return (
+    <LayoutProvider>
+      <Layout
+        description="Minimal Anti-Collusion Infrastructure (MACI) is an on-chain voting platform which protects privacy and minimizes the risk of collusion and bribery"
+        title={`Minimal Anti-Collusion Infrastructure (${siteConfig.title})`}
+      >
+        <HomepageHeader tagline={siteConfig.tagline} title={siteConfig.title} />
+
+        <main>
+          <section className={styles.introduction}>
+            <div className="container">
+              <h2 className={styles.borderBlue}>What is MACI?</h2>
+
+              <p>Minimal Anti-Collusion Infrastructure (MACI) is a private, on-chain, voting system.</p>
+
+              <p>
+                MACI is our attempt to build the most secure e-voting solution available. It enables on-chain voting
+                processes with significantly reduced risk of cheating, like bribery or collusion, through the use of
+                Ethereum smart contracts, encryption, and zero-knowledge proofs. Together these technologies provide a
+                set of guarantees including censorship resistance, correct execution, privacy, and a receipt-free voting
+                scheme, which ensures results are transparent but makes it impossible for outsiders to verify how any
+                specific user voted. We believe MACI is most beneficial for governance and funding events, when the
+                stakes are high and anti-collusion mechanisms are critical to help ensure fair and transparent outcomes.
+              </p>
+            </div>
+          </section>
+
+          <HomepageFeatures />
+        </main>
+      </Layout>
+    </LayoutProvider>
+  );
+};
+
+export default Home;

package/src/pages/projects.tsx

@@ -0,0 +1,44 @@
+import Layout from "@theme/Layout";
+import LayoutProvider from "@theme/Layout/Provider";
+import clsx from "clsx";
+
+import ProjectsList from "../components/ProjectList";
+
+import styles from "./index.module.css";
+
+interface ProjectspageHeaderProps {
+  tagline: string;
+  title: string;
+}
+
+const ProjectspageHeader = ({ tagline, title }: ProjectspageHeaderProps) => (
+  <header className={clsx("hero hero--dark", styles.heroBanner)}>
+    <div className={styles.heroTitle}>{title}</div>
+
+    <div className={styles.heroTagline}>
+      {tagline}
+
+      <span className={styles.blue}>.</span>
+    </div>
+  </header>
+);
+
+const Projects: React.FC = () => (
+  <LayoutProvider>
+    <Layout description="A list of projects built with the MACI protocol" title="Projects built with MACI">
+      <div>
+        <ProjectspageHeader tagline="Explore the projects built by the MACI community" title="Projects" />
+      </div>
+
+      <main>
+        <section className={styles.introduction}>
+          <div className="container">
+            <ProjectsList />
+          </div>
+        </section>
+      </main>
+    </Layout>
+  </LayoutProvider>
+);
+
+export default Projects;

package/src/pages/roadmap.md

@@ -0,0 +1,109 @@
+---
+title: MACI Product Roadmap
+description: An outline of the 2024 MACI team & product roadmap
+---
+
+# MACI Product Roadmap
+
+_This public roadmap is part of our core team's efforts to make our work more accessible and to foster more collaboration from our open source community. We plan to re-assess & iterate on our roadmap over time, and will update this document when we do._
+
+:::info
+This document aims to outline the 2025 MACI roadmap. Our roadmap is under constant discussion and evolution (e.g. see our [high level 2025 roadmap](/blog/2025-roadmap) updates) but we try our best to maintain this page to provide a high-level overview. Please join the conversation in our [discord server](https://discord.com/invite/sF5CT5rzrR) if you have feedback!
+
+**Last updated: 2025-04-23**
+:::
+
+## Team description
+
+The MACI core team is a small collaborative engineering team building various projects within [Privacy & Scaling Explorations (PSE)](https://pse.dev/). Our sustained focus is on MACI: an on-chain voting protocol that provides greatly increased collusion resistance & privacy. We also allocate a portion of our time to support the practical adoption of this technology by supporting community leaders to run democratic governance and public funding initiatives, like Quadratic Voting (QV), Quadratic Funding (QF), and Retroactive Public Goods Funding (RPGF) grant rounds.
+
+## MACI mission & vision
+
+MACI (Minimal Anti-Collusion Infrastructure) is a public good & a potential core piece of infrastructure for many Ethereum-based applications to support privacy-protecting on-chain governance. Using MACI, individual votes are private but final results are public, so no voter can reveal how they voted yet voting results are verifiable with cryptographic proofs to prevent censorship, bribery, collusion, and other forms of manipulation common in public polling processes.
+
+**Long term, the MACI team’s vision is to build the most secure e-voting solution in the world.**
+
+Short term, our vision is to empower developers to build with MACI to create collusion resistant & privacy-protecting voting applications, like quadratic funding platforms & DAO governance tools. Our goal is to provide an out-of-the-box solution for developers to quickly integrate into their applications & deploy. MACI aims to handle the voting infrastructure so you can focus on building the logic specific to your application.
+
+### High-level MACI ecosystem goals
+
+1. ~~2021: MACI integrated by an ecosystem project~~ (✅, [clr.fund](https://github.com/clrfund/monorepo/))
+2. ~~2023: MACI integrated by a PSE project~~ (✅, [QF](https://github.com/privacy-scaling-explorations/qf))
+3. ~~2024: MACI integrated by an additional external project~~ (✅, [PriVote](https://github.com/PriVote-Project), [Gitcoin](https://github.com/gitcoinco/MACI_QF))
+4. 2025: MACI used by multiple DAOs for governance applications
+5. 2028: MACI used in smaller municipal elections (counties, provinces, etc)
+6. 2030: MACI used in national elections
+
+### High-level MACI development goals
+
+1. ~~2021: release MACI v1.0~~ (✅)
+2. ~~2023: build technical feasibility for 10K concurrent voters on the platform~~ (✅)
+3. 2024:
+
+- ~~Q1: release MACI v1.2, with revamped documentation & educational resource~~ (✅)
+- ~~Q3: release MACI v2.0, with cleaner code and improved UX~~ (✅)
+
+4. 2025: release MACI v3.0, with new features for a more scalable and flexible platform
+5. 2026: build technical feasibility for 100K concurrent voters on the platform
+6. 2028: build technical feasibility for 1M concurrent voters on the platform
+
+# 2025 workstreams
+
+In 2025, we are focusing on several initiatives to support the practical adoption of MACI.
+
+## 1) MACI v3.0
+
+This new version comes with features that have been requested in the past, such as polls being more customisable, in terms of voice credits assigned to voters, and gatekeeping mechanisms.
+
+At a high level, the new features/improvements are:
+
+- Custom voice credits per poll
+- Custom gatekeeping per poll
+- Replacement of vote merkle trees for more efficient hash-chains
+- Offchain voting via MACI's relayer service
+
+## 2) Coordinator Service
+
+The coordinator service is a service to automate MACI coordinator functionality. This includes:
+
+- Contract deployment
+- Subgraph deploying
+- Proof generation
+- Proof and results submission
+
+This service exposes a REST API, as well as some Websocket endpoints (for proof generation only). Our goal is to release an efficient and easy to use service that can be used by any application that builds atop of MACI.
+
+## 3) Integration with DAO's tooling provider
+
+As an effort to support DAO governance, and help solve their issues with bribery and collusion, MACI is focusing on integrating with DAO's tooling providers.
+
+To start with, MACI is integrating with [Aragon](https://aragon.org/) by building a voting [plugin](https://github.com/privacy-scaling-explorations/maci-voting-plugin).
+
+In the future, we plan to continue working with other partners such as [Agora](https://www.agora.xyz/), and help them offer DAOs secure and private voting.
+
+## 4) Coordinator decentralisation
+
+It's no secret that one of MACI long standing issues has having a centralised coordinator. They are able to see all of the votes in cleartext, which allows them to collude with bribers themselves, as well as voters. As we look to tackle use cases such as DAO governance where large quantities of money are involved in proposals, we need to ensure that collusion between the coordinator and voters/bribers is reduced. This can be accomplished in several ways:
+
+- Use Multi Party Computation (MPC)
+- Use Homomorphic Encryption (HE)
+- Use a Trusted Execution Environment (TEE)
+
+We plan to research the best approach and start the implementation within the year.
+
+## Future R&D
+
+While not prioritized as an upcoming workstream, we think it’s worth calling out important areas of research & development that we’re excited to work on in the future:
+
+### MACI improvements
+
+- Scaling explorations, like SNARK Folding Schemes (e.g. [Nova integration](https://github.com/privacy-scaling-explorations/maci/issues/904))
+- Different matching mechanisms (e.g. [Group Wise Matching in Quadratic Funding](https://github.com/privacy-scaling-explorations/maci/issues/905))
+- Re-implementation of previously removed features such as [Topup](https://github.com/privacy-scaling-explorations/maci/issues/1384) and [Subsidy](https://github.com/privacy-scaling-explorations/maci/issues/1348)
+- [Benchmarks](https://github.com/privacy-scaling-explorations/maci/issues/1197) for the whole stack
+
+## Feedback
+
+Questions? Concerns? Ideas? We’d love to hear from you!
+
+Feel free to [create an issue on our GitHub](https://github.com/privacy-scaling-explorations/maci/issues) or reach out to our team in the [PSE Discord](https://discord.com/invite/sF5CT5rzrR) (`#maci` channel).

package/src/pages/typedoc.tsx

@@ -0,0 +1,11 @@
+import Layout from "@theme/Layout";
+
+import type { ReactElement } from "react";
+
+const TypedocPage = (): ReactElement => (
+  <Layout description="Description for your Typedoc page" title="Typedoc">
+    <iframe src="/typedoc_output/index.html" style={{ width: "100%", height: "100vh" }} title="typedoc" />
+  </Layout>
+);
+
+export default TypedocPage;

package/src/plugins/blog-plugin/index.ts

@@ -0,0 +1,86 @@
+import matter from "gray-matter";
+
+import fs from "fs";
+import path from "path";
+
+import type { Plugin as DocusaurusPlugin } from "@docusaurus/types";
+
+interface BlogPost {
+  title: string;
+  date: string;
+  slug: string;
+  description: string;
+  authorName: string;
+  tags: string[];
+  excerpt: string;
+}
+
+async function getAllFiles(dirPath: string, arrayOfFiles: string[] = []): Promise<string[]> {
+  const files = await fs.promises.readdir(dirPath);
+
+  const filePromises = files.map(async (file) => {
+    const filePath = path.join(dirPath, file);
+    const stat = await fs.promises.stat(filePath);
+
+    if (stat.isDirectory()) {
+      await getAllFiles(filePath, arrayOfFiles);
+    } else {
+      arrayOfFiles.push(filePath);
+    }
+  });
+
+  await Promise.all(filePromises);
+  return arrayOfFiles;
+}
+
+export { getAllFiles };
+
+async function loadContent(): Promise<BlogPost[]> {
+  const blogDir = path.join(__dirname, "..", "..", "..", "blog");
+  const files = await getAllFiles(blogDir);
+
+  const posts = (
+    await Promise.all(
+      files.map(async (filePath): Promise<BlogPost | null> => {
+        const fileContent = await fs.promises.readFile(filePath, "utf-8");
+        const { data } = matter(fileContent);
+
+        if (!data.title) {
+          return null;
+        }
+
+        const filename = path.basename(filePath);
+        const match = filename.match(/^(\d{4}-\d{2}-\d{2})/);
+        if (!match) {
+          return null;
+        }
+
+        const date = match[1];
+        const authorName = ((data.authors as Record<string, unknown> | undefined)?.name as string) || "";
+
+        return {
+          title: data.title as string,
+          description: data.description ? (data.description as string) : "",
+          date,
+          slug: data.slug ? (data.slug as string) : filename.replace(/\.md$/, ""), // Use slug from front matter if available
+          authorName,
+          tags: data.tags ? (data.tags as string[]) : [],
+          excerpt: data.excerpt ? (data.excerpt as string) : "",
+        };
+      }),
+    )
+  ).filter((post): post is BlogPost => post !== null);
+
+  // Sort posts by date in descending order (newest first)
+  posts.sort((a, b) => new Date(b.date).getTime() - new Date(a.date).getTime());
+
+  return posts;
+}
+
+export { loadContent };
+
+export default function blogPlugin(): DocusaurusPlugin<undefined> {
+  return {
+    name: "blog-plugin",
+  };
+}

package/src/react-app-env.d.ts

@@ -0,0 +1 @@
+declare module "*.png";

package/src/scripts/setupSolidityDocs.ts

@@ -0,0 +1,67 @@
+import fs from "fs";
+import path from "path";
+
+import { copyDirectory, generateToC, insertIndexPage } from "./utils";
+
+// where to move the solidity doc files over
+const solidityDocDir = path.resolve(
+  __dirname,
+  "../../versioned_docs/version-v3.x/technical-references/smart-contracts/solidity-docs",
+);
+// the origin folder (from the contracts package)
+const sourceDir = path.resolve(__dirname, "../../../../packages/contracts/docs");
+
+/**
+ * Currently, Solidity docgen generates the same heading for all files.
+ * We need to remove it and add the contract name as a heading.
+ * @param dir - the directory where the documentation files are located
+ */
+function updateHeadings(dir: string) {
+  const files = fs.readdirSync(dir);
+
+  files.forEach((file: string) => {
+    const absolutePath = path.join(dir, file);
+    const isDirectory = fs.statSync(absolutePath).isDirectory();
+
+    if (isDirectory) {
+      insertIndexPage(
+        absolutePath,
+        { title: file, label: file },
+        `
+          Documentation for smart contracts inside the ${file} folder.\n
+          ${generateToC(absolutePath)}\n
+        `,
+      );
+      updateHeadings(absolutePath);
+    } else {
+      // Read the content of the file
+      let fileContent = fs.readFileSync(absolutePath, "utf8");
+
+      // Remove the "# Solidity API" line
+      fileContent = fileContent.replace("# Solidity API\n", "");
+
+      // Replace the first "##" with "#"
+      fileContent = fileContent.replace("##", "#");
+
+      // Escape {...} by wrapping them in backticks
+      fileContent = fileContent.replace(/{(.*?)}/g, "`{$1}`");
+
+      // Write the modified content back to the file
+      fs.writeFileSync(absolutePath, fileContent, "utf8");
+    }
+  });
+}
+
+// copy over the directory
+copyDirectory(sourceDir, solidityDocDir);
+// update the headings
+updateHeadings(solidityDocDir);
+// insert index page
+insertIndexPage(
+  solidityDocDir,
+  {
+    title: "Solidity Docs",
+    label: "Solidity Docs",
+  },
+  "This is a collection of the Solidity documentation for the MACI protocol. It is autogenerated with solidity-docs and should serve as a good starting point for understanding the codebase.",
+);

package/src/scripts/setupTypedoc.ts

@@ -0,0 +1,112 @@
+import fs from "fs";
+import path from "path";
+
+import { copyDirectory, fitFormat, generateSidebarString, generateToC, insertIndexPage } from "./utils";
+
+const TYPEDOC_DIR = path.resolve(__dirname, "../../typedoc");
+
+/**
+ * A function that remove the auto-generated navigator
+ * and the title at the top of the page,
+ * meanwhile adding sidebar configurations above the content.
+ * @param file - the file being updated
+ * @param sidebarInfo - sidebar infos, passed in as a string
+ */
+function updateMdFiles(file: string, sidebarInfo: string) {
+  const content = fs.readFileSync(file).toString().split("\n");
+
+  if (content.length > 3) {
+    content.shift();
+    content.shift();
+    content.shift();
+  }
+
+  const writtenContent = content.join("\n").replaceAll("README.md", "index.md");
+  fs.writeFileSync(file, `${sidebarInfo}\n${writtenContent}`);
+}
+
+/**
+ * A function that parses a sub-directory of typedoc/,
+ * defines label for it and updates the markdown files.
+ * @param dir - the sub-directory being processed
+ */
+function parseAndRenameDirectory(dir: string) {
+  const dirname = path.resolve(TYPEDOC_DIR, dir);
+  const label = fitFormat(dir);
+
+  // only do things if it's a directory
+  if (fs.statSync(dirname).isDirectory()) {
+    const readmeFile = path.resolve(dirname, "README.md");
+
+    if (fs.existsSync(readmeFile)) {
+      updateMdFiles(readmeFile, generateSidebarString({ title: label, label }));
+      fs.renameSync(readmeFile, path.resolve(dirname, "index.md"));
+    }
+
+    // remove the first two lines of navigator
+    const modulesFile = path.resolve(dirname, "modules.md");
+
+    if (fs.existsSync(modulesFile)) {
+      updateMdFiles(modulesFile, generateSidebarString({ title: `${label} Module`, label: "module", position: 1 }));
+    }
+
+    processDirectory(dirname);
+  }
+}
+
+/**
+ * A function that processes a directory and updates the markdown files.
+ * @param directory - the directory being processed
+ */
+function processDirectory(directory: string) {
+  const items = fs.readdirSync(directory);
+  items.forEach((item) => {
+    const itemPath = path.resolve(directory, item);
+    if (fs.statSync(itemPath).isDirectory()) {
+      processDirectory(itemPath); // Recursively process subdirectories
+    } else if (fs.statSync(itemPath).isFile()) {
+      const itemLabel = item.split(".")[0];
+      updateMdFiles(itemPath, generateSidebarString({ title: itemLabel, label: itemLabel }));
+    }
+  });
+}
+
+/**
+ * A function that parses a sub-directory of typedoc/,
+ * defines label for it and updates the markdown files.
+ * @return target directory path for typedocs
+ */
+function defineTargetDirectory() {
+  const versionFile = path.resolve(__dirname, "../../versions.json");
+
+  if (fs.existsSync(versionFile)) {
+    const versionContent = fs.readFileSync(versionFile, "utf8");
+    if (versionContent) {
+      const versionContentJson = JSON.parse(versionContent) as string[];
+      return path.resolve(
+        __dirname,
+        `../../versioned_docs/version-${versionContentJson[0]}/technical-references/typescript-code/typedoc`,
+      );
+    }
+  }
+
+  return path.resolve(__dirname, "../../docs/technical-references/typescript-code/typedoc");
+}
+
+if (fs.existsSync(TYPEDOC_DIR)) {
+  const directories = fs.readdirSync(TYPEDOC_DIR, "utf8");
+  directories.forEach((dir) => {
+    parseAndRenameDirectory(dir);
+  });
+
+  insertIndexPage(
+    TYPEDOC_DIR,
+    { title: "Typedoc", label: "Typedoc" },
+    `\nTypedoc API documentation.\n${generateToC(TYPEDOC_DIR)}\n`,
+  );
+
+  const versionDir = defineTargetDirectory();
+  copyDirectory(TYPEDOC_DIR, versionDir);
+
+  fs.rmSync(TYPEDOC_DIR, { recursive: true, force: true });
+}