Skip to content

Add README Package Highlights#4020

Merged
holgerd77 merged 14 commits into
masterfrom
add-readme-package-highlights
Apr 25, 2025
Merged

Add README Package Highlights#4020
holgerd77 merged 14 commits into
masterfrom
add-readme-package-highlights

Conversation

@holgerd77

Copy link
Copy Markdown
Member

This PR adds some highlight section for our core packages at the beginning of the README docs.

@codecov

codecov Bot commented Apr 24, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.89%. Comparing base (934e20d) to head (3666cc2).
Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

Flag Coverage Δ
block 84.33% <ø> (?)
blockchain 89.32% <ø> (ø)
client ?
common 97.51% <ø> (ø)
devp2p 86.78% <ø> (ø)
evm 73.02% <ø> (?)
mpt 89.69% <ø> (-0.06%) ⬇️
statemanager 69.06% <ø> (ø)
static 99.11% <ø> (?)
tx 90.59% <ø> (?)
util 89.36% <ø> (ø)
vm 55.50% <ø> (ø)

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread packages/vm/README.md
| ------------------------------------------------------ |

This package provides an Ethereum `mainnet` compatible execution context for the
Ethereum `mainnet` compatible execution context for

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is it important to say mainnet here? That seems to be too narrowly focused since this would work in any chain context that you can specify in our common chain setup, right?

jochem-brouwer
jochem-brouwer previously approved these changes Apr 24, 2025

@jochem-brouwer jochem-brouwer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One small informational note regarding bundle sizes since those will change with every line of code we merge. LGTM otherwise!

Comment thread packages/block/README.md
- 🔮 `EIP-4844` Shard Blob Txs
- 💸 `EIP-4895` Beacon Chain Withdrawals
- 📨 `EIP-7685` Consensus Layer Requests
- 🛵 324KB bundle size (81KB gzipped)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ok, this is fine, but for every PR which we will merge in any of these packages these numbers will likely be incorrect. (Just an informational note. Should we update it for each release to reflect the bundle size?)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we could also consider not including the size here in the docs. There are bundle size tools for this (https://bundlephobia.com/package/@ethereumjs/block@5.3.0)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think it is super important to keep and brings great additional value if we do this (Paul is doing as well). This does not need to be "on point" by KB but gives users strong guidance if they can (bundle size is ok for them, just ballpark number) or cannot (bundle size far too high) use our libraries.

ScottyPoi
ScottyPoi previously approved these changes Apr 24, 2025
@ScottyPoi ScottyPoi force-pushed the add-readme-package-highlights branch from 31f70fe to a2d0476 Compare April 24, 2025 18:36
Comment thread packages/block/README.md Outdated
Comment thread packages/block/README.md
- 🔮 `EIP-4844` Shard Blob Txs
- 💸 `EIP-4895` Beacon Chain Withdrawals
- 📨 `EIP-7685` Consensus Layer Requests
- 🛵 324KB bundle size (81KB gzipped)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we could also consider not including the size here in the docs. There are bundle size tools for this (https://bundlephobia.com/package/@ethereumjs/block@5.3.0)

Comment thread packages/evm/README.md Outdated
Comment thread packages/mpt/README.md Outdated
Comment thread packages/statemanager/README.md Outdated
Comment thread packages/tx/README.md Outdated
Comment thread packages/vm/README.md Outdated
@am1r021 am1r021 dismissed stale reviews from jochem-brouwer and ScottyPoi via c20a901 April 24, 2025 18:45
@holgerd77

Copy link
Copy Markdown
Member Author

Sorry, do not have the patience to wait for yet another round of CI and approval, after 2 approvals already done and dismissed, especially for this doc PR. Will admin merge.

@holgerd77 holgerd77 merged commit e1091ae into master Apr 25, 2025
@holgerd77 holgerd77 deleted the add-readme-package-highlights branch April 25, 2025 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants