isthmus: operator fee #382
+285
−6
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,22 +10,33 @@ | |
| - [`SystemConfig`](#systemconfig) | ||
| - [`ConfigUpdate`](#configupdate) | ||
| - [Initialization](#initialization) | ||
| - [Modifying Operator Fee Parameters](#modifying-operator-fee-parameters) | ||
| - [Interface](#interface) | ||
| - [Operator fee parameters](#operator-fee-parameters) | ||
| - [`operatorFeeScalar`](#operatorfeescalar) | ||
| - [`operatorFeeConstant`](#operatorfeeconstant) | ||
| - [`setOperatorFeeScalars`](#setoperatorfeescalars) | ||
| - [Fee Vault Config](#fee-vault-config) | ||
| - [`setBaseFeeVaultConfig`](#setbasefeevaultconfig) | ||
| - [`setL1FeeVaultConfig`](#setl1feevaultconfig) | ||
| - [`setSequencerFeeVaultConfig`](#setsequencerfeevaultconfig) | ||
| - [`setOperatorFeeVaultConfig`](#setoperatorfeevaultconfig) | ||
| - [`OptimismPortal`](#optimismportal) | ||
| - [Interface](#interface-1) | ||
| - [`setConfig`](#setconfig) | ||
| - [`upgrade`](#upgrade) | ||
| - [Consensus Parameters](#consensus-parameters) | ||
| - [Operator Fee Scalar](#operator-fee-scalar) | ||
| - [Operator Fee Constant](#operator-fee-constant) | ||
| - [Service Roles](#service-roles) | ||
| - [Operator Fee Manager](#operator-fee-manager) | ||
|
|
||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| ## Overview | ||
|
|
||
| The `SystemConfig` and `OptimismPortal` are updated with a new flow for chain | ||
| configurability. A new service role `OperatorFeeManager` is added to manage the operator fee collection. | ||
|
|
||
| ## Constants | ||
|
|
||
|
|
@@ -39,10 +50,11 @@ The `ConfigType` enum represents configuration that can be modified. | |
| | `BASE_FEE_VAULT_CONFIG` | `uint8(1)` | Sets the Fee Vault Config for the `BaseFeeVault` | | ||
| | `L1_FEE_VAULT_CONFIG` | `uint8(2)` | Sets the Fee Vault Config for the `L1FeeVault` | | ||
| | `SEQUENCER_FEE_VAULT_CONFIG` | `uint8(3)` | Sets the Fee Vault Config for the `SequencerFeeVault` | | ||
| | `OPERATOR_FEE_VAULT_CONFIG` | `uint8(4)` | Sets the Fee Vault Config for the `OperatorFeeVault` | | ||
| | `L1_CROSS_DOMAIN_MESSENGER_ADDRESS` | `uint8(5)` | Sets the `L1CrossDomainMessenger` address | | ||
| | `L1_ERC_721_BRIDGE_ADDRESS` | `uint8(6)` | Sets the `L1ERC721Bridge` address | | ||
| | `L1_STANDARD_BRIDGE_ADDRESS` | `uint8(7)` | Sets the `L1StandardBridge` address | | ||
| | `REMOTE_CHAIN_ID` | `uint8(8)` | Sets the chain id of the base chain | | ||
|
|
||
| ## `SystemConfig` | ||
|
|
||
|
|
@@ -57,6 +69,7 @@ The following `ConfigUpdate` event is defined where the `CONFIG_VERSION` is `uin | |
| | `GAS_LIMIT` | `uint8(2)` | `abi.encode(uint64 _gasLimit)` | Modifies the L2 gas limit | | ||
| | `UNSAFE_BLOCK_SIGNER` | `uint8(3)` | `abi.encode(address)` | Modifies the account that is authorized to progress the unsafe chain | | ||
| | `EIP_1559_PARAMS` | `uint8(4)` | `uint256(uint64(uint32(_denominator))) << 32 \| uint64(uint32(_elasticity))` | Modifies the EIP-1559 denominator and elasticity | | ||
| | `OPERATOR_FEE_PARAMS` | `uint8(5)` | `uint256(_operatorFeeScalar) << 64 \| _operatorFeeConstant` | Modifies the operator fee parameters | | ||
|
|
||
| ### Initialization | ||
|
|
||
|
|
@@ -67,19 +80,59 @@ The following actions should happen during the initialization of the `SystemConf | |
| - `emit ConfigUpdate.GAS_LIMIT` | ||
| - `emit ConfigUpdate.UNSAFE_BLOCK_SIGNER` | ||
| - `emit ConfigUpdate.EIP_1559_PARAMS` | ||
| - `emit ConfigUpdate.OPERATOR_FEE_PARAMS` | ||
| - `setConfig(SET_GAS_PAYING_TOKEN)` | ||
| - `setConfig(SET_BASE_FEE_VAULT_CONFIG)` | ||
| - `setConfig(SET_L1_FEE_VAULT_CONFIG)` | ||
| - `setConfig(SET_SEQUENCER_FEE_VAULT_CONFIG)` | ||
| - `setConfig(SET_OPERATOR_FEE_VAULT_CONFIG)` | ||
| - `setConfig(SET_L1_CROSS_DOMAIN_MESSENGER_ADDRESS)` | ||
| - `setConfig(SET_L1_ERC_721_BRIDGE_ADDRESS)` | ||
| - `setConfig(SET_L1_STANDARD_BRIDGE_ADDRESS)` | ||
| - `setConfig(SET_REMOTE_CHAIN_ID)` | ||
|
|
||
| These actions MAY only be triggered if there is a diff to the value. | ||
|
|
||
| Since the `OperatorFeeVault` is new in Isthmus, the `setConfig(SET_OPERATOR_FEE_VAULT_CONFIG)` MUST be emitted. | ||
|
|
||
| `ConfigUpdate.OPERATOR_FEE_PARAMS` MAY be emitted. If it is not emitted, the `operatorFeeScalar` and | ||
| `operatorFeeConstant` are set to 0 by default. | ||
|
|
||
| ### Modifying Operator Fee Parameters | ||
|
|
||
| A new `SystemConfig` `UpdateType` is introduced that enables the modification of | ||
| the `operatorFeeScalar` and `operatorFeeConstant` by the [`OperatorFeeManager`](#operator-fee-manager). | ||
|
|
||
| ### Interface | ||
|
|
||
| #### Operator fee parameters | ||
|
|
||
| ##### `operatorFeeScalar` | ||
|
|
||
| This function returns the currently configured operator fee scalar. | ||
|
|
||
| ```solidity | ||
| function operatorFeeScalar()(uint32) | ||
| ``` | ||
|
|
||
| ##### `operatorFeeConstant` | ||
|
|
||
| This function returns the currently configured operator fee constant. | ||
|
|
||
| ```solidity | ||
| function operatorFeeConstant()(uint64) | ||
| ``` | ||
|
|
||
| ##### `setOperatorFeeScalars` | ||
|
|
||
| This function sets the `operatorFeeScalar` and `operatorFeeConstant`. | ||
|
|
||
| This function MUST only be callable by the [`OperatorFeeManager`](#operator-fee-manager). | ||
|
|
||
| ```solidity | ||
| function setOperatorFeeScalar(uint32 _operatorFeeScalar, uint64 _operatorFeeConstant)() | ||
| ``` | ||
|
|
||
| #### Fee Vault Config | ||
|
|
||
| For each `FeeVault`, there is a setter for its config. The arguments to the setter include | ||
|
|
@@ -106,6 +159,12 @@ function setL1FeeVaultConfig(address,uint256,WithdrawalNetwork) | |
| function setSequencerFeeVaultConfig(address,uint256,WithdrawalNetwork) | ||
| ``` | ||
|
|
||
| ##### `setOperatorFeeVaultConfig` | ||
|
|
||
| ```solidity | ||
| function setOperatorFeeVaultConfig(address,uint256,WithdrawalNetwork) | ||
| ``` | ||
|
|
||
| ## `OptimismPortal` | ||
|
|
||
| The `OptimismPortal` is updated to emit a special system `TransactionDeposited` event. | ||
|
|
@@ -157,3 +216,28 @@ The following fields are included: | |
| - `version` is `uint256(0)` | ||
| - `opaqueData` is the tightly packed transaction data where `mint` is `0`, `value` is `0`, the `gasLimit` | ||
| is `200_000`, `isCreation` is `false` and the `data` is the data passed into `upgrade`. | ||
|
|
||
| ## Consensus Parameters | ||
|
|
||
| The operator fee scalar and constant are new consensus parameters, so we define standard values for them. | ||
|
|
||
| ### [Operator Fee Scalar](exec-engine.md#operator-fees) | ||
|
|
||
| **Description:** Operator fee scalar -- used to calculate the operator fee<br/> | ||
| **Administrator:** [Operator Fee Manager](#operator-fee-manager)<br/> | ||
| **Requirement:** Between 0 and 0.5 * (baseFee + priorityFee) <br/> | ||
|
There was a problem hiding this comment. This isn't noted anywhere, apologies about that, but its probably best to put these configurability requirements in this file so they are all in a single place Also we would like to say that the requirement for these values is 0 for now for the superchain, with op-succinct you can use them however you would like, then when we do add zk as part of the superchain's proof system we can define the ranges of values. We don't have bandwidth to really think deeply about what the standard values should be from a product perspective and while what you have now could make sense, I don't want to ratify something thru gov that ultimately isnt right |
||
|
|
||
| ### [Operator Fee Constant](exec-engine.md#operator-fees) | ||
|
|
||
| **Description:** Operator fee constant -- used to calculate the operator fee<br/> | ||
| **Administrator:** [Operator Fee Manager](#operator-fee-manager)<br/> | ||
| **Requirement:** Between 0 and 600 Gwei <br/> | ||
|
|
||
| ## Service Roles | ||
|
|
||
| ### Operator Fee Manager | ||
|
|
||
| **Description:** Account authorized to modify the operator fee scalar. <br/> | ||
| **Administrator:** [System Config Owner](../configurability.md#system-config)<br/> | ||
| **Requirement:** <br/> | ||
| **Notes:** <br/> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Isthmus L2 Chain Derivation Changes | ||
|
|
||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
| **Table of Contents** | ||
|
|
||
| - [Network upgrade automation transactions](#network-upgrade-automation-transactions) | ||
|
|
||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| # Network upgrade automation transactions | ||
|
|
||
| The Isthmus hardfork activation block contains the following transactions, in this order: | ||
|
|
||
| - L1 Attributes Transaction | ||
| - User deposits from L1 | ||
| - Network Upgrade Transactions | ||
| - L1Block deployment | ||
| - Update L1Block Proxy ERC-1967 Implementation | ||
| - L1Block Enable Isthmus | ||
| - GasPriceOracle deployment | ||
| - Update GasPriceOracle Proxy ERC-1967 Implementation | ||
| - GasPriceOracle Enable Isthmus | ||
| - OptimismMintableERC20Factory deployment | ||
| - Update OptimismMintableERC20Factory Proxy ERC-1967 Implementation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # L1 Block Attributes | ||
|
|
||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
| **Table of Contents** | ||
|
|
||
| - [Overview](#overview) | ||
|
|
||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| ## Overview | ||
|
|
||
| The L1 block attributes transaction is updated to include the operator fee parameters. | ||
|
|
||
| | Input arg | Type | Calldata bytes | Segment | | ||
| | ----------------- | ------- | -------------- | ------- | | ||
| | {0x098999be} | | 0-3 | n/a | | ||
|
There was a problem hiding this comment. That's the call signature for the function. Those 4 bytes are the first four bytes of There was a problem hiding this comment. Bump on adding this to the spec to make it clear what this is |
||
| | baseFeeScalar | uint32 | 4-7 | 1 | | ||
| | blobBaseFeeScalar | uint32 | 8-11 | | | ||
| | sequenceNumber | uint64 | 12-19 | | | ||
| | l1BlockTimestamp | uint64 | 20-27 | | | ||
| | l1BlockNumber | uint64 | 28-35 | | | ||
| | basefee | uint256 | 36-67 | 2 | | ||
| | blobBaseFee | uint256 | 68-99 | 3 | | ||
| | l1BlockHash | bytes32 | 100-131 | 4 | | ||
| | batcherHash | bytes32 | 132-163 | 5 | | ||
| | operatorFeeScalar | uint32 | 164-167 | 6 | | ||
| | operatorFeeConstant | uint64 | 168-175 | | | ||
|
|
||
| In the first L2 block after the Isthmus activation block, the Isthmus L1 attributes are first used. | ||
|
|
||
| The pre-Isthmus values are migrated over 1:1. | ||
| Blocks after the Isthmus activation block contain all pre-Isthmus values 1:1, | ||
| and also set the following new attributes: | ||
|
|
||
| - The `operatorFeeScalar` is set to `0`. | ||
| - The `operatorFeeConstant` is set to `0`. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
small nit: I think its fine to omit the trailing
()when there is no return arg