ipld-eth-statedb/trie_by_cid/doc.go

// This package is a near complete copy of go-ethereum/trie and go-ethereum/core/state, modified to use
// a v0 IPFS blockstore as the backing DB, i.e. DB values are indexed by CID rather than hash.
package trie_by_cid

// Note: This is written so as to minimize the difference from the geth packages to allow easier
// patching during upgrades.
//
// Changes to the original functionality should be marked with (ipld-eth-statedb change)
// The main changes are within the triedb/hashdb package.
//
// Writes are currently disabled and will panic, but they may be useful for testing if possible.
//
// Tests from the original source are preserved as much as reasonably possible.  Memory DBs are
// replaced with Postgres connections within the state package, but not the trie packages, since
// they mostly check the structural consistency of the trie.
Redo trie_by_cid package to be read-write * use logrus instead of geth log * remove benchmarks * impl NodeIterator.ParentPath * update go mods 2023-04-25 09:14:04 +00:00			`// This package is a near complete copy of go-ethereum/trie and go-ethereum/core/state, modified to use`
			`// a v0 IPFS blockstore as the backing DB, i.e. DB values are indexed by CID rather than hash.`
			`package trie_by_cid`
Geth 1.13 (Deneb/Cancun) update (#5) The Geth `core/state` and `trie` packages underwent a big refactor between `v1.11.6` and `1.13.14`. This code, which was adapted from those, needed corresponding updates. To do this I applied the diff patches from Geth directly where possible and in some places had to clone new parts of the Geth code and adapt them. In order to make this process as straightforward as possible in the future, I've attempted to minimize the number of changes vs. Geth and added some documentation in the `trie_by_cid` package. Reviewed-on: https://git.vdb.to/cerc-io/ipld-eth-statedb/pulls/5 2024-05-29 10:00:12 +00:00
			`// Note: This is written so as to minimize the difference from the geth packages to allow easier`
			`// patching during upgrades.`
			`//`
			`// Changes to the original functionality should be marked with (ipld-eth-statedb change)`
			`// The main changes are within the triedb/hashdb package.`
			`//`
			`// Writes are currently disabled and will panic, but they may be useful for testing if possible.`
			`//`
			`// Tests from the original source are preserved as much as reasonably possible. Memory DBs are`
			`// replaced with Postgres connections within the state package, but not the trie packages, since`
			`// they mostly check the structural consistency of the trie.`