Merge pull request #2 from ronin-chain/feature/rename-to-katana-and-a…

…dd-dependencies

feat: rename to Katana and add dependencies

.github/workflows/test.yml

@@ -23,11 +23,20 @@ jobs:
       fail-fast: true
 
     name: Foundry project
-    runs-on: ubuntu-latest
+    runs-on: [self-hosted, gke]
+
     steps:
-      - uses: actions/checkout@v3
+      - id: 'gh-app'
+        name: 'Get Token'
+        uses: 'tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a' #v1.7.0
+        with:
+          app_id: ${{ secrets.GH_APP_ID }}
+          private_key: ${{ secrets.GH_PRIVATE_KEY }}
+
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
+          token: ${{ steps.gh-app.outputs.token }}
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
@@ -37,7 +46,7 @@ jobs:
       - name: Run Forge build
         run: |
           forge --version
-          forge build --sizes
+          forge build
         id: build
 
       - name: Run Forge tests

.gitmodules

@@ -2,4 +2,16 @@
 	path = lib/foundry-deployment-kit
 	url = https://github.com/axieinfinity/foundry-deployment-kit
 	branch = v0.2.0
-
+
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+[submodule "lib/solmate"]
+	path = lib/solmate
+	url = https://github.com/transmissions11/solmate
+[submodule "lib/katana-v3-contracts"]
+	path = lib/katana-v3-contracts
+	url = https://github.com/ronin-chain/katana-v3-contracts
+[submodule "lib/permit2"]
+	path = lib/permit2
+	url = https://github.com/Uniswap/permit2

foundry.toml

@@ -9,6 +9,7 @@ ffi = true
 
 solc = '0.8.26'
 optimizer_runs = 1_000_000
+via_ir=true
 evm_version = 'istanbul'
 use_literal_content = true
 extra_output = ["devdoc", "userdoc", "storagelayout"]

remappings.txt

@@ -2,4 +2,7 @@
 @contract-libs/=lib/foundry-deployment-kit/lib/contract-libs/src/
 forge-std/=lib/foundry-deployment-kit/lib/forge-std/src/
 @solady/=lib/foundry-deployment-kit/lib/solady/src/
-@openzeppelin/contracts/=lib/foundry-deployment-kit/lib/openzeppelin-contracts/contracts/
+@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
+solmate/=lib/solmate/
+permit2/=lib/permit2/
+@katana/v3-contracts/=lib/katana-v3-contracts/src/

script/utils/Contract.sol

@@ -3,7 +3,9 @@ pragma solidity ^0.8.23;
 
 import { LibString, TContract } from "@fdk/types/Types.sol";
 
-enum Contract { Counter }
+enum Contract {
+  Counter
+}
 
 using { key, name } for Contract global;
 

src/aggregate-router/AggregateRouter.sol

