improve gas usage estimation

gmx-io · Jun 15, 2023 · 0e784e3 · 0e784e3
1 parent 0da94bc
commit 0e784e3
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 9 deletions.
diff --git a/contracts/deposit/DepositUtils.sol b/contracts/deposit/DepositUtils.sol
@@ -155,6 +155,9 @@ library DepositUtils {
         string memory reason,
         bytes memory reasonBytes
     ) external {
+        // 63/64 gas is forwarded to external calls, reduce the startingGas to account for this
+        startingGas -= gasleft() / 63;
+
         Deposit.Props memory deposit = DepositStoreUtils.get(dataStore, key);
         if (deposit.account() == address(0)) {
             revert Errors.EmptyDeposit();
@@ -197,7 +200,7 @@ library DepositUtils {
             eventEmitter,
             depositVault,
             deposit.executionFee(),
-            startingGas - gasleft(),
+            startingGas,
             keeper,
             deposit.account()
         );

diff --git a/contracts/deposit/ExecuteDepositUtils.sol b/contracts/deposit/ExecuteDepositUtils.sol
@@ -102,6 +102,9 @@ library ExecuteDepositUtils {
     // @dev executes a deposit
     // @param params ExecuteDepositParams
     function executeDeposit(ExecuteDepositParams memory params) external {
+        // 63/64 gas is forwarded to external calls, reduce the startingGas to account for this
+        params.startingGas -= gasleft() / 63;
+
         Deposit.Props memory deposit = DepositStoreUtils.get(params.dataStore, params.key);
         DepositStoreUtils.remove(params.dataStore, params.key, deposit.account());
 
@@ -235,7 +238,7 @@ library ExecuteDepositUtils {
             params.eventEmitter,
             params.depositVault,
             deposit.executionFee(),
-            params.startingGas - gasleft(),
+            params.startingGas,
             params.keeper,
             deposit.account()
         );

diff --git a/contracts/gas/GasUtils.sol b/contracts/gas/GasUtils.sol
@@ -53,18 +53,23 @@ library GasUtils {
     // @param dataStore DataStore
     // @param bank the StrictBank contract holding the execution fee
     // @param executionFee the executionFee amount
-    // @param gasUsed the amount of gas used
+    // @param startingGas the starting gas
     // @param keeper the keeper to pay
     // @param refundReceiver the account that should receive any excess gas refunds
     function payExecutionFee(
         DataStore dataStore,
         EventEmitter eventEmitter,
         StrictBank bank,
         uint256 executionFee,
-        uint256 gasUsed,
+        uint256 startingGas,
         address keeper,
         address refundReceiver
     ) external {
+        // 63/64 gas is forwarded to external calls, reduce the startingGas to account for this
+        startingGas -= gasleft() / 63;
+        uint256 gasUsed = startingGas - gasleft();
+
+        // each external call forwards 63/64 of the remaining gas
         uint256 executionFeeForKeeper = adjustGasUsage(dataStore, gasUsed) * tx.gasprice;
 
         if (executionFeeForKeeper > executionFee) {

diff --git a/contracts/order/OrderUtils.sol b/contracts/order/OrderUtils.sol
@@ -147,6 +147,9 @@ library OrderUtils {
     // @dev executes an order
     // @param params BaseOrderUtils.ExecuteOrderParams
     function executeOrder(BaseOrderUtils.ExecuteOrderParams memory params) external {
+        // 63/64 gas is forwarded to external calls, reduce the startingGas to account for this
+        params.startingGas -= gasleft() / 63;
+
         OrderStoreUtils.remove(params.contracts.dataStore, params.key, params.order.account());
 
         BaseOrderUtils.validateNonEmptyOrder(params.order);
@@ -182,7 +185,7 @@ library OrderUtils {
             params.contracts.eventEmitter,
             params.contracts.orderVault,
             params.order.executionFee(),
-            params.startingGas - gasleft(),
+            params.startingGas,
             params.keeper,
             params.order.account()
         );
@@ -224,6 +227,9 @@ library OrderUtils {
         string memory reason,
         bytes memory reasonBytes
     ) external {
+        // 63/64 gas is forwarded to external calls, reduce the startingGas to account for this
+        startingGas -= gasleft() / 63;
+
         Order.Props memory order = OrderStoreUtils.get(dataStore, key);
         BaseOrderUtils.validateNonEmptyOrder(order);
 
@@ -250,7 +256,7 @@ library OrderUtils {
             eventEmitter,
             orderVault,
             order.executionFee(),
-            startingGas - gasleft(),
+            startingGas,
             keeper,
             order.account()
         );
@@ -274,6 +280,9 @@ library OrderUtils {
         string memory reason,
         bytes memory reasonBytes
     ) external {
+        // 63/64 gas is forwarded to external calls, reduce the startingGas to account for this
+        startingGas -= gasleft() / 63;
+
         Order.Props memory order = OrderStoreUtils.get(dataStore, key);
         BaseOrderUtils.validateNonEmptyOrder(order);
 
@@ -297,7 +306,7 @@ library OrderUtils {
             eventEmitter,
             orderVault,
             executionFee,
-            startingGas - gasleft(),
+            startingGas,
             keeper,
             order.account()
         );

diff --git a/contracts/withdrawal/WithdrawalUtils.sol b/contracts/withdrawal/WithdrawalUtils.sol
@@ -193,6 +193,9 @@ library WithdrawalUtils {
      * @param params The parameters for executing the withdrawal.
      */
     function executeWithdrawal(ExecuteWithdrawalParams memory params) external {
+        // 63/64 gas is forwarded to external calls, reduce the startingGas to account for this
+        params.startingGas -= gasleft() / 63;
+
         Withdrawal.Props memory withdrawal = WithdrawalStoreUtils.get(params.dataStore, params.key);
         WithdrawalStoreUtils.remove(params.dataStore, params.key, withdrawal.account());
 
@@ -232,7 +235,7 @@ library WithdrawalUtils {
             params.eventEmitter,
             params.withdrawalVault,
             withdrawal.executionFee(),
-            params.startingGas - gasleft(),
+            params.startingGas,
             params.keeper,
             withdrawal.account()
         );
@@ -257,6 +260,9 @@ library WithdrawalUtils {
         string memory reason,
         bytes memory reasonBytes
     ) external {
+        // 63/64 gas is forwarded to external calls, reduce the startingGas to account for this
+        startingGas -= gasleft() / 63;
+
         Withdrawal.Props memory withdrawal = WithdrawalStoreUtils.get(dataStore, key);
         if (withdrawal.account() == address(0)) {
             revert Errors.EmptyWithdrawal();
@@ -285,7 +291,7 @@ library WithdrawalUtils {
             eventEmitter,
             withdrawalVault,
             withdrawal.executionFee(),
-            startingGas - gasleft(),
+            startingGas,
             keeper,
             withdrawal.account()
         );