introduces a gas-optimized periphery contract for same-chain swaps (GenericSwapper v1.0.0)

config/global.json

@@ -94,5 +94,34 @@
     "scroll": "https://transaction.safe.scroll.xyz/api",
     "sei": "https://transaction.sei-safe.protofire.io/api",
     "zksync": "https://safe-transaction-zksync.safe.global/api"
+  },
+
+  "nativeAddress": {
+    "mainnet": "0x0000000000000000000000000000000000000000",
+    "arbitrum": "0x0000000000000000000000000000000000000000",
+    "aurora": "0x0000000000000000000000000000000000000000",
+    "avalanche": "0x0000000000000000000000000000000000000000",
+    "base": "0x0000000000000000000000000000000000000000",
+    "blast": "0x0000000000000000000000000000000000000000",
+    "boba": "0x0000000000000000000000000000000000000000",
+    "bsc": "0x0000000000000000000000000000000000000000",
+    "celo": "0x471EcE3750Da237f93B8E339c536989b8978a438and",
+    "fantom": "0x0000000000000000000000000000000000000000",
+    "fraxtal": "0x0000000000000000000000000000000000000000",
+    "fuse": "0x0000000000000000000000000000000000000000",
+    "gnosis": "0x0000000000000000000000000000000000000000",
+    "linea": "0x0000000000000000000000000000000000000000",
+    "mantle": "0x0000000000000000000000000000000000000000",
+    "metis": "0xDeadDeAddeAddEAddeadDEaDDEAdDeaDDeAD0000",
+    "mode": "0x0000000000000000000000000000000000000000",
+    "moonbeam": "0x0000000000000000000000000000000000000000",
+    "moonriver": "0x0000000000000000000000000000000000000000",
+    "optimism": "0x0000000000000000000000000000000000000000",
+    "polygon": "0x0000000000000000000000000000000000000000",
+    "polygonzkevm": "0x0000000000000000000000000000000000000000",
+    "rootstock": "0x0000000000000000000000000000000000000000",
+    "scroll": "0x0000000000000000000000000000000000000000",
+    "sei": "0x0000000000000000000000000000000000000000",
+    "zksync": "0x0000000000000000000000000000000000000000"
   }
 }

deployments/_deployments_log_file.json

@@ -19858,6 +19858,18 @@
             "VERIFIED": "true"
           }
         ]
+      },
+      "staging": {
+        "1.0.1": [
+          {
+            "ADDRESS": "0xE871874D8AC30E8aCD0eC67529b4a5dDD73Bf0d6",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2024-07-10 10:13:56",
+            "CONSTRUCTOR_ARGS": "0x0000000000000000000000000000000000000000000000000000000000000000",
+            "SALT": "",
+            "VERIFIED": "true"
+          }
+        ]
       }
     },
     "celo": {

deployments/bsc.diamond.staging.json

@@ -69,9 +69,13 @@
         "Name": "GenericSwapFacet",
         "Version": "1.0.0"
       },
-      "0xf92D157a857d55B5DA987E35488e746EA85f1ca3": {
+      "0xA269cb81E6bBB86683558e449cb1bAFFdb155Bfc": {
         "Name": "",
         "Version": ""
+      },
+      "0xE871874D8AC30E8aCD0eC67529b4a5dDD73Bf0d6": {
+        "Name": "GenericSwapFacetV3",
+        "Version": "1.0.1"
       }
     },
     "Periphery": {
@@ -81,6 +85,7 @@
       "GasRebateDistributor": "",
       "LiFuelFeeCollector": "0xc4f7A34b8d283f66925eF0f5CCdFC2AF3030DeaE",
       "Receiver": "0x76EE0F8fb09047284B6ea89881595Fc6F5B09E12",
+      "ReceiverStargateV2": "",
       "RelayerCelerIM": "",
       "ServiceFeeCollector": "0xdF4257A2f61E5D432Dedbc9c65917C268323421d",
       "TokenWrapper": "0x5215E9fd223BC909083fbdB2860213873046e45d"

deployments/bsc.staging.json

@@ -26,5 +26,6 @@
   "ThorSwapFacet": "0xa6aAe470E7B8E8916e692882A5db25bB40C398A7",
   "AmarokFacetPacked": "0x7ac3EB2D191EBAb9E925CAbFD4F8155be066b3aa",
   "MayanBridgeFacet": "0x5Ba4FeD1DAd2fD057A9f687B399B8e4cF2368214",
-  "MayanFacet": "0xd596C903d78870786c5DB0E448ce7F87A65A0daD"
+  "MayanFacet": "0xd596C903d78870786c5DB0E448ce7F87A65A0daD",
+  "GenericSwapFacetV3": "0xE871874D8AC30E8aCD0eC67529b4a5dDD73Bf0d6"
 }

