feat(cannon): Add backfill config (#398)

* feat(cannon): Add backfill config * chore: linting * chore: linting * chore: Add docker logs for failed assertion, disable beaconBlobSidecar * refactor: Update log field with additional parameters * fix: Update docker logs command to tail 150 lines * fix: Update docker logs command to include stderr output * fix: Increase the tail length for docker logs to 1000 * feat: Add logging for derived finalized epoch * fix: Update docker logs command to show recent logs * chore: Update debug logs in checkpoint iterator * fix: Update block_total_bytes and block_total_bytes_compressed * chore: comment out unused tmate session setup block
ethpandaops · Oct 15, 2024 · 9c3031d · 9c3031d
1 parent 2c1b572
commit 9c3031d
Show file tree

Hide file tree

Showing 19 changed files with 188 additions and 45 deletions.
diff --git a/.github/cannon/assert_clickhouse.sh b/.github/cannon/assert_clickhouse.sh
@@ -53,6 +53,7 @@ yq e '.networks[].types[] | [.name, .assert.query, .assert.expected] | @tsv' "$S
                     break
                 else
                     echo "Assertion failed for $name. Expected: $expected, Got: $result"
+                    docker logs xatu-cannon 2>&1 | grep -i "$name " | tail -n 10 || docker logs xatu-cannon --tail 10
                     sleep 2
                     continue
                 fi

diff --git a/.github/cannon/seeding.yaml b/.github/cannon/seeding.yaml
@@ -114,8 +114,8 @@ networks:
             AND epoch_start_date_time = '2024-08-09 02:24:00'
             AND block_root = '0xff8e97fdf4033e499681ff0eb056cf5f2877a8f9b16f14e2db3956b75190b9e7'
             AND block_version = 'deneb'
-            AND block_total_bytes = 204103
-            AND block_total_bytes_compressed = 95454
+            AND block_total_bytes = 94749
+            AND block_total_bytes_compressed = 55636
             AND parent_root = '0x54264e13e97a137bed2cc1a52cf76a94bb5e385507d34ff3902d18672f4ef79e'
             AND state_root = '0x3598ed522160cb6dd0aab216f03b26d61b32d87854c3d38754897017a66004f5'
             AND proposer_index = 416934

diff --git a/.github/workflows/cannon-smoke-test.yaml b/.github/workflows/cannon-smoke-test.yaml
@@ -75,6 +75,7 @@ jobs:
     - name: Create Xatu Cannon config
       run: |
         cat <<EOF > /tmp/cannon_config.yaml
+        logging: debug
         name: cannon-smoke-test
         labels:
           ethpandaops: rocks
@@ -97,7 +98,7 @@ jobs:
           beaconBlock:
             enabled: true
           beaconBlobSidecar:
-            enabled: true
+            enabled: false
           proposerDuty:
             enabled: true
           beaconCommittee:

diff --git a/pkg/cannon/cannon.go b/pkg/cannon/cannon.go
@@ -364,6 +364,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.AttesterSlashingConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -382,6 +383,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.ProposerSlashingConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -400,6 +402,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.VoluntaryExitConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -418,6 +421,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.DepositConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -436,6 +440,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.BLSToExecutionConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -454,6 +459,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.ExecutionTransactionConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -472,6 +478,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.WithdrawalConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -490,6 +497,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.BeaconBlockConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -524,6 +532,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.BeaconBlobSidecarConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -542,6 +551,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.ProposerDutyConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -560,6 +570,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					3,
+					&c.Config.Derivers.ElaboratedAttestationConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -578,6 +589,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					2,
+					&c.Config.Derivers.BeaconValidatorsConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -596,6 +608,7 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 					c.beacon,
 					finalizedCheckpoint,
 					2,
+					&c.Config.Derivers.BeaconCommitteeConfig.Iterator,
 				),
 				c.beacon,
 				clientMeta,
@@ -621,7 +634,9 @@ func (c *Cannon) startBeaconBlockProcessor(ctx context.Context) error {
 
 			go func() {
 				if err := c.startDeriverWhenReady(ctx, d); err != nil {
-					c.log.WithError(err).Error("Failed to start deriver")
+					c.log.
+						WithField("deriver", d.Name()).
+						WithError(err).Fatal("Failed to start deriver")
 				}
 			}()
 		}

