Arbitrum/atlas v1.1

.env.example

@@ -27,4 +27,5 @@ BASE_RPC_URL=https://base-mainnet.g.alchemy.com/v2/XXXXXXXX
 
 ETHERSCAN_API_KEY=XXXXXXXX
 POLYGONSCAN_API_KEY=XXXXXXXX
-BSCSCAN_API_KEY=XXXXXXXX
+BSCSCAN_API_KEY=XXXXXXXX
+ARBISCAN_API_KEY=XXXXXXXX

.github/workflows/ci.yml

@@ -73,7 +73,7 @@ jobs:
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
 
   tests:
-    needs: ["lint", "build"]
+    needs: ["build"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

LICENSE

@@ -9,14 +9,10 @@ Parameters
 
 Licensor:             Fastlane Labs
 
-Licensed Work:        FastLane Protocol
-                      The Licensed Work is (c) 2023 Fastlane Labs
+Licensed Work:        Atlas Protocol
+                      The Licensed Work is (c) 2024 Fastlane Labs
 
-Additional Use Grant: Any uses listed and defined at
-                      fastlane-protocol-license.fastlane.finance
-
-Change Date:          The earlier of 2025-07-01 or a date specified at
-                      fastlane-protocol-license.fastlane.finance
+Change Date:          2026-07-01
 
 Change License:       GNU General Public License v2.0 or later
 

deployments.json

@@ -18,10 +18,10 @@
     "FL_ONLINE_DAPP_CONTROL": "0xf0E388C7DFfE14a61280a4E5b84d77be3d2875e3"
   },
   "POLYGON": {
-    "ATLAS": "0x912AceADa1b9c9B378894D0610C5684167710FDD",
-    "ATLAS_VERIFICATION": "0x2fBF38a38D753E4ce398000CCC552Efa50702e1e",
-    "SIMULATOR": "0x1244E4B8D93D2A72692Bf3600f7f5a494e24895a",
-    "SORTER": "0xFac7bf300E7eb17A2eD0Be67b60f5FeDd2E28E90",
+    "ATLAS": "0xB363f4D32DdB0b43622eA07Ae9145726941272B4",
+    "ATLAS_VERIFICATION": "0x621c6970fD9F124230feE35117d318069056819a",
+    "SIMULATOR": "0x82A3460920582968688FD887F21c5F3155A3BBd4",
+    "SORTER": "0xf8Bd19064A77297A691a29d9a40dF76F32fc86ad",
     "FL_ONLINE_DAPP_CONTROL": "0x498aC70345AD6b161eEf4AFBEA8F010401cfa780"
   },
   "BSC": {
@@ -54,6 +54,13 @@
     "SORTER": "0x81b2a2eD250fFF6808C54B46d519C9491E822F09",
     "L2_GAS_CALCULATOR": "0x7AcE2aC844F4104f86a2A04010C1b1e3f5d43196"
   },
