Bootstrap surge factor using the network's current value

Author: m-Peter

bootstrap/bootstrap.go

@@ -2,13 +2,15 @@ package bootstrap
 
 import (
 	"context"
+	_ "embed"
 	"errors"
 	"fmt"
 	"math"
 	"time"
 
 	pebbleDB "github.com/cockroachdb/pebble"
 	gethTypes "github.com/ethereum/go-ethereum/core/types"
+	"github.com/onflow/cadence"
 	"github.com/onflow/flow-go-sdk/access"
 	"github.com/onflow/flow-go-sdk/access/grpc"
 	"github.com/onflow/flow-go/fvm/environment"
@@ -50,6 +52,11 @@ const (
 	DefaultResourceExhaustedMaxRetryDelay = 30 * time.Second
 )
 
+var (
+	//go:embed cadence/get_fees_surge_factor.cdc
+	getFeesSurgeFactor []byte
+)
+
 type Storages struct {
 	Storage       *pebble.Storage
 	Registers     *pebble.RegisterStorage
@@ -649,12 +656,12 @@ func setupStorage(
 	// }
 
 	feeParameters := pebble.NewFeeParameters(store)
-	if _, err = feeParameters.Get(); errors.Is(err, errs.ErrEntityNotFound) {
-		if err := feeParameters.Store(models.DefaultFeeParameters, batch); err != nil {
-			return nil, nil, fmt.Errorf("failed to bootstrap fee parameters: %w", err)
-		}
-	} else if err != nil {
-		return nil, nil, fmt.Errorf("failed to load latest fee parameters: %w", err)
+	currentFeeParams, err := getNetworkFeeParams(context.Background(), config, client, logger)
+	if err != nil {
+		return nil, nil, fmt.Errorf("failed to fetch current fees surge factor: %w", err)
+	}
+	if err := feeParameters.Store(currentFeeParams, batch); err != nil {
+		return nil, nil, fmt.Errorf("failed to bootstrap fee parameters: %w", err)
 	}
 
 	if batch.Count() > 0 {
@@ -794,3 +801,36 @@ func (m *metricsWrapper) Stop() {
 	m.stopFN()
 	<-m.Done()
 }
+
+// getNetworkFeeParams returns the network's current Flow fees parameters
+func getNetworkFeeParams(
+	ctx context.Context,
+	config config.Config,
+	client *requester.CrossSporkClient,
+	logger zerolog.Logger,
+) (*models.FeeParameters, error) {
+	val, err := client.ExecuteScriptAtLatestBlock(
+		ctx,
+		requester.ReplaceAddresses(getFeesSurgeFactor, config.FlowNetworkID),
+		nil,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	// sanity check, should never occur
+	if _, ok := val.(cadence.UFix64); !ok {
+		return nil, fmt.Errorf("failed to convert surgeFactor %v to UFix64, got type: %T", val, val)
+	}
+
+	surgeFactor := val.(cadence.UFix64)
+
+	logger.Debug().
+		Uint64("surge-factor", uint64(surgeFactor)).
+		Msg("get current surge factor executed")
+
+	feeParameters := models.DefaultFeeParameters()
+	feeParameters.SurgeFactor = surgeFactor
+
+	return feeParameters, nil
+}

bootstrap/cadence/get_fees_surge_factor.cdc

@@ -0,0 +1,5 @@
+import FlowFees
+
+access(all) fun main(): UFix64 {
+    return FlowFees.getFeeParameters().surgeFactor
+}

models/fee_parameters.go

@@ -12,10 +12,12 @@ const feeParamsPrecision = 100_000_000
 
 var surgeFactorScale = big.NewInt(feeParamsPrecision)
 
-var DefaultFeeParameters = &FeeParameters{
-	SurgeFactor:         cadence.UFix64(feeParamsPrecision),
-	InclusionEffortCost: cadence.UFix64(feeParamsPrecision),
-	ExecutionEffortCost: cadence.UFix64(feeParamsPrecision),
+func DefaultFeeParameters() *FeeParameters {
+	return &FeeParameters{
+		SurgeFactor:         cadence.UFix64(feeParamsPrecision),
+		InclusionEffortCost: cadence.UFix64(feeParamsPrecision),
+		ExecutionEffortCost: cadence.UFix64(feeParamsPrecision),
+	}
 }
 
 type FeeParameters struct {

services/requester/batch_tx_pool.go

@@ -218,7 +218,7 @@ func (t *BatchTxPool) batchSubmitTransactionsForSameAddress(
 		return err
 	}
 
-	script := replaceAddresses(batchRunTxScript, t.config.FlowNetworkID)
+	script := ReplaceAddresses(batchRunTxScript, t.config.FlowNetworkID)
 	flowTx, err := t.buildTransaction(
 		latestBlock,
 		account,
@@ -254,7 +254,7 @@ func (t *BatchTxPool) submitSingleTransaction(
 		return err
 	}
 
-	script := replaceAddresses(runTxScript, t.config.FlowNetworkID)
+	script := ReplaceAddresses(runTxScript, t.config.FlowNetworkID)
 	flowTx, err := t.buildTransaction(
 		latestBlock,
 		account,

services/requester/remote_cadence_arch.go

@@ -109,7 +109,7 @@ func (rca *RemoteCadenceArch) runCall(input []byte) (*evmTypes.ResultSummary, er
 	scriptResult, err := rca.client.ExecuteScriptAtBlockHeight(
 		context.Background(),
 		rca.blockHeight,
-		replaceAddresses(dryRunScript, rca.chainID),
+		ReplaceAddresses(dryRunScript, rca.chainID),
 		[]cadence.Value{hexEncodedTx, hexEncodedAddress},
 	)
 	if err != nil {

services/requester/requester.go

@@ -453,7 +453,7 @@ func (e *EVM) GetCode(
 func (e *EVM) GetLatestEVMHeight(ctx context.Context) (uint64, error) {
 	val, err := e.client.ExecuteScriptAtLatestBlock(
 		ctx,
-		replaceAddresses(getLatestEVMHeight, e.config.FlowNetworkID),
+		ReplaceAddresses(getLatestEVMHeight, e.config.FlowNetworkID),
 		nil,
 	)
 	if err != nil {

services/requester/single_tx_pool.go

@@ -98,7 +98,7 @@ func (t *SingleTxPool) Add(
 		return err
 	}
 
-	script := replaceAddresses(runTxScript, t.config.FlowNetworkID)
+	script := ReplaceAddresses(runTxScript, t.config.FlowNetworkID)
 	flowTx, err := t.buildTransaction(
 		latestBlock,
 		account,

services/requester/utils.go

@@ -8,14 +8,15 @@ import (
 	"github.com/onflow/flow-go/model/flow"
 )
 
-// replaceAddresses replace the addresses based on the network
-func replaceAddresses(script []byte, chainID flow.ChainID) []byte {
+// ReplaceAddresses replace the addresses based on the network
+func ReplaceAddresses(script []byte, chainID flow.ChainID) []byte {
 	// make the list of all contracts we should replace address for
 	sc := systemcontracts.SystemContractsForChain(chainID)
 	contracts := []systemcontracts.SystemContract{
 		sc.EVMContract,
 		sc.FungibleToken,
 		sc.FlowToken,
+		sc.FlowFees,
 	}
 
 	s := string(script)