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

Adds clarifying text to the EIP-155 specification. #2272

Merged
merged 1 commit into from
Jun 9, 2020

Conversation

MicahZoltu
Copy link
Contributor

As someone implementing stuff related to signing in this space I have had to come back and read this EIP many times to remind myself how to properly sign/recover a transaction post EIP-155. Each time, I read this EIP and am left confused about what I'm actually supposed to do when signing. After once again digging to figure out what I'm supposed to do I decided to edit this EIP to hopefully prevent future developers (including myself) from running into the same frustration.

This change is non-normative and only attempts to improve clarity of the process. If a normative change was made, this means my understanding is flawed and corrections should be made before this PR is merged.

The major change is to include a section for how to generate a valid post-155 signature. The original text only explained how to validate a post-155 signature and it was left up to the reader to figure out how to generate one.

I chose to use SHOULD here because it offers the users additional security against replay attacks and generally should be preferred unless you have good reason to not sign this way. This could be widened to MAY if that is desirable. MUST would be a normative change so that was intentionally not chosen.

I have also made a couple grammatical and formatting changes to the original text while editing which I felt helped improve readability.

When opening a pull request to submit a new EIP, please use the suggested template: https://github.com/ethereum/EIPs/blob/master/eip-template.md

We have a GitHub bot that automatically merges some PRs. It will merge yours immediately if certain criteria are met:

  • The PR edits only existing draft PRs.
  • The build passes.
  • Your Github username or email address is listed in the 'author' header of all affected PRs, inside .
  • If matching on email address, the email address is the one publicly listed on your GitHub profile.

As someone implementing stuff related to signing in this space I have had to come back and read this EIP many times to remind myself how to properly sign/recover a transaction post EIP-155.  Each time, I read this EIP and am left confused about what I'm actually supposed to do when signing.  After once again digging to figure out what I'm supposed to do I decided to edit this EIP to hopefully prevent future developers (including myself) from running into the same frustration.

This change is non-normative and only attempts to improve clarity of the process.  If a normative change was made, this means my understanding is flawed and corrections should be made before this PR is merged.

The major change is to include a section for how to generate a valid post-155 signature.  The original text only explained how to _validate_ a post-155 signature and it was left up to the reader to figure out how to generate one.

I chose to use **SHOULD** here because it offers the users additional security against replay attacks and generally should be preferred unless you have good reason to not sign this way.  This could be widened to **MAY** if that is desirable.  **MUST** would be a normative change so that was intentionally not chosen.

I have also made a couple grammatical and formatting changes to the original text while editing which I felt helped improve readability.
@Dan-Nolan
Copy link

I like this change. I found this issue from searching why v was 27 in a particular transaction signed post spurious dragon.

@axic
Copy link
Member

axic commented Apr 21, 2020

@vbuterin can you review this?

@MicahZoltu
Copy link
Contributor Author

@axic At this point I don't think we are going to hear from @vbuterin. Can we move forward without that? I dislike the idea of publishing a new EIP just for a non-normative change like this that is meant to provide clarity for implementers, but I'm not sure what other option is available when the EIP author(s) are non-responsive.

@gcolvin gcolvin merged commit 2cb94cc into ethereum:master Jun 9, 2020
@MicahZoltu MicahZoltu deleted the patch-4 branch June 9, 2020 05:59
pizzarob pushed a commit to pizzarob/EIPs that referenced this pull request Jun 12, 2020
As someone implementing stuff related to signing in this space I have had to come back and read this EIP many times to remind myself how to properly sign/recover a transaction post EIP-155.  Each time, I read this EIP and am left confused about what I'm actually supposed to do when signing.  After once again digging to figure out what I'm supposed to do I decided to edit this EIP to hopefully prevent future developers (including myself) from running into the same frustration.

This change is non-normative and only attempts to improve clarity of the process.  If a normative change was made, this means my understanding is flawed and corrections should be made before this PR is merged.

The major change is to include a section for how to generate a valid post-155 signature.  The original text only explained how to _validate_ a post-155 signature and it was left up to the reader to figure out how to generate one.

I chose to use **SHOULD** here because it offers the users additional security against replay attacks and generally should be preferred unless you have good reason to not sign this way.  This could be widened to **MAY** if that is desirable.  **MUST** would be a normative change so that was intentionally not chosen.

I have also made a couple grammatical and formatting changes to the original text while editing which I felt helped improve readability.
tkstanczak pushed a commit to tkstanczak/EIPs that referenced this pull request Nov 7, 2020
As someone implementing stuff related to signing in this space I have had to come back and read this EIP many times to remind myself how to properly sign/recover a transaction post EIP-155.  Each time, I read this EIP and am left confused about what I'm actually supposed to do when signing.  After once again digging to figure out what I'm supposed to do I decided to edit this EIP to hopefully prevent future developers (including myself) from running into the same frustration.

This change is non-normative and only attempts to improve clarity of the process.  If a normative change was made, this means my understanding is flawed and corrections should be made before this PR is merged.

The major change is to include a section for how to generate a valid post-155 signature.  The original text only explained how to _validate_ a post-155 signature and it was left up to the reader to figure out how to generate one.

I chose to use **SHOULD** here because it offers the users additional security against replay attacks and generally should be preferred unless you have good reason to not sign this way.  This could be widened to **MAY** if that is desirable.  **MUST** would be a normative change so that was intentionally not chosen.

I have also made a couple grammatical and formatting changes to the original text while editing which I felt helped improve readability.
Arachnid pushed a commit to Arachnid/EIPs that referenced this pull request Mar 6, 2021
As someone implementing stuff related to signing in this space I have had to come back and read this EIP many times to remind myself how to properly sign/recover a transaction post EIP-155.  Each time, I read this EIP and am left confused about what I'm actually supposed to do when signing.  After once again digging to figure out what I'm supposed to do I decided to edit this EIP to hopefully prevent future developers (including myself) from running into the same frustration.

This change is non-normative and only attempts to improve clarity of the process.  If a normative change was made, this means my understanding is flawed and corrections should be made before this PR is merged.

The major change is to include a section for how to generate a valid post-155 signature.  The original text only explained how to _validate_ a post-155 signature and it was left up to the reader to figure out how to generate one.

I chose to use **SHOULD** here because it offers the users additional security against replay attacks and generally should be preferred unless you have good reason to not sign this way.  This could be widened to **MAY** if that is desirable.  **MUST** would be a normative change so that was intentionally not chosen.

I have also made a couple grammatical and formatting changes to the original text while editing which I felt helped improve readability.
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