comments

AdaptorV1
data.Store
metadataupdates.Store
TransformFunc

Author: Tangui-Bitfly

backend/cmd/eth1indexer/main.go

@@ -192,7 +192,7 @@ func Run() {
 	}
 
 	indexer := executionlayer.NewIndexer(
-		executionlayer.NewBigtableAdaptor(
+		executionlayer.NewAdaptorV1(
 			data.NewStore(database.Wrap(bigtable, data.Table)),
 			metadataupdates.NewStore(database.Wrap(bigtable, metadataupdates.Table), cache),
 		),

backend/cmd/misc/main.go

@@ -1632,7 +1632,7 @@ func indexOldEth1Blocks(startBlock uint64, endBlock uint64, batchSize uint64, co
 		return
 	}
 	indexer := executionlayer.NewIndexer(
-		executionlayer.NewBigtableAdaptor(
+		executionlayer.NewAdaptorV1(
 			data.NewStore(database.Wrap(bigtable, data.Table)),
 			metadataupdates.NewStore(database.Wrap(bigtable, metadataupdates.Table), cache),
 		),

backend/pkg/commons/db2/data/data.go

@@ -16,6 +16,7 @@ import (
 	"github.com/gobitfly/beaconchain/pkg/commons/types"
 )
 
+// Store encapsulate all the interaction with the data store which contains all the indexed objects
 type Store struct {
 	db database.Database
 }
@@ -116,6 +117,10 @@ func (store Store) AddIndexedBlock(block IndexedBlock) ([]string, error) {
 	return maps.Keys(updates), nil
 }
 
+// Get allows to retrieve Transactions and ERC20 Transfers from the Store
+// some Option can be applied to add filter on the search
+// This is a WIP functionality, used only in tests for now
+// but it will the base for account dashboard functionalities
 func (store Store) Get(chainIDs []string, addresses []common.Address, prefixes map[string]map[string]string, limit int64, opts ...Option) ([]*Interaction, map[string]map[string]string, error) {
 	sources := map[formatType]unMarshalInteraction{
 		typeTx:       unMarshalTx,

backend/pkg/commons/db2/data/tables.go

@@ -2,6 +2,7 @@ package data
 
 const Table = "data"
 
+// Schema is a map containing the bigtable table and the family
 var Schema = map[string][]string{
 	Table: {
 		defaultFamily,

backend/pkg/commons/db2/metadataupdates/store.go

@@ -9,6 +9,13 @@ import (
 	"github.com/gobitfly/beaconchain/pkg/commons/types"
 )
 
+// Store encapsulate all the interaction with the metadata_updates store, it contains:
+//   - the mutation for a block (in case of reorg)
+//   - the balance update keys (balance to update, record is deleted once balance is updated)
+//   - the contract keys (to track if an address is a contract)
+//
+// also have caching to prevent putting multiple balance to update for the same address / token pair
+// clearing the cache is the responsibility of the caller for now
 type Store struct {
 	db    database.Database
 	cache Cache
@@ -37,6 +44,8 @@ func (store Store) NewBatch() *database.Batch {
 	return database.NewBatch(store.db)
 }
 
+// AddIndexedBlock extracts all the data to save from an IndexedBlock
+// Moreover it takes a list of keys as param to save the different keys update in the data.Store in case of a reorg
 func (store Store) AddIndexedBlock(number uint64, hash []byte, block IndexedBlock, keys []string) error {
 	updates := make(map[string][]database.Item)
 	if len(keys) > 0 {

backend/pkg/executionlayer/adaptor.go

@@ -21,19 +21,22 @@ type IndexedBlock struct {
 	Contracts       []metadataupdates.ContractUpdateWithAddress
 }
 
-func NewBigtableAdaptor(data data.Store, metadataUpdates metadataupdates.Store) BigTableAdaptor {
-	return BigTableAdaptor{
+// AdaptorV1 represents the current storage organisation
+// it consists of a data store where indexed object are saved
+// and a metadataUpdates store where balances and some other data are saved
+type AdaptorV1 struct {
+	data            data.Store
+	metadataUpdates metadataupdates.Store
+}
+
+func NewAdaptorV1(data data.Store, metadataUpdates metadataupdates.Store) AdaptorV1 {
+	return AdaptorV1{
 		data:            data,
 		metadataUpdates: metadataUpdates,
 	}
 }
 
-type BigTableAdaptor struct {
-	data            data.Store
-	metadataUpdates metadataupdates.Store
-}
-
-func (adaptor BigTableAdaptor) Save(blockNumber uint64, hash []byte, block IndexedBlock) error {
+func (adaptor AdaptorV1) Save(blockNumber uint64, hash []byte, block IndexedBlock) error {
 	keys, err := adaptor.data.AddIndexedBlock(data.IndexedBlock{
 		ChainID:         block.ChainID,
 		Block:           block.Block,

backend/pkg/executionlayer/indexer_test.go

@@ -139,7 +139,7 @@ func TestIndexerWithBigTable(t *testing.T) {
 			defer func() { _ = metadataBigtable.Clear() }()
 
 			indexer := NewIndexer(
-				NewBigtableAdaptor(
+				NewAdaptorV1(
 					data.NewStore(database.Wrap(dataBigtable, data.Table)),
 					metadataupdates.NewStore(database.Wrap(metadataBigtable, metadataupdates.Table), metadataupdates.NoopCache{}),
 				),

backend/pkg/executionlayer/transformer.go

@@ -23,6 +23,10 @@ import (
 	"github.com/gobitfly/beaconchain/pkg/commons/types"
 )
 
+// TransformFunc describes a function that will index a specific object from the types.Eth1Block
+// example: transaction, ERC20 transfer, block, ...
+// It will put the indexed result into the res *IndexedBlock param
+// This way all transform functions have the same signature
 type TransformFunc func(chainID string, block *types.Eth1Block, res *IndexedBlock) error
 
 var Transformers = map[string]TransformFunc{