-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
299 changed files
with
17,831 additions
and
2,631 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,11 @@ | ||
uint | ||
ith | ||
nd | ||
mitre | ||
readded | ||
crate | ||
developper | ||
ist | ||
iam | ||
espace | ||
acn |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: Greetings | ||
|
||
on: [pull_request, issues] | ||
|
||
jobs: | ||
greeting: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/first-interaction@v1 | ||
with: | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
issue-message: 'Since this is your first issue, we kindly remind you to check out [EIP-1](https://eips.ethereum.org/EIPS/eip-1) for guidance.' | ||
pr-message: 'Since this is your first pull request, we kindly remind you to check out [EIP-1](https://eips.ethereum.org/EIPS/eip-1) for guidance.' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
name: "Mark stale PRs" | ||
|
||
on: | ||
schedule: | ||
# Run this every hour, so we are not spammed with changes at once. Later we could consider changing this to once a day. | ||
- cron: "0 * * * *" | ||
|
||
jobs: | ||
stale: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/stale@v3 | ||
with: | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
stale-pr-message: 'There has been no activity on this pull request for two months. It will be closed in a week if no further activity occurs. If you would like to move this EIP forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.' | ||
close-pr-message: 'This pull request was closed due to inactivity. If you are still pursuing it, feel free to reopen it and respond to any feedback or request a review in a comment.' | ||
days-before-stale: 60 | ||
days-before-close: 7 | ||
stale-pr-label: 'stale' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,10 +3,9 @@ eip: 1 | |
title: EIP Purpose and Guidelines | ||
status: Active | ||
type: Meta | ||
author: Martin Becze <[email protected]>, Hudson Jameson <[email protected]>, and others | ||
https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md | ||
author: Martin Becze <[email protected]>, Hudson Jameson <[email protected]>, et al. | ||
created: 2015-10-27 | ||
updated: 2015-12-07, 2016-02-01, 2018-03-21, 2018-05-29, 2018-10-17, 2019-05-19 | ||
updated: 2015-12-07, 2016-02-01, 2018-03-21, 2018-05-29, 2018-10-17, 2019-05-19, 2019-12-04, 2020-06-17 | ||
--- | ||
|
||
## What is an EIP? | ||
|
@@ -23,11 +22,11 @@ For Ethereum implementers, EIPs are a convenient way to track the progress of th | |
|
||
There are three types of EIP: | ||
|
||
- A **Standard Track EIP** describes any change that affects most or all Ethereum implementations, such as a change to the network protocol, a change in block or transaction validity rules, proposed application standards/conventions, or any change or addition that affects the interoperability of applications using Ethereum. Furthermore Standard EIPs can be broken down into the following categories. Standards Track EIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. | ||
- **Core** - improvements requiring a consensus fork (e.g. [EIP5], [EIP101]), as well as changes that are not necessarily consensus critical but may be relevant to [“core dev” discussions](https://github.com/ethereum/pm) (for example, [EIP90], and the miner/node strategy changes 2, 3, and 4 of [EIP86]). | ||
- **Networking** - includes improvements around [devp2p] ([EIP8]) and [Light Ethereum Subprotocol], as well as proposed improvements to network protocol specifications of [whisper] and [swarm]. | ||
- **Interface** - includes improvements around client [API/RPC] specifications and standards, and also certain language-level standards like method names ([EIP6]) and [contract ABIs]. The label “interface” aligns with the [interfaces repo] and discussion should primarily occur in that repository before an EIP is submitted to the EIPs repository. | ||
- **ERC** - application-level standards and conventions, including contract standards such as token standards ([ERC20]), name registries ([ERC26], [ERC137]), URI schemes ([ERC67]), library/package formats ([EIP82]), and wallet formats ([EIP75], [EIP85]). | ||
- A **Standards Track EIP** describes any change that affects most or all Ethereum implementations, such as a change to the network protocol, a change in block or transaction validity rules, proposed application standards/conventions, or any change or addition that affects the interoperability of applications using Ethereum. Furthermore Standard EIPs can be broken down into the following categories. Standards Track EIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. | ||
- **Core** - improvements requiring a consensus fork (e.g. [EIP-5](./eip-5.md), [EIP-101](./eip-101.md)), as well as changes that are not necessarily consensus critical but may be relevant to [“core dev” discussions](https://github.com/ethereum/pm) (for example, [EIP-90], and the miner/node strategy changes 2, 3, and 4 of [EIP-86](./eip-86.md)). | ||
- **Networking** - includes improvements around [devp2p] ([EIP-8](./eip-8.md)) and [Light Ethereum Subprotocol], as well as proposed improvements to network protocol specifications of [whisper] and [swarm]. | ||
- **Interface** - includes improvements around client [API/RPC] specifications and standards, and also certain language-level standards like method names ([EIP-6](./eip-6.md)) and [contract ABIs]. The label “interface” aligns with the [interfaces repo] and discussion should primarily occur in that repository before an EIP is submitted to the EIPs repository. | ||
- **ERC** - application-level standards and conventions, including contract standards such as token standards ([ERC-20](./eip-20.md)), name registries ([ERC-26](https://github.com/ethereum/EIPs/issues/26), [ERC-137](./eip-137.md)), URI schemes ([ERC-67](https://github.com/ethereum/EIPs/issues/67)), library/package formats ([EIP-82](https://github.com/ethereum/EIPs/issues/82)), and wallet formats ([EIP-75](https://github.com/ethereum/EIPs/issues/75), [EIP-85](https://github.com/ethereum/EIPs/issues/85)). | ||
- A **Meta EIP** describes a process surrounding Ethereum or proposes a change to (or an event in) a process. Process EIPs are like Standards Track EIPs but apply to areas other than the Ethereum protocol itself. They may propose an implementation, but not to Ethereum's codebase; they often require community consensus; unlike Informational EIPs, they are more than recommendations, and users are typically not free to ignore them. Examples include procedures, guidelines, changes to the decision-making process, and changes to the tools or environment used in Ethereum development. Any meta-EIP is also considered a Process EIP. | ||
- An **Informational EIP** describes an Ethereum design issue, or provides general guidelines or information to the Ethereum community, but does not propose a new feature. Informational EIPs do not necessarily represent Ethereum community consensus or a recommendation, so users and implementers are free to ignore Informational EIPs or follow their advice. | ||
|
||
|
@@ -110,20 +109,20 @@ Other exceptional statuses include: | |
|
||
Each EIP should have the following parts: | ||
|
||
- Preamble - RFC 822 style headers containing metadata about the EIP, including the EIP number, a short descriptive title (limited to a maximum of 44 characters), and the author details. See [below](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md#eip-header-preamble) for details. | ||
- Preamble - RFC 822 style headers containing metadata about the EIP, including the EIP number, a short descriptive title (limited to a maximum of 44 characters), and the author details. See [below](./eip-1.md#eip-header-preamble) for details. | ||
- Abstract - A short (~200 word) description of the technical issue being addressed. | ||
- Motivation (*optional) - The motivation is critical for EIPs that want to change the Ethereum protocol. It should clearly explain why the existing protocol specification is inadequate to address the problem that the EIP solves. EIP submissions without sufficient motivation may be rejected outright. | ||
- Specification - The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Ethereum platforms (cpp-ethereum, go-ethereum, parity, ethereumJ, ethereumjs-lib, [and others](https://github.com/ethereum/wiki/wiki/Clients). | ||
- Rationale - The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion. | ||
- Backwards Compatibility - All EIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The EIP must explain how the author proposes to deal with these incompatibilities. EIP submissions without a sufficient backwards compatibility treatise may be rejected outright. | ||
- Test Cases - Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Other EIPs can choose to include links to test cases if applicable. | ||
- Implementations - The implementations must be completed before any EIP is given status “Final”, but it need not be completed before the EIP is merged as draft. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of “rough consensus and running code” is still useful when it comes to resolving many discussions of API details. | ||
- Security Considerations - All EIPs must contain a section that discusses the security implications/considerations relevant to the proposed change. Include information that might be important for security discussions, surfaces risks and can be used throughout the life cycle of the proposal. E.g. include security-relevant design decisions, concerns, important discussions, implementation-specific guidance and pitfalls, an outline of threats and risks and how they are being addressed. EIP submissions missing the "Security Considerations" section will be rejected. An EIP cannot proceed to status "Final" without a Security Considerations discussion deemed sufficient by the reviewers. | ||
- Copyright Waiver - All EIPs must be in the public domain. See the bottom of this EIP for an example copyright waiver. | ||
|
||
## EIP Formats and Templates | ||
|
||
EIPs should be written in [markdown] format. | ||
Image files should be included in a subdirectory of the `assets` folder for that EIP as follows: `assets/eip-N` (where **N** is to be replaced with the EIP number). When linking to an image in the EIP, use relative links such as `../assets/eip-1/image.png`. | ||
EIPs should be written in [markdown] format. There is a [template](https://github.com/ethereum/EIPs/blob/master/eip-template.md) to follow. | ||
|
||
## EIP Header Preamble | ||
|
||
|
@@ -137,13 +136,13 @@ Each EIP must begin with an [RFC 822](https://www.ietf.org/rfc/rfc822.txt) style | |
|
||
` * discussions-to:` *a url pointing to the official discussion thread* | ||
|
||
` status:` *Draft | Last Call | Accepted | Final | Active | Abandoned | Rejected | Superseded* | ||
` status:` *Draft, Last Call, Accepted, Final, Active, Abandoned, Rejected, or Superseded* | ||
|
||
`* review-period-end:` *date review period ends* | ||
|
||
` type:` *Standards Track | Informational | Meta* | ||
` type:` *Standards Track, Meta, or Informational* | ||
|
||
` * category:` *Core | Networking | Interface | ERC* (Standards Track EIPs only) | ||
` * category:` *Core, Networking, Interface, or ERC* (fill out for Standards Track EIPs only) | ||
|
||
` created:` *date created on* | ||
|
||
|
@@ -213,9 +212,13 @@ EIPs may have a `requires` header, indicating the EIP numbers that this EIP depe | |
|
||
EIPs may also have a `superseded-by` header indicating that an EIP has been rendered obsolete by a later document; the value is the number of the EIP that replaces the current document. The newer EIP must have a `replaces` header containing the number of the EIP that it rendered obsolete. | ||
|
||
## Linking to other EIPs | ||
|
||
References to other EIPs should follow the format `EIP-N` where `N` is the EIP number you are referring to. Each EIP that is referenced in an EIP **MUST** be accompanied by a relative markdown link the first time it is referenced, and **MAY** be accompaniede by a link on subsequent references. The link **MUST** always be done via relative paths so that the links work in this GitHub repository, forks of this repository, the main EIPs site, mirrors of the main EIP site, etc. For example, you would link to this EIP with `[EIP-1](./eip-1.md)`. | ||
|
||
## Auxiliary Files | ||
|
||
EIPs may include auxiliary files such as diagrams. Such files must be named EIP-XXXX-Y.ext, where “XXXX” is the EIP number, “Y” is a serial number (starting at 1), and “ext” is replaced by the actual file extension (e.g. “png”). | ||
Images, diagrams and auxiliary files should be included in a subdirectory of the `assets` folder for that EIP as follows: `assets/eip-N` (where **N** is to be replaced with the EIP number). When linking to an image in the EIP, use relative links such as `../assets/eip-1/image.png`. | ||
|
||
## Transferring EIP Ownership | ||
|
||
|
@@ -243,6 +246,8 @@ The current EIP editors are | |
|
||
` * Alex Beregszaszi (@axic)` | ||
|
||
` * Micah Zoltu (@MicahZoltu)` | ||
|
||
## EIP Editor Responsibilities | ||
|
||
For each new EIP that comes in, an editor does the following: | ||
|
@@ -265,13 +270,17 @@ Many EIPs are written and maintained by developers with write access to the Ethe | |
|
||
The editors don't pass judgment on EIPs. We merely do the administrative & editorial part. | ||
|
||
## Style Guide | ||
|
||
When referring to an EIP by number, it should be written in the hyphenated form `EIP-X` where `X` is the EIP's assigned number. | ||
|
||
## History | ||
|
||
This document was derived heavily from [Bitcoin's BIP-0001] written by Amir Taaki which in turn was derived from [Python's PEP-0001]. In many places text was simply copied and modified. Although the PEP-0001 text was written by Barry Warsaw, Jeremy Hylton, and David Goodger, they are not responsible for its use in the Ethereum Improvement Process, and should not be bothered with technical questions specific to Ethereum or the EIP. Please direct all comments to the EIP editors. | ||
|
||
December 7, 2015: EIP 1 has been improved and will be placed as a PR. | ||
December 7, 2015: EIP-1 has been improved and will be placed as a PR. | ||
|
||
February 1, 2016: EIP 1 has added editors, made draft improvements to process, and has merged with Master stream. | ||
February 1, 2016: EIP-1 has added editors, made draft improvements to process, and has merged with Master stream. | ||
|
||
March 21, 2018: Minor edits to accommodate the new automatically-generated EIP directory on [eips.ethereum.org](https://eips.ethereum.org/). | ||
|
||
|
@@ -281,30 +290,21 @@ Oct 17, 2018: The `updated` header was introduced. | |
|
||
May 19, 2019: The **Abandoned** status was introduced. | ||
|
||
Dec 4, 2019: The "Security Considerations" section was introduced. | ||
|
||
June 17, 2020: Canonicalizes the format for referencing EIPs by number in the "Style Guide". | ||
|
||
See [the revision history for further details](https://github.com/ethereum/EIPs/commits/master/EIPS/eip-1.md), which is also available by clicking on the History button in the top right of the EIP. | ||
|
||
### Bibliography | ||
|
||
[EIP5]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-5.md | ||
[EIP101]: https://github.com/ethereum/EIPs/issues/28 | ||
[EIP90]: https://github.com/ethereum/EIPs/issues/90 | ||
[EIP86]: https://github.com/ethereum/EIPs/issues/86#issue-145324865 | ||
[devp2p]: https://github.com/ethereum/wiki/wiki/%C3%90%CE%9EVp2p-Wire-Protocol | ||
[EIP8]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-8.md | ||
[Light Ethereum Subprotocol]: https://github.com/ethereum/wiki/wiki/Light-client-protocol | ||
[whisper]: https://github.com/ethereum/go-ethereum/wiki/Whisper-Overview | ||
[swarm]: https://github.com/ethereum/go-ethereum/pull/2959 | ||
[API/RPC]: https://github.com/ethereum/wiki/wiki/JSON-RPC | ||
[EIP6]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-6.md | ||
[contract ABIs]: https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI | ||
[interfaces repo]: https://github.com/ethereum/interfaces | ||
[ERC20]: https://github.com/ethereum/EIPs/issues/20 | ||
[ERC26]: https://github.com/ethereum/EIPs/issues/26 | ||
[ERC137]: https://github.com/ethereum/EIPs/issues/137 | ||
[ERC67]: https://github.com/ethereum/EIPs/issues/67 | ||
[EIP82]: https://github.com/ethereum/EIPs/issues/82 | ||
[EIP75]: https://github.com/ethereum/EIPs/issues/75 | ||
[EIP85]: https://github.com/ethereum/EIPs/issues/85 | ||
[the Ethereum subreddit]: https://www.reddit.com/r/ethereum/ | ||
[one of the Ethereum Gitter chat rooms]: https://gitter.im/ethereum/ | ||
[pull request]: https://github.com/ethereum/EIPs/pulls | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.