Godoc for indexer constructor

2023-09-29 20:50:11 +08:00
parent f0e7c74362
commit d80e2104de
1 changed files with 4 additions and 0 deletions
@@ -33,6 +33,10 @@ import (
 )

 // NewStateDiffIndexer creates and returns an implementation of the StateDiffIndexer interface.
+// `chainConfig` is used when processing chain state.
+// `nodeInfo` contains metadata on the Ethereum node, which is inserted with the indexed state.
+// `config` contains configuration specific to the indexer.
+// `diff` tells us to mark state nodes as belonging to an incremental diff, as opposed to a full snapshot.
 func NewStateDiffIndexer(
 	ctx context.Context,
 	chainConfig *params.ChainConfig,