The Ethereum Foundation leads research into cryptographic protocols that are useful within the greater Ethereum community and more generally. Cryptography is a key tool that enables greater functionality, security, efficiency, and auditability in decentralized settings. We are currently conducting research into verifiable delay functions, multiparty computation, vector commitments, and zero-knowledge proofs etc. We have a culture of open source and no patents are put on any work that we produce.
This repository holds the codebase to our website, crypto.ethereum.org
Inspired by: https://github.com/ethereum/protocol-prototyping-site/blob/main/TEAM_MEMBERS.txt
The main stack used in the project includes:
- Next.js.
- TypeScript.
- ChakraUI as component library.
- KaTeX to render LaTeX math syntax.
The project is bootstrapped with create-next-app, with a custom scaffolding.
This project uses pnpm—run corepack enable to enable it. The canonical Node version is specified in .nvmrc. Run pnpm fetch to pull team work data from GitHub (runs automatically during build, but not dev).
First, run the development server:
pnpm devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.
The following list describes the main elements of the project structure:
public: contains static assets like fonts and images.src: contains the source code.components: React components.- components with state are directly located inside
/components. layout: components used to contain and apply different layouts to different pages.UI: stateless (functional) components.
- components with state are directly located inside
pages: includes components that renders to pages and NextJS API Routes.posts: markdown blog posts.styles: css stylesheets.global.css: global stylesheet.
theme: contains the Chakra UI custom theme, organized infoundationsandcomponentsfor better scaling.utils: utilitary stuff.constants.ts: this is the global constants file, containg URLs and lists of elements we use across the site.types.ts: contains the custom defined TypeScript types and interfaces.
Support for GitHub Flavored Markdown, which is a superset of CommonMark and adds supports to other features like tables.
The site uses KaTeX to render LaTeX/math and inside /research publications abstracts. LaTeX-rendering libs are not 100% compatible with LaTex yet, so please check the support table if you are having issues with some expression.
The site supports both internal and external blog posts.
- Internal posts: to add a new one, just create a new markdown (
.md) file undersrc/posts(make sure first this directory exists, otherwise create it first, under/src). The name of the file should follow the kebab case convention, as it will be used to generate the url to the post. You also have to add some Front Matter metadata, like the posttitle,author(s)anddate, which are required.
Metadata example:
---
title: 'VDF Proving with SnarkPack'
description 'Some awesome description for social media snippets, under 160 characters'
author: 'Mary Maller'
date: '2022-03-16'
---
Post titles should be under 60 characters. Learn more on title tags.
Post descriptions should be under 160 characters. Learn more on meta descriptions.
- External posts: Team members can maintain their own
work.jsonfiles in their GitHub repositories. Configure team members inTEAM_MEMBERS.txtand runpnpm fetchto pull their work items. The format isusername/repo/display-name/twitter/branch.
Image files should be placed inside /public/images/ and the path to the image will be referenced as /images/${filename}. For example, we can insert the EF logo in a post by using
Take into account that images are automatically centered, no need to add extra HTML.
Follow this syntax.
- Locally: Make sure the site builds locally, otherwise the build will break and the new version of the site (e.g.: adding a new post) will not be generated. To be sure of this, run
pnpm buildlocally and check that you get no errors. - On GitHub: check that the
Deploy Previewpasses succesfully.
The source files (.md) for the bounties pages are located at /src/bounties-data-source. If you need to update the content from a certain bounty, just modify the corresponding file. LaTeX/math is also supported here.
For a better organization, images used in bounties pages are placed inside /public/images/bounties/ and the path to the image have to be referenced as /images/bounties/${filename} (check /src/bounties-data-source/rsa/assumptions.md as example).
Follow the current Event structure you can find in /src/pages/events.tsx and use any other existent entry as example, like the example below:
<Event
conference='Cryptographic Frontier 2022, Trondheim'
workshop='Open Problems in Decentralized Computation at Eurocrypt 2022'
url='https://sites.google.com/view/cryptographic-frontier-2022/'
>
this workshop brings the most interesting and challenging open cryptographic questions
that Ethereum, Filecoin and other blockchain systems face, to the attention of academia.
We will cover a large spectrum of research topics, such as vector commitments, SNARKs,
shuffles, authenticated data structures and more. We will start the day with an update
on to the problems discussed at last year's workshop.
</Event>
Be sure to provide a value for conference, workshop and the correct url.
- Dates should follow the
yyyy-mm-ddformat (for both internal and external posts), likedate: '2022-03-16' - Blog posts are sorted automatically by date, regardless the order of insertion.
- Check the current sample posts on
src/posts.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
This is a very clear and step-by-step guide on it.
We recommend checking the official docs.