Make checkpointing chainstore optional via build constraints

Author: masih

build/buildconstants/params_2k.go

@@ -200,3 +200,7 @@ var F3Enabled = true
 const ManifestServerID = "12D3KooWHcNBkqXEBrsjoveQvj6zDF3vK5S9tAfqyYaQF1LGSJwG"
 
 var F3BootstrapEpoch abi.ChainEpoch = 1000
+
+// F3Consensus set whether F3 should checkpoint tipsets finalized by F3. This
+// flag has no effect if F3 is not enabled.
+const F3Consensus = true

build/buildconstants/params_butterfly.go

@@ -101,3 +101,7 @@ var WhitelistedBlock = cid.Undef
 const F3Enabled = true
 const ManifestServerID = "12D3KooWJr9jy4ngtJNR7JC1xgLFra3DjEtyxskRYWvBK9TC3Yn6"
 const F3BootstrapEpoch abi.ChainEpoch = 1000
+
+// F3Consensus set whether F3 should checkpoint tipsets finalized by F3. This
+// flag has no effect if F3 is not enabled.
+const F3Consensus = true

build/buildconstants/params_calibnet.go

@@ -148,3 +148,7 @@ var WhitelistedBlock = cid.Undef
 const F3Enabled = true
 const ManifestServerID = "12D3KooWS9vD9uwm8u2uPyJV32QBAhKAmPYwmziAgr3Xzk2FU1Mr"
 const F3BootstrapEpoch abi.ChainEpoch = UpgradeWaffleHeight + 100
+
+// F3Consensus set whether F3 should checkpoint tipsets finalized by F3. This
+// flag has no effect if F3 is not enabled.
+const F3Consensus = true

build/buildconstants/params_interop.go

@@ -139,3 +139,7 @@ var WhitelistedBlock = cid.Undef
 const F3Enabled = true
 const ManifestServerID = "12D3KooWQJ2rdVnG4okDUB6yHQhAjNutGNemcM7XzqC9Eo4z9Jce"
 const F3BootstrapEpoch abi.ChainEpoch = 1000
+
+// F3Consensus set whether F3 should checkpoint tipsets finalized by F3. This
+// flag has no effect if F3 is not enabled.
+const F3Consensus = true

build/buildconstants/params_mainnet.go

@@ -173,3 +173,7 @@ var WhitelistedBlock = cid.MustParse("bafy2bzaceapyg2uyzk7vueh3xccxkuwbz3nxewjyg
 const F3Enabled = true
 const ManifestServerID = "12D3KooWENMwUF9YxvQxar7uBWJtZkA6amvK4xWmKXfSiHUo2Qq7"
 const F3BootstrapEpoch abi.ChainEpoch = -1
+
+// F3Consensus set whether F3 should checkpoint tipsets finalized by F3. This
+// flag has no effect if F3 is not enabled.
+const F3Consensus = false

build/buildconstants/params_testground.go

@@ -126,6 +126,10 @@ var (
 	F3Enabled                        = false
 	ManifestServerID                 = ""
 	F3BootstrapEpoch  abi.ChainEpoch = -1
+
+	// F3Consensus set whether F3 should checkpoint tipsets finalized by F3. This
+	// flag has no effect if F3 is not enabled.
+	F3Consensus = true
 )
 
 func init() {

chain/lf3/ec.go

@@ -30,6 +30,9 @@ type ecWrapper struct {
 	ChainStore   *store.ChainStore
 	Syncer       *chain.Syncer
 	StateManager *stmgr.StateManager
+
+	// Checkpoint sets whether to checkpoint tipsets finalized by F3 in ChainStore.
+	Checkpoint bool
 }
 
 type f3TipSet struct {
@@ -209,6 +212,9 @@ func (ec *ecWrapper) getPowerTableLotusTSK(ctx context.Context, tsk types.TipSet
 }
 
 func (ec *ecWrapper) Finalize(ctx context.Context, key gpbft.TipSetKey) error {
+	if !ec.Checkpoint {
+		return nil // Nothing to do; checkpointing is not enabled.
+	}
 	tsk, err := toLotusTipSetKey(key)
 	if err != nil {
 		return err
@@ -242,9 +248,5 @@ func (ec *ecWrapper) getTipSetFromF3TSK(ctx context.Context, key gpbft.TipSetKey
 }
 
 func toLotusTipSetKey(key gpbft.TipSetKey) (types.TipSetKey, error) {
-	tsk, err := types.TipSetKeyFromBytes(key)
-	if err != nil {
-		return types.TipSetKey{}, xerrors.Errorf("decoding tpiset key: %w", err)
-	}
-	return tsk, nil
+	return types.TipSetKeyFromBytes(key)
 }

chain/lf3/f3.go

@@ -36,18 +36,21 @@ type F3 struct {
 	newLeases chan leaseRequest
 }
 
+type F3ConsensusEnabled bool
+
 type F3Params struct {
 	fx.In
 
-	NetworkName      dtypes.NetworkName
-	ManifestProvider manifest.ManifestProvider
-	PubSub           *pubsub.PubSub
-	Host             host.Host
-	ChainStore       *store.ChainStore
-	Syncer           *chain.Syncer
-	StateManager     *stmgr.StateManager
-	Datastore        dtypes.MetadataDS
-	Wallet           api.Wallet
+	NetworkName        dtypes.NetworkName
+	ManifestProvider   manifest.ManifestProvider
+	PubSub             *pubsub.PubSub
+	Host               host.Host
+	ChainStore         *store.ChainStore
+	Syncer             *chain.Syncer
+	StateManager       *stmgr.StateManager
+	Datastore          dtypes.MetadataDS
+	Wallet             api.Wallet
+	F3ConsensusEnabled F3ConsensusEnabled
 }
 
 var log = logging.Logger("f3")
@@ -59,6 +62,7 @@ func New(mctx helpers.MetricsCtx, lc fx.Lifecycle, params F3Params) (*F3, error)
 		ChainStore:   params.ChainStore,
 		StateManager: params.StateManager,
 		Syncer:       params.Syncer,
+		Checkpoint:   bool(params.F3ConsensusEnabled),
 	}
 	verif := blssig.VerifierWithKeyOnG1()
 

chain/types/tipset_key.go

@@ -10,6 +10,7 @@ import (
 	block "github.com/ipfs/go-block-format"
 	"github.com/ipfs/go-cid"
 	typegen "github.com/whyrusleeping/cbor-gen"
+	"golang.org/x/xerrors"
 
 	"github.com/filecoin-project/go-state-types/abi"
 )
@@ -52,7 +53,7 @@ func NewTipSetKey(cids ...cid.Cid) TipSetKey {
 func TipSetKeyFromBytes(encoded []byte) (TipSetKey, error) {
 	_, err := decodeKey(encoded)
 	if err != nil {
-		return EmptyTSK, err
+		return EmptyTSK, xerrors.Errorf("decoding tpiset key: %w", err)
 	}
 	return TipSetKey{string(encoded)}, nil
 }

node/builder_chain.go

@@ -13,6 +13,7 @@ import (
 
 	"github.com/filecoin-project/lotus/api"
 	"github.com/filecoin-project/lotus/build"
+	"github.com/filecoin-project/lotus/build/buildconstants"
 	"github.com/filecoin-project/lotus/chain"
 	"github.com/filecoin-project/lotus/chain/beacon"
 	"github.com/filecoin-project/lotus/chain/consensus"
@@ -164,6 +165,7 @@ var ChainNode = Options(
 	),
 
 	If(build.IsF3Enabled(),
+		Override(new(*lf3.F3ConsensusEnabled), buildconstants.F3Consensus),
 		Override(new(manifest.ManifestProvider), lf3.NewManifestProvider),
 		Override(new(*lf3.F3), lf3.New),
 	),