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

EIP-2228: Promote to Review #3302

Merged
merged 9 commits into from
Mar 11, 2021
Merged

EIP-2228: Promote to Review #3302

merged 9 commits into from
Mar 11, 2021

Conversation

fulldecent
Copy link
Contributor

Promoting to Last Call

@eip-automerger
Copy link

eip-automerger commented Feb 28, 2021

Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s):

  • Trying to change EIP 2228 state from Draft to Review

Copy link
Contributor

@MicahZoltu MicahZoltu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommend removing Vitalik's name from the motivation. I think it is better to just refer to it being called XXX in EIP-YYY rather than appealing to authority and saying who the speaker was in each case.


EIP links must be in the form [EIP-XXX](./eip-XXX.md)


Remove the external link to Geth. We can instead just say that some client documentation calls it mainnet.


Consider just mentioning in the motivation that it is called X, Y, and Z in various EIPs and around the internet. Presumably, once we finalize this EIP someone will go through and clean up the EIPs with the incorrect name at which point all of the links to "evidence" will no longer make sense. If the motivation of this EIP just says "there are places where it is called these other things" then we don't have to worry about their mutability.


Remove ## References section, it isn't a standard EIP section.


Remove ## Implementation section, it isn't a required section and since it contains no reference implementation it can be removed.

@poojaranjan
Copy link
Contributor

I think there is an intermediary status "Review" introduced with the new EIP Standardization process.

Instead of moving it to the "Last Call", @fulldecent consider moving to the "Review" status.

@MicahZoltu
Copy link
Contributor

Oh, good catch @poojaranjan. This should definitely be moving to Review rather than Last Call.

@fulldecent
Copy link
Contributor Author

fulldecent commented Mar 6, 2021

@MicahZoltu all items are addressed in these commits. Requesting, please, your promotion to Review status with these changes by merging this PR.

5c94ace

135a1da

14be2c7

602622b

EIPS/eip-2228.md Outdated Show resolved Hide resolved
EIPS/eip-2228.md Outdated
Comment on lines 23 to 31
The Ethereum network with chainid 1 is referenced using several conflicting names across EIPs (as published at the time EIP 2228 was written), client implementations, and information published on the internet at large:

* Vitalik has called it "main net" at http://eips.ethereum.org/EIPS/eip-155 http://eips.ethereum.org/EIPS/eip-170
* Vitalik has called it "mainnet" at http://eips.ethereum.org/EIPS/eip-86
* Vitalik has called it "Main net" at http://eips.ethereum.org/EIPS/eip-2* http://eips.ethereum.org/EIPS/eip-150
* "main net" at [EIP-155](./eip-155.md), [EIP-170](./eip-170.md)
* "mainnet" at [EIP-86 [DRAFT]](./eip-86.md), [client documentation](https://geth.ethereum.org/support/FAQ)
* "Main net" at [EIP-2](./eip-2.md), [EIP-150](./eip-150.md)
* \* In EIP-2, it is unclear if the first letter is capital because it is a proper noun or if it is the the first word in a text column presented in sentence case
* Vitalik has called it "Mainnet" at http://eips.ethereum.org/EIPS/eip-7
* Geth documentation calls its "mainnet" at https://geth.ethereum.org/support/FAQ
* A final EIP here has referred to it as "Mainnet" at http://eips.ethereum.org/EIPS/eip-779
* "Mainnet" at [EIP-7](./eip-7.md), [EIP-779](./eip-779.md)

In several examples above, even papers written by the same author use (as published at the time EIP 2228 was written) inconsistent names to refer to the Ethereum network with chainid 1.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Ethereum network with chainid 1 is referenced using several conflicting names across EIPs (as published at the time EIP 2228 was written), client implementations, and information published on the internet at large:
* Vitalik has called it "main net" at http://eips.ethereum.org/EIPS/eip-155 http://eips.ethereum.org/EIPS/eip-170
* Vitalik has called it "mainnet" at http://eips.ethereum.org/EIPS/eip-86
* Vitalik has called it "Main net" at http://eips.ethereum.org/EIPS/eip-2* http://eips.ethereum.org/EIPS/eip-150
* "main net" at [EIP-155](./eip-155.md), [EIP-170](./eip-170.md)
* "mainnet" at [EIP-86 [DRAFT]](./eip-86.md), [client documentation](https://geth.ethereum.org/support/FAQ)
* "Main net" at [EIP-2](./eip-2.md), [EIP-150](./eip-150.md)
* \* In EIP-2, it is unclear if the first letter is capital because it is a proper noun or if it is the the first word in a text column presented in sentence case
* Vitalik has called it "Mainnet" at http://eips.ethereum.org/EIPS/eip-7
* Geth documentation calls its "mainnet" at https://geth.ethereum.org/support/FAQ
* A final EIP here has referred to it as "Mainnet" at http://eips.ethereum.org/EIPS/eip-779
* "Mainnet" at [EIP-7](./eip-7.md), [EIP-779](./eip-779.md)
In several examples above, even papers written by the same author use (as published at the time EIP 2228 was written) inconsistent names to refer to the Ethereum network with chainid 1.
The Ethereum network with chainid 1 is referenced using several conflicting names across EIPs, client implementations, and information published on the internet at large. In several locations, even documents written by the same author use inconsistent names to refer to the Ethereum network with chainid 1. Names in use at the time of this writing include:
* `main net`
* `mainnet`
* `Main net`
* `Mainnet`

At the least, you'll need to remove draft EIPs from the list and the external link to https://geth.ethereum.org/support/FAQ. I don't believe that linking to these documents provides any future value to this EIP so I recommend just getting rid of all of the links and instead just providing a list of options you have seen used around the internet.

Also, I recommend adding something to the motivation section that explains why there is value in consistency here, as I think that is more important than showing that there is a historic lack of consistency.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is adopted substantially at 199121d

EIPS/eip-2228.md Outdated
Comment on lines 39 to 46
### Trademark note

Note: Ethereum [is a registered trademark](https://tsdr.uspto.gov/#caseNumber=86634529&caseType=SERIAL_NO&searchType=statusSearch) of Ethereum Foundation and [the Foundation asserts](https://ethereum.org/en/terms-of-use/) "you must not use [this mark] without the prior written permission of the Foundation".

Your application MAY reference "Ethereum® Mainnet" and include a note "Ethereum is a registered trademark of Ethereum Foundation" elsewhere.

Trademark status, fair use of trademarks, and any written permissions you have with the Ethereum Foundation are outside the scope of this EIP.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The general EIP policy is to not include any external links. Also, I feel like an EIP is not the appropriate place to mention trademarks or other legal statuses. If people want to read the ToU they can read the ToU, no need to restate it here. Your last line of this sums up my position pretty cleanly, but feels unnecessary to include in the EIP.

Suggested change
### Trademark note
Note: Ethereum [is a registered trademark](https://tsdr.uspto.gov/#caseNumber=86634529&caseType=SERIAL_NO&searchType=statusSearch) of Ethereum Foundation and [the Foundation asserts](https://ethereum.org/en/terms-of-use/) "you must not use [this mark] without the prior written permission of the Foundation".
Your application MAY reference "Ethereum® Mainnet" and include a note "Ethereum is a registered trademark of Ethereum Foundation" elsewhere.
Trademark status, fair use of trademarks, and any written permissions you have with the Ethereum Foundation are outside the scope of this EIP.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The normative part of this comment is addressed in b5ccfed. I refer further discussion to the discussions-to page.

@fulldecent
Copy link
Contributor Author

@MicahZoltu has raised a few points here:

  • Whether it is appropriate to mention Geth in a document surveying usage of "main net" wording
  • Whether EIPs may link to things
  • Whether a document published under the (delegated) authority of Ethereum Foundation and discussing the naming of a product created by the Ethereum Foundation is appropriate to reference a written policy Ethereum Foundation already has on usage of that name

I would like a chance to make points on these topics.

At the moment, this PR is requesting to promote EIP-2228 into "Review" status which represents "An EIP Author marks an EIP as ready for and requesting Peer Review". I think "Review" is an appropriate status given the level of discussions we are having and I request that those above questions are closed without prejudice here so they can be more appropriately considered at the EIP Discussions-To address.

@MicahZoltu MicahZoltu changed the title Promote to last call Promote to Review Mar 7, 2021
@MicahZoltu
Copy link
Contributor

MicahZoltu commented Mar 7, 2021

Ah, I forgot that this was Review and not Last Call (just updated PR title to reflect that).

That being said, the bar to get to Review is that it follows all of the current editorial rules (no external links, no links to draft EIPs).

While I agree that my commentary on the terms of use reference is perhaps a discussion that could happen elsewhere and could is a change that isn't necessary for moving to Review, the link to it goes against our current policy of no external links.

We can move the discussion of whether ToU is appropriate over to the discussions-to link if you like, but if you want to propose a change the current policy of no external links that probably should happen elsewhere (unrelated to this EIP).

…ity note

git clone...; cd EIPS
rm $(egrep -l 'status: Draft|status: Review|status: Withdrawn|status: Last Call' * )
grep -h 'status: ' * | sort -u 
grep -iw 'main \?net' * | sort
@fulldecent
Copy link
Contributor Author

The requirement "no external links" is not documented. Here is a PR that adds that documentation: #3358


The requirement "no links to draft EIPs" is not documented. Here is a PR that adds that documentation: #3357

Well noted, thank you


I have made commits to address all normative feedback here. Requesting please a ⬇️ CREATE A MERGE COMMIT, and for discussion to continue at the discussion-to address.

@fulldecent fulldecent changed the title Promote to Review EIP-2228: Promote to Review Mar 10, 2021
@MicahZoltu MicahZoltu merged commit 4d1be5b into ethereum:master Mar 11, 2021
phi-line pushed a commit to phi-line/EIPs that referenced this pull request Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants