antimev: add envelopeFee set and check

Author: txhsl

antimev/envelope.go

@@ -40,15 +40,24 @@ var (
 // IsEnvelope checks whether a transaction is an Envelope transaction. The criteria
 // include receiver's address, data prefix and data length check.
 func IsEnvelope(tx *types.Transaction) bool {
-	if tx.To() == nil || *(tx.To()) != systemcontracts.GovernanceRewardProxyHash {
+	return IsEnvelopeToAddress(tx.To()) && IsEnvelopeData(tx.Data())
+}
+
+// IsEnvelopeToAddress checks whether an address pointer has the expected value for
+// Envelope To address.
+func IsEnvelopeToAddress(addr *common.Address) bool {
+	if addr == nil || *addr != systemcontracts.GovernanceRewardProxyHash {
 		return false
 	}
+	return true
+}
 
-	data := tx.Data()
+// IsEnvelopeData checks whether the input data bytes has the expected prefix for
+// Envelope specification.
+func IsEnvelopeData(data []byte) bool {
 	if len(data) < minEncryptedDataSize || !bytes.HasPrefix(data, EncryptedDataPrefix) {
 		return false
 	}
-
 	return true
 }
 

contracts/solidity/Policy.sol

@@ -17,6 +17,7 @@ contract Policy is IPolicy, GovernanceVote, GovProxyUpgradeable {
     uint256 public minGasTipCap;
     uint256 public baseFee;
     uint256 internal candidateLimit;
+    uint256 public envelopeFee;
 
     // Only for precompiled uups implementation in genesis file, need to be removed when upgrading the contract.
     // This override is added because "immutable __self" in UUPSUpgradeable is not avaliable in precompiled contract.
@@ -130,4 +131,21 @@ contract Policy is IPolicy, GovernanceVote, GovProxyUpgradeable {
         if (limit > 0) return limit;
         else return DEFAULT_CANDIDATE_LIMIT;
     }
+
+    function setEnvelopeFee(
+        uint256 _fee
+    )
+        external
+        needVote(
+            bytes32(
+                // keccak256("setEnvelopeFee")
+                0xab26bca1cb5d7b0a97ee434cabffdf1efbc3073c1645a8ed4d1732335c51df49
+            ),
+            keccak256(abi.encode(_fee))
+        )
+    {
+        if (_fee <= 0) revert Errors.InvalidEnvelopeFee();
+        envelopeFee = _fee;
+        emit SetEnvelopeFee(_fee);
+    }
 }

contracts/solidity/interfaces/IPolicy.sol

@@ -7,6 +7,7 @@ interface IPolicy {
     event SetMinGasTipCap(uint256 gasTipCap);
     event SetBaseFee(uint256 baseFee);
     event SetCandidateLimit(uint256 candidateLimit);
+    event SetEnvelopeFee(uint256 envelopeFee);
 
     // add an address to blacklist policy
     function addBlackList(address _addr) external;

contracts/solidity/libraries/Errors.sol

@@ -20,6 +20,7 @@ library Errors {
     error InvalidMinGasTipCap();
     error InvalidBaseFee();
     error InvalidCandidateLimit();
+    error InvalidEnvelopeFee();
 
     // Governance Errors
     error SideCallNotAllowed();

core/state_transition.go

@@ -21,6 +21,7 @@ import (
 	"math"
 	"math/big"
 
+	"github.com/ethereum/go-ethereum/antimev"
 	"github.com/ethereum/go-ethereum/common"
 	cmath "github.com/ethereum/go-ethereum/common/math"
 	"github.com/ethereum/go-ethereum/core/systemcontracts"
@@ -328,9 +329,13 @@ func (st *StateTransition) preCheck() error {
 			// For LegacyTx, GasFeeCap and GasPrice are equal, so checking GasTipCap and GasFeeCap is enough.
 			if st.evm.ChainConfig().DBFT != nil {
 				var minGasTipCap = st.state.GetState(systemcontracts.PolicyProxyHash, systemcontracts.GetMinGasTipCapStateHash()).Big()
+				if antimev.IsEnvelopeToAddress(msg.To) && antimev.IsEnvelopeData(msg.Data) {
+					var envelopeFee = st.state.GetState(systemcontracts.PolicyProxyHash, systemcontracts.GetEnvelopeFeeStateHash()).Big()
+					minGasTipCap.Add(minGasTipCap, envelopeFee)
+				}
 				if cmath.BigMin(msg.GasTipCap, new(big.Int).Sub(msg.GasFeeCap, st.evm.Context.BaseFee)).Cmp(minGasTipCap) < 0 {
-					return fmt.Errorf("%w: address %v, gasTipCap %v, gasFeeCap %v, policy minGasTipCap %v, baseFee %v ", ErrUnderpriced,
-						msg.From.Hex(), msg.GasTipCap, msg.GasFeeCap, minGasTipCap, st.evm.Context.BaseFee)
+					return fmt.Errorf("%w: address %v, gasTipCap %v, gasFeeCap %v, policy minGasTipCap (including Envelope fee for Envelopes) %v, baseFee %v ",
+						ErrUnderpriced, msg.From.Hex(), msg.GasTipCap, msg.GasFeeCap, minGasTipCap, st.evm.Context.BaseFee)
 				}
 			}
 		}

core/systemcontracts/contracts.go

@@ -24,6 +24,7 @@ const (
 const blackListSlotIndex = 1
 const minGasTipCapSlotIndex = 2
 const baseFeeSlotIndex = 3
+const envelopeFeeSlotIndex = 5
 
 // A set of genesis contract hashes.
 var (
@@ -95,3 +96,9 @@ func GetBaseFeeStateHash() common.Hash {
 func GetBlackListStateHash(addr common.Address) common.Hash {
 	return crypto.Keccak256Hash(common.LeftPadBytes(addr.Bytes(), 32), common.LeftPadBytes([]byte{blackListSlotIndex}, 32))
 }
+
+// GetEnvelopeFeeStateHash computes and returns the storage key of envelopeFee
+// in policy contract, for reading corresponding values from statedb.
+func GetEnvelopeFeeStateHash() common.Hash {
+	return common.BytesToHash([]byte{envelopeFeeSlotIndex})
+}

core/txpool/validation.go

@@ -21,6 +21,7 @@ import (
 	"fmt"
 	"math/big"
 
+	"github.com/ethereum/go-ethereum/antimev"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/common/math"
 	"github.com/ethereum/go-ethereum/core"
@@ -215,8 +216,13 @@ func ValidateTransactionWithState(tx *types.Transaction, signer types.Signer, op
 	// For LegacyTx, GasFeeCap and GasPrice are equal, so checking GasTipCap and GasFeeCap is enough
 	var minGasTipCap = opts.State.GetState(systemcontracts.PolicyProxyHash, systemcontracts.GetMinGasTipCapStateHash()).Big()
 	var baseFee = opts.State.GetState(systemcontracts.PolicyProxyHash, systemcontracts.GetBaseFeeStateHash()).Big()
+	// Apply policy envelope fee check
+	if antimev.IsEnvelope(tx) {
+		var envelopeFee = opts.State.GetState(systemcontracts.PolicyProxyHash, systemcontracts.GetEnvelopeFeeStateHash()).Big()
+		minGasTipCap.Add(minGasTipCap, envelopeFee)
+	}
 	if math.BigMin(tx.GasTipCap(), new(big.Int).Sub(tx.GasFeeCap(), baseFee)).Cmp(minGasTipCap) < 0 {
-		return fmt.Errorf("%w: policy minGasTipCap needed %v, baseFee needed %v, gasTipCap %v, gasFeeCap %v ",
+		return fmt.Errorf("%w: policy minGasTipCap (including Envelope fee for Envelopes) needed %v, baseFee needed %v, gasTipCap %v, gasFeeCap %v ",
 			ErrUnderpriced, minGasTipCap, baseFee, tx.GasTipCap(), tx.GasFeeCap())
 	}
 	// Apply policy blacklist