docs/GenericSwapper.md

@@ -0,0 +1,97 @@
+# GenericSwapper
+
+## Description
+
+Gas-optimized periphery contract used for executing same-chain swaps (incl. an optional fee collection step)
+
+## How To Use
+
+This contract was designed to provide a heavily gas-optimized way to execute same-chain swaps. It will not emit any events and it can only use the LI.FI DEX Aggregator to execute these swaps. Other DEXs are not supported.
+It will also not check if token approvals from the GenericSwapper to the LI.FI DEX Aggregator and to the FeeCollector exist. If such approvals are missing, they would have to be set first (see function below).
+
+In order to still be able to trace transactions a `transactionId` will be appended to the calldata, separated from the actual calldata with a delimiter ('`0xdeadbeef`').
+
+The contract has a number of specialized methods for various use cases:
+
+This method is used to execute a single swap from ERC20 to ERC20
+
+```solidity
+    /// @notice Performs a single swap from an ERC20 token to another ERC20 token
+    /// @param _receiver the address to receive the swapped tokens into (also excess tokens)
+    /// @param _minAmountOut the minimum amount of the final asset to receive
+    /// @param _swapData an object containing swap related data to perform swaps before bridging
+    function swapTokensSingleV3ERC20ToERC20(
+        address _receiver,
+        uint256 _minAmountOut,
+        LibSwap.SwapData calldata _swapData
+    )
+```
+
+This method is used to execute a single swap from ERC20 to native
+
+```solidity
+    /// @notice Performs a single swap from an ERC20 token to the network's native token
+    /// @param _receiver the address to receive the swapped tokens into (also excess tokens)
+    /// @param _minAmountOut the minimum amount of the final asset to receive
+    /// @param _swapData an object containing swap related data to perform swaps before bridging
+    function swapTokensSingleV3ERC20ToNative(
+        address payable _receiver,
+        uint256 _minAmountOut,
+        LibSwap.SwapData calldata _swapData
+    )
+```
+
+This method is used to execute a single swap from native to ERC20
+
+```solidity
+    /// @notice Performs a single swap from the network's native token to ERC20 token
+    /// @param _receiver the address to receive the swapped tokens into (also excess tokens)
+    /// @param _minAmountOut the minimum amount of the final asset to receive
+    /// @param _swapData an object containing swap related data to perform swaps before bridging
+    function swapTokensSingleV3NativeToERC20(
+        address payable _receiver,
+        uint256 _minAmountOut,
+        LibSwap.SwapData calldata _swapData
+    )
+```
+
+This method is used to execute a swap from ERC20 any other token (ERC20 or native) incl. a previous fee collection step
+
+```solidity
+    /// @notice Performs multiple swaps in one transaction, starting with ERC20 and ending with native
+    /// @param _receiver the address to receive the swapped tokens into (also excess tokens)
+    /// @param _minAmountOut the minimum amount of the final asset to receive
+    /// @param _swapData an object containing swap related data to perform swaps before bridging
+    function swapTokensMultipleV3ERC20ToAny(
+        address payable _receiver,
+        uint256 _minAmountOut,
+        LibSwap.SwapData[] calldata _swapData
+    )
+
+```
+
+This method is used to execute a swap from native to ERC20 incl. a previous fee collection step
+
+```solidity
+    /// @notice Performs multiple swaps in one transaction, starting with native and ending with ERC20
+    /// @param _receiver the address to receive the swapped tokens into (also excess tokens)
+    /// @param _minAmountOut the minimum amount of the final asset to receive
+    /// @param _swapData an object containing swap related data to perform swaps before bridging
+    function swapTokensMultipleV3NativeToERC20(
+        address payable _receiver,
+        uint256 _minAmountOut,
+        LibSwap.SwapData[] calldata _swapData
+    )
+```
+
+This method is used to set max approvals between the GenericSwapper and the DEXAggregator as well as the FeeCollector
+(it can only be called by the registered admin address)
+
+```solidity
+    /// @notice (Re-)Sets max approvals from this contract to DEX Aggregator and FeeCollector
+    /// @param _approvals The information which approvals to set for which token
+    function setApprovalForTokens(
+        TokenApproval[] calldata _approvals
+    )
+
+```

