EIPs README

The project's README from github.com/ethereum/EIPs. As one markdown file: README.md.

Ethereum Improvement Proposals (EIPs)

ATTENTION: The EIPs repository has recently undergone a separation of ERCs and EIPs. ERCs are now accessible at https://github.com/ethereum/ercs. All new ERCs and updates to existing ones must be directed at this new repository. The editors apologize for this inconvenience.

The goal of the EIP project is to standardize and provide high-quality documentation for Ethereum itself and conventions built upon it. This repository tracks past and ongoing improvements to Ethereum in the form of Ethereum Improvement Proposals (EIPs). EIP-1 governs how EIPs are published.

The status page tracks and lists EIPs, which can be divided into the following categories:

Core EIPs are improvements to the Ethereum consensus protocol.
Networking EIPs specify the peer-to-peer networking layer of Ethereum.
Interface EIPs standardize interfaces to Ethereum, which determine how users and applications interact with the blockchain.
ERCs specify application layer standards, which determine how applications running on Ethereum can interact with each other.
Meta EIPs are miscellaneous improvements that nonetheless require some sort of consensus.
Informational EIPs are non-standard improvements that do not require any form of consensus.

Before you write an EIP, ideas MUST be thoroughly discussed on Ethereum Magicians or Ethereum Research. Once consensus is reached, thoroughly read and review EIP-1, which describes the EIP process.

Please note that this repository is for documenting standards and not for help implementing them. These types of inquiries should be directed to the Ethereum Stack Exchange. For specific questions and concerns regarding EIPs, it's best to comment on the relevant discussion thread of the EIP denoted by the discussions-to tag in the EIP's preamble.

If you would like to become an EIP Editor, please read EIP-5069.

Preferred Citation Format

The canonical URL for an EIP that has achieved draft status at any point is at https://eips.ethereum.org/. For example, the canonical URL for EIP-1 is https://eips.ethereum.org/EIPS/eip-1.

Consider any document not published at https://eips.ethereum.org/ as a working paper. Additionally, consider published EIPs with a status of "draft", "review", or "last call" to be incomplete drafts, and note that their specification is likely to be subject to change.

Validation and Automerging

All pull requests in this repository must pass automated checks before they can be automatically merged:

eip-review-bot determines when PRs can be automatically merged ^1
EIP-1 rules are enforced using eipw^2
HTML formatting and broken links are enforced using HTMLProofer ^2
Spelling is enforced with CodeSpell^2
- False positives sometimes occur. When this happens, please submit a PR editing .codespell-whitelist and ONLY .codespell-whitelist
Markdown best practices are checked using markdownlint ^2

It is possible to run the EIP validator locally:

Make sure to add cargo's bin directory to your environment (typically $HOME/.cargo/bin in your PATH environment variable)

cargo install eipw
eipw --config ./config/eipw.toml <INPUT FILE / DIRECTORY>

Build the status page locally

Install prerequisites

Open Terminal.
Check whether you have Ruby 3.1.4 installed. Later versions are not supported.
```
ruby --version
```
If you don't have Ruby installed, install Ruby 3.1.4.
Install Bundler:
```
gem install bundler
```
Install dependencies:
```
bundle install
```

Build your local Jekyll site

Bundle assets and start the server:
```
bundle exec jekyll serve
```
Preview your local Jekyll site in your web browser at http://localhost:4000.

More information on Jekyll and GitHub Pages here.

ethereum

Searching Database…

14K ·GitHub

What is this?

It is the official repository of Ethereum Improvement Proposals (EIPs) — technical standards documents that specify improvements to Ethereum itself and conventions built upon it.

Is this a piece of software or a collection of documents?

A collection of specification documents rather than software. Each EIP is a numbered proposal, EIP-1 governs how proposals are published, and a status page tracks and lists them all.

How would I get my own idea turned into an EIP?

First discuss the idea thoroughly on Ethereum Magicians or Ethereum Research until consensus forms, then read EIP-1, which describes the EIP process, before writing anything.

If I get stuck implementing a standard, can I ask here?

No — the repository documents standards only and does not help implement them. Implementation questions go to Ethereum Stack Exchange, and concerns about a specific EIP go to its discussion thread under the discussions-to tag.

Can I run the proposal checks or the status page locally?

Yes. The EIP validator runs locally via Rust's cargo, and the status page is a Jekyll site that requires exactly Ruby 3.1.4 — later versions are not supported — plus Bundler, after which you build and preview it in a browser.

How do I become an EIP editor?

The README directs prospective EIP Editors to read EIP-5069, the proposal that describes the role.

What are similar projects?

bips, shardeum, node, go-ethereum, rfcs, openzeppelin-contracts, solidity, union

Which topics is it in?

technical-documentation, jekyll, evm, governance, consensus, standards, github-pages, ethereum, protocol, cryptocurrency, web3, ruby

Creator: ethereum
Size: 116 MB
Stars: 14K
Updated: CommitOct 16
Age: 10y
Commits · 90 Days