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

feat(docs): add primer on all transaction types #3897

Merged
merged 4 commits into from
Jul 25, 2023

Conversation

tcoratger
Copy link
Contributor

Should solve #3803.

I added the description of the different types of transactions in two places:

  • In the code for new contributors who would be lost.
  • In the official documentation (book) for users with a little more text.

If it is not necessary, I can remove the description in the book, but I thought it could provide additional information.

@tcoratger tcoratger requested a review from gakonst as a code owner July 24, 2023 21:17
@codecov
Copy link

codecov bot commented Jul 24, 2023

Codecov Report

Merging #3897 (ceec98b) into main (9b9ae82) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

Files Changed Coverage Δ
crates/primitives/src/transaction/mod.rs 82.22% <ø> (ø)

... and 9 files with indirect coverage changes

Flag Coverage Δ
integration-tests 15.54% <ø> (-0.02%) ⬇️
unit-tests 64.44% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
reth binary 26.44% <ø> (ø)
blockchain tree 83.01% <ø> (ø)
pipeline 89.66% <ø> (ø)
storage (db) 74.19% <ø> (ø)
trie 94.70% <ø> (+0.05%) ⬆️
txpool 46.56% <ø> (+0.56%) ⬆️
networking 77.67% <ø> (-0.02%) ⬇️
rpc 58.28% <ø> (ø)
consensus 64.46% <ø> (+0.13%) ⬆️
revm 33.68% <ø> (ø)
payload builder 6.61% <ø> (ø)
primitives 88.01% <ø> (ø)

Copy link
Collaborator

@mattsse mattsse left a comment

Choose a reason for hiding this comment

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

awesome!

I will use this as the base and extend this with docs about reth's internal transaction types (txpool, primitives) and rpc types

book/run/transactions.md Outdated Show resolved Hide resolved
@mattsse mattsse added the C-docs An addition or correction to our documentation label Jul 24, 2023
@mattsse mattsse added this pull request to the merge queue Jul 25, 2023
Merged via the queue into paradigmxyz:main with commit 34fc89b Jul 25, 2023
@tcoratger tcoratger deleted the tx-doc branch July 25, 2023 11:17
merklefruit pushed a commit to anton-rs/op-reth that referenced this pull request Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-docs An addition or correction to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants