feat: config for maximized feecap (#597)

Author: magik6k

cmd/curio/tasks/tasks.go

@@ -108,7 +108,7 @@ func StartTasks(ctx context.Context, dependencies *deps.Deps, shutdownChan chan
 
 	var activeTasks []harmonytask.TaskInterface
 
-	sender, sendTask := message.NewSender(full, full, db)
+	sender, sendTask := message.NewSender(full, full, db, cfg.Fees.MaximizeFeeCap)
 	balanceMgrTask := balancemgr.NewBalanceMgrTask(db, full, chainSched, sender)
 	activeTasks = append(activeTasks, sendTask, balanceMgrTask)
 	dependencies.Sender = sender

deps/config/doc_gen.go

@@ -36,6 +36,7 @@ func DefaultCurioConfig() *CurioConfig {
 			MaxWindowPoStGasFee:        types.MustParseFIL("5"),
 			CollateralFromMinerBalance: false,
 			DisableCollateralFallback:  false,
+			MaximizeFeeCap:             true,
 		},
 		Addresses: []CurioAddresses{{
 			PreCommitControl:   []string{},
@@ -439,6 +440,11 @@ type CurioFees struct {
 
 	// Don't send collateral with messages even if there is no available balance in the miner actor (Default: false)
 	DisableCollateralFallback bool
+
+	// MaximizeFeeCap makes the sender set maximum allowed FeeCap on all sent messages.
+	// This generally doesn't increase message cost, but in highly congested network messages
+	// are much less likely to get stuck in mempool. (Default: true)
+	MaximizeFeeCap bool
 }
 
 type CurioAddresses struct {

deps/config/types.go

@@ -342,6 +342,13 @@ description: The default curio configuration
   # type: bool
   #DisableCollateralFallback = false
 
+  # MaximizeFeeCap makes the sender set maximum allowed FeeCap on all sent messages.
+  # This generally doesn't increase message cost, but in highly congested network messages
+  # are much less likely to get stuck in mempool. (Default: true)
+  #
+  # type: bool
+  #MaximizeFeeCap = true
+
   # maxBatchFee = maxBase + maxPerSector * nSectors
   # (Default: #Base = "0 FIL" and #PerSector = "0.02 FIL")
   #

documentation/en/configuration/default-curio-configuration.md

@@ -47,6 +47,8 @@ type SignerAPI interface {
 type Sender struct {
 	api SenderAPI
 
+	maximizeFeeCap bool
+
 	sendTask *SendTask
 
 	db *harmonydb.DB
@@ -260,16 +262,17 @@ var _ harmonytask.TaskInterface = &SendTask{}
 var _ = harmonytask.Reg(&SendTask{})
 
 // NewSender creates a new Sender.
-func NewSender(api SenderAPI, signer SignerAPI, db *harmonydb.DB) (*Sender, *SendTask) {
+func NewSender(api SenderAPI, signer SignerAPI, db *harmonydb.DB, maximizeFeeCap bool) (*Sender, *SendTask) {
 	st := &SendTask{
 		api:    api,
 		signer: signer,
 		db:     db,
 	}
 
 	return &Sender{
-		api: api,
-		db:  db,
+		api:            api,
+		db:             db,
+		maximizeFeeCap: maximizeFeeCap,
 
 		sendTask: st,
 	}, st
@@ -295,6 +298,10 @@ func (s *Sender) Send(ctx context.Context, msg *types.Message, mss *api.MessageS
 		return cid.Undef, xerrors.Errorf("MessageSendSpec.MsgUuid must be zero")
 	}
 
+	if s.maximizeFeeCap {
+		mss.MaximizeFeeCap = true
+	}
+
 	fromA, err := s.api.StateAccountKey(ctx, msg.From, types.EmptyTSK)
 	if err != nil {
 		return cid.Undef, xerrors.Errorf("getting key address: %w", err)