refactor(protocol): additional cleaning up (#13646)

taikoxyz · Apr 25, 2023 · a1fc8b1 · a1fc8b1
1 parent 8ebd2ce
commit a1fc8b1
Show file tree

Hide file tree

Showing 11 changed files with 28 additions and 56 deletions.
diff --git a/packages/protocol/contracts/L1/TaikoData.sol b/packages/protocol/contracts/L1/TaikoData.sol
@@ -32,7 +32,7 @@ library TaikoData {
     }
 
     struct StateVariables {
-        uint64 basefee;
+        uint64 blockFee;
         uint64 accBlockFees;
         uint64 genesisHeight;
         uint64 genesisTimestamp;
@@ -142,7 +142,7 @@ library TaikoData {
         uint64 numBlocks;
         uint64 nextEthDepositToProcess;
         // Slot 9
-        uint64 basefee;
+        uint64 blockFee;
         uint64 proofTimeIssued;
         uint64 lastVerifiedBlockId;
         uint64 __reserved91;

diff --git a/packages/protocol/contracts/L1/TaikoL1.sol b/packages/protocol/contracts/L1/TaikoL1.sol
@@ -35,21 +35,21 @@ contract TaikoL1 is EssentialContract, IXchainSync, TaikoEvents, TaikoErrors {
      *
      * @param _addressManager The AddressManager address.
      * @param _genesisBlockHash The block hash of the genesis block.
-     * @param _initBasefee Initial (reasonable) basefee value.
+     * @param _initBlockFee Initial (reasonable) block fee value.
      * @param _initProofTimeIssued Initial proof time which keeps the inflow/outflow in balance
      */
     function init(
         address _addressManager,
         bytes32 _genesisBlockHash,
-        uint64 _initBasefee,
+        uint64 _initBlockFee,
         uint64 _initProofTimeIssued
     ) external initializer {
         EssentialContract._init(_addressManager);
         LibVerifying.init({
             state: state,
             config: getConfig(),
             genesisBlockHash: _genesisBlockHash,
-            initBasefee: _initBasefee,
+            initBlockFee: _initBlockFee,
             initProofTimeIssued: _initProofTimeIssued
         });
     }
@@ -152,7 +152,7 @@ contract TaikoL1 is EssentialContract, IXchainSync, TaikoEvents, TaikoErrors {
     }
 
     function getBlockFee() public view returns (uint64) {
-        return state.basefee;
+        return state.blockFee;
     }
 
     function getProofReward(

diff --git a/packages/protocol/contracts/L1/libs/LibProposing.sol b/packages/protocol/contracts/L1/libs/LibProposing.sol
@@ -90,12 +90,12 @@ library LibProposing {
         blk.metaHash = LibUtils.hashMetadata(meta);
         blk.proposer = msg.sender;
 
-        if (state.taikoTokenBalances[msg.sender] < state.basefee)
+        if (state.taikoTokenBalances[msg.sender] < state.blockFee)
             revert L1_INSUFFICIENT_TOKEN();
 
         unchecked {
-            state.taikoTokenBalances[msg.sender] -= state.basefee;
-            state.accBlockFees += state.basefee;
+            state.taikoTokenBalances[msg.sender] -= state.blockFee;
+            state.accBlockFees += state.blockFee;
             state.accProposedAt += meta.timestamp;
         }
 

diff --git a/packages/protocol/contracts/L1/libs/LibTokenomics.sol b/packages/protocol/contracts/L1/libs/LibTokenomics.sol
@@ -55,7 +55,7 @@ library LibTokenomics {
     }
 
     /**
-     * Update the baseFee for proofs
+     * Update the block reward for proofs
      *
      * @param state The actual state data
      * @param proofTime The actual proof time
@@ -92,19 +92,19 @@ library LibTokenomics {
     }
 
     /**
-     * Calculate the newProofTimeIssued and newBasefee
+     * Calculate the newProofTimeIssued and BlockFee
      *
      * @param state The actual state data
      * @param config Config data
      * @param proofTime The actual proof time
      * @return newProofTimeIssued Accumulated proof time
-     * @return newBasefee New basefee
+     * @return BlockFee New block fee
      */
-    function getNewBaseFeeandProofTimeIssued(
+    function getNewBlockFeeAndProofTimeIssued(
         TaikoData.State storage state,
         TaikoData.Config memory config,
         uint64 proofTime
-    ) internal view returns (uint64 newProofTimeIssued, uint64 newBasefee) {
+    ) internal view returns (uint64 newProofTimeIssued, uint64 BlockFee) {
         newProofTimeIssued = (state.proofTimeIssued > config.proofTimeTarget)
             ? state.proofTimeIssued - config.proofTimeTarget
             : uint64(0);
@@ -121,33 +121,6 @@ library LibTokenomics {
             Math.SCALING_FACTOR_1E18) /
             (config.proofTimeTarget * config.adjustmentQuotient);
 
-        newBasefee = uint64(result.min(type(uint64).max));
-    }
-
-    /**
-     * Calculating the exponential smoothened with (target/quotient)
-     *
-     * @param value Result of cumulativeProofTime
-     * @param target Target proof time
-     * @param quotient Quotient
-     * @return uint64 Calculated new basefee
-     */
-    function _calcBasefee(
-        uint256 value,
-        uint256 target,
-        uint256 quotient
-    ) private pure returns (uint64) {
-        uint256 x = (value * Math.SCALING_FACTOR_1E18) / (target * quotient);
-
-        if (Math.MAX_EXP_INPUT <= x) {
-            x = Math.MAX_EXP_INPUT;
-        }
-
-        uint256 result = (uint256(Math.exp(int256(x))) /
-            Math.SCALING_FACTOR_1E18) / (target * quotient);
-
-        if (result > type(uint64).max) return type(uint64).max;
-
-        return uint64(result);
+        BlockFee = uint64(result.min(type(uint64).max));
     }
 }
diff --git a/packages/protocol/contracts/L1/libs/LibUtils.sol b/packages/protocol/contracts/L1/libs/LibUtils.sol
@@ -53,7 +53,7 @@ library LibUtils {
     ) internal view returns (TaikoData.StateVariables memory) {
         return
             TaikoData.StateVariables({
-                basefee: state.basefee,
+                blockFee: state.blockFee,
                 accBlockFees: state.accBlockFees,
                 genesisHeight: state.genesisHeight,
                 genesisTimestamp: state.genesisTimestamp,

diff --git a/packages/protocol/contracts/L1/libs/LibVerifying.sol b/packages/protocol/contracts/L1/libs/LibVerifying.sol
@@ -33,7 +33,7 @@ library LibVerifying {
         TaikoData.State storage state,
         TaikoData.Config memory config,
         bytes32 genesisBlockHash,
-        uint64 initBasefee,
+        uint64 initBlockFee,
         uint64 initProofTimeIssued
     ) internal {
         if (
@@ -61,7 +61,7 @@ library LibVerifying {
         state.genesisHeight = uint64(block.number);
         state.genesisTimestamp = timeNow;
 
-        state.basefee = initBasefee;
+        state.blockFee = initBlockFee;
         state.proofTimeIssued = initProofTimeIssued;
         state.numBlocks = 1;
 
@@ -160,8 +160,8 @@ library LibVerifying {
 
         uint64 reward = LibTokenomics.getProofReward(state, proofTime);
 
-        (state.proofTimeIssued, state.basefee) = LibTokenomics
-            .getNewBaseFeeandProofTimeIssued(state, config, proofTime);
+        (state.proofTimeIssued, state.blockFee) = LibTokenomics
+            .getNewBlockFeeAndProofTimeIssued(state, config, proofTime);
 
         unchecked {
             state.accBlockFees -= reward;

diff --git a/packages/protocol/contracts/L2/TaikoL2.sol b/packages/protocol/contracts/L2/TaikoL2.sol
@@ -191,7 +191,8 @@ contract TaikoL2 is EssentialContract, TaikoL2Signer, IXchainSync {
         }
 
         // On L2, basefee is not burnt, but sent to a treasure instead.
-        // TODO(daniel): how to verify the tresasure address in protocol?
+        // The circuits will need to verify the basefee recipient is the deginated
+        // address.
         if (block.basefee != basefee)
             revert L2_BASEFEE_MISMATCH(uint64(basefee), uint64(block.basefee));
 

diff --git a/packages/protocol/test/TaikoL1.sim.sol b/packages/protocol/test/TaikoL1.sim.sol
@@ -131,7 +131,7 @@ contract TaikoL1Simulation is TaikoL1TestBase, FoundryRandom {
             "time,",
             "lastVerifiedBlockId,",
             "numBlocks,",
-            "baseFee,",
+            "blockFee,",
             "accProposedAt"
         );
         console2.log(str);
@@ -149,7 +149,7 @@ contract TaikoL1Simulation is TaikoL1TestBase, FoundryRandom {
             ",",
             Strings.toString(vars.numBlocks),
             ",",
-            Strings.toString(vars.basefee),
+            Strings.toString(vars.blockFee),
             ",",
             Strings.toString(vars.accProposedAt)
         );

diff --git a/packages/protocol/test/TaikoL1.t.sol b/packages/protocol/test/TaikoL1.t.sol
@@ -249,7 +249,6 @@ contract TaikoL1Test is TaikoL1TestBase {
         uint256 iterationCnt = 10;
         // Declare here so that block prop/prove/verif. can be used in 1 place
         TaikoData.BlockMetadata memory meta;
-        TaikoData.ForkChoice memory fk;
         bytes32 blockHash;
         bytes32 signalRoot;
         bytes32[] memory parentHashes = new bytes32[](iterationCnt);

diff --git a/packages/website/pages/docs/reference/contract-documentation/L1/TaikoData.md b/packages/website/pages/docs/reference/contract-documentation/L1/TaikoData.md
@@ -11,7 +11,6 @@ struct Config {
   uint256 chainId;
   uint256 maxNumProposedBlocks;
   uint256 ringBufferSize;
-  uint256 maxNumVerifiedBlocks;
   uint256 maxVerificationsPerTx;
   uint256 blockMaxGasLimit;
   uint256 maxTransactionsPerBlock;
@@ -35,7 +34,7 @@ struct Config {
 
 ```solidity
 struct StateVariables {
-  uint64 basefee;
+  uint64 blockFee;
   uint64 accBlockFees;
   uint64 genesisHeight;
   uint64 genesisTimestamp;
@@ -163,7 +162,7 @@ struct State {
   uint64 accBlockFees;
   uint64 numBlocks;
   uint64 nextEthDepositToProcess;
-  uint64 basefee;
+  uint64 blockFee;
   uint64 proofTimeIssued;
   uint64 lastVerifiedBlockId;
   uint64 __reserved91;

diff --git a/packages/website/pages/docs/reference/contract-documentation/L1/TaikoL1.md b/packages/website/pages/docs/reference/contract-documentation/L1/TaikoL1.md
@@ -19,7 +19,7 @@ receive() external payable
 ### init
 
 ```solidity
-function init(address _addressManager, bytes32 _genesisBlockHash, uint64 _initBasefee, uint64 _initProofTimeIssued) external
+function init(address _addressManager, bytes32 _genesisBlockHash, uint64 _initBlockFee, uint64 _initProofTimeIssued) external
 ```
 
 Initialize the rollup.
@@ -30,7 +30,7 @@ Initialize the rollup.
 | --------------------- | ------- | ------------------------------------------------------------ |
 | \_addressManager      | address | The AddressManager address.                                  |
 | \_genesisBlockHash    | bytes32 | The block hash of the genesis block.                         |
-| \_initBasefee         | uint64  | Initial (reasonable) basefee value.                          |
+| \_initBlockFee        | uint64  | Initial (reasonable) block fee value.                        |
 | \_initProofTimeIssued | uint64  | Initial proof time which keeps the inflow/outflow in balance |
 
 ### proposeBlock