feat: deployment config for fee oracle contract

.changeset/seven-carpets-tell.md

@@ -0,0 +1,5 @@
+---
+'@eth-optimism/contracts': patch
+---
+
+Introduces the congestion price oracle contract

packages/contracts/contracts/optimistic-ethereum/OVM/predeploys/OVM_GasPriceOracle.sol

@@ -0,0 +1,75 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >0.5.0 <0.8.0;
+
+/* External Imports */
+import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
+
+/**
+ * @title OVM_GasPriceOracle
+ * @dev This contract exposes the current execution price, a measure of how congested the network
+ * currently is. This measure is used by the Sequencer to determine what fee to charge for
+ * transactions. When the system is more congested, the execution price will increase and fees
+ * will also increase as a result.
+ *
+ * Compiler used: optimistic-solc
+ * Runtime target: OVM
+ */
+contract OVM_GasPriceOracle is Ownable {
+
+    /*************
+     * Variables *
+     *************/
+
+    // Current execution price
+    uint256 public executionPrice;
+
+    /*************
+     * Constants *
+     *************/
+    uint256 public constant EXECUTION_PRICE_MULTIPLE = 100000000;
+
+    /***************
+     * Constructor *
+     ***************/
+
+    /**
+     * @param _owner Address that will initially own this contract.
+     */
+    constructor(
+        address _owner,
+        uint256 _initialExecutionPrice
+    )
+        Ownable()
+    {
+        setExecutionPrice(_initialExecutionPrice);
+        transferOwnership(_owner);
+    }
+
+
+    /********************
+     * Public Functions *
+     ********************/
+
+    /**
+     * Allows the owner to modify the execution price.
+     * @param _executionPrice New execution price.
+     */
+    function setExecutionPrice(
+        uint256 _executionPrice
+    )
+        public
+        onlyOwner
+    {
+        require(
+            _executionPrice != 0,
+            "OVM_GasPriceOracle: execution price must not be zero"
+        );
+
+        require(
+            _executionPrice % EXECUTION_PRICE_MULTIPLE == 1,
+            "OVM_GasPriceOracle: execution price must satisfy x % (10**8) == 1"
+        );
+
+        executionPrice = _executionPrice;
+    }
+}

packages/contracts/deploy-l2/000-OVM_GasPriceOracle.deploy.ts

@@ -0,0 +1,31 @@
+/* Imports: External */
+import { DeployFunction } from 'hardhat-deploy/dist/types'
+
+/* Imports: Internal */
+import { getContractDefinition } from '../src'
+
+const deployFn: DeployFunction = async (hre: any) => {
+  const { deployments, getNamedAccounts } = hre
+  const { deploy } = deployments
+  const { deployer } = await getNamedAccounts()
+
+  const gasPriceOracle = getContractDefinition('OVM_GasPriceOracle', true)
+
+  const gasOracleOwner = (hre as any).deployConfig.ovmSequencerAddress
+  const initialGasPrice = (hre as any).deployConfig.initialGasPriceOracleGasPrice
+
+  if (!gasOracleOwner || !initialGasPrice) {
+    throw new Error('initialGasPrice & ovmSequencerAddress required to deploy gas price oracle')
+  }
+
+  await deploy('OVM_GasPriceOracle', {
+    contract: gasPriceOracle,
+    from: deployer,
+    args: [gasOracleOwner, initialGasPrice],
+    log: true,
+  });
+}
+
+deployFn.tags = ['OVM_GasPriceOracle']
+
+export default deployFn

packages/contracts/deployments/README.md

@@ -1,6 +1,15 @@
 # Optimism Regenesis Deployments
 ## LAYER 2
 
