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

[Fix] use Eip2718Error, add docs on different encodings #869

Merged
merged 4 commits into from
Jun 12, 2024

Conversation

prestwich
Copy link
Member

closes #283 and more!

Motivation

Turns out we weren't even using the 2718 error type.

Solution

Change Decodable2718 to use the error type.
Add docs about network encoding vs 2718 encoding
remove erroneous references to RLP in 2718 docs

PR Checklist

  • Added Tests
  • Added Documentation
  • Breaking changes

@prestwich prestwich added bug Something isn't working debt Tech debt which needs to be addressed labels Jun 11, 2024
@prestwich prestwich self-assigned this Jun 11, 2024
crates/eips/src/eip2718.rs Outdated Show resolved Hide resolved
Comment on lines +216 to +217
/// The network encoding is the RLP encoding of the eip2718-encoded
/// envelope.
Copy link
Member

Choose a reason for hiding this comment

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

this cost me days of my life

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>
@prestwich prestwich merged commit 6787cf4 into main Jun 12, 2024
22 checks passed
@prestwich prestwich deleted the prestwich/2718-refactor branch June 12, 2024 11:27
ben186 pushed a commit to ben186/alloy that referenced this pull request Jul 27, 2024
* fix: use 2718 error

* nit: remove rlp reference

* doc: more of em

* Update crates/eips/src/eip2718.rs

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>

---------

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working debt Tech debt which needs to be addressed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Provide examples for and document encoding with Encodable2718 and Decodable2718
2 participants