@@ -0,0 +1,84 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity ^0.8.17;
+
+// Command implementations
+import { Dispatcher } from "./base/Dispatcher.sol";
+import { RewardsCollector } from "./base/RewardsCollector.sol";
+import { RouterParameters } from "./base/RouterImmutables.sol";
+import { PaymentsImmutables, PaymentsParameters } from "./modules/PaymentsImmutables.sol";
+import { NFTImmutables, NFTParameters } from "./modules/NFTImmutables.sol";
+import { KatanaImmutables, KatanaParameters } from "./modules/katana/KatanaImmutables.sol";
+import { Commands } from "./libraries/Commands.sol";
+import { IAggregateRouter } from "./interfaces/IAggregateRouter.sol";
+
+contract AggregateRouter is IAggregateRouter, Dispatcher, RewardsCollector {
+  modifier checkDeadline(uint256 deadline) {
+    if (block.timestamp > deadline) revert TransactionDeadlinePassed();
+    _;
+  }
+
+  constructor(RouterParameters memory params)
+    KatanaImmutables(
+      KatanaParameters(params.v2Factory, params.v3Factory, params.pairInitCodeHash, params.poolInitCodeHash)
+    )
+    PaymentsImmutables(PaymentsParameters(params.permit2, params.weth9, params.openseaConduit, params.sudoswap))
+    NFTImmutables(
+      NFTParameters(
+        params.seaportV1_5,
+        params.seaportV1_4,
+        params.nftxZap,
+        params.x2y2,
+        params.foundation,
+        params.sudoswap,
+        params.elementMarket,
+        params.nft20Zap,
+        params.cryptopunks,
+        params.looksRareV2,
+        params.routerRewardsDistributor,
+        params.looksRareRewardsDistributor,
+        params.looksRareToken
+      )
+    )
+  { }
+
+  /// @inheritdoc IAggregateRouter
+  function execute(bytes calldata commands, bytes[] calldata inputs, uint256 deadline)
+    external
+    payable
+    checkDeadline(deadline)
+  {
+    execute(commands, inputs);
+  }
+
+  /// @inheritdoc Dispatcher
+  function execute(bytes calldata commands, bytes[] calldata inputs) public payable override isNotLocked {
+    bool success;
+    bytes memory output;
+    uint256 numCommands = commands.length;
+    if (inputs.length != numCommands) revert LengthMismatch();
+
+    // loop through all given commands, execute them and pass along outputs as defined
+    for (uint256 commandIndex = 0; commandIndex < numCommands;) {
+      bytes1 command = commands[commandIndex];
+
+      bytes calldata input = inputs[commandIndex];
+
+      (success, output) = dispatch(command, input);
+
+      if (!success && successRequired(command)) {
+        revert ExecutionFailed({ commandIndex: commandIndex, message: output });
+      }
+
+      unchecked {
+        commandIndex++;
+      }
+    }
+  }
+
+  function successRequired(bytes1 command) internal pure returns (bool) {
+    return command & Commands.FLAG_ALLOW_REVERT == 0;
+  }
+
+  /// @notice To receive ETH from WETH and NFT protocols
+  receive() external payable { }
+}

src/aggregate-router/base/Callbacks.sol

@@ -1,32 +1,32 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 pragma solidity ^0.8.17;
 
-import {IERC721Receiver} from '@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol';
-import {IERC1155Receiver} from '@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol';
-import {IERC165} from '@openzeppelin/contracts/utils/introspection/IERC165.sol';
+import { IERC721Receiver } from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
+import { IERC1155Receiver } from "@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol";
+import { IERC165 } from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 /// @title ERC Callback Support
 /// @notice Implements various functions introduced by a variety of ERCs for security reasons.
 /// All are called by external contracts to ensure that this contract safely supports the ERC in question.
 contract Callbacks is IERC721Receiver, IERC1155Receiver {
-    function onERC721Received(address, address, uint256, bytes calldata) external pure returns (bytes4) {
-        return this.onERC721Received.selector;
-    }
+  function onERC721Received(address, address, uint256, bytes calldata) external pure returns (bytes4) {
+    return this.onERC721Received.selector;
+  }
 
-    function onERC1155Received(address, address, uint256, uint256, bytes calldata) external pure returns (bytes4) {
-        return this.onERC1155Received.selector;
-    }
+  function onERC1155Received(address, address, uint256, uint256, bytes calldata) external pure returns (bytes4) {
+    return this.onERC1155Received.selector;
+  }
 
-    function onERC1155BatchReceived(address, address, uint256[] calldata, uint256[] calldata, bytes calldata)
-        external
-        pure
-        returns (bytes4)
-    {
-        return this.onERC1155BatchReceived.selector;
-    }
+  function onERC1155BatchReceived(address, address, uint256[] calldata, uint256[] calldata, bytes calldata)
+    external
+    pure
+    returns (bytes4)
+  {
+    return this.onERC1155BatchReceived.selector;
+  }
 
-    function supportsInterface(bytes4 interfaceId) external pure returns (bool) {
-        return interfaceId == type(IERC1155Receiver).interfaceId || interfaceId == type(IERC721Receiver).interfaceId
-            || interfaceId == type(IERC165).interfaceId;
-    }
+  function supportsInterface(bytes4 interfaceId) external pure returns (bool) {
+    return interfaceId == type(IERC1155Receiver).interfaceId || interfaceId == type(IERC721Receiver).interfaceId
+      || interfaceId == type(IERC165).interfaceId;
+  }
 }