YAS 430 OVM gasLimit-proportional burn for rate limiting

packages/contracts/contracts/optimistic-ethereum/chain/CanonicalTransactionChain.sol

@@ -86,7 +86,7 @@ contract CanonicalTransactionChain is ContractResolver {
     {
         return keccak256(abi.encodePacked(
             _batchHeader.timestamp,
-            _batchHeader.isL1ToL2Tx,
+            _batchHeader.isL1ToL2Tx, // TODO REPLACE WITH QUEUE ORIGIN (if you are a PR reviewer please lmk!)
             _batchHeader.elementsMerkleRoot,
             _batchHeader.numElementsInBatch,
             _batchHeader.cumulativePrevElements

packages/contracts/contracts/optimistic-ethereum/ovm/ExecutionManager.sol

@@ -6,6 +6,7 @@ import { L2ToL1MessagePasser } from "./precompiles/L2ToL1MessagePasser.sol";
 import { L1MessageSender } from "./precompiles/L1MessageSender.sol";
 import { StateManager } from "./StateManager.sol";
 import { SafetyChecker } from "./SafetyChecker.sol";
+import { StateManagerGasSanitizer } from "./StateManagerGasSanitizer.sol";
 
 /* Library Imports */
 import { ContractResolver } from "../utils/resolvers/ContractResolver.sol";
@@ -15,6 +16,7 @@ import { RLPWriter } from "../utils/libraries/RLPWriter.sol";
 
 /* Testing Imports */
 import { StubSafetyChecker } from "./test-helpers/StubSafetyChecker.sol";
+import { console } from "@nomiclabs/buidler/console.sol";
 
 /**
  * @title ExecutionManager
@@ -108,7 +110,7 @@ contract ExecutionManager is ContractResolver {
     {
         // Deploy a default state manager
         StateManager stateManager = resolveStateManager();
-
+        
         // Associate all Ethereum precompiles
         for (uint160 i = 1; i < 20; i++) {
             stateManager.associateCodeContract(address(i), address(i));
@@ -241,10 +243,6 @@ contract ExecutionManager is ContractResolver {
         // Set the active contract to be our EOA address
         switchActiveContract(_fromAddress);
 
-        // Do pre-execution gas checks and updates
-        startNewGasEpochIfNecessary(_timestamp);
-        validateTxGasLimit(_ovmTxGasLimit, _queueOrigin);
-
         // Set methodId based on whether we're creating a contract
         bytes32 methodId;
         uint256 callSize;
@@ -287,6 +285,10 @@ contract ExecutionManager is ContractResolver {
             mstore8(add(_callBytes, 3), methodId)
         }
 
+        // Do pre-execution gas checks and updates
+        startNewGasEpochIfNecessary(_timestamp);
+        validateTxGasLimit(_ovmTxGasLimit, _queueOrigin);
+        StateManagerGasSanitizer(address(resolveStateManager())).resetOVMGasRefund();
         // subtract the flat gas fee off the tx gas limit which we will pass as gas
         _ovmTxGasLimit -= gasMeterConfig.OvmTxBaseGasFee;
 
@@ -1022,7 +1024,6 @@ contract ExecutionManager is ContractResolver {
      */
     function ovmEXTCODESIZE()
         public
-        view
     {
         StateManager stateManager = resolveStateManager();
         bytes32 _targetAddressBytes;
@@ -1053,7 +1054,6 @@ contract ExecutionManager is ContractResolver {
      */
     function ovmEXTCODEHASH()
         public
-        view
     {
         StateManager stateManager = resolveStateManager();
         bytes32 _targetAddressBytes;
@@ -1089,7 +1089,6 @@ contract ExecutionManager is ContractResolver {
      */
     function ovmEXTCODECOPY()
         public
-        view
     {
         StateManager stateManager = resolveStateManager();
         bytes32 _targetAddressBytes;
@@ -1147,12 +1146,12 @@ contract ExecutionManager is ContractResolver {
         return executionContext.l1MessageSender;
     }
 
-    function getCumulativeSequencedGas() public view returns(uint) {
-        return uint(StateManager(resolveStateManager()).getStorageView(METADATA_STORAGE_ADDRESS, CUMULATIVE_SEQUENCED_GAS_STORAGE_KEY));
+    function getCumulativeSequencedGas() public returns(uint) {
+        return uint(StateManager(resolveStateManager()).getStorage(METADATA_STORAGE_ADDRESS, CUMULATIVE_SEQUENCED_GAS_STORAGE_KEY));
     }
 
-    function getCumulativeQueuedGas() public view returns(uint) {
-        return uint(StateManager(resolveStateManager()).getStorageView(METADATA_STORAGE_ADDRESS, CUMULATIVE_QUEUED_GAS_STORAGE_KEY));
+    function getCumulativeQueuedGas() public returns(uint) {
+        return uint(StateManager(resolveStateManager()).getStorage(METADATA_STORAGE_ADDRESS, CUMULATIVE_QUEUED_GAS_STORAGE_KEY));
     }
 
     /*
@@ -1226,17 +1225,20 @@ contract ExecutionManager is ContractResolver {
     }
 
     function updateCumulativeGas(uint _gasConsumed) internal {
+        uint refund = StateManagerGasSanitizer(address(resolveStateManager())).getOVMGasRefund();
         if (executionContext.queueOrigin == 0) {
             setCumulativeSequencedGas(
                 getCumulativeSequencedGas()
                 + gasMeterConfig.OvmTxBaseGasFee
                 + _gasConsumed
+                - refund
             );
         } else {
             setCumulativeQueuedGas(
                 getCumulativeQueuedGas()
                 + gasMeterConfig.OvmTxBaseGasFee
                 + _gasConsumed
+                - refund
             );
         }
     }
@@ -1386,56 +1388,67 @@ contract ExecutionManager is ContractResolver {
      * @notice Sets the new cumulative sequenced gas as a result of tx execution.
      */
     function setCumulativeSequencedGas(uint _value) internal {
-        StateManager(resolveStateManager()).setStorage(METADATA_STORAGE_ADDRESS, CUMULATIVE_SEQUENCED_GAS_STORAGE_KEY, bytes32(_value));
+        setMetadataStorageSlot(CUMULATIVE_SEQUENCED_GAS_STORAGE_KEY, bytes32(_value));
     }
 
     /**
      * @notice Sets the new cumulative queued gas as a result of this new tx.
      */
     function setCumulativeQueuedGas(uint _value) internal {
-        StateManager(resolveStateManager()).setStorage(METADATA_STORAGE_ADDRESS, CUMULATIVE_QUEUED_GAS_STORAGE_KEY, bytes32(_value));
+        setMetadataStorageSlot(CUMULATIVE_QUEUED_GAS_STORAGE_KEY, bytes32(_value));
     }
 
     /**
      * @notice Gets what the cumulative sequenced gas was at the start of this gas rate limit epoch.
      */
-    function getGasRateLimitEpochStart() public view returns (uint) {
-        return uint(StateManager(resolveStateManager()).getStorageView(METADATA_STORAGE_ADDRESS, GAS_RATE_LMIT_EPOCH_START_STORAGE_KEY));
+    function getGasRateLimitEpochStart() public returns (uint) {
+        return uint(getMetadataStorageSlot(GAS_RATE_LMIT_EPOCH_START_STORAGE_KEY));
     }
 
     /**
      * @notice Used to store the current time at the start of a new gas rate limit epoch.
      */
     function setGasRateLimitEpochStart(uint _value) internal {
-        StateManager(resolveStateManager()).setStorage(METADATA_STORAGE_ADDRESS, GAS_RATE_LMIT_EPOCH_START_STORAGE_KEY, bytes32(_value));
+        setMetadataStorageSlot(GAS_RATE_LMIT_EPOCH_START_STORAGE_KEY, bytes32(_value));
     }
 
     /**
      * @notice Sets the cumulative sequenced gas at the start of a new gas rate limit epoch.
      */
     function setCumulativeSequencedGasAtEpochStart(uint _value) internal {
-        StateManager(resolveStateManager()).setStorage(METADATA_STORAGE_ADDRESS, CUMULATIVE_SEQUENCED_GAS_AT_EPOCH_START_STORAGE_KEY, bytes32(_value));
+        setMetadataStorageSlot(CUMULATIVE_SEQUENCED_GAS_AT_EPOCH_START_STORAGE_KEY, bytes32(_value));
     }
 
     /**
      * @notice Gets what the cumulative sequenced gas was at the start of this gas rate limit epoch.
      */
-    function getCumulativeSequencedGasAtEpochStart() internal view returns (uint) {
-        return uint(StateManager(resolveStateManager()).getStorageView(METADATA_STORAGE_ADDRESS, CUMULATIVE_SEQUENCED_GAS_AT_EPOCH_START_STORAGE_KEY));
+    function getCumulativeSequencedGasAtEpochStart() internal returns (uint) {
+        return uint(getMetadataStorageSlot(CUMULATIVE_SEQUENCED_GAS_AT_EPOCH_START_STORAGE_KEY));
     }
 
     /**
      * @notice Sets what the cumulative queued gas is at the start of a new gas rate limit epoch.
      */
     function setCumulativeQueuedGasAtEpochStart(uint _value) internal {
-        StateManager(resolveStateManager()).setStorage(METADATA_STORAGE_ADDRESS, CUMULATIVE_QUEUED_GAS_AT_EPOCH_START_STORAGE_KEY, bytes32(_value));
+        setMetadataStorageSlot(CUMULATIVE_QUEUED_GAS_AT_EPOCH_START_STORAGE_KEY, bytes32(_value));
     }
 
     /**
      * @notice Gets the cumulative queued gas was at the start of this gas rate limit epoch.
      */
-    function getCumulativeQueuedGasAtEpochStart() internal view returns (uint) {
-        return uint(StateManager(resolveStateManager()).getStorageView(METADATA_STORAGE_ADDRESS, CUMULATIVE_QUEUED_GAS_AT_EPOCH_START_STORAGE_KEY));
+    function getCumulativeQueuedGasAtEpochStart() internal returns (uint) {
+        return uint(getMetadataStorageSlot(CUMULATIVE_QUEUED_GAS_AT_EPOCH_START_STORAGE_KEY));
+    }
+
+    /**
+     * @notice Gets the OVM slot value for the given key at the METADATA_STORAGE_ADDRESS.
+     */
+    function getMetadataStorageSlot(bytes32 _key) internal returns (bytes32) {
+        return StateManager(resolveStateManager()).getStorage(METADATA_STORAGE_ADDRESS, _key);
+    }
+
+    function setMetadataStorageSlot(bytes32 _key, bytes32 _value) internal {
+        StateManager(resolveStateManager()).setStorage(METADATA_STORAGE_ADDRESS, _key, _value);
     }
 
     /*
@@ -1455,6 +1468,6 @@ contract ExecutionManager is ContractResolver {
         view
         returns (StateManager)
     {
-        return StateManager(resolveContract("StateManager"));
+        return StateManager(resolveContract("StateManagerGasSanitizer"));
     }
 }

packages/contracts/contracts/optimistic-ethereum/ovm/FullStateManager.sol

@@ -188,7 +188,6 @@ contract FullStateManager is StateManager {
         address _ovmContractAddress
     )
         public
-        view
         returns (address)
     {
         return ovmAddressToCodeContractAddress[_ovmContractAddress];
@@ -203,7 +202,6 @@ contract FullStateManager is StateManager {
         address _codeContractAddress
     )
         public
-        view
         returns (address)
     {
         return codeContractAddressToOvmAddress[_codeContractAddress];
@@ -219,7 +217,6 @@ contract FullStateManager is StateManager {
         address _codeContractAddress
     )
         public
-        view
         returns (bytes memory codeContractBytecode)
     {
         assembly {
@@ -246,7 +243,6 @@ contract FullStateManager is StateManager {
         address _codeContractAddress
     )
         public
-        view
         returns (bytes32 _codeContractHash)
     {
         // TODO: Look up cached hash values eventually to avoid having to load all of this bytecode

packages/contracts/contracts/optimistic-ethereum/ovm/PartialStateManager.sol

@@ -4,6 +4,7 @@ pragma experimental ABIEncoderV2;
 import { StateManager } from "./StateManager.sol";
 import { StateTransitioner } from "./StateTransitioner.sol";
 import { ExecutionManager } from "./ExecutionManager.sol";
+import { StateManagerGasSanitizer } from "./StateManagerGasSanitizer.sol";
 
 /* Library Imports */
 import { ContractResolver } from "../utils/resolvers/ContractResolver.sol";
@@ -57,9 +58,9 @@ contract PartialStateManager is ContractResolver {
         _;
     }
 
-    modifier onlyExecutionManager {
-        ExecutionManager executionManager = resolveExecutionManager();
-        require(msg.sender == address(executionManager));
+    modifier onlyStateManagerGasSanitizer {
+        StateManagerGasSanitizer StateManagerGasSanitizer = resolveStateManagerGasSanitizer();
+        require(msg.sender == address(StateManagerGasSanitizer));
         _;
     }
 
@@ -278,7 +279,7 @@ contract PartialStateManager is ContractResolver {
         bytes32 _slot
     )
         public
-        onlyExecutionManager
+        onlyStateManagerGasSanitizer
         returns (bytes32)
     {
         flagIfNotVerifiedStorage(_ovmContractAddress, _slot);
@@ -315,7 +316,7 @@ contract PartialStateManager is ContractResolver {
         bytes32 _value
     )
         public
-        onlyExecutionManager
+        onlyStateManagerGasSanitizer
     {
         if (!storageSlotTouched[_ovmContractAddress][_slot]) {
             updatedStorageSlotContract[updatedStorageSlotCounter] = bytes32(bytes20(_ovmContractAddress));
@@ -342,7 +343,7 @@ contract PartialStateManager is ContractResolver {
         address _ovmContractAddress
     )
         public
-        onlyExecutionManager
+        onlyStateManagerGasSanitizer
         returns (uint)
     {
         flagIfNotVerifiedContract(_ovmContractAddress);
@@ -375,7 +376,7 @@ contract PartialStateManager is ContractResolver {
         uint _value
     )
         public
-        onlyExecutionManager
+        onlyStateManagerGasSanitizer
     {
         // TODO: Figure out if we actually need to verify contracts here.
         //flagIfNotVerifiedContract(_ovmContractAddress);
@@ -398,7 +399,7 @@ contract PartialStateManager is ContractResolver {
         address _ovmContractAddress
     )
         public
-        onlyExecutionManager
+        onlyStateManagerGasSanitizer
     {
         flagIfNotVerifiedContract(_ovmContractAddress);
 
@@ -428,7 +429,7 @@ contract PartialStateManager is ContractResolver {
         address _codeContractAddress
     )
         public
-        onlyExecutionManager
+        onlyStateManagerGasSanitizer
     {
         ovmAddressToCodeContractAddress[_ovmContractAddress] = _codeContractAddress;
     }
@@ -442,7 +443,7 @@ contract PartialStateManager is ContractResolver {
         address _ovmContractAddress
     )
         public
-        onlyExecutionManager
+        onlyStateManagerGasSanitizer
     {
         isVerifiedContract[_ovmContractAddress] = true;
         setOvmContractNonce(_ovmContractAddress, 0);
@@ -472,7 +473,7 @@ contract PartialStateManager is ContractResolver {
         address _ovmContractAddress
     )
         public
-        onlyExecutionManager
+        onlyStateManagerGasSanitizer
         returns(address)
     {
         flagIfNotVerifiedContract(_ovmContractAddress);
@@ -586,10 +587,10 @@ contract PartialStateManager is ContractResolver {
      * Contract Resolution
      */
 
-    function resolveExecutionManager()
+    function resolveStateManagerGasSanitizer()
         internal
-        view returns (ExecutionManager)
+        view returns (StateManagerGasSanitizer)
     {
-        return ExecutionManager(resolveContract("ExecutionManager"));
+        return StateManagerGasSanitizer(resolveContract("StateManagerGasSanitizer"));
     }
 }

packages/contracts/contracts/optimistic-ethereum/ovm/StateManager.sol

@@ -22,10 +22,10 @@ contract StateManager {
     // Contract code storage / contract address retrieval
     function associateCodeContract(address _ovmContractAddress, address _codeContractAddress) public;
     function registerCreatedContract(address _ovmContractAddress) public;
-    function getCodeContractAddressFromOvmAddress(address _ovmContractAddress) external view returns(address);
-    function getOvmAddressFromCodeContractAddress(address _codeContractAddress) external view returns(address);
+    function getCodeContractAddressFromOvmAddress(address _ovmContractAddress) external returns(address);
+    function getOvmAddressFromCodeContractAddress(address _codeContractAddress) external returns(address);
     function getCodeContractBytecode(
         address _codeContractAddress
-    ) public view returns (bytes memory codeContractBytecode);
-    function getCodeContractHash(address _codeContractAddress) external view returns (bytes32 _codeContractHash);
+    ) public returns (bytes memory codeContractBytecode);
+    function getCodeContractHash(address _codeContractAddress) external returns (bytes32 _codeContractHash);
 }