+  "ARBITRUM": {
+    "ATLAS": "0xf0E388C7DFfE14a61280a4E5b84d77be3d2875e3",
+    "ATLAS_VERIFICATION": "0xD72D821dA82964c0546a5501347a3959808E072f",
+    "SIMULATOR": "0xae631aCDC436b9Dfd75C5629F825330d91459445",
+    "SORTER": "0xb47387995e866908B25b49e8BaC7e499170461A6",
+    "L2_GAS_CALCULATOR": "0xAb665f032e6A20Ef7D43FfD4E92a2f4fd6d5771e"
+  },
   "MAINNET": {
     "ATLAS": "",
     "ATLAS_VERIFICATION": "",

foundry.toml

@@ -5,7 +5,7 @@
   block_gas_limit = 300000000
   gas_limit = 3000000000
   gas_price = 1500000000
-  solc_version = "0.8.25"
+  solc_version = "0.8.28"
   evm_version = "cancun"
   isolate = false
   gas_reports = ["Atlas", "AtlasVerification", "Simulator", "Sorter", "ExecutionEnvironment"]

package.json

@@ -19,6 +19,7 @@
       "deploy-atlas-polygon": "source .env && forge script script/deploy-atlas.s.sol:DeployAtlasScript --rpc-url ${POLYGON_RPC_URL} --legacy --broadcast --etherscan-api-key ${POLYGONSCAN_API_KEY} --verify --delay 30",
 
       "deploy-atlas-arbitrum-sepolia": "source .env && forge script script/deploy-atlas.s.sol:DeployAtlasScript --rpc-url ${ARBITRUM_SEPOLIA_RPC_URL} --broadcast --etherscan-api-key ${ARBISCAN_API_KEY} --verify --delay 30",
+      "deploy-atlas-arbitrum": "source .env && forge script script/deploy-atlas.s.sol:DeployAtlasScript --rpc-url ${ARBITRUM_RPC_URL} --broadcast --etherscan-api-key ${ARBISCAN_API_KEY} --verify --delay 30",
 
       "deploy-fl-online-amoy": "source .env && forge script script/deploy-fl-online-control.s.sol:DeployFLOnlineControlScript --rpc-url ${AMOY_RPC_URL} --broadcast --etherscan-api-key ${POLYGONSCAN_API_KEY} --verify",
       "deploy-fl-online-polygon": "source .env && forge script script/deploy-fl-online-control.s.sol:DeployFLOnlineControlScript --rpc-url ${POLYGON_RPC_URL} --broadcast --etherscan-api-key ${POLYGONSCAN_API_KEY} --verify",
@@ -62,6 +63,8 @@
       "solver-deposit": "source .env && forge script script/solver-deposit.s.sol:SolverAtlasDepositScript --fork-url http://localhost:8545 --broadcast --non-interactive",
       "setup-demo": "npm run deploy-atlas-swap-intent-tx-builder && npm run deploy-solver && npm run solver-deposit",
 
+      "deploy-gas-calculator-base": "source .env && forge script script/deploy-gas-calculator.s.sol:DeployGasCalculatorScript --rpc-url ${BASE_RPC_URL} --broadcast --etherscan-api-key ${ETHERSCAN_API_KEY} --verify",
+
       "atlas-addr": "echo 'ATLAS:' && jq -r '.ATLAS' deployments.json",
       "swap-intent-addr": "echo 'SWAP INTENT DAPP CONTROL:' && jq -r '.SWAP_INTENT_DAPP_CONTROL' deployments.json",
       "tx-builder-addr": "echo 'TX BUILDER:' && jq -r '.TX_BUILDER' deployments.json",

script/base/deploy-base.s.sol

@@ -1,21 +1,21 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.8.25;
+pragma solidity 0.8.28;
 
 import "forge-std/Script.sol";
 import "forge-std/Test.sol";
 import "forge-std/StdJson.sol";
 
 import { IERC20 } from "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
 
-import { Atlas } from "src/contracts/atlas/Atlas.sol";
-import { AtlasVerification } from "src/contracts/atlas/AtlasVerification.sol";
-import { SwapIntentDAppControl } from "src/contracts/examples/intents-example/SwapIntentDAppControl.sol";
-import { TxBuilder } from "src/contracts/helpers/TxBuilder.sol";
-import { Simulator } from "src/contracts/helpers/Simulator.sol";
-import { Sorter } from "src/contracts/helpers/Sorter.sol";
-import { SimpleRFQSolver } from "test/SwapIntent.t.sol";
+import { Atlas } from "../../src/contracts/atlas/Atlas.sol";
+import { AtlasVerification } from "../../src/contracts/atlas/AtlasVerification.sol";
+import { SwapIntentDAppControl } from "../../src/contracts/examples/intents-example/SwapIntentDAppControl.sol";
+import { TxBuilder } from "../../src/contracts/helpers/TxBuilder.sol";
+import { Simulator } from "../../src/contracts/helpers/Simulator.sol";
+import { Sorter } from "../../src/contracts/helpers/Sorter.sol";
+import { SimpleRFQSolver } from "../../test/SwapIntent.t.sol";
 
-import { Utilities } from "src/contracts/helpers/Utilities.sol";
+import { Utilities } from "../../src/contracts/helpers/Utilities.sol";
 
 contract DeployBaseScript is Script {
     using stdJson for string;
@@ -72,6 +72,19 @@ contract DeployBaseScript is Script {
         }
     }
 
+    function _getSurchargeRates() internal view returns (uint256 atlasSurchargeRate, uint256 bundlerSurchargeRate) {
+        uint256 chainId = block.chainid;
+        if (chainId == 137 || chainId == 80_002) {
+            // POLYGON and AMOY
+            atlasSurchargeRate = 5_000_000; // 50%
+            bundlerSurchargeRate = 5_000_000; // 50%
+        } else {
+            // Default - for all other chains
+            atlasSurchargeRate = 1_000_000; // 10%
+            bundlerSurchargeRate = 1_000_000; // 10%
+        }
+    }
+
     // NOTE: When handling JSON with StdJson, prefix keys with '.' e.g. '.ATLAS'
     // These 2 functions abstract away the '.' thing though.
     // Pass in a key like 'ATLAS', and the current chain will be detected via `block.chainid` in `_getDeployChain()`
@@ -85,7 +98,14 @@ contract DeployBaseScript is Script {
 
         // console.log("Getting", fullKey, "from deployments.json");
 
-        // NOTE: Use fullKey method above for safety
+        // Revert if key doesn't exist in JSON.
+        if (!json.keyExists(fullKey)) revert(string.concat(fullKey, " not found in deployments.json"));
+
+        // If key exists but is empty, return address(0)
+        address decodedAddr = abi.decode(json.parseRaw(fullKey), (address));
+        if (decodedAddr == address(0x20) || decodedAddr == address(0)) return address(0);
+
+        // Otherwise, return the address
         return json.readAddress(fullKey);
     }
 

script/create-oev-demo-positions.s.sol

@@ -1,16 +1,16 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.8.25;
+pragma solidity 0.8.28;
 
 import "forge-std/Script.sol";
 import "forge-std/Test.sol";
 
 import { DeployBaseScript } from "script/base/deploy-base.s.sol";
 
-import { ChainlinkDAppControl } from "src/contracts/examples/oev-example/ChainlinkDAppControl.sol";
-import { ChainlinkAtlasWrapper } from "src/contracts/examples/oev-example/ChainlinkAtlasWrapper.sol";
+import { ChainlinkDAppControl } from "../src/contracts/examples/oev-example/ChainlinkDAppControl.sol";
+import { ChainlinkAtlasWrapper } from "../src/contracts/examples/oev-example/ChainlinkAtlasWrapper.sol";
 
-import { Token } from "src/contracts/helpers/DemoToken.sol";
-import { DemoLendingProtocol } from "src/contracts/helpers/DemoLendingProtocol.sol";
+import { Token } from "../src/contracts/helpers/DemoToken.sol";
+import { DemoLendingProtocol } from "../src/contracts/helpers/DemoLendingProtocol.sol";
 
 // Sets up a few liquidatable positions in the Lending Protocol. ETH for gas fees distributed by Lending Gov.
 contract CreateOEVDemoPositionsScript is DeployBaseScript {

script/deploy-atlas.s.sol

@@ -1,20 +1,25 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.8.25;
+pragma solidity 0.8.28;
 
 import "forge-std/Script.sol";
 import "forge-std/Test.sol";
 
-import { DeployBaseScript } from "script/base/deploy-base.s.sol";
-import { DeployGasCalculatorScript } from "script/deploy-gas-calculator.s.sol";
+import { DeployBaseScript } from "./base/deploy-base.s.sol";
+import { GasCalculatorDeployHelper } from "./deploy-gas-calculator.s.sol";
 
-import { Atlas } from "src/contracts/atlas/Atlas.sol";
-import { AtlasVerification } from "src/contracts/atlas/AtlasVerification.sol";
-import { TxBuilder } from "src/contracts/helpers/TxBuilder.sol";
-import { Simulator } from "src/contracts/helpers/Simulator.sol";
-import { Sorter } from "src/contracts/helpers/Sorter.sol";
-import { ExecutionEnvironment } from "src/contracts/common/ExecutionEnvironment.sol";
+import { FactoryLib } from "../src/contracts/atlas/FactoryLib.sol";
+import { Atlas } from "../src/contracts/atlas/Atlas.sol";
+import { AtlasVerification } from "../src/contracts/atlas/AtlasVerification.sol";
+import { TxBuilder } from "../src/contracts/helpers/TxBuilder.sol";
+import { Simulator } from "../src/contracts/helpers/Simulator.sol";
+import { Sorter } from "../src/contracts/helpers/Sorter.sol";
+import { ExecutionEnvironment } from "../src/contracts/common/ExecutionEnvironment.sol";
+
+contract DeployAtlasScript is DeployBaseScript, GasCalculatorDeployHelper {
+    uint256 ESCROW_DURATION = 64;
+    uint256 ATLAS_SURCHARGE_RATE; // Set below
+    uint256 BUNDLER_SURCHARGE_RATE; // Set below
 
-contract DeployAtlasScript is DeployBaseScript {
     function run() external {
         console.log("\n=== DEPLOYING Atlas ===\n");
 
@@ -23,19 +28,16 @@ contract DeployAtlasScript is DeployBaseScript {
         uint256 deployerPrivateKey = vm.envUint("GOV_PRIVATE_KEY");
         address deployer = vm.addr(deployerPrivateKey);
 
-        // Computes the addresses at which contracts will be deployed
-        address expectedAtlasAddr = vm.computeCreateAddress(deployer, vm.getNonce(deployer) + 1);
-        address expectedAtlasVerificationAddr = vm.computeCreateAddress(deployer, vm.getNonce(deployer) + 2);
-        address expectedSimulatorAddr = vm.computeCreateAddress(deployer, vm.getNonce(deployer) + 3);
+        (ATLAS_SURCHARGE_RATE, BUNDLER_SURCHARGE_RATE) = _getSurchargeRates();
 
-        // Deploy gas calculator for Arbitrum chains after other deployments
-        address l2GasCalculatorAddr = address(0);
-        uint256 chainId = block.chainid;
+        // Computes the addresses at which AtlasVerification will be deployed
+        address expectedAtlasAddr = vm.computeCreateAddress(deployer, vm.getNonce(deployer) + 2);
+        address expectedAtlasVerificationAddr = vm.computeCreateAddress(deployer, vm.getNonce(deployer) + 3);
+        address expectedSimulatorAddr = vm.computeCreateAddress(deployer, vm.getNonce(deployer) + 4);
 
-        if (chainId == 42_161 || chainId == 42_170 || chainId == 421_614) {
-            // Deploy gas calculator for Arbitrum chains
-            l2GasCalculatorAddr = vm.computeCreateAddress(deployer, vm.getNonce(deployer) + 4);
-        }
+        // Deploy L2 Gas Calculator after other deployments
+        address expectedL2GasCalculatorAddr = _predictGasCalculatorAddress(deployer, vm.getNonce(deployer) + 5);
+        address actualL2GasCalculatorAddr; // Set below during deployment if chain is an L2
 
         address prevSimAddr = _getAddressFromDeploymentsJson("SIMULATOR");
         uint256 prevSimBalance = (prevSimAddr == address(0)) ? 0 : prevSimAddr.balance;
@@ -47,33 +49,36 @@ contract DeployAtlasScript is DeployBaseScript {
         vm.startBroadcast(deployerPrivateKey);
 
         ExecutionEnvironment execEnvTemplate = new ExecutionEnvironment(expectedAtlasAddr);
+        FactoryLib factoryLib = new FactoryLib(address(execEnvTemplate));
         atlas = new Atlas({
-            escrowDuration: 64,
+            escrowDuration: ESCROW_DURATION,
+            atlasSurchargeRate: ATLAS_SURCHARGE_RATE,
+            bundlerSurchargeRate: BUNDLER_SURCHARGE_RATE,
             verification: expectedAtlasVerificationAddr,
             simulator: expectedSimulatorAddr,
-            executionTemplate: address(execEnvTemplate),
+            factoryLib: address(factoryLib),
             initialSurchargeRecipient: deployer,
-            l2GasCalculator: l2GasCalculatorAddr // is 0 if not on Arbitrum
+            l2GasCalculator: expectedL2GasCalculatorAddr // address(0) if chain not an L2
          });
         atlasVerification = new AtlasVerification(address(atlas));
-
         simulator = new Simulator();
+
+        // If chain is an L2, expectedL2GasCalculatorAddr will be non-zero
+        if (expectedL2GasCalculatorAddr != address(0)) {
+            actualL2GasCalculatorAddr = _newGasCalculator();
+        }
+
+        // After predicted address deployments done, do other setup txs:
         simulator.setAtlas(address(atlas));
 
         // If prev Simulator deployment has native assets, withdraw them to new Simulator
         if (prevSimBalance > 0) {
             Simulator(payable(prevSimAddr)).withdrawETH(address(simulator));
         }
 
+        // Sorter address not predicted or required in the other contracts, so deployed last.
         sorter = new Sorter(address(atlas));
 
-        if (chainId == 42_161 || chainId == 42_170 || chainId == 421_614) {
-            // Deploy gas calculator for Arbitrum chains
-            console.log("Deploying L2 Gas Calculator at: ", l2GasCalculatorAddr);
-            DeployGasCalculatorScript gasCalculatorDeployer = new DeployGasCalculatorScript();
-            l2GasCalculatorAddr = gasCalculatorDeployer.deployL2GasCalculator();
-        }
-
         vm.stopBroadcast();
 
         bool error = false;
@@ -122,6 +127,25 @@ contract DeployAtlasScript is DeployBaseScript {
             console.log("ERROR: Sorter deployment address is 0x0");
             error = true;
         }
+        // Check FactoryLib address set correctly in Atlas
+        if (address(factoryLib) != atlas.FACTORY_LIB()) {
+            console.log("ERROR: FactoryLib address not set correctly in Atlas");
+            error = true;
+        }
+        // Check ExecutionEnvironment address set correctly in FactoryLib
+        if (address(execEnvTemplate) != factoryLib.EXECUTION_ENV_TEMPLATE()) {
+            console.log("ERROR: ExecutionEnvironment address not set correctly in FactoryLib");
+            error = true;
+        }
+        // Check L2 Gas Calculator address set correctly
+        if (actualL2GasCalculatorAddr != atlas.L2_GAS_CALCULATOR()) {
+            console.log("ERROR: L2 Gas Calculator address not set correctly in Atlas");
+            error = true;
+        }
+        if (actualL2GasCalculatorAddr != expectedL2GasCalculatorAddr) {
+            console.log("ERROR: L2 Gas Calculator deployment address not as expected");
+            error = true;
+        }
         // Check ESCROW_DURATION was not set to 0
         if (atlas.ESCROW_DURATION() == 0) {
             console.log("ERROR: ESCROW_DURATION was set to 0");
@@ -137,8 +161,8 @@ contract DeployAtlasScript is DeployBaseScript {
         _writeAddressToDeploymentsJson("ATLAS_VERIFICATION", address(atlasVerification));
         _writeAddressToDeploymentsJson("SIMULATOR", address(simulator));
         _writeAddressToDeploymentsJson("SORTER", address(sorter));
-        if (l2GasCalculatorAddr != address(0)) {
-            _writeAddressToDeploymentsJson("L2_GAS_CALCULATOR", l2GasCalculatorAddr);
+        if (actualL2GasCalculatorAddr != address(0)) {
+            _writeAddressToDeploymentsJson("L2_GAS_CALCULATOR", actualL2GasCalculatorAddr);
         }
 
         // Print the table header
@@ -150,8 +174,8 @@ contract DeployAtlasScript is DeployBaseScript {
         console.log("| AtlasVerification     | ", address(atlasVerification), " |");
         console.log("| Simulator             | ", address(simulator), " |");
         console.log("| Sorter                | ", address(sorter), " |");
-        if (l2GasCalculatorAddr != address(0)) {
-            console.log("| L2 Gas Calculator     | ", l2GasCalculatorAddr, " |");
+        if (actualL2GasCalculatorAddr != address(0)) {
+            console.log("| L2 Gas Calculator     | ", actualL2GasCalculatorAddr, " |");
         }
         console.log("------------------------------------------------------------------------");
         console.log("\n");

script/deploy-demo-tokens.s.sol

@@ -1,17 +1,17 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.8.25;
+pragma solidity 0.8.28;
 
 import "forge-std/Script.sol";
 import "forge-std/Test.sol";
 
 import { DeployBaseScript } from "script/base/deploy-base.s.sol";
 
-import { Atlas } from "src/contracts/atlas/Atlas.sol";
-import { AtlasVerification } from "src/contracts/atlas/AtlasVerification.sol";
-import { V2RewardDAppControl } from "src/contracts/examples/v2-example-router/V2RewardDAppControl.sol";
-import { IUniswapV2Router02 } from "src/contracts/examples/v2-example-router/interfaces/IUniswapV2Router.sol";
+import { Atlas } from "../src/contracts/atlas/Atlas.sol";
+import { AtlasVerification } from "../src/contracts/atlas/AtlasVerification.sol";
+import { V2RewardDAppControl } from "../src/contracts/examples/v2-example-router/V2RewardDAppControl.sol";
+import { IUniswapV2Router02 } from "../src/contracts/examples/v2-example-router/interfaces/IUniswapV2Router.sol";
 
-import { Token } from "src/contracts/helpers/DemoToken.sol";
+import { Token } from "../src/contracts/helpers/DemoToken.sol";
 import { WETH } from "solady/tokens/WETH.sol";
 
 // Deploy 3 stablecoin tokens (DAI, USDA, USDB) - all 18 decimals

script/deploy-exec-env.s.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.8.25;
+pragma solidity 0.8.28;
 
 import "forge-std/Script.sol";
 import "forge-std/Test.sol";
 
-import { DeployBaseScript } from "script/base/deploy-base.s.sol";
+import { DeployBaseScript } from "./base/deploy-base.s.sol";
 
-import { ExecutionEnvironment } from "src/contracts/common/ExecutionEnvironment.sol";
+import { ExecutionEnvironment } from "../src/contracts/common/ExecutionEnvironment.sol";
 
 contract DeployExecEnvScript is DeployBaseScript {
     ExecutionEnvironment public execEnv;