script/deploy/facets/DeployGenericSwapFacetV3.s.sol

@@ -3,13 +3,39 @@ pragma solidity ^0.8.17;
 
 import { DeployScriptBase } from "./utils/DeployScriptBase.sol";
 import { GenericSwapFacetV3 } from "lifi/Facets/GenericSwapFacetV3.sol";
+import { stdJson } from "forge-std/Script.sol";
 
 contract DeployScript is DeployScriptBase {
+    using stdJson for string;
+
     constructor() DeployScriptBase("GenericSwapFacetV3") {}
 
-    function run() public returns (GenericSwapFacetV3 deployed) {
+    function run()
+        public
+        returns (GenericSwapFacetV3 deployed, bytes memory constructorArgs)
+    {
+        constructorArgs = getConstructorArgs();
+
         deployed = GenericSwapFacetV3(
             deploy(type(GenericSwapFacetV3).creationCode)
         );
     }
+
+    function getConstructorArgs() internal override returns (bytes memory) {
+        // get path of global config file
+        string memory globalConfigPath = string.concat(
+            root,
+            "/config/global.json"
+        );
+
+        // read file into json variable
+        string memory globalConfigJson = vm.readFile(globalConfigPath);
+
+        // extract network's native address
+        address nativeAddress = globalConfigJson.readAddress(
+            string.concat(".nativeAddress.", network)
+        );
+
+        return abi.encode(nativeAddress);
+    }
 }

script/deploy/facets/DeployGenericSwapper.s.sol

@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.17;
+
+import { DeployScriptBase } from "./utils/DeployScriptBase.sol";
+import { stdJson } from "forge-std/Script.sol";
+import { GenericSwapper } from "lifi/Periphery/GenericSwapper.sol";
+
+contract DeployScript is DeployScriptBase {
+    using stdJson for string;
+
+    constructor() DeployScriptBase("GenericSwapper") {}
+
+    function run()
+        public
+        returns (GenericSwapper deployed, bytes memory constructorArgs)
+    {
+        constructorArgs = getConstructorArgs();
+
+        deployed = GenericSwapper(deploy(type(GenericSwapper).creationCode));
+    }
+
+    function getConstructorArgs() internal override returns (bytes memory) {
+        string memory path = string.concat(
+            root,
+            "/deployments/",
+            network,
+            ".",
+            fileSuffix,
+            "json"
+        );
+        string memory json = vm.readFile(path);
+        address dexAggregatorAddress = json.readAddress(".LiFiDEXAggregator");
+        address feeCollectorAddress = json.readAddress(".FeeCollector");
+
+        return abi.encode(dexAggregatorAddress, feeCollectorAddress);
+    }
+}

script/deploy/resources/deployRequirements.json

@@ -413,6 +413,17 @@
       }
     }
   },
