feat(tx_index): fill transaction index gap on enabling automatic backfill #12353

akaladarshi · 2024-08-07T10:56:13Z

Related Issues

Fixes part of: #11007

Proposed Changes

Adds EnableAutomaticBackFill in index config in fullNode
Adds MaxAutomaticBackFillTxIndexHeight in index config in fullnode
Tries to fill the gap between the last populated from current tipset tx hashes till:
- we reach MaxAutomaticBackFillTxIndexHeight or
- we reach a conflict in the eth tx hash index database
Adds PopulateAfterSnapshot for eth tx hash index to populate data for while loading from snapshot

akaladarshi · 2024-08-07T10:57:32Z

@aarshkshah1992 As per our discussion about waiting till the observer gets the latest head and process that,
I have a few ideas, let's discuss them once we verify this is correct.

aarshkshah1992

Round 1 of review. @akaladarshi Please can we also add logic to populate this from a snapshot just like we do for the MsgIndex ?

aarshkshah1992 · 2024-08-07T11:18:35Z

node/modules/ethmodule.go

@@ -78,7 +84,7 @@ func EthModuleAPI(cfg config.FevmConfig) func(helpers.MetricsCtx, repo.LockedRep
 				}

 				// Tipset listener
-				_ = ev.Observe(&ethTxHashManager)
+				ev.Observe(&ethTxHashManager)



We don't need this change.

aarshkshah1992 · 2024-08-07T11:30:55Z

node/config/types.go

@@ -621,6 +621,9 @@ type IndexConfig struct {
 	// EXPERIMENTAL FEATURE. USE WITH CAUTION
 	// EnableMsgIndex enables indexing of messages on chain.
 	EnableMsgIndex bool
+
+	// EnableAutomaticBackFill enables automatic index back-filling
+	EnableAutomaticBackFill bool


For now, we need to rename this to EnableAutomaticBackFillTxIndex as we're only doing it for the TX Index.

aarshkshah1992 · 2024-08-07T11:32:20Z

node/impl/full/txhashmanager.go

+	return nil
+}
+
+// PopulateExistingMappings walk back from the current head to the minimum height and populate the eth transaction hash lookup database


nit: check grammar

aarshkshah1992 · 2024-08-07T11:35:26Z

node/impl/full/txhashmanager.go

@@ -23,6 +23,49 @@ func (m *EthTxHashManager) Revert(ctx context.Context, from, to *types.TipSet) e
 	return nil
 }

+// FillIndexGap back-fills the gap between the current head and the last populated transaction index


nit: "last populated transaction index in* the Index"

aarshkshah1992 · 2024-08-07T11:38:29Z

node/impl/full/txhashmanager.go

+
+	totalProcessedBlock := 0
+	ts := m.StateAPI.Chain.GetHeaviestTipSet()
+	for _, block := range ts.Blocks() {


I think we need to keep going back in the chain to backfill. This loop terminates after backfilling messages in the heaviest tipset only.

We need to be careful on two fronts with going backward up the chain for two reasons:

the last processed message CID may not be on the canonical chain anymore so you may never encounter it; and

the last processed message may not even be in the blockstore due to a splitstore compaciton or some other happening (e.g. you've copied across someone else's txhash.db or restored an old one from disk, whatever)

I suspect ChainGetPath might be a good API to try here: get the tipset of the lastTxHash, get the latest tipset, find the path between. I'm just not sure what the error conditions are for that - how big a gap is too large, and how do we deal with splitstore GC problems (I suspect "find me the tipset for lastTxHash would error in that case if it was too old, in which case what's the strategy then?).

@rvagg I have been going through the ChainGetPath code, but I didn't see it returning a too old error, it only returns a not found error.

If it is not found then nodes have to import the snapshot.
Is there any other way to get the state?

Also ChainGetPath returns both revert and apply changes, so do we have to filter out apply changes and start backfilling?

Discuss this with @akaladarshi async. We worked through multiple solutions here. He will post a note about it.

aarshkshah1992 · 2024-08-07T11:38:48Z

node/impl/full/txhashmanager.go

+		totalProcessedBlock++
+	}
+
+	ts, err = m.StateAPI.Chain.GetTipSetFromKey(ctx, ts.Parents())


This needs to move to the loop above

aarshkshah1992 · 2024-08-07T11:39:23Z

node/impl/full/txhashmanager.go

+		for _, msg := range msgs {
+			if msg.Cid() == lastTxCid {
+				// We've reached the last indexed transaction
+				return nil


log completion and then return. Add logging around how many entires were inserted, which tipset it started from and which one it ended at etc.

akaladarshi · 2024-08-08T11:47:58Z

@aarshkshah1992 For the observer part, I thought we could do something like this:

Create a backfill chan
Provide the backfill chan to the observer
- Once it gets a new block from ChainNotify is sends it to the backfill chan
- Wait till the backfill chan is closed (means backfill is done)
Provide the same backfill chan to the FillIndexGap function in EthTxManager, also make it async
- It will wait till it receives the new block through the backfill chan from the observer
- Starts backfilling
- Once backfilling is done close the backfill chan so the observer can proceed as usual

aarshkshah1992 reviewed Aug 7, 2024

View reviewed changes

akaladarshi added 3 commits August 11, 2024 18:40

feat: fill transaction index gap on enabling automatic backfill

58978df

refactor: tx index back-filling

c4e0f06

feat: populate index from snapshot

4b56a36

akaladarshi force-pushed the akaladarshi/backfill-tx-index-gap branch from 0ec35b0 to 4b56a36 Compare August 12, 2024 04:22

fix: ci linter issues

72c2991

akaladarshi requested a review from aarshkshah1992 August 12, 2024 04:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(tx_index): fill transaction index gap on enabling automatic backfill #12353

feat(tx_index): fill transaction index gap on enabling automatic backfill #12353

akaladarshi commented Aug 7, 2024 •

edited

Loading

akaladarshi commented Aug 7, 2024

aarshkshah1992 left a comment

aarshkshah1992 Aug 7, 2024

aarshkshah1992 Aug 7, 2024

akaladarshi Aug 12, 2024

aarshkshah1992 Aug 7, 2024

aarshkshah1992 Aug 7, 2024

aarshkshah1992 Aug 7, 2024

rvagg Aug 8, 2024

akaladarshi Aug 8, 2024

aarshkshah1992 Aug 8, 2024

aarshkshah1992 Aug 7, 2024

aarshkshah1992 Aug 7, 2024

akaladarshi commented Aug 8, 2024

feat(tx_index): fill transaction index gap on enabling automatic backfill #12353

Are you sure you want to change the base?

feat(tx_index): fill transaction index gap on enabling automatic backfill #12353

Conversation

akaladarshi commented Aug 7, 2024 • edited Loading

Related Issues

Proposed Changes

akaladarshi commented Aug 7, 2024

aarshkshah1992 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akaladarshi commented Aug 8, 2024

akaladarshi commented Aug 7, 2024 •

edited

Loading