Skip to content

Commit e1091ae

Browse files
holgerd77am1r021
andauthored
Add README Package Highlights (#4020)
* Add README highlights (VM) * Add README highlights (EVM) * Add README highlights (tx) * Add README highlights (block) * Add README highlights (mpt) * Add README highlights (statemanager) * VM bundle size update * Update packages/block/README.md * Update packages/evm/README.md * Update packages/mpt/README.md * Update packages/statemanager/README.md * Update packages/tx/README.md * Update packages/vm/README.md --------- Co-authored-by: Scorbajio <[email protected]>
1 parent 934e20d commit e1091ae

File tree

6 files changed

+58
-10
lines changed

6 files changed

+58
-10
lines changed

packages/block/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@
99
| Implements schema and functions related to Ethereum blocks. |
1010
| ----------------------------------------------------------- |
1111

12+
- 🦄 All block features till **Pectra**
13+
- 🌴 Tree-shakeable API
14+
- 👷🏼 Controlled dependency set (4 external + `@Noble` crypto)
15+
- 🔮 `EIP-4844` Shard Blob Txs
16+
- 💸 `EIP-4895` Beacon Chain Withdrawals
17+
- 📨 `EIP-7685` Consensus Layer Requests
18+
- 🛵 324KB bundle size (81KB gzipped)
19+
- 🏄🏾‍♂️ WASM-free default + Fully browser ready
20+
1221
## Table of Contents
1322

1423
- [Installation](#installation)

packages/evm/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@
99
| TypeScript implementation of the Ethereum EVM. |
1010
| ---------------------------------------------- |
1111

12+
- 🦄 All hardforks up till **Pectra**
13+
- 🌴 Tree-shakeable API
14+
- 👷🏼 Controlled dependency set (7 external + `@Noble` crypto)
15+
- 🧩 Flexible EIP on/off engine
16+
- 🛠️ Custom precompiles
17+
- 🚀 Build-in profiler
18+
- 🪢 User-friendly colored debugging
19+
- 🛵 422KB bundle size (110KB gzipped)
20+
- 🏄🏾‍♂️ WASM-free default + Fully browser ready
21+
1222
## Table of Contents
1323

1424
- [Installation](#installation)

packages/mpt/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,16 @@
77
[![Discord][discord-badge]][discord-link]
88

99
| Implementation of the [Modified Merkle Patricia Trie](https://ethereum.org/en/developers/docs/data-structures-and-encoding/patricia-merkle-mpt/) as specified in the [Ethereum Yellow Paper](http://gavwood.com/Paper.pdf) |
10-
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11-
12-
> The modified Merkle Patricia tree (mpt) provides a persistent data structure to map between arbitrary-length binary data (byte arrays). It is defined in terms of a mutable data structure to map between 256-bit binary fragments and arbitrary-length binary data. The core of the mpt, and its sole requirement in terms of the protocol specification, is to provide a single 32-byte value that identifies a given set of key-value pairs.
10+
| ---------------------------------------------------------------------------- |
11+
12+
- 🔭 Highly scalable
13+
- 🌴 Tree-shakeable API
14+
- 👷🏼 Controlled dependency set (3 external + `@Noble` crypto)
15+
- ⏳ Checkpoint Functionality
16+
- 🛢️ Flexible storage backends
17+
- ⚖️ `EIP-1186` Proofs
18+
- 🛵 176KB bundle size (48KB gzipped)
19+
- 🏄🏾‍♂️ WASM-free default + Fully browser ready
1320

1421
## Table of Contents
1522

packages/statemanager/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@
99
| Library to provide high level access to Ethereum State |
1010
| ------------------------------------------------------ |
1111

12+
- 🫧 Transparent state access from EVM/VM
13+
- 🌴 Tree-shakeable API
14+
- 👷🏼 Controlled dependency set (5 external + `@Noble` crypto)
15+
- ⏳ Checkpoints + Diff-based Caches
16+
- 🔌 Unified interface (for custom SMs)
17+
- 🎁 3 SMs included (Merkle/Simple/RPC)
18+
- 🛵 233KB bundle size (for Merkle SM) (63KB gzipped)
19+
- 🏄🏾‍♂️ WASM-free default + Fully browser ready
20+
1221
## Table of Contents
1322

1423
- [Installation](#installation)

packages/tx/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@
99
| Implements schema and functions for the different Ethereum transaction types |
1010
| ---------------------------------------------------------------------------- |
1111

12+
- 🦄 All tx types up till **Pectra**
13+
- 🌴 Tree-shakeable API
14+
- 👷🏼 Controlled dependency set (1 external + `@Noble` crypto)
15+
- 🎼 Unified tx type API
16+
- 📲 New type for **EIP-7702** account abstraction
17+
- 🛵 190KB bundle size (all tx types) (47KB gzipped)
18+
- 🏄🏾‍♂️ WASM-free default + Fully browser ready
19+
1220
## Table of Contents
1321

1422
- [Installation](#installation)

packages/vm/README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,19 @@
99
| Execution Context for the Ethereum EVM Implementation. |
1010
| ------------------------------------------------------ |
1111

12-
This package provides an Ethereum `mainnet` compatible execution context for the
12+
Ethereum `mainnet` compatible execution context for
1313
[@ethereumjs/evm](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/evm)
14-
EVM implementation.
15-
16-
So beyond bytecode processing this package allows to run or build new Ethereum blocks or single transactions
17-
and update a blockchain state accordingly.
18-
19-
Note that up till `v5` this package also was the bundled package for the EVM implementation itself.
14+
to build and run blocks and txs and update state.
15+
16+
- 🦄 All hardforks up till **Pectra**
17+
- 🌴 Tree-shakeable API
18+
- 👷🏼 Controlled dependency set (7 external + `@Noble` crypto)
19+
- 🧩 Flexible EIP on/off engine
20+
- 📲 **EIP-7702** ready
21+
- 📬 Flexible state retrieval (Merkle, RPC,...)
22+
- 🔎 Passes official #Ethereum tests
23+
- 🛵 668KB bundle size (170KB gzipped)
24+
- 🏄🏾‍♂️ WASM-free default + Fully browser ready
2025

2126
## Table of Contents
2227

0 commit comments

Comments
 (0)