From 7575a88b03b478d068cbf96529a12a9b64217947 Mon Sep 17 00:00:00 2001 From: i-norden Date: Sun, 9 Apr 2023 12:58:18 -0500 Subject: [PATCH] add a bit to the README about the alt implementation --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index a8eefb5..6f331b2 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,9 @@ Postgres IPLD blockstore in the "public.blocks" table) and access state and stor Note: "IPFS" is chosen in the name of "ipfs-ethdb" as it can function through an IPFS BlockService abstraction or directly ontop of an IPLD blockstore, whereas this repository is very tightly coupled to the schema in ipld-eth-db. + +The top-level package contains the implementation of the `vm.StateDB` interface that accesses state directly using the +`state_cids` and `storage_cids` tables in ipld-eth-db. The `trie_by_cid` package contains an alternative implementation +which accesses state in `ipld.blocks` through the typical trie traversal access pattern (using CIDs instead of raw +keccak256 hashes), it is used for benchmarking and for functionality which requires performing a trie traversal +(things which must collect intermediate nodes, e.g. `eth_getProof` and `eth_getSlice`).