+## OPTIMISTIC-KOVAN
+
+Network : __optimistic-kovan (chain id: 69)__
+
+|Contract|Address|
+|--|--|
+|OVM_GasPriceOracle|[0xFb3593931f0160476b942003c6F5A4AC7e3f49E4](https://kovan-optimistic.etherscan.io/address/0xFb3593931f0160476b942003c6F5A4AC7e3f49E4)|
+---
+
 ### Chain IDs:
 - Mainnet: 10
 - Kovan: 69

packages/contracts/deployments/optimistic-kovan/.chainId

@@ -0,0 +1 @@
+69

packages/contracts/deployments/optimistic-kovan/OVM_GasPriceOracle.json

@@ -0,0 +1,177 @@
+{
+  "address": "0xFb3593931f0160476b942003c6F5A4AC7e3f49E4",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "_owner",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "_initialExecutionPrice",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "nonpayable",
+      "type": "constructor"
+    },
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": true,
+          "internalType": "address",
+          "name": "previousOwner",
+          "type": "address"
+        },
+        {
+          "indexed": true,
+          "internalType": "address",
+          "name": "newOwner",
+          "type": "address"
+        }
+      ],
+      "name": "OwnershipTransferred",
+      "type": "event"
+    },
+    {
+      "inputs": [],
+      "name": "EXECUTION_PRICE_MULTIPLE",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "executionPrice",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "owner",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "renounceOwnership",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "_executionPrice",
+          "type": "uint256"
+        }
+      ],
+      "name": "setExecutionPrice",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "newOwner",
+          "type": "address"
+        }
+      ],
+      "name": "transferOwnership",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    }
+  ],
+  "transactionHash": "0xdc9dfeb2d1fe8ac9233a3f4c3181e9721beafac4768821004b815885d8bb5642",
+  "receipt": {
+    "to": null,
+    "from": "0xd033f09cB85621F98F7A84C64dB381ac16Eff818",
+    "contractAddress": "0xFb3593931f0160476b942003c6F5A4AC7e3f49E4",
+    "transactionIndex": 0,
+    "gasUsed": "1376043",
+    "logsBloom": "0x00000020000000000000000000000040000000000000000000840000000000000000000000000000000000100000000000000000000000040000000000000000000000000000000000000008000000000001000010000000000000000000000400000000020080000000000000008800000000000000000000000010000000400000000000000000000000000000000000000000002000000000000000000000000000000000000000010000000000020000000000000000000000000000000000008002000000000000000000000000000000000000000000000000000060000000000000000000000000000000000001000000000000000000000000000000",
+    "blockHash": "0x8af40bd1c0a0573d94e75a13259e8d76605536d834063ad1da80b50c615c5317",
+    "transactionHash": "0xdc9dfeb2d1fe8ac9233a3f4c3181e9721beafac4768821004b815885d8bb5642",
+    "logs": [
+      {
+        "transactionIndex": 0,
+        "blockNumber": 184144,
+        "transactionHash": "0xdc9dfeb2d1fe8ac9233a3f4c3181e9721beafac4768821004b815885d8bb5642",
+        "address": "0x4200000000000000000000000000000000000006",
+        "topics": [
+          "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
+          "0x000000000000000000000000d033f09cb85621f98f7a84c64db381ac16eff818",
+          "0x0000000000000000000000004200000000000000000000000000000000000005"
+        ],
+        "data": "0x0000000000000000000000000000000000000000000000000000000000000000",
+        "logIndex": 0,
+        "blockHash": "0x8af40bd1c0a0573d94e75a13259e8d76605536d834063ad1da80b50c615c5317"
+      },
+      {
+        "transactionIndex": 0,
+        "blockNumber": 184144,
+        "transactionHash": "0xdc9dfeb2d1fe8ac9233a3f4c3181e9721beafac4768821004b815885d8bb5642",
+        "address": "0xFb3593931f0160476b942003c6F5A4AC7e3f49E4",
+        "topics": [
+          "0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0",
+          "0x0000000000000000000000000000000000000000000000000000000000000000",
+          "0x000000000000000000000000d033f09cb85621f98f7a84c64db381ac16eff818"
+        ],
+        "data": "0x",
+        "logIndex": 1,
+        "blockHash": "0x8af40bd1c0a0573d94e75a13259e8d76605536d834063ad1da80b50c615c5317"
+      },
+      {
+        "transactionIndex": 0,
+        "blockNumber": 184144,
+        "transactionHash": "0xdc9dfeb2d1fe8ac9233a3f4c3181e9721beafac4768821004b815885d8bb5642",
+        "address": "0xFb3593931f0160476b942003c6F5A4AC7e3f49E4",
+        "topics": [
+          "0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0",
+          "0x000000000000000000000000d033f09cb85621f98f7a84c64db381ac16eff818",
+          "0x00000000000000000000000018394b52d3cb931dfa76f63251919d051953413d"
+        ],
+        "data": "0x",
+        "logIndex": 2,
+        "blockHash": "0x8af40bd1c0a0573d94e75a13259e8d76605536d834063ad1da80b50c615c5317"
+      }
+    ],
+    "blockNumber": 184144,
+    "cumulativeGasUsed": "1376043",
+    "status": 1,
+    "byzantium": true
+  },
+  "args": [
+    "0x18394B52d3Cb931dfA76F63251919D051953413d",
+    100000001
+  ],
+  "bytecode": "0x60806040523480156200001c57600080620000196200033c565b50505b5060405162000bb838038062000bb8833981810160405260408110156200004d576000806200004a6200033c565b50505b81019080805192919060200180519250600091506200006d9050620000ec565b90508060006001816200007f620003a9565b816001600160a01b0302191690836001600160a01b0316021790620000a36200040b565b5050506001600160a01b038116600060008051602062000b9883398151915260405160405180910390a350620000d981620000fe565b620000e482620001d6565b5050620004a1565b60005a620000f96200045a565b905090565b62000108620000ec565b6001600160a01b03166200011b62000319565b6001600160a01b031614620001705760405162461bcd60e51b8152602060048201819052602482015260008051602062000b788339815191526044820152606401604051809103906200016d6200033c565b50505b6305f5e1008106600114620001c25760405162461bcd60e51b815260040180806020018281038252604581526020018062000b336045913960600191505060405180910390620001bf6200033c565b50505b80806001620001d06200040b565b50505050565b620001e0620000ec565b6001600160a01b0316620001f362000319565b6001600160a01b031614620002485760405162461bcd60e51b8152602060048201819052602482015260008051602062000b78833981519152604482015260640160405180910390620002456200033c565b50505b6001600160a01b0381166200029a5760405162461bcd60e51b815260040180806020018281038252602681526020018062000b0d6026913960400191505060405180910390620002976200033c565b50505b806001600160a01b0316600080620002b1620003a9565b906101000a90046001600160a01b03166001600160a01b031660008051602062000b9883398151915260405160405180910390a3806000600181620002f5620003a9565b816001600160a01b0302191690836001600160a01b0316021790620001d06200040b565b6000808062000327620003a9565b906101000a90046001600160a01b0316905090565b632a2a7adb598160e01b8152600481016020815285602082015260005b868110156200037657808601518282016040015260200162000359565b506020828760640184336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b505050565b6303daa959598160e01b8152836004820152602081602483336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b8051935060005b60408110156200040657600082820152602001620003ed565b505050565b6322bd64c0598160e01b8152836004820152846024820152600081604483336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b600081526020620003ed565b6373509064598160e01b8152602081600483336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b80516000825293506020620003ed565b61065c80620004b16000396000f3fe608060405234801561001957600080610016610496565b50505b506004361061006b5760003560e01c80632ba10eac14610079578063494b489b14610093578063715018a61461009b5780638da5cb5b146100a5578063ee6d2073146100c9578063f2fde38b146100ef575b600080610076610496565b50505b61008161011e565b60405190815260200160405180910390f35b610081610126565b6100a3610133565b005b6100ad610235565b6040516001600160a01b03909116815260200160405180910390f35b6100a3600480360360208110156100e8576000806100e5610496565b50505b5035610256565b6100a36004803603602081101561010e5760008061010b610496565b50505b50356001600160a01b0316610332565b6305f5e10081565b6001610130610501565b81565b61013b610486565b6001600160a01b031661014c610235565b6001600160a01b0316146101af5760405162461bcd60e51b815260206004820181905260248201527f4f776e61626c653a2063616c6c6572206973206e6f7420746865206f776e65726044820152606401604051809103906101ac610496565b50505b600080806101bb610501565b906101000a90046001600160a01b03166001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a360008060018161020e610501565b816001600160a01b0302191690836001600160a01b031602179061023061055c565b505050565b60008080610241610501565b906101000a90046001600160a01b0316905090565b61025e610486565b6001600160a01b031661026f610235565b6001600160a01b0316146102d25760405162461bcd60e51b815260206004820181905260248201527f4f776e61626c653a2063616c6c6572206973206e6f7420746865206f776e65726044820152606401604051809103906102cf610496565b50505b6305f5e10081066001146103205760405162461bcd60e51b8152600401808060200182810382526045815260200180610617604591396060019150506040518091039061031d610496565b50505b8080600161032c61055c565b50505050565b61033a610486565b6001600160a01b031661034b610235565b6001600160a01b0316146103ae5760405162461bcd60e51b815260206004820181905260248201527f4f776e61626c653a2063616c6c6572206973206e6f7420746865206f776e65726044820152606401604051809103906103ab610496565b50505b6001600160a01b0381166103fc5760405162461bcd60e51b81526004018080602001828103825260268152602001806105f160269139604001915050604051809103906103f9610496565b50505b806001600160a01b0316600080610411610501565b906101000a90046001600160a01b03166001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000600181610464610501565b816001600160a01b0302191690836001600160a01b031602179061032c61055c565b60005a6104916105aa565b905090565b632a2a7adb598160e01b8152600481016020815285602082015260005b868110156104ce5780860151828201604001526020016104b3565b506020828760640184336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b505050565b6303daa959598160e01b8152836004820152602081602483336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b8051935060005b604081101561023057600082820152602001610545565b6322bd64c0598160e01b8152836004820152846024820152600081604483336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b600081526020610545565b6373509064598160e01b8152602081600483336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b8051600082529350602061054556fe4f776e61626c653a206e6577206f776e657220697320746865207a65726f2061646472657373457865637574696f6e207072696365206d757374207361746973667920607072696365202520455845435554494f4e5f50524943455f4d554c5449504c45203d3d2031602e4f776e61626c653a206e6577206f776e657220697320746865207a65726f2061646472657373457865637574696f6e207072696365206d757374207361746973667920607072696365202520455845435554494f4e5f50524943455f4d554c5449504c45203d3d2031602e4f776e61626c653a2063616c6c6572206973206e6f7420746865206f776e65728be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0",
+  "deployedBytecode": "0x608060405234801561001957600080610016610496565b50505b506004361061006b5760003560e01c80632ba10eac14610079578063494b489b14610093578063715018a61461009b5780638da5cb5b146100a5578063ee6d2073146100c9578063f2fde38b146100ef575b600080610076610496565b50505b61008161011e565b60405190815260200160405180910390f35b610081610126565b6100a3610133565b005b6100ad610235565b6040516001600160a01b03909116815260200160405180910390f35b6100a3600480360360208110156100e8576000806100e5610496565b50505b5035610256565b6100a36004803603602081101561010e5760008061010b610496565b50505b50356001600160a01b0316610332565b6305f5e10081565b6001610130610501565b81565b61013b610486565b6001600160a01b031661014c610235565b6001600160a01b0316146101af5760405162461bcd60e51b815260206004820181905260248201527f4f776e61626c653a2063616c6c6572206973206e6f7420746865206f776e65726044820152606401604051809103906101ac610496565b50505b600080806101bb610501565b906101000a90046001600160a01b03166001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a360008060018161020e610501565b816001600160a01b0302191690836001600160a01b031602179061023061055c565b505050565b60008080610241610501565b906101000a90046001600160a01b0316905090565b61025e610486565b6001600160a01b031661026f610235565b6001600160a01b0316146102d25760405162461bcd60e51b815260206004820181905260248201527f4f776e61626c653a2063616c6c6572206973206e6f7420746865206f776e65726044820152606401604051809103906102cf610496565b50505b6305f5e10081066001146103205760405162461bcd60e51b8152600401808060200182810382526045815260200180610617604591396060019150506040518091039061031d610496565b50505b8080600161032c61055c565b50505050565b61033a610486565b6001600160a01b031661034b610235565b6001600160a01b0316146103ae5760405162461bcd60e51b815260206004820181905260248201527f4f776e61626c653a2063616c6c6572206973206e6f7420746865206f776e65726044820152606401604051809103906103ab610496565b50505b6001600160a01b0381166103fc5760405162461bcd60e51b81526004018080602001828103825260268152602001806105f160269139604001915050604051809103906103f9610496565b50505b806001600160a01b0316600080610411610501565b906101000a90046001600160a01b03166001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000600181610464610501565b816001600160a01b0302191690836001600160a01b031602179061032c61055c565b60005a6104916105aa565b905090565b632a2a7adb598160e01b8152600481016020815285602082015260005b868110156104ce5780860151828201604001526020016104b3565b506020828760640184336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b505050565b6303daa959598160e01b8152836004820152602081602483336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b8051935060005b604081101561023057600082820152602001610545565b6322bd64c0598160e01b8152836004820152846024820152600081604483336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b600081526020610545565b6373509064598160e01b8152602081600483336000905af158600e01573d6000803e3d6000fd5b3d6001141558600a015760016000f35b8051600082529350602061054556fe4f776e61626c653a206e6577206f776e657220697320746865207a65726f2061646472657373457865637574696f6e207072696365206d757374207361746973667920607072696365202520455845435554494f4e5f50524943455f4d554c5449504c45203d3d2031602e"
+}

packages/contracts/tasks/deploy.ts

@@ -99,6 +99,12 @@ task('deploy')
     undefined,
     types.string
   )
+  .addOptionalParam(
+    'initialGasPriceOracleGasPrice',
+    'The initial execution price for the gas price oracle.',
+    undefined,
+    types.int
+  )
   .setAction(async (args, hre: any, runSuper) => {
     // Necessary because hardhat doesn't let us attach non-optional parameters to existing tasks.
     const validateAddressArg = (argName: string) => {