+  "GenericSwapper": {
+    "configData": {
+    "contractAddresses": {
+      "FeeCollector": {
+        "allowToDeployWithZeroAddress": "false"
+      },
+      "LiFiDEXAggregator": {
+        "allowToDeployWithZeroAddress": "false"
+      }
+    }
+  },
   "FeeCollector": {
     "configData": {
       "_owner": {

src/Facets/GenericSwapFacetV3.sol

@@ -8,16 +8,24 @@ import { LibAllowList } from "../Libraries/LibAllowList.sol";
 import { LibAsset } from "../Libraries/LibAsset.sol";
 import { ContractCallNotAllowed, CumulativeSlippageTooHigh, NativeAssetTransferFailed } from "../Errors/GenericErrors.sol";
 import { ERC20, SafeTransferLib } from "solmate/utils/SafeTransferLib.sol";
-import { console2 } from "forge-std/console2.sol";
 
 /// @title GenericSwapFacetV3
 /// @author LI.FI (https://li.fi)
 /// @notice Provides gas-optimized functionality for fee collection and for swapping through any APPROVED DEX
 /// @dev Can only execute calldata for APPROVED function selectors
-/// @custom:version 1.0.0
+/// @custom:version 1.0.1
 contract GenericSwapFacetV3 is ILiFi {
     using SafeTransferLib for ERC20;
 
+    /// Storage
+    address public immutable NATIVE_ADDRESS;
+
+    /// Constructor
+    /// @param _nativeAddress the address of the native token for this network
+    constructor(address _nativeAddress) {
+        NATIVE_ADDRESS = _nativeAddress;
+    }
+
     /// External Methods ///
 
     // SINGLE SWAPS
@@ -114,7 +122,7 @@ contract GenericSwapFacetV3 is ILiFi {
             _transactionId,
             _swapData.callTo,
             sendingAssetId,
-            address(0),
+            NATIVE_ADDRESS,
             fromAmount,
             amountReceived,
             block.timestamp
@@ -126,7 +134,7 @@ contract GenericSwapFacetV3 is ILiFi {
             _referrer,
             _receiver,
             sendingAssetId,
-            address(0),
+            NATIVE_ADDRESS,
             fromAmount,
             amountReceived
         );
@@ -183,7 +191,7 @@ contract GenericSwapFacetV3 is ILiFi {
         emit LibSwap.AssetSwapped(
             _transactionId,
             callTo,
-            address(0),
+            NATIVE_ADDRESS,
             receivingAssetId,
             fromAmount,
             amountReceived,
@@ -195,7 +203,7 @@ contract GenericSwapFacetV3 is ILiFi {
             _integrator,
             _referrer,
             _receiver,
-            address(0),
+            NATIVE_ADDRESS,
             receivingAssetId,
             fromAmount,
             amountReceived
@@ -506,7 +514,6 @@ contract GenericSwapFacetV3 is ILiFi {
         uint256 _minAmountOut,
         LibSwap.SwapData[] calldata _swapData
     ) private {
-        console2.log("in _transferNativeTokensAndEmitEvent");
         uint256 amountReceived = address(this).balance;
 
         // make sure minAmountOut was received
@@ -517,7 +524,6 @@ contract GenericSwapFacetV3 is ILiFi {
         // solhint-disable-next-line avoid-low-level-calls
         (bool success, ) = _receiver.call{ value: amountReceived }("");
         if (!success) {
-            console2.log("HEYA");
             revert NativeAssetTransferFailed();
         }
 
@@ -528,7 +534,7 @@ contract GenericSwapFacetV3 is ILiFi {
             _referrer,
             _receiver,
             _swapData[0].sendingAssetId,
-            address(0),
+            NATIVE_ADDRESS,
             _swapData[0].fromAmount,
             amountReceived
         );
@@ -540,7 +546,7 @@ contract GenericSwapFacetV3 is ILiFi {
         address receiver
     ) private {
         // if a balance exists in sendingAsset, it must be positive slippage
-        if (address(sendingAsset) != address(0)) {
+        if (address(sendingAsset) != NATIVE_ADDRESS) {
             uint256 sendingAssetBalance = sendingAsset.balanceOf(
                 address(this)
             );