diff --git a/pkg/cannon/deriver/beacon/eth/v1/beacon_blob.go b/pkg/cannon/deriver/beacon/eth/v1/beacon_blob.go
@@ -31,7 +31,8 @@ const (
 )
 
 type BeaconBlobDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type BeaconBlobDeriver struct {
@@ -45,7 +46,10 @@ type BeaconBlobDeriver struct {
 
 func NewBeaconBlobDeriver(log logrus.FieldLogger, config *BeaconBlobDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *BeaconBlobDeriver {
 	return &BeaconBlobDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v1/beacon_blob"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v1/beacon_blob",
+			"type":   BeaconBlobDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v1/beacon_committee.go b/pkg/cannon/deriver/beacon/eth/v1/beacon_committee.go
@@ -29,7 +29,8 @@ const (
 )
 
 type BeaconCommitteeDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type BeaconCommitteeDeriver struct {
@@ -43,7 +44,10 @@ type BeaconCommitteeDeriver struct {
 
 func NewBeaconCommitteeDeriver(log logrus.FieldLogger, config *BeaconCommitteeDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *BeaconCommitteeDeriver {
 	return &BeaconCommitteeDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v1/beacon_committee"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v1/beacon_committee",
+			"type":   BeaconCommitteeDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v1/beacon_validators.go b/pkg/cannon/deriver/beacon/eth/v1/beacon_validators.go
@@ -29,8 +29,9 @@ const (
 )
 
 type BeaconValidatorsDeriverConfig struct {
-	Enabled   bool `yaml:"enabled" default:"true"`
-	ChunkSize int  `yaml:"chunkSize" default:"100"`
+	Enabled   bool                                 `yaml:"enabled" default:"true"`
+	ChunkSize int                                  `yaml:"chunkSize" default:"100"`
+	Iterator  iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type BeaconValidatorsDeriver struct {
@@ -44,7 +45,10 @@ type BeaconValidatorsDeriver struct {
 
 func NewBeaconValidatorsDeriver(log logrus.FieldLogger, config *BeaconValidatorsDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *BeaconValidatorsDeriver {
 	return &BeaconValidatorsDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v1/validators"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v1/validators",
+			"type":   BeaconValidatorsDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v1/proposer_duty.go b/pkg/cannon/deriver/beacon/eth/v1/proposer_duty.go
@@ -30,7 +30,8 @@ const (
 )
 
 type ProposerDutyDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type ProposerDutyDeriver struct {
@@ -44,7 +45,10 @@ type ProposerDutyDeriver struct {
 
 func NewProposerDutyDeriver(log logrus.FieldLogger, config *ProposerDutyDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *ProposerDutyDeriver {
 	return &ProposerDutyDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v1/proposer_duty"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v1/proposer_duty",
+			"type":   ProposerDutyDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v2/attester_slashing.go b/pkg/cannon/deriver/beacon/eth/v2/attester_slashing.go
@@ -28,7 +28,8 @@ const (
 )
 
 type AttesterSlashingDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type AttesterSlashingDeriver struct {
@@ -42,7 +43,10 @@ type AttesterSlashingDeriver struct {
 
 func NewAttesterSlashingDeriver(log logrus.FieldLogger, config *AttesterSlashingDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *AttesterSlashingDeriver {
 	return &AttesterSlashingDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v2/attester_slashing"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v2/attester_slashing",
+			"type":   AttesterSlashingDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v2/beacon_block.go b/pkg/cannon/deriver/beacon/eth/v2/beacon_block.go
@@ -32,7 +32,8 @@ const (
 )
 
 type BeaconBlockDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type BeaconBlockDeriver struct {
@@ -46,7 +47,10 @@ type BeaconBlockDeriver struct {
 
 func NewBeaconBlockDeriver(log logrus.FieldLogger, config *BeaconBlockDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *BeaconBlockDeriver {
 	return &BeaconBlockDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v2/beacon_block"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v2/beacon_block",
+			"type":   BeaconBlockDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v2/bls_to_execution_change.go b/pkg/cannon/deriver/beacon/eth/v2/bls_to_execution_change.go
@@ -30,7 +30,8 @@ const (
 )
 
 type BLSToExecutionChangeDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type BLSToExecutionChangeDeriver struct {
@@ -44,7 +45,10 @@ type BLSToExecutionChangeDeriver struct {
 
 func NewBLSToExecutionChangeDeriver(log logrus.FieldLogger, config *BLSToExecutionChangeDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *BLSToExecutionChangeDeriver {
 	return &BLSToExecutionChangeDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v2/bls_to_execution_change"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v2/bls_to_execution_change",
+			"type":   BLSToExecutionChangeDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v2/deposit.go b/pkg/cannon/deriver/beacon/eth/v2/deposit.go
@@ -28,7 +28,8 @@ const (
 )
 
 type DepositDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type DepositDeriver struct {
@@ -42,7 +43,10 @@ type DepositDeriver struct {
 
 func NewDepositDeriver(log logrus.FieldLogger, config *DepositDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *DepositDeriver {
 	return &DepositDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v2/deposit"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v2/deposit",
+			"type":   DepositDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v2/elaborated_attestation.go b/pkg/cannon/deriver/beacon/eth/v2/elaborated_attestation.go
@@ -29,7 +29,8 @@ const (
 )
 
 type ElaboratedAttestationDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type ElaboratedAttestationDeriver struct {
@@ -43,7 +44,10 @@ type ElaboratedAttestationDeriver struct {
 
 func NewElaboratedAttestationDeriver(log logrus.FieldLogger, config *ElaboratedAttestationDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *ElaboratedAttestationDeriver {
 	return &ElaboratedAttestationDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v2/elaborated_attestation"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v2/elaborated_attestation",
+			"type":   ElaboratedAttestationDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v2/execution_transaction.go b/pkg/cannon/deriver/beacon/eth/v2/execution_transaction.go
@@ -38,7 +38,8 @@ type ExecutionTransactionDeriver struct {
 }
 
 type ExecutionTransactionDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 const (
@@ -47,7 +48,10 @@ const (
 
 func NewExecutionTransactionDeriver(log logrus.FieldLogger, config *ExecutionTransactionDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *ExecutionTransactionDeriver {
 	return &ExecutionTransactionDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v2/execution_transaction"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v2/execution_transaction",
+			"type":   ExecutionTransactionDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,

diff --git a/pkg/cannon/deriver/beacon/eth/v2/proposer_slashing.go b/pkg/cannon/deriver/beacon/eth/v2/proposer_slashing.go
@@ -28,7 +28,8 @@ const (
 )
 
 type ProposerSlashingDeriverConfig struct {
-	Enabled bool `yaml:"enabled" default:"true"`
+	Enabled  bool                                 `yaml:"enabled" default:"true"`
+	Iterator iterator.BackfillingCheckpointConfig `yaml:"iterator"`
 }
 
 type ProposerSlashingDeriver struct {
@@ -42,7 +43,10 @@ type ProposerSlashingDeriver struct {
 
 func NewProposerSlashingDeriver(log logrus.FieldLogger, config *ProposerSlashingDeriverConfig, iter *iterator.BackfillingCheckpoint, beacon *ethereum.BeaconNode, clientMeta *xatu.ClientMeta) *ProposerSlashingDeriver {
 	return &ProposerSlashingDeriver{
-		log:        log.WithField("module", "cannon/event/beacon/eth/v2/proposer_slashing"),
+		log: log.WithFields(logrus.Fields{
+			"module": "cannon/event/beacon/eth/v2/proposer_slashing",
+			"type":   ProposerSlashingDeriverName.String(),
+		}),
 		cfg:        config,
 		iterator:   iter,
 		beacon:     beacon,
-Original file line number
+Diff line change
@@ Expand Up @@
                         break
                     else
                         echo "Assertion failed for $name. Expected: $expected, Got: $result"
+                        docker logs xatu-cannon 2>&1 | grep -i "$name " | tail -n 10 || docker logs xatu-cannon --tail 10
                         sleep 2
                         continue
                     fi
@@ Expand Down @@