Better input type for chain prune

api/api_full.go

@@ -171,7 +171,7 @@ type FullNode interface {
 
 	// ChainPrune prunes the stored chain state and garbage collects; only supported if you
 	// are using the splitstore
-	ChainPrune(ctx context.Context, opts map[string]interface{}) error //perm:admin
+	ChainPrune(ctx context.Context, opts PruneOpts) error //perm:admin
 
 	// ChainCheckBlockstore performs an (asynchronous) health check on the chain/state blockstore
 	// if supported by the underlying implementation.
@@ -1223,3 +1223,8 @@ type MsigTransaction struct {
 
 	Approved []address.Address
 }
+
+type PruneOpts struct {
+	MovingGC    bool
+	RetainState int64
+}

blockstore/splitstore/splitstore_prune.go

@@ -14,6 +14,7 @@ import (
 	"go.opencensus.io/stats"
 	"golang.org/x/xerrors"
 
+	"github.com/filecoin-project/lotus/api"
 	bstore "github.com/filecoin-project/lotus/blockstore"
 	"github.com/filecoin-project/lotus/build"
 	"github.com/filecoin-project/lotus/chain/types"
@@ -44,40 +45,11 @@ var (
 
 // PruneChain instructs the SplitStore to prune chain state in the coldstore, according to the
 // options specified.
-func (s *SplitStore) PruneChain(opts map[string]interface{}) error {
-	// options
-	var onlineGC, movingGC bool
-	var retainState int64 = -1
-
-	for k, v := range opts {
-		switch k {
-		case PruneOnlineGC:
-			onlineGC = true
-		case PruneRetainState:
-			retaini64, ok := v.(int64)
-			if !ok {
-				// deal with json-rpc types...
-				retainf64, ok := v.(float64)
-				if !ok {
-					return xerrors.Errorf("bad state retention specification; expected int64 or float64 but got %T", v)
-				}
-				retainState = int64(retainf64)
-			} else {
-				retainState = retaini64
-			}
-		default:
-			return xerrors.Errorf("unrecognized option %s", k)
-		}
-	}
+func (s *SplitStore) PruneChain(opts api.PruneOpts) error {
+	retainState := opts.RetainState
 
-	if onlineGC && movingGC {
-		return xerrors.Errorf("at most one of online, moving GC can be specified")
-	}
-	if !onlineGC && !movingGC {
-		onlineGC = true
-	}
 	var gcOpts []bstore.BlockstoreGCOption
-	if movingGC {
+	if opts.MovingGC {
 		gcOpts = append(gcOpts, bstore.WithFullGC(true))
 	}
 	doGC := func() error { return s.gcBlockstore(s.cold, gcOpts) }

cli/chain.go

@@ -35,7 +35,6 @@ import (
 	"github.com/filecoin-project/lotus/api"
 	lapi "github.com/filecoin-project/lotus/api"
 	"github.com/filecoin-project/lotus/api/v0api"
-	"github.com/filecoin-project/lotus/blockstore/splitstore"
 	"github.com/filecoin-project/lotus/build"
 	"github.com/filecoin-project/lotus/chain/actors"
 	"github.com/filecoin-project/lotus/chain/consensus/filcns"
@@ -1497,14 +1496,14 @@ var ChainPruneCmd = &cli.Command{
 		defer closer()
 		ctx := ReqContext(cctx)
 
-		opts := make(map[string]interface{})
+		opts := lapi.PruneOpts{}
 		if cctx.Bool("online-gc") {
-			opts[splitstore.PruneOnlineGC] = true
+			opts.MovingGC = false
 		}
 		if cctx.Bool("moving-gc") {
-			opts[splitstore.PruneMovingGC] = cctx.String("move-to")
+			opts.MovingGC = true
 		}
-		opts[splitstore.PruneRetainState] = int64(cctx.Int("retention"))
+		opts.RetainState = int64(cctx.Int("retention"))
 
 		return api.ChainPrune(ctx, opts)
 	},

documentation/en/api-v1-unstable-methods.md

@@ -974,7 +974,8 @@ Inputs:
 ```json
 [
   {
-    "abc": 123
+    "MovingGC": true,
+    "RetainState": 9
   }
 ]
 ```

itests/splitstore_test.go

@@ -161,8 +161,7 @@ func TestColdStorePrune(t *testing.T) {
 			break
 		}
 	}
-	pruneOpts := make(map[string]interface{})
-	pruneOpts[splitstore.PruneRetainState] = int64(0) // Prune from compaction boundary
+	pruneOpts := api.PruneOpts{RetainState: int64(0), MovingGC: false}
 	require.NoError(t, full.ChainPrune(ctx, pruneOpts))
 	bm.Restart()
 	waitForPrune(ctx, t, 1, full)