Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace resolution, superseded-by and replaces with withdrawal-reason. #4198

Merged
merged 5 commits into from
Oct 29, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 2 additions & 14 deletions EIPS/eip-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,7 @@ Each EIP must begin with an [RFC 822](https://www.ietf.org/rfc/rfc822.txt) style

` * requires:` *EIP number(s)*

` * replaces:` *EIP number(s)*

` * superseded-by:` *EIP number(s)*

` * resolution:` *a url pointing to the resolution of this EIP*
` * withdrawal-reason:` *A sentence explaining why the EIP was withdrawn.*

Headers that permit lists must separate elements with commas.

Expand All @@ -169,13 +165,9 @@ It is not possible to use both an email and a GitHub username at the same time.

At least one author must use a GitHub username, in order to get notified on change requests and have the capability to approve or reject them.

#### `resolution` header

The `resolution` header is required for Standards Track EIPs only. It contains a URL that should point to an email message or other web resource where the pronouncement about the EIP is made.

#### `discussions-to` header

While an EIP is a draft, a `discussions-to` header will indicate the mailing list or URL where the EIP is being discussed. As mentioned above, an example of a place to discuss your EIP is [Ethereum Magicians](https://ethereum-magicians.org/) (this is suitable for EIPs that may be contentious or have a strong governance aspect).
While an EIP is a draft, a `discussions-to` header will indicate the URL where the EIP is being discussed. As mentioned above, an example of a place to discuss your EIP is [Ethereum Magicians](https://ethereum-magicians.org/) (this is suitable for EIPs that may be contentious or have a strong governance aspect).

As an exception, `discussions-to` cannot point to GitHub pull requests.

Expand All @@ -199,10 +191,6 @@ The `updated` header records the date(s) when the EIP was updated with "substant

EIPs may have a `requires` header, indicating the EIP numbers that this EIP depends on.

#### `superseded-by` and `replaces` headers

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 accompanied 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)`.
Expand Down
3 changes: 1 addition & 2 deletions EIPS/eip-1706.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ title: Disable SSTORE with gasleft lower than call stipend
author: Alex Forshtat <alex@tabookey.com>, Yoav Weiss <yoav@tabookey.com>
discussions-to: https://github.com/alex-forshtat-tbk/EIPs/issues/1
status: Withdrawn
withdrawal-reason: The authors prefer [EIP-2200](./eip-2200.md)
type: Standards Track
category: Core
created: 2019-01-15
requires: 1283
superseded-by: 2200
---
> :information_source: **[EIP-2200] has superseded [EIP-1706].** :information_source:

## Simple Summary
The proposal that had been accepted changes security properties of a large portion of an existing contract code base that may be infeasible to update and validate. This proposal will make the old assumptions hold even after a network upgrade.
Expand Down
1 change: 1 addition & 0 deletions EIPS/eip-3338.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Limit account nonce to 2^52
author: Micah Zoltu (@MicahZoltu), Alex Beregszaszi (@axic)
discussions-to: https://ethereum-magicians.org/t/eip-2681-limit-account-nonce-to-2-64-1/4324
status: Withdrawn
withdrawal-reason: Withdrawn in favor of [EIP-2681](./eip-2681.md)
type: Standards Track
category: Core
created: 2021-03-07
Expand Down
1 change: 1 addition & 0 deletions EIPS/eip-3382.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Hardcoded Block Gas Limit
author: Philippe Castonguay (@PhABC)
discussions-to: https://ethereum-magicians.org/t/eip-3382-hardcoded-gas-limit
status: Withdrawn
withdrawal-reason: The author prefers [EIP-3756](./eip-3756.md)
type: Standards Track
category: Core
created: 2021-03-13
Expand Down
1 change: 0 additions & 1 deletion eip-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ type: <Standards Track, Meta, or Informational>
category (*only required for Standards Track): <Core, Networking, Interface, or ERC>
created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
requires (*optional): <EIP number(s)>
replaces (*optional): <EIP number(s)>
---

This is the suggested template for new EIPs.
Expand Down