Store routes. (#50)

Author: dvc94ch

src/Gateway.sol

@@ -94,21 +94,6 @@ contract Gateway is IGateway, IExecutor, IUpgradable, GatewayEIP712 {
 
     constructor(uint16 network, address proxy) payable GatewayEIP712(network, proxy) {}
 
-    // EIP-712 typed hash
-    function initialize(address proxyAdmin, TssKey[] calldata keys, Network[] calldata networks) external {
-        require(PROXY_ADDRESS == address(this) || msg.sender == FACTORY, "only proxy can be initialize");
-        ERC1967.setAdmin(proxyAdmin);
-
-        // Register networks
-        RouteStore.getMainStorage().initialize(networks, NetworkID.wrap(NETWORK_ID));
-
-        // Register keys
-        ShardStore.getMainStorage().registerTssKeys(keys);
-
-        // emit event
-        emit ShardsRegistered(keys);
-    }
-
     function nonceOf(address account) external view returns (uint64) {
         return uint64(_nonces[account]);
     }
@@ -591,13 +576,6 @@ contract Gateway is IGateway, IExecutor, IUpgradable, GatewayEIP712 {
         return route.estimateWeiCost(uint16(messageSize), gasLimit);
     }
 
-    /**
-     * Deposit funds to the gateway contract
-     * IMPORTANT: this function must be called only by the administrator!!!!
-     */
-    function deposit() external payable {}
-    receive() external payable {}
-
     /**
      * Withdraw funds from the gateway contract
      * @param amount The amount to withdraw
@@ -784,33 +762,4 @@ contract Gateway is IGateway, IExecutor, IUpgradable, GatewayEIP712 {
             prev = key;
         }
     }
-
-    function upgrade(address newImplementation) external payable {
-        require(msg.sender == ERC1967.getAdmin(), "unauthorized");
-
-        // Store the address of the implementation contract
-        ERC1967.setImplementation(newImplementation);
-    }
-
-    function upgradeAndCall(address newImplementation, bytes memory initializer)
-        external
-        payable
-        returns (bytes memory returndata)
-    {
-        require(msg.sender == ERC1967.getAdmin(), "unauthorized");
-
-        // Store the address of the implementation contract
-        ERC1967.setImplementation(newImplementation);
-
-        // Initialize storage by calling the implementation's using `delegatecall`.
-        bool success;
-        (success, returndata) = newImplementation.delegatecall(initializer);
-
-        // Revert if the initialization failed
-        if (!success) {
-            assembly ("memory-safe") {
-                revert(add(returndata, 32), mload(returndata))
-            }
-        }
-    }
 }

src/GatewayProxy.sol

@@ -4,14 +4,8 @@
 pragma solidity >=0.8.0;
 
 import {ERC1967} from "./utils/ERC1967.sol";
-import {Context, CreateKind, IUniversalFactory} from "../lib/universal-factory/src/IUniversalFactory.sol";
 
 contract GatewayProxy {
-    /**
-     * @dev The address of the `UniversalFactory` contract, must be the same on all networks.
-     */
-    IUniversalFactory internal constant FACTORY = IUniversalFactory(0x0000000000001C4Bf962dF86e38F0c10c7972C6E);
-
     /**
      * @dev EIP-1967 storage slot with the address of the current implementation.
      * This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1.
@@ -20,33 +14,19 @@ contract GatewayProxy {
     bytes32 private constant IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
 
     constructor(address admin) payable {
-        // This contract must be deployed by the `UniversalFactory`
-        Context memory ctx = FACTORY.context();
-        require(ctx.contractAddress == address(this), "Only the UniversalFactory can deploy this contract");
-        require(ctx.kind == CreateKind.CREATE2, "Only CREATE2 is allowed");
-
-        require(ctx.data.length > 0, "ctx.data cannot be empty length");
-        require(ctx.data.length >= 128, "unexpected ctx.data format, expected 128 bytes");
-
-        // Store the address of the implementation contract
-        // DeploymentAuthorization memory authorization;
-        uint8 v;
-        bytes32 r;
-        bytes32 s;
-        address implementation;
-        (v, r, s, implementation) = abi.decode(ctx.data, (uint8, bytes32, bytes32, address));
-
-        // Verify the signature
-        bytes32 digest = keccak256(abi.encode(address(this), implementation));
-        require(admin == ecrecover(digest, v, r, s), "invalid signature");
-
         // Set the ERC1967 admin.
         ERC1967.setAdmin(admin);
+    }
 
-        // Set the ERC1967 implementation.
-        ERC1967.setImplementation(implementation);
+    function upgrade(address newImplementation) external payable {
+        require(msg.sender == ERC1967.getAdmin(), "unauthorized");
+
+        // Store the address of the implementation contract
+        ERC1967.setImplementation(newImplementation);
     }
 
+    receive() external payable {}
+
     fallback() external payable {
         assembly ("memory-safe") {
             // Copy the calldata to memory

test/utils/GmpProxy.sol renamed to src/GmpProxy.sol

@@ -30,23 +30,27 @@ library RouteStore {
     /**
      * @dev Network info stored in the Gateway Contract
      * @param gasLimit The maximum amount of gas we allow on this particular network.
-     * @param relativeGasPrice Gas price of destination chain, in terms of the source chain token.
+     * @param relativeGasPriceNumerator Gas price of destination chain, in terms of the source chain token.
+     * @param relativeGasPriceDenominator Gas price of destination chain, in terms of the source chain token.
      * @param baseFee Base fee for cross-chain message approval on destination, in terms of source native gas token.
      */
     struct NetworkInfo {
+        bytes32 gateway;
         uint64 gasLimit;
-        UFloat9x56 relativeGasPrice;
         uint128 baseFee;
+        uint256 relativeGasPriceNumerator;
+        uint256 relativeGasPriceDenominator;
     }
 
     /**
      * @dev Emitted when a route is updated.
      * @param networkId Network identifier.
-     * @param relativeGasPrice Gas price of destination chain, in terms of the source chain token.
+     * @param relativeGasPriceNumerator Gas price of destination chain, in terms of the source chain token.
+     * @param relativeGasPriceDenominator Gas price of destination chain, in terms of the source chain token.
      * @param baseFee Base fee for cross-chain message approval on destination, in terms of source native gas token.
      * @param gasLimit The maximum amount of gas we allow on this particular network.
      */
-    event RouteUpdated(uint16 indexed networkId, UFloat9x56 relativeGasPrice, uint128 baseFee, uint64 gasLimit);
+    event RouteUpdated(uint16 indexed networkId, uint256 relativeGasPriceNumerator, uint256 relativeGasPriceDenominator, uint128 baseFee, uint64 gasLimit);
 
     /**
      * @dev Shard info stored in the Gateway Contract
@@ -169,13 +173,12 @@ library RouteStore {
 
         // Update relative gas price and base fee if any of them are greater than zero
         if (route.relativeGasPriceDenominator > 0) {
-            UFloat9x56 relativeGasPrice =
-                UFloatMath.fromRational(route.relativeGasPriceNumerator, route.relativeGasPriceDenominator);
-            stored.relativeGasPrice = relativeGasPrice;
+            stored.relativeGasPriceNumerator = route.relativeGasPriceNumerator;
+            stored.relativeGasPriceDenominator = route.relativeGasPriceDenominator;
             stored.baseFee = route.baseFee;
         }
 
-        emit RouteUpdated(route.networkId.asUint(), stored.relativeGasPrice, stored.baseFee, stored.gasLimit);
+        emit RouteUpdated(route.networkId.asUint(), stored.relativeGasPriceNumerator, stored.relativeGasPriceDenominator, stored.baseFee, stored.gasLimit);
     }
 
     /**
@@ -191,7 +194,8 @@ library RouteStore {
             require(created, "network already initialized");
             require(network.id != networkdID.asUint() || network.gateway == address(this), "wrong gateway address");
             info.gasLimit = 15_000_000; // Default to 15M gas
-            info.relativeGasPrice = UFloatMath.ONE;
+            info.relativeGasPriceNumerator = 1;
+            info.relativeGasPriceDenominator = 1;
             info.baseFee = 0;
         }
     }
@@ -208,16 +212,16 @@ library RouteStore {
         bytes32[] memory idx = store.routes.keys;
         Route[] memory routes = new Route[](idx.length);
         for (uint256 i = 0; i < idx.length; i++) {
-            (bool success, NetworkInfo storage route) = tryGet(store, NetworkID.wrap(uint16(uint256(idx[i]))));
+            NetworkID networkId = NetworkID.wrap(uint16(uint256(idx[i])));
+            (bool success, NetworkInfo storage route) = tryGet(store, networkId);
             require(success, "route not found");
-            (uint256 numerator, uint256 denominator) = route.relativeGasPrice.toRational();
             routes[i] = Route({
-                networkId: NetworkID.wrap(uint16(uint256(idx[i]))),
+                networkId: networkId,
                 gasLimit: route.gasLimit,
                 baseFee: route.baseFee,
-                gateway: bytes32(uint256(uint160(address(this)))),
-                relativeGasPriceNumerator: numerator,
-                relativeGasPriceDenominator: denominator
+                gateway: route.gateway,
+                relativeGasPriceNumerator: route.relativeGasPriceNumerator,
+                relativeGasPriceDenominator: route.relativeGasPriceDenominator
             });
         }
         return routes;
@@ -228,7 +232,7 @@ library RouteStore {
      */
     function _checkPreconditions(NetworkInfo memory route, uint256 messageSize, uint256 gasLimit) private pure {
         // Verify if the network exists
-        require(route.baseFee > 0 || UFloat9x56.unwrap(route.relativeGasPrice) > 0, "route is temporarily disabled");
+        require(route.baseFee > 0 || route.relativeGasPriceDenominator > 0, "route is temporarily disabled");
 
         // Verify if the gas limit and message size are within the limits
         require(gasLimit <= route.gasLimit, "gas limit exceeded");
@@ -254,22 +258,7 @@ library RouteStore {
         gasCost = GasUtils.estimateGas(uint16(nonZeros), uint16(zeros), gasLimit);
 
         // Calculate the gas cost: gasPrice * gasCost + baseFee
-        fee = UFloatMath.saturatingMul(route.relativeGasPrice, gasCost).saturatingAdd(route.baseFee);
-    }
-
-    /**
-     * @dev Utility function for measure the wei cost of a GMP message.
-     */
-    function estimateWeiCost(NetworkInfo memory route, bytes calldata data, uint256 gasLimit)
-        internal
-        pure
-        returns (uint256)
-    {
-        _checkPreconditions(route, data.length, gasLimit);
-        uint256 nonZeros = GasUtils.countNonZerosCalldata(data);
-        uint256 zeros = data.length - nonZeros;
-        return
-            GasUtils.estimateWeiCost(route.relativeGasPrice, route.baseFee, uint16(nonZeros), uint16(zeros), gasLimit);
+        fee = route.relativeGasPriceNumerator.saturatingMul(gasCost).saturatingDiv(route.relativeGasPriceDenominator).saturatingAdd(route.baseFee);
     }
 
     /**
@@ -281,6 +270,9 @@ library RouteStore {
         returns (uint256)
     {
         _checkPreconditions(route, messageSize, gasLimit);
-        return GasUtils.estimateWeiCost(route.relativeGasPrice, route.baseFee, uint16(messageSize), 0, gasLimit);
+
+        UFloat9x56 relativeGasPrice =
+            UFloatMath.fromRational(route.relativeGasPriceNumerator, route.relativeGasPriceDenominator);
+        return GasUtils.estimateWeiCost(relativeGasPrice, route.baseFee, uint16(messageSize), 0, gasLimit);
     }
 }

src/storage/Routes.sol

@@ -38,23 +38,23 @@ library GasUtils {
      * Obs: To guarantee the overhead is constant regardless the input size, always use `calldata` instead of `memory`
      * for external functions.
      */
-    uint256 internal constant EXECUTION_SELECTOR_OVERHEAD = 496;
+    uint256 internal constant EXECUTION_SELECTOR_OVERHEAD = 496 - 44;
 
     /**
      * @dev Base cost of the `IExecutor.execute` method.
      */
-    uint256 internal constant EXECUTION_BASE_COST = EXECUTION_SELECTOR_OVERHEAD + 46960 + 144;
+    uint256 internal constant EXECUTION_BASE_COST = EXECUTION_SELECTOR_OVERHEAD + 46960 + 144 + 22;
 
     /**
      * @dev Base cost of the `IGateway.submitMessage` method.
      */
-    uint256 internal constant SUBMIT_BASE_COST = 24064;
+    uint256 internal constant SUBMIT_BASE_COST = 24064 - 66 + 133 + 44;
 
     /**
      * @dev Extra gas cost that any account `Contract or EOA` must pay when calling `IGateway.submitMessage` method.
      * This cost is necessary for initialize the account's `nonce` storage slot.
      */
-    uint256 internal constant FIRST_MESSAGE_EXTRA_COST = 17100;
+    uint256 internal constant FIRST_MESSAGE_EXTRA_COST = 17100 + 6000;
 
     /**
      * @dev Solidity's reserved location for the free memory pointer.
@@ -106,7 +106,7 @@ library GasUtils {
 
             // Base cost: OPCODES + COLD SLOAD + COLD DELEGATECALL + RETURNDATACOPY
             // uint256 gasCost = 57 + 2100 + 2600;
-            uint256 gasCost = 31 + 2100 + 2600 + 32;
+            uint256 gasCost = 31 + 2100 + 2600 + 32 + 66;
 
             // CALLDATACOPY
             gasCost = gasCost.saturatingAdd(calldataLen * 3);
@@ -140,7 +140,7 @@ library GasUtils {
             gasCost += words << 8;
 
             // Memory expansion cost
-            words += 17 - 1;
+            words += 17 - 1 + 2;
             gasCost += ((words * words) >> 9) + (words * 3);
 
             return gasCost;