Add README Package Highlights#4020
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
| | ------------------------------------------------------ | | ||
|
|
||
| This package provides an Ethereum `mainnet` compatible execution context for the | ||
| Ethereum `mainnet` compatible execution context for |
There was a problem hiding this comment.
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
left a comment
There was a problem hiding this comment.
One small informational note regarding bundle sizes since those will change with every line of code we merge. LGTM otherwise!
| - 🔮 `EIP-4844` Shard Blob Txs | ||
| - 💸 `EIP-4895` Beacon Chain Withdrawals | ||
| - 📨 `EIP-7685` Consensus Layer Requests | ||
| - 🛵 324KB bundle size (81KB gzipped) |
There was a problem hiding this comment.
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?)
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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.
31f70fe to
a2d0476
Compare
| - 🔮 `EIP-4844` Shard Blob Txs | ||
| - 💸 `EIP-4895` Beacon Chain Withdrawals | ||
| - 📨 `EIP-7685` Consensus Layer Requests | ||
| - 🛵 324KB bundle size (81KB gzipped) |
There was a problem hiding this comment.
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)
|
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. |
This PR adds some highlight section for our core packages at the beginning of the README docs.