From 46234d6efa41cd695cfa4ce196189ff4bdad656b Mon Sep 17 00:00:00 2001 From: Manu NALEPA Date: Mon, 16 Dec 2024 10:55:44 +0100 Subject: [PATCH 01/12] Light Ethereum Subprotocol: Update link --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 32311a996885c1..68a967233e4618 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -23,7 +23,7 @@ There are three types of EIP: - 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. Standards Track EIPs consist of three parts—a design document, an implementation, and (if warranted) an update to the [reference implementation](https://github.com/ethereum/execution-specs/) and [formal specification](https://github.com/ethereum/yellowpaper). Furthermore, Standards Track EIPs can be broken down into the following categories: - **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) (eg. the miner/node strategy changes 2, 3, and 4 of [EIP-86](./eip-86.md)). - - **Networking**: includes improvements around [devp2p](https://github.com/ethereum/devp2p/blob/readme-spec-links/rlpx.md) ([EIP-8](./eip-8.md)) and [Light Ethereum Subprotocol](https://ethereum.org/en/developers/docs/nodes-and-clients/#light-node), as well as proposed improvements to network protocol specifications of [whisper](https://github.com/ethereum/go-ethereum/issues/16013#issuecomment-364639309) and [swarm](https://github.com/ethereum/go-ethereum/pull/2959). + - **Networking**: includes improvements around [devp2p](https://github.com/ethereum/devp2p/blob/readme-spec-links/rlpx.md) ([EIP-8](./eip-8.md)) and [Light Ethereum Subprotocol](https://github.com/ethereum/devp2p/blob/master/caps/les.md), as well as proposed improvements to network protocol specifications of [whisper](https://github.com/ethereum/go-ethereum/issues/16013#issuecomment-364639309) and [swarm](https://github.com/ethereum/go-ethereum/pull/2959). - **Interface**: includes improvements around language-level standards like method names ([EIP-6](./eip-6.md)) and [contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html). - **ERC**: application-level standards and conventions, including contract standards such as token standards ([ERC-20](./eip-20.md)), name registries ([ERC-137](./eip-137.md)), URI schemes, library/package formats, and wallet formats. From d16bf0c910eb5996bd6da1b6931acc1e1275b543 Mon Sep 17 00:00:00 2001 From: Manu NALEPA Date: Mon, 16 Dec 2024 11:09:50 +0100 Subject: [PATCH 02/12] Standardize bold on **Core**. --- EIPS/eip-1.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 68a967233e4618..c1843c5edf0568 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -51,11 +51,11 @@ Parties involved in the process are you, the champion or *EIP Author*, the [*EIP Before you begin writing a formal EIP, you should vet your idea. Ask the Ethereum community first if an idea is original to avoid wasting time on something that will be rejected based on prior research. It is thus recommended to open a discussion thread on the [Ethereum Magicians forum](https://ethereum-magicians.org/) to do this. -Once the idea has been vetted, your next responsibility will be to present (by means of an EIP) the idea to the reviewers and all interested parties, invite editors, developers, and the community to give feedback on the aforementioned channels. You should try and gauge whether the interest in your EIP is commensurate with both the work involved in implementing it and how many parties will have to conform to it. For example, the work required for implementing a Core EIP will be much greater than for an ERC and the EIP will need sufficient interest from the Ethereum client teams. Negative community feedback will be taken into consideration and may prevent your EIP from moving past the Draft stage. +Once the idea has been vetted, your next responsibility will be to present (by means of an EIP) the idea to the reviewers and all interested parties, invite editors, developers, and the community to give feedback on the aforementioned channels. You should try and gauge whether the interest in your EIP is commensurate with both the work involved in implementing it and how many parties will have to conform to it. For example, the work required for implementing a **Core** EIP will be much greater than for an ERC and the EIP will need sufficient interest from the Ethereum client teams. Negative community feedback will be taken into consideration and may prevent your EIP from moving past the Draft stage. ### Core EIPs -For Core EIPs, given that they require client implementations to be considered **Final** (see "EIPs Process" below), you will need to either provide an implementation for clients or convince clients to implement your EIP. +For **Core** EIPs, given that they require client implementations to be considered **Final** (see "EIPs Process" below), you will need to either provide an implementation for clients or convince clients to implement your EIP. The best way to get client implementers to review your EIP is to present it on an AllCoreDevs call. You can request to do so by posting a comment linking your EIP on an [AllCoreDevs agenda GitHub Issue](https://github.com/ethereum/pm/issues). From 91776064ec6fea70dd9ea853394e4c6eab772845 Mon Sep 17 00:00:00 2001 From: Manu NALEPA Date: Mon, 16 Dec 2024 11:11:24 +0100 Subject: [PATCH 03/12] Ethereum Magicians ==> the Ethereum Magicians Forum. --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index c1843c5edf0568..0f7a5bf7cbcdf2 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -172,7 +172,7 @@ At least one author must use a GitHub username, in order to get notified on chan While an EIP is a draft, a `discussions-to` header will indicate the URL where the EIP is being discussed. -The preferred discussion URL is a topic on [Ethereum Magicians](https://ethereum-magicians.org/). The URL cannot point to Github pull requests, any URL which is ephemeral, and any URL which can get locked over time (i.e. Reddit topics). +The preferred discussion URL is a topic on the [Ethereum Magicians Forum](https://ethereum-magicians.org/). The URL cannot point to Github pull requests, any URL which is ephemeral, and any URL which can get locked over time (i.e. Reddit topics). ### `type` header From e425b7eb4ff7f962c262d27c4f938373b10b45a5 Mon Sep 17 00:00:00 2001 From: Manu NALEPA Date: Mon, 16 Dec 2024 11:15:38 +0100 Subject: [PATCH 04/12] Remove trailing `/` in links. --- EIPS/eip-1.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 0f7a5bf7cbcdf2..f12258d0e80af0 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -21,7 +21,7 @@ For Ethereum implementers, EIPs are a convenient way to track the progress of th There are three types of EIP: -- 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. Standards Track EIPs consist of three parts—a design document, an implementation, and (if warranted) an update to the [reference implementation](https://github.com/ethereum/execution-specs/) and [formal specification](https://github.com/ethereum/yellowpaper). Furthermore, Standards Track EIPs can be broken down into the following categories: +- 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. Standards Track EIPs consist of three parts—a design document, an implementation, and (if warranted) an update to the [reference implementation](https://github.com/ethereum/execution-specs) and [formal specification](https://github.com/ethereum/yellowpaper). Furthermore, Standards Track EIPs can be broken down into the following categories: - **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) (eg. the miner/node strategy changes 2, 3, and 4 of [EIP-86](./eip-86.md)). - **Networking**: includes improvements around [devp2p](https://github.com/ethereum/devp2p/blob/readme-spec-links/rlpx.md) ([EIP-8](./eip-8.md)) and [Light Ethereum Subprotocol](https://github.com/ethereum/devp2p/blob/master/caps/les.md), as well as proposed improvements to network protocol specifications of [whisper](https://github.com/ethereum/go-ethereum/issues/16013#issuecomment-364639309) and [swarm](https://github.com/ethereum/go-ethereum/pull/2959). - **Interface**: includes improvements around language-level standards like method names ([EIP-6](./eip-6.md)) and [contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html). @@ -49,7 +49,7 @@ REVERT (0xfe) Parties involved in the process are you, the champion or *EIP Author*, the [*EIP Editors*](#eip-editors), and the [*Ethereum Core Developers*](https://github.com/ethereum/pm). -Before you begin writing a formal EIP, you should vet your idea. Ask the Ethereum community first if an idea is original to avoid wasting time on something that will be rejected based on prior research. It is thus recommended to open a discussion thread on the [Ethereum Magicians forum](https://ethereum-magicians.org/) to do this. +Before you begin writing a formal EIP, you should vet your idea. Ask the Ethereum community first if an idea is original to avoid wasting time on something that will be rejected based on prior research. It is thus recommended to open a discussion thread on the [Ethereum Magicians forum](https://ethereum-magicians.org) to do this. Once the idea has been vetted, your next responsibility will be to present (by means of an EIP) the idea to the reviewers and all interested parties, invite editors, developers, and the community to give feedback on the aforementioned channels. You should try and gauge whether the interest in your EIP is commensurate with both the work involved in implementing it and how many parties will have to conform to it. For example, the work required for implementing a **Core** EIP will be much greater than for an ERC and the EIP will need sufficient interest from the Ethereum client teams. Negative community feedback will be taken into consideration and may prevent your EIP from moving past the Draft stage. @@ -63,7 +63,7 @@ The AllCoreDevs call serves as a way for client implementers to do three things. These calls generally result in a "rough consensus" around what EIPs should be implemented. This "rough consensus" rests on the assumptions that EIPs are not contentious enough to cause a network split and that they are technically sound. -:warning: The EIPs process and AllCoreDevs call were not designed to address contentious non-technical issues, but, due to the lack of other ways to address these, often end up entangled in them. This puts the burden on client implementers to try and gauge community sentiment, which hinders the technical coordination function of EIPs and AllCoreDevs calls. If you are shepherding an EIP, you can make the process of building community consensus easier by making sure that the [Ethereum Magicians forum](https://ethereum-magicians.org/) thread for your EIP includes or links to as much of the community discussion as possible and that various stakeholders are well-represented. +:warning: The EIPs process and AllCoreDevs call were not designed to address contentious non-technical issues, but, due to the lack of other ways to address these, often end up entangled in them. This puts the burden on client implementers to try and gauge community sentiment, which hinders the technical coordination function of EIPs and AllCoreDevs calls. If you are shepherding an EIP, you can make the process of building community consensus easier by making sure that the [Ethereum Magicians forum](https://ethereum-magicians.org) thread for your EIP includes or links to as much of the community discussion as possible and that various stakeholders are well-represented. *In short, your role as the champion is to write the EIP using the style and format described below, shepherd the discussions in the appropriate forums, and build community consensus around the idea.* @@ -116,7 +116,7 @@ EIPs should be written in [markdown](https://github.com/adam-p/markdown-here/wik ## EIP Header Preamble -Each EIP must begin with an [RFC 822] style header preamble, preceded and followed by three hyphens (`---`). This header is also termed ["front matter" by Jekyll](https://jekyllrb.com/docs/front-matter/). The headers must appear in the following order. +Each EIP must begin with an [RFC 822] style header preamble, preceded and followed by three hyphens (`---`). This header is also termed ["front matter" by Jekyll](https://jekyllrb.com/docs/front-matter). The headers must appear in the following order. `eip`: *EIP number* @@ -172,7 +172,7 @@ At least one author must use a GitHub username, in order to get notified on chan While an EIP is a draft, a `discussions-to` header will indicate the URL where the EIP is being discussed. -The preferred discussion URL is a topic on the [Ethereum Magicians Forum](https://ethereum-magicians.org/). The URL cannot point to Github pull requests, any URL which is ephemeral, and any URL which can get locked over time (i.e. Reddit topics). +The preferred discussion URL is a topic on the [Ethereum Magicians Forum](https://ethereum-magicians.org). The URL cannot point to Github pull requests, any URL which is ephemeral, and any URL which can get locked over time (i.e. Reddit topics). ### `type` header @@ -297,12 +297,12 @@ Permitted Networking Specifications URLs must anchor to a specific commit, and s Links to a W3C "Recommendation" status specification may be included using normal markdown syntax. For example, the following link would be allowed: ```markdown -[Secure Contexts](https://www.w3.org/TR/2021/CRD-secure-contexts-20210918/) +[Secure Contexts](https://www.w3.org/TR/2021/CRD-secure-contexts-20210918) ``` Which renders as: -[Secure Contexts](https://www.w3.org/TR/2021/CRD-secure-contexts-20210918/) +[Secure Contexts](https://www.w3.org/TR/2021/CRD-secure-contexts-20210918) Permitted W3C recommendation URLs MUST anchor to a specification in the technical reports namespace with a date, and so MUST match this regular expression: @@ -315,12 +315,12 @@ Permitted W3C recommendation URLs MUST anchor to a specification in the technica Links to WHATWG specifications may be included using normal markdown syntax, such as: ```markdown -[HTML](https://html.spec.whatwg.org/commit-snapshots/578def68a9735a1e36610a6789245ddfc13d24e0/) +[HTML](https://html.spec.whatwg.org/commit-snapshots/578def68a9735a1e36610a6789245ddfc13d24e0) ``` Which renders as: -[HTML](https://html.spec.whatwg.org/commit-snapshots/578def68a9735a1e36610a6789245ddfc13d24e0/) +[HTML](https://html.spec.whatwg.org/commit-snapshots/578def68a9735a1e36610a6789245ddfc13d24e0) Permitted WHATWG specification URLs must anchor to a specification defined in the `spec` subdomain (idea specifications are not allowed) and to a commit snapshot, and so must match this regular expression: From cbd869c51aa1743383c072efd049713662204471 Mon Sep 17 00:00:00 2001 From: Manu NALEPA Date: Mon, 16 Dec 2024 11:19:41 +0100 Subject: [PATCH 05/12] Code format all EIP states. --- EIPS/eip-1.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index f12258d0e80af0..6123b5d065ffa3 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -51,7 +51,7 @@ Parties involved in the process are you, the champion or *EIP Author*, the [*EIP Before you begin writing a formal EIP, you should vet your idea. Ask the Ethereum community first if an idea is original to avoid wasting time on something that will be rejected based on prior research. It is thus recommended to open a discussion thread on the [Ethereum Magicians forum](https://ethereum-magicians.org) to do this. -Once the idea has been vetted, your next responsibility will be to present (by means of an EIP) the idea to the reviewers and all interested parties, invite editors, developers, and the community to give feedback on the aforementioned channels. You should try and gauge whether the interest in your EIP is commensurate with both the work involved in implementing it and how many parties will have to conform to it. For example, the work required for implementing a **Core** EIP will be much greater than for an ERC and the EIP will need sufficient interest from the Ethereum client teams. Negative community feedback will be taken into consideration and may prevent your EIP from moving past the Draft stage. +Once the idea has been vetted, your next responsibility will be to present (by means of an EIP) the idea to the reviewers and all interested parties, invite editors, developers, and the community to give feedback on the aforementioned channels. You should try and gauge whether the interest in your EIP is commensurate with both the work involved in implementing it and how many parties will have to conform to it. For example, the work required for implementing a **Core** EIP will be much greater than for an ERC and the EIP will need sufficient interest from the Ethereum client teams. Negative community feedback will be taken into consideration and may prevent your EIP from moving past the `Draft` stage. ### Core EIPs @@ -83,9 +83,9 @@ The following is the standardization process for all EIPs in all tracks: If this period results in necessary normative changes it will revert the EIP to `Review`. -**Final** - This EIP represents the final standard. A Final EIP exists in a state of finality and should only be updated to correct errata and add non-normative clarifications. +**Final** - This EIP represents the final standard. A `Final` EIP exists in a state of finality and should only be updated to correct errata and add non-normative clarifications. -A pull request moving an EIP from Last Call to Final SHOULD contain no changes other than the status update. Any content or editorial proposed change SHOULD be separate from this status-updating pull request and committed prior to it. +A pull request moving an EIP from `Last Call` to `Final` SHOULD contain no changes other than the status update. Any content or editorial proposed change SHOULD be separate from this status-updating pull request and committed prior to it. **Stagnant** - Any EIP in `Draft` or `Review` or `Last Call` if inactive for a period of 6 months or greater is moved to `Stagnant`. An EIP may be resurrected from this state by Authors or EIP Editors through moving it back to `Draft` or its earlier status. If not resurrected, a proposal may stay forever in this status. @@ -107,7 +107,7 @@ Each EIP should have the following parts: - Backwards Compatibility *(optional)* - All EIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their consequences. The EIP must explain how the author proposes to deal with these incompatibilities. This section may be omitted if the proposal does not introduce any backwards incompatibilities, but this section must be included if backward incompatibilities exist. - Test Cases *(optional)* - Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Tests should either be inlined in the EIP as data (such as input/expected output pairs, or included in `../assets/eip-###/`. This section may be omitted for non-Core proposals. - Reference Implementation *(optional)* - An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. This section may be omitted for all EIPs. -- 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. +- 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. The copyright waiver MUST link to the license file and use the following wording: `Copyright and related rights waived via [CC0](../LICENSE.md).` ## EIP Formats and Templates From 61021928bc75993940fd7555722abb6a65ef81b8 Mon Sep 17 00:00:00 2001 From: Manu NALEPA Date: Mon, 16 Dec 2024 11:21:48 +0100 Subject: [PATCH 06/12] Refer `yyyy-mm-dd` as the ISO 8601 format as done in the rest of the EIP. --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 6123b5d065ffa3..49853e6bc4a71a 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -184,7 +184,7 @@ The `category` header specifies the EIP's category. This is required for standar ### `created` header -The `created` header records the date that the EIP was assigned a number. Both headers should be in yyyy-mm-dd format, e.g. 2001-08-14. +The `created` header records the date that the EIP was assigned a number. Both headers should be in the format of ISO 8601 (yyyy-mm-dd). ### `requires` header From d9303c5a70740e6183367cbde59db988686fb159 Mon Sep 17 00:00:00 2001 From: Manu NALEPA Date: Mon, 16 Dec 2024 11:40:35 +0100 Subject: [PATCH 07/12] Adap link texts to the document title, and a link to the `Ethereum Proof-ofStake Consensus Specifications`. --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 49853e6bc4a71a..4d3c29ab540fb4 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -21,7 +21,7 @@ For Ethereum implementers, EIPs are a convenient way to track the progress of th There are three types of EIP: -- 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. Standards Track EIPs consist of three parts—a design document, an implementation, and (if warranted) an update to the [reference implementation](https://github.com/ethereum/execution-specs) and [formal specification](https://github.com/ethereum/yellowpaper). Furthermore, Standards Track EIPs can be broken down into the following categories: +- 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. Standards Track EIPs consist of a design document, an implementation, and (if warranted) an update to the [Ethereum Execution Client Specifications](https://github.com/ethereum/execution-specs), the [Ethereum Proof-of-Stake Consensus Specifications](https://github.com/ethereum/consensus-specs) and the [Ethereum Yellow Paper](https://github.com/ethereum/yellowpaper). Furthermore, Standards Track EIPs can be broken down into the following categories: - **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) (eg. the miner/node strategy changes 2, 3, and 4 of [EIP-86](./eip-86.md)). - **Networking**: includes improvements around [devp2p](https://github.com/ethereum/devp2p/blob/readme-spec-links/rlpx.md) ([EIP-8](./eip-8.md)) and [Light Ethereum Subprotocol](https://github.com/ethereum/devp2p/blob/master/caps/les.md), as well as proposed improvements to network protocol specifications of [whisper](https://github.com/ethereum/go-ethereum/issues/16013#issuecomment-364639309) and [swarm](https://github.com/ethereum/go-ethereum/pull/2959). - **Interface**: includes improvements around language-level standards like method names ([EIP-6](./eip-6.md)) and [contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html). From 78c2cfcd8b6d51692043921a0647e825caa0894e Mon Sep 17 00:00:00 2001 From: Sam Wilson <57262657+SamWilsn@users.noreply.github.com> Date: Wed, 18 Dec 2024 12:24:18 -0500 Subject: [PATCH 08/12] Update eip-1.md --- EIPS/eip-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 4d3c29ab540fb4..c7d320936154a9 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -21,7 +21,7 @@ For Ethereum implementers, EIPs are a convenient way to track the progress of th There are three types of EIP: -- 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. Standards Track EIPs consist of a design document, an implementation, and (if warranted) an update to the [Ethereum Execution Client Specifications](https://github.com/ethereum/execution-specs), the [Ethereum Proof-of-Stake Consensus Specifications](https://github.com/ethereum/consensus-specs) and the [Ethereum Yellow Paper](https://github.com/ethereum/yellowpaper). Furthermore, Standards Track EIPs can be broken down into the following categories: +- 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. Standards Track EIPs consist of a design document, an implementation, and (if warranted) an update to the [Ethereum Execution Client Specifications](https://github.com/ethereum/execution-specs), the [Ethereum Proof-of-Stake Consensus Specifications](https://github.com/ethereum/consensus-specs), and the [Ethereum Yellow Paper](https://github.com/ethereum/yellowpaper). Furthermore, Standards Track EIPs can be broken down into the following categories: - **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) (eg. the miner/node strategy changes 2, 3, and 4 of [EIP-86](./eip-86.md)). - **Networking**: includes improvements around [devp2p](https://github.com/ethereum/devp2p/blob/readme-spec-links/rlpx.md) ([EIP-8](./eip-8.md)) and [Light Ethereum Subprotocol](https://github.com/ethereum/devp2p/blob/master/caps/les.md), as well as proposed improvements to network protocol specifications of [whisper](https://github.com/ethereum/go-ethereum/issues/16013#issuecomment-364639309) and [swarm](https://github.com/ethereum/go-ethereum/pull/2959). - **Interface**: includes improvements around language-level standards like method names ([EIP-6](./eip-6.md)) and [contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html). From 07c376714ac7343a3d6b9b27bf785224b251bf45 Mon Sep 17 00:00:00 2001 From: Sam Wilson <57262657+SamWilsn@users.noreply.github.com> Date: Wed, 18 Dec 2024 12:42:32 -0500 Subject: [PATCH 09/12] Update eip-1.md: Use **bold** for statuses, and _italic_ for category/type --- EIPS/eip-1.md | 56 +++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index c7d320936154a9..b81f8f771cc151 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -21,23 +21,23 @@ For Ethereum implementers, EIPs are a convenient way to track the progress of th There are three types of EIP: -- 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. Standards Track EIPs consist of a design document, an implementation, and (if warranted) an update to the [Ethereum Execution Client Specifications](https://github.com/ethereum/execution-specs), the [Ethereum Proof-of-Stake Consensus Specifications](https://github.com/ethereum/consensus-specs), and the [Ethereum Yellow Paper](https://github.com/ethereum/yellowpaper). Furthermore, Standards Track EIPs can be broken down into the following categories: - - **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) (eg. the miner/node strategy changes 2, 3, and 4 of [EIP-86](./eip-86.md)). - - **Networking**: includes improvements around [devp2p](https://github.com/ethereum/devp2p/blob/readme-spec-links/rlpx.md) ([EIP-8](./eip-8.md)) and [Light Ethereum Subprotocol](https://github.com/ethereum/devp2p/blob/master/caps/les.md), as well as proposed improvements to network protocol specifications of [whisper](https://github.com/ethereum/go-ethereum/issues/16013#issuecomment-364639309) and [swarm](https://github.com/ethereum/go-ethereum/pull/2959). - - **Interface**: includes improvements around language-level standards like method names ([EIP-6](./eip-6.md)) and [contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html). - - **ERC**: application-level standards and conventions, including contract standards such as token standards ([ERC-20](./eip-20.md)), name registries ([ERC-137](./eip-137.md)), URI schemes, library/package formats, and wallet formats. +- 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. _Standards Track_ EIPs consist of a design document, an implementation, and (if warranted) an update to the [Ethereum Execution Client Specifications](https://github.com/ethereum/execution-specs), the [Ethereum Proof-of-Stake Consensus Specifications](https://github.com/ethereum/consensus-specs), and the [Ethereum Yellow Paper](https://github.com/ethereum/yellowpaper). Furthermore, _Standards Track_ EIPs can be broken down into the following categories: + - _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) (eg. the miner/node strategy changes 2, 3, and 4 of [EIP-86](./eip-86.md)). + - _Networking_: includes improvements around [devp2p](https://github.com/ethereum/devp2p/blob/readme-spec-links/rlpx.md) ([EIP-8](./eip-8.md)) and [Light Ethereum Subprotocol](https://github.com/ethereum/devp2p/blob/master/caps/les.md), as well as proposed improvements to network protocol specifications of [whisper](https://github.com/ethereum/go-ethereum/issues/16013#issuecomment-364639309) and [swarm](https://github.com/ethereum/go-ethereum/pull/2959). + - _Interface_: includes improvements around language-level standards like method names ([EIP-6](./eip-6.md)) and [contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html). + - _ERC_: application-level standards and conventions, including contract standards such as token standards ([ERC-20](./eip-20.md)), name registries ([ERC-137](./eip-137.md)), URI schemes, library/package formats, and wallet formats. -- 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. +- 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. -- 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. +- 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. It is highly recommended that a single EIP contain a single key proposal or new idea. The more focused the EIP, the more successful it tends to be. A change to one client doesn't require an EIP; a change that affects multiple clients, or defines a standard for multiple apps to use, does. An EIP must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. -### Special requirements for Core EIPs +### Special requirements for _Core_ EIPs -If a **Core** EIP mentions or proposes changes to the EVM (Ethereum Virtual Machine), it should refer to the instructions by their mnemonics and define the opcodes of those mnemonics at least once. A preferred way is the following: +If a _Core_ EIP mentions or proposes changes to the EVM (Ethereum Virtual Machine), it should refer to the instructions by their mnemonics and define the opcodes of those mnemonics at least once. A preferred way is the following: ``` REVERT (0xfe) @@ -51,11 +51,11 @@ Parties involved in the process are you, the champion or *EIP Author*, the [*EIP Before you begin writing a formal EIP, you should vet your idea. Ask the Ethereum community first if an idea is original to avoid wasting time on something that will be rejected based on prior research. It is thus recommended to open a discussion thread on the [Ethereum Magicians forum](https://ethereum-magicians.org) to do this. -Once the idea has been vetted, your next responsibility will be to present (by means of an EIP) the idea to the reviewers and all interested parties, invite editors, developers, and the community to give feedback on the aforementioned channels. You should try and gauge whether the interest in your EIP is commensurate with both the work involved in implementing it and how many parties will have to conform to it. For example, the work required for implementing a **Core** EIP will be much greater than for an ERC and the EIP will need sufficient interest from the Ethereum client teams. Negative community feedback will be taken into consideration and may prevent your EIP from moving past the `Draft` stage. +Once the idea has been vetted, your next responsibility will be to present (by means of an EIP) the idea to the reviewers and all interested parties, invite editors, developers, and the community to give feedback on the aforementioned channels. You should try and gauge whether the interest in your EIP is commensurate with both the work involved in implementing it and how many parties will have to conform to it. For example, the work required for implementing a _Core_ EIP will be much greater than for an _ERC_ and the EIP will need sufficient interest from the Ethereum client teams. Negative community feedback will be taken into consideration and may prevent your EIP from moving past the **Draft** stage. -### Core EIPs +### _Core_ EIPs -For **Core** EIPs, given that they require client implementations to be considered **Final** (see "EIPs Process" below), you will need to either provide an implementation for clients or convince clients to implement your EIP. +For _Core_ EIPs, given that they require client implementations to be considered **Final** (see "EIPs Process" below), you will need to either provide an implementation for clients or convince clients to implement your EIP. The best way to get client implementers to review your EIP is to present it on an AllCoreDevs call. You can request to do so by posting a comment linking your EIP on an [AllCoreDevs agenda GitHub Issue](https://github.com/ethereum/pm/issues). @@ -79,15 +79,15 @@ The following is the standardization process for all EIPs in all tracks: **Review** - An EIP Author marks an EIP as ready for and requesting Peer Review. -**Last Call** - This is the final review window for an EIP before moving to `Final`. An EIP Editor will assign `Last Call` status and set a review end date (`last-call-deadline`), typically 14 days later. +**Last Call** - This is the final review window for an EIP before moving to **Final**. An EIP Editor will assign **Last Call** status and set a review end date (`last-call-deadline`), typically 14 days later. -If this period results in necessary normative changes it will revert the EIP to `Review`. +If this period results in necessary normative changes it will revert the EIP to **Review**. -**Final** - This EIP represents the final standard. A `Final` EIP exists in a state of finality and should only be updated to correct errata and add non-normative clarifications. +**Final** - This EIP represents the final standard. A **Final** EIP exists in a state of finality and should only be updated to correct errata and add non-normative clarifications. -A pull request moving an EIP from `Last Call` to `Final` SHOULD contain no changes other than the status update. Any content or editorial proposed change SHOULD be separate from this status-updating pull request and committed prior to it. +A pull request moving an EIP from **Last Call** to **Final** SHOULD contain no changes other than the status update. Any content or editorial proposed change SHOULD be separate from this status-updating pull request and committed prior to it. -**Stagnant** - Any EIP in `Draft` or `Review` or `Last Call` if inactive for a period of 6 months or greater is moved to `Stagnant`. An EIP may be resurrected from this state by Authors or EIP Editors through moving it back to `Draft` or its earlier status. If not resurrected, a proposal may stay forever in this status. +**Stagnant** - Any EIP in **Draft** or **Review** or **Last Call** if inactive for a period of 6 months or greater is moved to **Stagnant**. An EIP may be resurrected from this state by Authors or EIP Editors through moving it back to **Draft** or its earlier status. If not resurrected, a proposal may stay forever in this status. >*EIP Authors are notified of any algorithmic change to the status of their EIP* @@ -105,9 +105,9 @@ Each EIP should have the following parts: - 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 (besu, erigon, ethereumjs, go-ethereum, nethermind, reth, or others). - 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 should discuss important objections or concerns raised during discussion around the EIP. - Backwards Compatibility *(optional)* - All EIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their consequences. The EIP must explain how the author proposes to deal with these incompatibilities. This section may be omitted if the proposal does not introduce any backwards incompatibilities, but this section must be included if backward incompatibilities exist. -- Test Cases *(optional)* - Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Tests should either be inlined in the EIP as data (such as input/expected output pairs, or included in `../assets/eip-###/`. This section may be omitted for non-Core proposals. +- Test Cases *(optional)* - Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Tests should either be inlined in the EIP as data (such as input/expected output pairs, or included in `../assets/eip-###/`. This section may be omitted for non-_Core_ proposals. - Reference Implementation *(optional)* - An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. This section may be omitted for all EIPs. -- 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. +- 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. The copyright waiver MUST link to the license file and use the following wording: `Copyright and related rights waived via [CC0](../LICENSE.md).` ## EIP Formats and Templates @@ -130,17 +130,17 @@ Each EIP must begin with an [RFC 822] style header preamble, preceded and follow `status`: *Draft, Review, Last Call, Final, Stagnant, Withdrawn, Living* -`last-call-deadline`: *The date last call period ends on* (Optional field, only needed when status is `Last Call`) +`last-call-deadline`: *The date last call period ends on* (Optional field, only needed when status is **Last Call**) -`type`: *One of `Standards Track`, `Meta`, or `Informational`* +`type`: *One of Standards Track, Meta, or Informational* -`category`: *One of `Core`, `Networking`, `Interface`, or `ERC`* (Optional field, only needed for `Standards Track` EIPs) +`category`: *One of Core, Networking, Interface, or ERC* (Optional field, only needed for _Standards Track_ EIPs) `created`: *Date the EIP was created on* `requires`: *EIP number(s)* (Optional field) -`withdrawal-reason`: *A sentence explaining why the EIP was withdrawn.* (Optional field, only needed when status is `Withdrawn`) +`withdrawal-reason`: *A sentence explaining why the EIP was withdrawn.* (Optional field, only needed when status is **Withdrawn**) Headers that permit lists must separate elements with commas. @@ -170,17 +170,17 @@ At least one author must use a GitHub username, in order to get notified on chan ### `discussions-to` header -While an EIP is a draft, a `discussions-to` header will indicate the URL where the EIP is being discussed. +While an EIP is a **Draft**, a `discussions-to` header will indicate the URL where the EIP is being discussed. The preferred discussion URL is a topic on the [Ethereum Magicians Forum](https://ethereum-magicians.org). The URL cannot point to Github pull requests, any URL which is ephemeral, and any URL which can get locked over time (i.e. Reddit topics). ### `type` header -The `type` header specifies the type of EIP: Standards Track, Meta, or Informational. If the track is Standards please include the subcategory (core, networking, interface, or ERC). +The `type` header specifies the type of EIP: _Standards Track_, _Meta_, or _Informational_. If the type is _Standards Track_ please include the subcategory (_Core_, _Networking_, _Interface_, or _ERC_). ### `category` header -The `category` header specifies the EIP's category. This is required for standards-track EIPs only. +The `category` header specifies the EIP's category. This is required for _Standards Track_ EIPs only. ### `created` header @@ -531,7 +531,7 @@ If you would like to become an EIP Editor, please check [EIP-5069](./eip-5069.md For each new EIP that comes in, an editor does the following: -- Read the EIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to get to final status. +- Read the EIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to get to **Final** status. - The title should accurately describe the content. - Check the EIP for language (spelling, grammar, sentence structure, etc.), markup (GitHub flavored Markdown), code style @@ -565,7 +565,7 @@ The `description` field in the preamble: ### EIP numbers -When referring to an EIP with a `category` of `ERC`, it must be written in the hyphenated form `ERC-X` where `X` is that EIP's assigned number. When referring to EIPs with any other `category`, it must be written in the hyphenated form `EIP-X` where `X` is that EIP's assigned number. +When referring to an EIP with a `category` of _ERC_, it must be written in the hyphenated form `ERC-X` where `X` is that EIP's assigned number. When referring to EIPs with any other `category`, it must be written in the hyphenated form `EIP-X` where `X` is that EIP's assigned number. ### RFC 2119 and RFC 8174 From 3556a2988acfffbdeb4506c8846dfbce731193e9 Mon Sep 17 00:00:00 2001 From: Sam Wilson <57262657+SamWilsn@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:02:00 -0500 Subject: [PATCH 10/12] Update eip-1.md: Use RFCs over ISOs; fix RFC links --- EIPS/eip-1.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index b81f8f771cc151..4984cb484fad0b 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -144,7 +144,7 @@ Each EIP must begin with an [RFC 822] style header preamble, preceded and follow Headers that permit lists must separate elements with commas. -Headers requiring dates will always do so in the format of ISO 8601 (yyyy-mm-dd). +Headers requiring dates will always do so in the format of [RFC 3339]'s `full-date` (yyyy-mm-dd). ### `author` header @@ -184,7 +184,7 @@ The `category` header specifies the EIP's category. This is required for _Standa ### `created` header -The `created` header records the date that the EIP was assigned a number. Both headers should be in the format of ISO 8601 (yyyy-mm-dd). +The `created` header records the date that the EIP was assigned a number. Both headers should be in the format of [RFC 3339]'s `full-date` (yyyy-mm-dd). ### `requires` header @@ -569,9 +569,9 @@ When referring to an EIP with a `category` of _ERC_, it must be written in the h ### RFC 2119 and RFC 8174 -EIPs are encouraged to follow [RFC 2119](https://www.ietf.org/rfc/rfc2119.html) and [RFC 8174](https://www.ietf.org/rfc/rfc8174.html) for terminology and to insert the following at the beginning of the Specification section: +EIPs are encouraged to follow [RFC 2119] and [RFC 8174] for terminology and to insert the following at the beginning of the Specification section: -> The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174. +> The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119] and [RFC 8174]. ## History @@ -581,4 +581,7 @@ This document was derived heavily from [Bitcoin's BIP-0001](https://github.com/b Copyright and related rights waived via [CC0](../LICENSE.md). -[RFC 822]: https://www.ietf.org/rfc/rfc822.txt +[RFC 822]: https://www.rfc-editor.org/rfc/rfc822 +[RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339 +[RFC 2119]: https://www.ietf.org/rfc/rfc2119 +[RFC 8174]: https://www.ietf.org/rfc/rfc8174 From ba497de6581e56daf69596438db613fea3150e8c Mon Sep 17 00:00:00 2001 From: Sam Wilson <57262657+SamWilsn@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:38:03 -0500 Subject: [PATCH 11/12] Update eip-1.md: Use underscores for italic --- EIPS/eip-1.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 4984cb484fad0b..b5ae617d4377af 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -47,7 +47,7 @@ REVERT (0xfe) ### Shepherding an EIP -Parties involved in the process are you, the champion or *EIP Author*, the [*EIP Editors*](#eip-editors), and the [*Ethereum Core Developers*](https://github.com/ethereum/pm). +Parties involved in the process are you, the champion or _EIP Author_, the [_EIP Editors_](#eip-editors), and the [_Ethereum Core Developers_](https://github.com/ethereum/pm). Before you begin writing a formal EIP, you should vet your idea. Ask the Ethereum community first if an idea is original to avoid wasting time on something that will be rejected based on prior research. It is thus recommended to open a discussion thread on the [Ethereum Magicians forum](https://ethereum-magicians.org) to do this. @@ -101,12 +101,12 @@ 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), a description (limited to a maximum of 140 characters), and the author details. Irrespective of the category, the title and description should not include EIP number. See [below](./eip-1.md#eip-header-preamble) for details. - Abstract - Abstract is a multi-sentence (short paragraph) technical summary. This should be a very terse and human-readable version of the specification section. Someone should be able to read only the abstract to get the gist of what this specification does. -- Motivation *(optional)* - A motivation section 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. This section may be omitted if the motivation is evident. +- Motivation _(optional)_ - A motivation section 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. This section may be omitted if the motivation is evident. - 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 (besu, erigon, ethereumjs, go-ethereum, nethermind, reth, or others). - 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 should discuss important objections or concerns raised during discussion around the EIP. -- Backwards Compatibility *(optional)* - All EIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their consequences. The EIP must explain how the author proposes to deal with these incompatibilities. This section may be omitted if the proposal does not introduce any backwards incompatibilities, but this section must be included if backward incompatibilities exist. -- Test Cases *(optional)* - Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Tests should either be inlined in the EIP as data (such as input/expected output pairs, or included in `../assets/eip-###/`. This section may be omitted for non-_Core_ proposals. -- Reference Implementation *(optional)* - An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. This section may be omitted for all EIPs. +- Backwards Compatibility _(optional)_ - All EIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their consequences. The EIP must explain how the author proposes to deal with these incompatibilities. This section may be omitted if the proposal does not introduce any backwards incompatibilities, but this section must be included if backward incompatibilities exist. +- Test Cases _(optional)_ - Test cases for an implementation are mandatory for EIPs that are affecting consensus changes. Tests should either be inlined in the EIP as data (such as input/expected output pairs, or included in `../assets/eip-###/`. This section may be omitted for non-_Core_ proposals. +- Reference Implementation _(optional)_ - An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. This section may be omitted for all EIPs. - 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. The copyright waiver MUST link to the license file and use the following wording: `Copyright and related rights waived via [CC0](../LICENSE.md).` @@ -118,29 +118,29 @@ EIPs should be written in [markdown](https://github.com/adam-p/markdown-here/wik Each EIP must begin with an [RFC 822] style header preamble, preceded and followed by three hyphens (`---`). This header is also termed ["front matter" by Jekyll](https://jekyllrb.com/docs/front-matter). The headers must appear in the following order. -`eip`: *EIP number* +`eip`: _EIP number_ -`title`: *The EIP title is a few words, not a complete sentence* +`title`: _The EIP title is a few words, not a complete sentence_ -`description`: *Description is one full (short) sentence* +`description`: _Description is one full (short) sentence_ -`author`: *The list of the author's or authors' name(s) and/or username(s), or name(s) and email(s). Details are below.* +`author`: _The list of the author's or authors' name(s) and/or username(s), or name(s) and email(s). Details are below._ -`discussions-to`: *The url pointing to the official discussion thread* +`discussions-to`: _The url pointing to the official discussion thread_ -`status`: *Draft, Review, Last Call, Final, Stagnant, Withdrawn, Living* +`status`: _Draft, Review, Last Call, Final, Stagnant, Withdrawn, Living_ -`last-call-deadline`: *The date last call period ends on* (Optional field, only needed when status is **Last Call**) +`last-call-deadline`: _The date last call period ends on_ (Optional field, only needed when status is **Last Call**) -`type`: *One of Standards Track, Meta, or Informational* +`type`: _One of Standards Track, Meta, or Informational_ -`category`: *One of Core, Networking, Interface, or ERC* (Optional field, only needed for _Standards Track_ EIPs) +`category`: _One of Core, Networking, Interface, or ERC_ (Optional field, only needed for _Standards Track_ EIPs) -`created`: *Date the EIP was created on* +`created`: _Date the EIP was created on_ -`requires`: *EIP number(s)* (Optional field) +`requires`: _EIP number(s)_ (Optional field) -`withdrawal-reason`: *A sentence explaining why the EIP was withdrawn.* (Optional field, only needed when status is **Withdrawn**) +`withdrawal-reason`: _A sentence explaining why the EIP was withdrawn._ (Optional field, only needed when status is **Withdrawn**) Headers that permit lists must separate elements with commas. From 2ad764d5075a6d61ec4fa4bcc3c3b0bfdabbb498 Mon Sep 17 00:00:00 2001 From: Sam Wilson <57262657+SamWilsn@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:59:42 -0500 Subject: [PATCH 12/12] Update eip-1.md --- EIPS/eip-1.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index b5ae617d4377af..a1631700140928 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -65,7 +65,7 @@ These calls generally result in a "rough consensus" around what EIPs should be i :warning: The EIPs process and AllCoreDevs call were not designed to address contentious non-technical issues, but, due to the lack of other ways to address these, often end up entangled in them. This puts the burden on client implementers to try and gauge community sentiment, which hinders the technical coordination function of EIPs and AllCoreDevs calls. If you are shepherding an EIP, you can make the process of building community consensus easier by making sure that the [Ethereum Magicians forum](https://ethereum-magicians.org) thread for your EIP includes or links to as much of the community discussion as possible and that various stakeholders are well-represented. -*In short, your role as the champion is to write the EIP using the style and format described below, shepherd the discussions in the appropriate forums, and build community consensus around the idea.* +_In short, your role as the champion is to write the EIP using the style and format described below, shepherd the discussions in the appropriate forums, and build community consensus around the idea._ ### EIP Process @@ -89,7 +89,7 @@ A pull request moving an EIP from **Last Call** to **Final** SHOULD contain no c **Stagnant** - Any EIP in **Draft** or **Review** or **Last Call** if inactive for a period of 6 months or greater is moved to **Stagnant**. An EIP may be resurrected from this state by Authors or EIP Editors through moving it back to **Draft** or its earlier status. If not resurrected, a proposal may stay forever in this status. ->*EIP Authors are notified of any algorithmic change to the status of their EIP* +> _EIP Authors are notified of any algorithmic change to the status of their EIP_ **Withdrawn** - The EIP Author(s) have withdrawn the proposed EIP. This state has finality and can no longer be resurrected using this EIP number. If the idea is pursued at later date it is considered a new proposal.