feat: check runtime vs database db

[joanestebanr]

Description

• Each database have a new key/value table (key_value)
• The system, at startup, checks that each database is compatible with this run. To achieve this:
  • It checks previous data from key/value table, if it's empty it stores the revelant data to database (in case of syncer is chainID plus the addresses, in case of aggsender is networkID)
  • If the database data and runtime are compatible (is checked with function IsCompatible(storage T) error can run, if not it's a fail (you can override that setting config variable RequireStorageContentCompatibility to false)
• The evmdriver for syncer check that the runtime environment match what is stored on DB:
• Aggsender use the networkID

Config changes

• There are a new param RequireStorageContentCompatibility (by default is true) as global var that is injected in: BridgeL1Sync, BridgeL2Sync, LastGERSync, AggSender:

[BridgeL1Sync]
RequireStorageContentCompatibility = {{RequireStorageContentCompatibility}}

[BridgeL2Sync]
RequireStorageContentCompatibility = {{RequireStorageContentCompatibility}}

[LastGERSync]
RequireStorageContentCompatibility = {{RequireStorageContentCompatibility}}

[AggSender]
RequireStorageContentCompatibility = {{RequireStorageContentCompatibility}}

Fixes #165

Review comments:

• The interface Logger have been moved from aggsender/types to common packages because it's required by multiples modules
• The integration of this feature in syncer is:
• The compatibility data is sync.RuntimeData:

type RuntimeData struct {
	ChainID   uint64
	Addresses []common.Address
}

• sync.EVMDriver have a new fields compatibilityChecker compatibility.CompatibilityChecker that implements the logic of this feature
• The current (runtime) data is provided by sync.downloader interface using GetRuntimeData
• The stored data is provided by sync.processorInterface implementing interface compatibility.CompatibilityDataStorager[RuntimeData]: There are a helper objects to allow provide this funcionality directly: that is compatibility.NewKeyValueToCompatibilityStorage[T]

The objects in compatibility module:

---
title: CompatibilityCheck class diagram
---
classDiagram
   
    CompatibilityCheck <|-- RuntimeDataGetter
    CompatibilityCheck <|-- CompatibilityDataStorager
    
    class CompatibilityCheck{
        +Check(ctx context.Context, tx db.Querier)
    }
    class CompatibilityDataStorager{
        + GetCompatibilityData(ctx context.Context, tx db.Querier) (bool, T, error)
        + SetCompatibilityData(ctx context.Context, tx db.Querier, data T) error
    }

    class RuntimeDataGetter{
        + func(ctx context.Context) (T, error)
    }

Loading

To implement CompatibilityDataStorager you can use:

PR Checklist:

• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added or updated tests that comprehensively prove my change is effective or that my feature works

[rachit77]

LGTM

[Stefan-Ethernal]

Why don't we move this to the constructor function (NewCompatibilityCheck)?

[joanestebanr]

I prefer a lazy initialization: if I create the object but I don't use it doesn't produce any error, but if you try to use it you need to fullfil the parameters.

I case that your question if over populating s.Logger. It's for the same reason, if I don't need Logger I don't need to populate until I'm going to use it, also, in the first version, not setting the Logger variable was an error

WDTY?

[Stefan-Ethernal]

WDYT, in order to be semantically more correct?

Suggested change

	func (s *CompatibilityCheck[T]) initialize() error {
	func (s *CompatibilityCheck[T]) validate() error {

[joanestebanr]

In fact it's doing both things: the field Logger is initialized and the rest checked... I don't mind if you prefer validate for me it's ok. WDYT?

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
84.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud