Blocks backfilling option - 0 Empty implementations

go.mod

@@ -11,7 +11,7 @@ require (
 	github.com/DataDog/zstd v1.5.2
 	github.com/Microsoft/go-winio v0.5.2
 	github.com/NYTimes/gziphandler v1.1.1
-	github.com/ava-labs/coreth v0.12.10-rc.2
+	github.com/ava-labs/coreth v0.12.9-rc.9.0.20240102092814-d949adb6f925
 	github.com/ava-labs/ledger-avalanche/go v0.0.0-20231102202641-ae2ebdaeac34
 	github.com/btcsuite/btcd/btcutil v1.1.3
 	github.com/cockroachdb/pebble v0.0.0-20230209160836-829675f94811

go.sum

@@ -66,8 +66,8 @@ github.com/allegro/bigcache v1.2.1-0.20190218064605-e24eb225f156 h1:eMwmnE/GDgah
 github.com/allegro/bigcache v1.2.1-0.20190218064605-e24eb225f156/go.mod h1:Cb/ax3seSYIx7SuZdm2G2xzfwmv3TPSk2ucNfQESPXM=
 github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY=
 github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
-github.com/ava-labs/coreth v0.12.10-rc.2 h1:+2YK7PzStcLCHtsBb1VQjw6DyMl1sMZatReZAyIy7w8=
-github.com/ava-labs/coreth v0.12.10-rc.2/go.mod h1:RIbv14KMyWSj4hB1danS+vEPCUsgArZUEo99SaP5nW8=
+github.com/ava-labs/coreth v0.12.9-rc.9.0.20240102092814-d949adb6f925 h1:KOHtYLQe1bOZiUKyiSDazLL02mYZgvzzwnDt3Hv0VA0=
+github.com/ava-labs/coreth v0.12.9-rc.9.0.20240102092814-d949adb6f925/go.mod h1:T12n5GJrWOdzveIVyou/Xe7Dqlutd9fzGZne1wpHEYA=
 github.com/ava-labs/ledger-avalanche/go v0.0.0-20231102202641-ae2ebdaeac34 h1:mg9Uw6oZFJKytJxgxnl3uxZOs/SB8CVHg6Io4Tf99Zc=
 github.com/ava-labs/ledger-avalanche/go v0.0.0-20231102202641-ae2ebdaeac34/go.mod h1:pJxaT9bUgeRNVmNRgtCHb7sFDIRKy7CzTQVi8gGNT6g=
 github.com/aymerick/raymond v2.0.3-0.20180322193309-b565731e1464+incompatible/go.mod h1:osfaiScAUVup+UC9Nfq76eWqDhXlp+4UYaA8uhTBO6g=

proto/vm/vm.proto

@@ -80,6 +80,11 @@ service VM {
   // [summaryHeight].
   rpc GetStateSummary(GetStateSummaryRequest) returns (GetStateSummaryResponse);
 
+  // BackfillBlocksEnabled indicates whether the block backfilling is enabled for this VM.
+  rpc BackfillBlocksEnabled(google.protobuf.Empty) returns (BackfillBlocksEnabledResponse);
+  // BackfillBlocks pushes to the VM downloaded blocks to be backfilled.
+  rpc BackfillBlocks(BackfillBlocksRequest) returns (BackfillBlocksResponse);
+
   // Block
   rpc BlockVerify(BlockVerifyRequest) returns (BlockVerifyResponse);
   rpc BlockAccept(BlockAcceptRequest) returns (google.protobuf.Empty);
@@ -110,6 +115,8 @@ enum Error {
   ERROR_NOT_FOUND = 2;
   ERROR_HEIGHT_INDEX_INCOMPLETE = 3;
   ERROR_STATE_SYNC_NOT_IMPLEMENTED = 4;
+  ERROR_STATE_SYNC_BLOCK_BACKFILLING_NOT_ENABLED = 5;
+  ERROR_STATE_SYNC_STOP_BLOCK_BACKFILLING = 6;
 }
 
 message InitializeRequest {
@@ -401,6 +408,22 @@ message GetStateSummaryResponse {
   Error err = 3;
 }
 
+message BackfillBlocksEnabledResponse {
+  bytes id = 1;
+  uint64 height = 2;
+  Error err = 3;
+}
+
+message BackfillBlocksRequest {
+  repeated bytes blks_bytes = 1;
+}
+
+message BackfillBlocksResponse {
+  bytes id = 1;
+  uint64 height = 2;
+  Error err = 3;
+}
+
 message StateSummaryAcceptRequest {
   bytes bytes = 1;
 }

snow/engine/snowman/block/state_syncable_vm.go

@@ -6,9 +6,16 @@ package block
 import (
 	"context"
 	"errors"
+
+	"github.com/ava-labs/avalanchego/ids"
 )
 
-var ErrStateSyncableVMNotImplemented = errors.New("vm does not implement StateSyncableVM interface")
+var (
+	ErrStateSyncableVMNotImplemented = errors.New("vm does not implement StateSyncableVM interface")
+	ErrBlockBackfillingNotEnabled    = errors.New("vm does not require block backfilling")
+	ErrStopBlockBackfilling          = errors.New("vm required stopping block backfilling")
+	ErrInternalBlockBackfilling      = errors.New("block backfilling internal error")
+)
 
 // StateSyncableVM contains the functionality to allow VMs to sync to a given
 // state, rather then boostrapping from genesis.
@@ -42,4 +49,22 @@ type StateSyncableVM interface {
 	// Returns database.ErrNotFound if no summary is available at
 	// [summaryHeight].
 	GetStateSummary(ctx context.Context, summaryHeight uint64) (StateSummary, error)
+
+	// BackfillBlocksEnabled checks if VM wants to download all blocks from state summary one
+	// down to genesis.
+	//
+	// Returns the ID and height of the block it wants to start backfilling from.
+	// Returns ErrBlockBackfillingNotEnabled if block backfilling is not enabled.
+	// BackfillBlocksEnabled can be called multiple times by the engine
+	BackfillBlocksEnabled(ctx context.Context) (ids.ID, uint64, error)
+
+	// BackfillBlocks passes blocks bytes retrieved via GetAncestors calls to the VM
+	// It's left to the VM the to parse, validate and index the blocks.
+	// BackfillBlocks returns the next block ID to be requested and an error
+	// Returns the ID and height of the block it wants to start backfilling from.
+	// Returns [ErrStopBlockBackfilling] if VM has done backfilling; engine will stop requesting blocks.
+	// Returns [ErrInternalBlockBackfilling] if VM has erred in a way that should make block backfilling fail.
+	// If BackfillBlocks returns any other error, engine will issue a GetAncestor call to a different peer
+	// with the previously requested block ID
+	BackfillBlocks(ctx context.Context, blocks [][]byte) (ids.ID, uint64, error)
 }

snow/engine/snowman/block/test_state_syncable_vm.go

@@ -9,6 +9,8 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
+
+	"github.com/ava-labs/avalanchego/ids"
 )
 
 var (
@@ -19,6 +21,8 @@ var (
 	errGetLastStateSummary        = errors.New("unexpectedly called GetLastStateSummary")
 	errParseStateSummary          = errors.New("unexpectedly called ParseStateSummary")
 	errGetStateSummary            = errors.New("unexpectedly called GetStateSummary")
+	errBackfillBlocksEnabled      = errors.New("unexpectedly called BackfillBlocksEnabled")
+	errBackfillBlock              = errors.New("unexpectedly called BackfillBlock")
 )
 
 type TestStateSyncableVM struct {
@@ -35,6 +39,9 @@ type TestStateSyncableVM struct {
 	GetLastStateSummaryF        func(context.Context) (StateSummary, error)
 	ParseStateSummaryF          func(ctx context.Context, summaryBytes []byte) (StateSummary, error)
 	GetStateSummaryF            func(ctx context.Context, summaryHeight uint64) (StateSummary, error)
+
+	BackfillBlocksEnabledF func(context.Context) (ids.ID, uint64, error)
+	BackfillBlocksF        func(context.Context, [][]byte) (ids.ID, uint64, error)
 }
 
 func (vm *TestStateSyncableVM) StateSyncEnabled(ctx context.Context) (bool, error) {
@@ -86,3 +93,23 @@ func (vm *TestStateSyncableVM) GetStateSummary(ctx context.Context, summaryHeigh
 	}
 	return nil, errGetStateSummary
 }
+
+func (vm *TestStateSyncableVM) BackfillBlocksEnabled(ctx context.Context) (ids.ID, uint64, error) {
+	if vm.BackfillBlocksEnabledF != nil {
+		return vm.BackfillBlocksEnabledF(ctx)
+	}
+	if vm.CantGetStateSummary && vm.T != nil {
+		require.FailNow(vm.T, errGetStateSummary.Error())
+	}
+	return ids.Empty, 0, errBackfillBlocksEnabled
+}
+
+func (vm *TestStateSyncableVM) BackfillBlocks(ctx context.Context, blocks [][]byte) (ids.ID, uint64, error) {
+	if vm.BackfillBlocksF != nil {
+		return vm.BackfillBlocksF(ctx, blocks)
+	}
+	if vm.CantGetStateSummary && vm.T != nil {
+		require.FailNow(vm.T, errGetStateSummary.Error())
+	}
+	return ids.Empty, 0, errBackfillBlock
+}

vms/metervm/block_metrics.go

@@ -43,7 +43,9 @@ type blockMetrics struct {
 	parseStateSummary,
 	parseStateSummaryErr,
 	getStateSummary,
-	getStateSummaryErr metric.Averager
+	getStateSummaryErr,
+	backfillBlocksEnabled,
+	backfillBlocks metric.Averager
 }
 
 func (m *blockMetrics) Initialize(
@@ -88,6 +90,8 @@ func (m *blockMetrics) Initialize(
 		m.parseStateSummaryErr = newAverager(namespace, "parse_state_summary_err", reg, &errs)
 		m.getStateSummary = newAverager(namespace, "get_state_summary", reg, &errs)
 		m.getStateSummaryErr = newAverager(namespace, "get_state_summary_err", reg, &errs)
+		m.backfillBlocksEnabled = newAverager(namespace, "backfill_blocks_enabled", reg, &errs)
+		m.backfillBlocks = newAverager(namespace, "backfill_blocks", reg, &errs)
 	}
 	return errs.Err
 }

vms/metervm/state_syncable_vm.go

@@ -6,6 +6,7 @@ package metervm
 import (
 	"context"
 
+	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/snow/engine/snowman/block"
 )
 
@@ -78,3 +79,37 @@ func (vm *blockVM) GetStateSummary(ctx context.Context, height uint64) (block.St
 	vm.blockMetrics.getStateSummary.Observe(duration)
 	return summary, nil
 }
+
+func (vm *blockVM) BackfillBlocksEnabled(ctx context.Context) (ids.ID, uint64, error) {
+	if vm.ssVM == nil {
+		return ids.Empty, 0, block.ErrStateSyncableVMNotImplemented
+	}
+
+	start := vm.clock.Time()
+	blkID, blkHeight, err := vm.ssVM.BackfillBlocksEnabled(ctx)
+	end := vm.clock.Time()
+	duration := float64(end.Sub(start))
+	if err != nil {
+		vm.blockMetrics.backfillBlocksEnabled.Observe(duration)
+		return ids.Empty, blkHeight, err
+	}
+	vm.blockMetrics.backfillBlocksEnabled.Observe(duration)
+	return blkID, blkHeight, nil
+}
+
+func (vm *blockVM) BackfillBlocks(ctx context.Context, blocks [][]byte) (ids.ID, uint64, error) {
+	if vm.ssVM == nil {
+		return ids.Empty, 0, block.ErrStateSyncableVMNotImplemented
+	}
+
+	start := vm.clock.Time()
+	nextWantedBlkID, nextWantedBlkHeight, err := vm.ssVM.BackfillBlocks(ctx, blocks)
+	end := vm.clock.Time()
+	duration := float64(end.Sub(start))
+	if err != nil {
+		vm.blockMetrics.backfillBlocks.Observe(duration)
+		return nextWantedBlkID, nextWantedBlkHeight, err
+	}
+	vm.blockMetrics.backfillBlocks.Observe(duration)
+	return nextWantedBlkID, nextWantedBlkHeight, nil
+}