feat: introduce fee splitter for revenue share (#17536)

* feat: fee splitter system (#469)


----

Co-authored-by: Disco <[email protected]>
Co-authored-by: Flux <[email protected]>
Co-authored-by: Chiin <[email protected]>

* fix: failing tests (#553)

* refactor: revenue sharing config (#538)

* fix: pre pr and semgrep (#565)

* fix: warnings (#571)

* fix: tests failing on fork environment (#575)

* fix: use encode call on constructors (#578)

* feat: add integration splitter test (#581)

* fix: integration test nits (#583)

* test: more coverage on splitter tests (#594)


---------

Co-authored-by: Chiin <[email protected]>

* fix: add missing operator fee vault field (#616)

* feat: invariants and tests (#595)

* fix: ir informationals (#609)

* fix: pre pr (#622)

* refactor: use cdm (#624)

* fix: update withdrawal gas limit value on check (#627)

* fix: remove rev share field from deploy op chain input struct (#628)

* refactor: remove initializer and vaults getter changes (#631)

* fix: remove immutable check over vaults (#634)


Co-authored-by: 0xng <[email protected]>
Co-authored-by: Funkornaut <[email protected]>
Co-authored-by: Joxess <[email protected]>

* fix: audit findings (#658)

* fix: pre pr

* feat: add user guide docs for rev sharing on op deployer (#666)

* docs: add create2 comment (#667)

---------

Co-authored-by: Funkornaut <[email protected]>
Co-authored-by: Flux <[email protected]>
Co-authored-by: Chiin <[email protected]>
Co-authored-by: Simon Something /DrGoNoGo <[email protected]>
Co-authored-by: 0xng <[email protected]>
Co-authored-by: Joxess <[email protected]>

Author: 7 people

.circleci/config.yml

@@ -562,7 +562,7 @@ jobs:
   contracts-bedrock-build:
     docker:
       - image: <<pipeline.parameters.default_docker_image>>
-    resource_class: xlarge
+    resource_class: 2xlarge
     parameters:
       build_args:
         description: Forge build arguments
@@ -862,7 +862,7 @@ jobs:
     circleci_ip_ranges: true
     docker:
       - image: <<pipeline.parameters.default_docker_image>>
-    resource_class: xlarge
+    resource_class: 2xlarge
     parameters:
       test_list:
         description: List of test files to run

.gitignore

@@ -50,4 +50,4 @@ __pycache__
 crytic-export
 
 # ignore local asdf config
-.tool-versions
+.tool-versions

.semgrep/rules/sol-rules.yaml

@@ -194,6 +194,7 @@ rules:
     paths:
       exclude:
         - packages/contracts-bedrock/src/legacy/L1ChugSplashProxy.sol
+        - packages/contracts-bedrock/test/invariants/FeeSplit.t.sol
 
   - id: sol-style-enforce-require-msg
     languages: [solidity]

devnet-sdk/contracts/constants/constants.go

@@ -22,13 +22,15 @@ var (
 	ProxyAdmin                    types.Address = common.HexToAddress("0x4200000000000000000000000000000000000018")
 	BaseFeeVault                  types.Address = common.HexToAddress("0x4200000000000000000000000000000000000019")
 	L1FeeVault                    types.Address = common.HexToAddress("0x420000000000000000000000000000000000001a")
+	OperatorFeeVault              types.Address = common.HexToAddress("0x420000000000000000000000000000000000001B")
 	SchemaRegistry                types.Address = common.HexToAddress("0x4200000000000000000000000000000000000020")
 	EAS                           types.Address = common.HexToAddress("0x4200000000000000000000000000000000000021")
 	CrossL2Inbox                  types.Address = common.HexToAddress("0x4200000000000000000000000000000000000022")
 	L2ToL2CrossDomainMessenger    types.Address = common.HexToAddress("0x4200000000000000000000000000000000000023")
 	SuperchainETHBridge           types.Address = common.HexToAddress("0x4200000000000000000000000000000000000024")
 	ETHLiquidity                  types.Address = common.HexToAddress("0x4200000000000000000000000000000000000025")
 	SuperchainTokenBridge         types.Address = common.HexToAddress("0x4200000000000000000000000000000000000028")
+	FeeSplitter                   types.Address = common.HexToAddress("0x420000000000000000000000000000000000002B")
 	GovernanceToken               types.Address = common.HexToAddress("0x4200000000000000000000000000000000000042")
 	Create2Deployer               types.Address = common.HexToAddress("0x13b0D85CcB8bf860b6b79AF3029fCA081AE9beF2")
 	MultiCall3                    types.Address = common.HexToAddress("0xcA11bde05977b3631167028862bE2a173976CA11")

op-chain-ops/devkeys/devkeys.go

@@ -158,6 +158,10 @@ const (
 	SequencerFeeVaultRecipientRole ChainOperatorRole = 9
 	// SystemConfigOwner is the key that can make SystemConfig changes.
 	SystemConfigOwner ChainOperatorRole = 10
+	// OperatorFeeVaultRecipientRole is the key that receives from the OperatorFeeVault predeploy
+	OperatorFeeVaultRecipientRole ChainOperatorRole = 11
+	// ChainFeesRecipientRole is the key that receives the chain's share from the FeeSplitter
+	ChainFeesRecipientRole ChainOperatorRole = 12
 )
 
 func (role ChainOperatorRole) String() string {
@@ -182,8 +186,12 @@ func (role ChainOperatorRole) String() string {
 		return "l1-fee-vault-recipient"
 	case SequencerFeeVaultRecipientRole:
 		return "sequencer-fee-vault-recipient"
+	case OperatorFeeVaultRecipientRole:
+		return "operator-fee-vault-recipient"
 	case SystemConfigOwner:
 		return "system-config-owner"
+	case ChainFeesRecipientRole:
+		return "chain-fees-recipient"
 	default:
 		return fmt.Sprintf("unknown-operator-%d", uint64(role))
 	}

op-chain-ops/genesis/config.go

@@ -86,6 +86,22 @@ type DevDeployConfig struct {
 	FundDevAccounts bool `json:"fundDevAccounts"`
 }
 
+type RevenueShareDeployConfig struct {
+	UseRevenueShare    bool           `json:"useRevenueShare"`
+	ChainFeesRecipient common.Address `json:"chainFeesRecipient"`
+}
+
+var _ ConfigChecker = (*RevenueShareDeployConfig)(nil)
+
+func (d *RevenueShareDeployConfig) Check(log log.Logger) error {
+	if d.UseRevenueShare {
+		if d.ChainFeesRecipient == (common.Address{}) {
+			return fmt.Errorf("%w: ChainFeesRecipient cannot be address(0)", ErrInvalidDeployConfig)
+		}
+	}
+	return nil
+}
+
 type L2GenesisBlockDeployConfig struct {
 	L2GenesisBlockNonce         hexutil.Uint64 `json:"l2GenesisBlockNonce"`
 	L2GenesisBlockGasLimit      hexutil.Uint64 `json:"l2GenesisBlockGasLimit"`
@@ -150,18 +166,24 @@ type L2VaultsDeployConfig struct {
 	// SequencerFeeVaultRecipient represents the recipient of fees accumulated in the SequencerFeeVault.
 	// Can be an account on L1 or L2, depending on the SequencerFeeVaultWithdrawalNetwork value.
 	SequencerFeeVaultRecipient common.Address `json:"sequencerFeeVaultRecipient"`
+	// OperatorFeeVaultRecipient represents the recipient of fees accumulated in the OperatorFeeVault.
+	OperatorFeeVaultRecipient common.Address `json:"operatorFeeVaultRecipient"`
 	// BaseFeeVaultMinimumWithdrawalAmount represents the minimum withdrawal amount for the BaseFeeVault.
 	BaseFeeVaultMinimumWithdrawalAmount *hexutil.Big `json:"baseFeeVaultMinimumWithdrawalAmount"`
 	// L1FeeVaultMinimumWithdrawalAmount represents the minimum withdrawal amount for the L1FeeVault.
 	L1FeeVaultMinimumWithdrawalAmount *hexutil.Big `json:"l1FeeVaultMinimumWithdrawalAmount"`
 	// SequencerFeeVaultMinimumWithdrawalAmount represents the minimum withdrawal amount for the SequencerFeeVault.
 	SequencerFeeVaultMinimumWithdrawalAmount *hexutil.Big `json:"sequencerFeeVaultMinimumWithdrawalAmount"`
+	// OperatorFeeVaultMinimumWithdrawalAmount represents the minimum withdrawal amount for the OperatorFeeVault.
+	OperatorFeeVaultMinimumWithdrawalAmount *hexutil.Big `json:"operatorFeeVaultMinimumWithdrawalAmount"`
 	// BaseFeeVaultWithdrawalNetwork represents the withdrawal network for the BaseFeeVault.
 	BaseFeeVaultWithdrawalNetwork WithdrawalNetwork `json:"baseFeeVaultWithdrawalNetwork"`
 	// L1FeeVaultWithdrawalNetwork represents the withdrawal network for the L1FeeVault.
 	L1FeeVaultWithdrawalNetwork WithdrawalNetwork `json:"l1FeeVaultWithdrawalNetwork"`
 	// SequencerFeeVaultWithdrawalNetwork represents the withdrawal network for the SequencerFeeVault.
 	SequencerFeeVaultWithdrawalNetwork WithdrawalNetwork `json:"sequencerFeeVaultWithdrawalNetwork"`
+	// OperatorFeeVaultWithdrawalNetwork represents the withdrawal network for the OperatorFeeVault.
+	OperatorFeeVaultWithdrawalNetwork WithdrawalNetwork `json:"operatorFeeVaultWithdrawalNetwork"`
 }
 
 var _ ConfigChecker = (*L2VaultsDeployConfig)(nil)
@@ -176,6 +198,9 @@ func (d *L2VaultsDeployConfig) Check(log log.Logger) error {
 	if d.SequencerFeeVaultRecipient == (common.Address{}) {
 		return fmt.Errorf("%w: SequencerFeeVaultRecipient cannot be address(0)", ErrInvalidDeployConfig)
 	}
+	if d.OperatorFeeVaultRecipient == (common.Address{}) {
+		return fmt.Errorf("%w: OperatorFeeVaultRecipient cannot be address(0)", ErrInvalidDeployConfig)
+	}
 	if !d.BaseFeeVaultWithdrawalNetwork.Valid() {
 		return fmt.Errorf("%w: BaseFeeVaultWithdrawalNetwork can only be 0 (L1) or 1 (L2)", ErrInvalidDeployConfig)
 	}
@@ -185,6 +210,9 @@ func (d *L2VaultsDeployConfig) Check(log log.Logger) error {
 	if !d.SequencerFeeVaultWithdrawalNetwork.Valid() {
 		return fmt.Errorf("%w: SequencerFeeVaultWithdrawalNetwork can only be 0 (L1) or 1 (L2)", ErrInvalidDeployConfig)
 	}
+	if !d.OperatorFeeVaultWithdrawalNetwork.Valid() {
+		return fmt.Errorf("%w: OperatorFeeVaultWithdrawalNetwork can only be 0 (L1) or 1 (L2)", ErrInvalidDeployConfig)
+	}
 	return nil
 }
 
@@ -743,6 +771,7 @@ type L2InitializationConfig struct {
 	L2CoreDeployConfig
 	FeeMarketConfig
 	AltDADeployConfig
+	RevenueShareDeployConfig
 }
 
 func (d *L2InitializationConfig) Check(log log.Logger) error {

op-chain-ops/genesis/testdata/test-deploy-config-full.json

@@ -40,12 +40,15 @@
   "baseFeeVaultRecipient": "0x42000000000000000000000000000000000000f5",
   "l1FeeVaultRecipient": "0x42000000000000000000000000000000000000f6",
   "sequencerFeeVaultRecipient": "0x42000000000000000000000000000000000000f7",
+  "operatorFeeVaultRecipient": "0x4200000000000000000000000000000000000063",
   "baseFeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000",
   "l1FeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000",
   "sequencerFeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000",
+  "operatorFeeVaultMinimumWithdrawalAmount": "0x8ac7230489e80000",
   "baseFeeVaultWithdrawalNetwork": 0,
   "l1FeeVaultWithdrawalNetwork": 1,
   "sequencerFeeVaultWithdrawalNetwork": 1,
+  "operatorFeeVaultWithdrawalNetwork": 1,
   "l1StandardBridgeProxy": "0x42000000000000000000000000000000000000f8",
   "l1CrossDomainMessengerProxy": "0x42000000000000000000000000000000000000f9",
   "l1ERC721BridgeProxy": "0x4200000000000000000000000000000000000060",
@@ -94,5 +97,7 @@
   "daChallengeProxy": "0x0000000000000000000000000000000000000000",
   "daChallengeWindow": 0,
   "daResolveWindow": 0,
-  "daResolverRefundPercentage": 0
+  "daResolverRefundPercentage": 0,
+  "useRevenueShare": true,
+  "chainFeesRecipient": "0x0000000000000000000000000000000000000444"
 }

op-chain-ops/genesis/withdrawal_network_test.go

@@ -83,18 +83,21 @@ func TestWithdrawalNetworkInlineJSON(t *testing.T) {
 		BaseFeeVaultWithdrawalNetwork      WithdrawalNetwork `json:"baseFeeVaultWithdrawalNetwork"`
 		L1FeeVaultWithdrawalNetwork        WithdrawalNetwork `json:"l1FeeVaultWithdrawalNetwork"`
 		SequencerFeeVaultWithdrawalNetwork WithdrawalNetwork `json:"sequencerFeeVaultWithdrawalNetwork"`
+		OperatorFeeVaultWithdrawalNetwork  WithdrawalNetwork `json:"operatorFeeVaultWithdrawalNetwork"`
 	}
 
 	jsonString := `{
 		"baseFeeVaultWithdrawalNetwork": "remote",
 		"l1FeeVaultWithdrawalNetwork": "local",
-		"sequencerFeeVaultWithdrawalNetwork": "local"
+		"sequencerFeeVaultWithdrawalNetwork": "local",
+		"operatorFeeVaultWithdrawalNetwork": "local"
 	}`
 
 	intJsonString := `{
 		"baseFeeVaultWithdrawalNetwork": 0,
 		"l1FeeVaultWithdrawalNetwork": 1,
-		"sequencerFeeVaultWithdrawalNetwork": 1
+		"sequencerFeeVaultWithdrawalNetwork": 1,
+		"operatorFeeVaultWithdrawalNetwork": 1
 	}`
 
 	t.Run("StringMarshaling", func(t *testing.T) {
@@ -104,6 +107,7 @@ func TestWithdrawalNetworkInlineJSON(t *testing.T) {
 		require.Equal(t, WithdrawalNetwork("remote"), decoded.BaseFeeVaultWithdrawalNetwork)
 		require.Equal(t, WithdrawalNetwork("local"), decoded.L1FeeVaultWithdrawalNetwork)
 		require.Equal(t, WithdrawalNetwork("local"), decoded.SequencerFeeVaultWithdrawalNetwork)
+		require.Equal(t, WithdrawalNetwork("local"), decoded.OperatorFeeVaultWithdrawalNetwork)
 
 		encoded, err := json.Marshal(decoded)
 		require.NoError(t, err)
@@ -118,6 +122,7 @@ func TestWithdrawalNetworkInlineJSON(t *testing.T) {
 		require.Equal(t, WithdrawalNetwork("remote"), decoded.BaseFeeVaultWithdrawalNetwork)
 		require.Equal(t, WithdrawalNetwork("local"), decoded.L1FeeVaultWithdrawalNetwork)
 		require.Equal(t, WithdrawalNetwork("local"), decoded.SequencerFeeVaultWithdrawalNetwork)
+		require.Equal(t, WithdrawalNetwork("local"), decoded.OperatorFeeVaultWithdrawalNetwork)
 
 		encoded, err := json.Marshal(decoded)
 		require.NoError(t, err)

op-chain-ops/interopgen/deploy.go

@@ -21,6 +21,7 @@ import (
 	"github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer"
 	"github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/manage"
 	"github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/opcm"
+	"github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/standard"
 	"github.com/ethereum-optimism/optimism/op-service/eth"
 )
 
@@ -329,11 +330,17 @@ func GenesisL2(l2Host *script.Host, cfg *L2Config, deployment *L2Deployment, mul
 		L1FeeVaultRecipient:                      cfg.L1FeeVaultRecipient,
 		L1FeeVaultMinimumWithdrawalAmount:        cfg.L1FeeVaultMinimumWithdrawalAmount.ToInt(),
 		L1FeeVaultWithdrawalNetwork:              big.NewInt(int64(cfg.L1FeeVaultWithdrawalNetwork.ToUint8())),
+		OperatorFeeVaultRecipient:                cfg.OperatorFeeVaultRecipient,
+		OperatorFeeVaultMinimumWithdrawalAmount:  cfg.OperatorFeeVaultMinimumWithdrawalAmount.ToInt(),
+		OperatorFeeVaultWithdrawalNetwork:        big.NewInt(int64(cfg.OperatorFeeVaultWithdrawalNetwork.ToUint8())),
 		GovernanceTokenOwner:                     cfg.GovernanceTokenOwner,
 		Fork:                                     big.NewInt(cfg.SolidityForkNumber(1)),
 		DeployCrossL2Inbox:                       multichainDepSet,
 		EnableGovernance:                         cfg.EnableGovernance,
 		FundDevAccounts:                          cfg.FundDevAccounts,
+		UseRevenueShare:                          cfg.UseRevenueShare,
+		ChainFeesRecipient:                       cfg.ChainFeesRecipient,
+		L1FeesDepositor:                          standard.L1FeesDepositor,
 	}); err != nil {
 		return fmt.Errorf("failed L2 genesis: %w", err)
 	}

op-chain-ops/interopgen/recipe.go

@@ -186,6 +186,10 @@ func (r *InteropDevL2Recipe) build(l1ChainID uint64, addrs devkeys.Addresses) (*
 	if err != nil {
 		return nil, err
 	}
+	operatorFeeVaultRecipient, err := addrs.Address(chainOps(devkeys.OperatorFeeVaultRecipientRole))
+	if err != nil {
+		return nil, err
+	}
 	sequencerP2P, err := addrs.Address(chainOps(devkeys.SequencerP2PRole))
 	if err != nil {
 		return nil, err
@@ -228,12 +232,15 @@ func (r *InteropDevL2Recipe) build(l1ChainID uint64, addrs devkeys.Addresses) (*
 				BaseFeeVaultRecipient:                    baseFeeVaultRecipient,
 				L1FeeVaultRecipient:                      l1FeeVaultRecipient,
 				SequencerFeeVaultRecipient:               sequencerFeeVaultRecipient,
+				OperatorFeeVaultRecipient:                operatorFeeVaultRecipient,
 				BaseFeeVaultMinimumWithdrawalAmount:      (*hexutil.Big)(Ether(10)),
 				L1FeeVaultMinimumWithdrawalAmount:        (*hexutil.Big)(Ether(10)),
 				SequencerFeeVaultMinimumWithdrawalAmount: (*hexutil.Big)(Ether(10)),
+				OperatorFeeVaultMinimumWithdrawalAmount:  (*hexutil.Big)(Ether(10)),
 				BaseFeeVaultWithdrawalNetwork:            "remote",
 				L1FeeVaultWithdrawalNetwork:              "remote",
 				SequencerFeeVaultWithdrawalNetwork:       "remote",
+				OperatorFeeVaultWithdrawalNetwork:        "remote",
 			},
 			GovernanceDeployConfig: genesis.GovernanceDeployConfig{
 				EnableGovernance: false,
@@ -282,6 +289,10 @@ func (r *InteropDevL2Recipe) build(l1ChainID uint64, addrs devkeys.Addresses) (*
 			AltDADeployConfig: genesis.AltDADeployConfig{
 				UseAltDA: false,
 			},
+			RevenueShareDeployConfig: genesis.RevenueShareDeployConfig{
+				UseRevenueShare:    false,
+				ChainFeesRecipient: common.Address{},
+			},
 		},
 		Prefund:                 make(map[common.Address]*big.Int),
 		SaltMixer:               "",