routing-finder-lane 1.0.0

package/.idea/copilot.data.migration.agent.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AgentMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/copilot.data.migration.ask.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AskMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/copilot.data.migration.ask2agent.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Ask2AgentMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/copilot.data.migration.edit.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="EditMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/ratex-sdk.iml" filepath="$PROJECT_DIR$/.idea/ratex-sdk.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/php.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MessDetectorOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCSFixerOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCodeSnifferOptionsConfiguration">
+    <option name="highlightLevel" value="WARNING" />
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PhpStanOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PsalmOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+</project>

package/.idea/ratex-sdk.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 DecenterApps
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,209 @@
+# 💡 RateX SDK
+
+<div style='flex: 0.2; align="center"'>
+<img src="https://raw.githubusercontent.com/DecenterApps/RateX/main/images/decenter_logo.png" alt="Decenter Logo" style="max-width: 100%;" />
+</div>
+
+## 🌟 Introduction
+
+RateX SDK is a tool for developers to seamlessly integrate DEX aggregation functionality into their applications on Ethereum and Arbitrum. This open-source SDK helps you find optimal swap routes across multiple decentralized exchanges, offering competitive rates without taking positive slippage or fees. With RateX SDK, you can fetch quotes and generate transaction data for executing swaps through our smart contracts, while ensuring transparency and control over the routing process.
+
+### Why are we making this?
+
+Current DEX aggregators may not charge fees but often take positive slippage, which is the difference between the expected price and the actual execution price of a trade. Additionally, their routing algorithms are typically closed source, leaving users vulnerable if these services start charging fees.
+
+Our goal is to create a competitive alternative by:
+
+- Not taking positive slippage or fees
+- Making our routing algorithm open source
+- Running the code (SDK) directly on the user's machine (in browser), rather than on a server
+
+## ✨ Features
+
+- 🔍 **Best route finding** across multiple DEXes
+- 💰 **No fees or positive slippage** taken
+- 🖥️ **Client-side execution** instead of servers
+- 🔓 **Open-source routing algorithm**
+- ⚡ **Support for Arbitrum and Ethereum networks**
+
+## 🛠️ Supported DEXes
+
+| DEX                       | Supported |
+| ------------------------- | :-------: |
+| Uniswap V2                |    ✅     |
+| Uniswap V3                |    ✅     |
+| Sushiswap V2              |    ✅     |
+| Balancer (weighted pools) |    ✅     |
+| Camelot                   |    ✅     |
+
+## 🌐 RateX Contracts
+
+| Contract Name     | Ethereum ⚫                                                                                                           | Arbitrum 🔵                                                                                                          |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| RateX             | [0xAC64cF5B37124e62Ad716e664faF711Bd0882056](https://etherscan.io/address/0xAC64cF5B37124e62Ad716e664faF711Bd0882056) | [0x1D3ac829f8b0056972491095342730710e956629](https://arbiscan.io/address/0x1D3ac829f8b0056972491095342730710e956629) |
+| Uniswap Helper    | [0xBFA0CAC4e1FC4958Ef24732F5b1e063637D20704](https://etherscan.io/address/0xBFA0CAC4e1FC4958Ef24732F5b1e063637D20704) | [0xBf70F85011047C4cF31696780BdB6db752527d7c](https://arbiscan.io/address/0xBf70F85011047C4cF31696780BdB6db752527d7c) |
+| Sushiswap Helper  | [0xAc62F8Ff99B1fEa563Cf8D47Ce1B9fE76F3AC5b8](https://etherscan.io/address/0xAc62F8Ff99B1fEa563Cf8D47Ce1B9fE76F3AC5b8) | [0x141fc598Ed85a23e78f2b58ABe95AC013d196249](https://arbiscan.io/address/0x141fc598Ed85a23e78f2b58ABe95AC013d196249) |
+| Balancer Helper   | [0xf77f3E6ed19DAFe90f90c3C1609207902C7414f9](https://etherscan.io/address/0xf77f3E6ed19DAFe90f90c3C1609207902C7414f9) | [0xd1dFeDe71160a0a1e869e2D3F428A47531726BfE](https://arbiscan.io/address/0xd1dFeDe71160a0a1e869e2D3F428A47531726BfE) |
+| Uniswap V2 Helper | [0x043EEB82faC75641146955Fea5509C824b2AD22A](https://etherscan.io/address/0x043EEB82faC75641146955Fea5509C824b2AD22A) | [0x24725a85903e83A4829F51287B8E0BD321121DbC](https://arbiscan.io/address/0x24725a85903e83A4829F51287B8E0BD321121DbC) |
+| Camelot Helper    | N/A                                                                                                                   | [0x91DE0353a4f93BD460dE3a373Feb50c53571c078](https://arbiscan.io/address/0x91DE0353a4f93BD460dE3a373Feb50c53571c078) |
+
+Note: Camelot Helper is not available on Ethereum mainnet.
+
+## Requirements
+
+Before you begin, ensure you have the following tools installed:
+
+- [Node.js (>= v18)](https://nodejs.org/en/download/)
+
+## 📦 Installation
+
+```bash
+npm install ratex-sdk
+```
+
+or with yarn
+
+```bash
+yarn add ratex-sdk
+```
+
+## 🚀 Quick Start
+
+### JavaScript
+
+```javascript
+const { RateX, Dexes } = require("ratex-sdk");
+
+async function main() {
+  const rateX = new RateX({
+    rpcUrl: "https://arb1.arbitrum.io/rpc",
+    chainId: 42161,
+    dexes: [Dexes.UNISWAP_V2, Dexes.UNISWAP_V3],
+    graphApiKey: "YOUR_GRAPH_API_KEY",
+  });
+
+  const tokenIn = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"; // WETH
+  const tokenOut = "0x6B175474E89094C44Da98b954EedeAC495271d0F"; // DAI
+  const amountIn = BigInt("1000000000000000000"); // 1 WETH
+
+  const quote = await rateX.getQuote(tokenIn, tokenOut, amountIn);
+  console.log("Best quote:", quote);
+
+  const swapParams = await rateX.getSwapParameters(
+    tokenIn,
+    tokenOut,
+    amountIn,
+    1, // 1% slippage
+    "0xYourAddress",
+    30 // 30 minutes deadline
+  );
+  console.log("Swap parameters:", swapParams);
+}
+
+main().catch(console.error);
+```
+
+### TypeScript
+
+```typescript
+import { RateX, Dexes } from "ratex-sdk";
+
+async function main() {
+  const rateX = new RateX({
+    rpcUrl: "https://arb1.arbitrum.io/rpc",
+    chainId: 42161,
+    dexes: [Dexes.UNISWAP_V2, Dexes.UNISWAP_V3],
+    graphApiKey: "YOUR_GRAPH_API_KEY",
+  });
+
+  const tokenIn: string = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"; // WETH
+  const tokenOut: string = "0x6B175474E89094C44Da98b954EedeAC495271d0F"; // DAI
+  const amountIn: bigint = BigInt("1000000000000000000"); // 1 WETH
+
+  const quote = await rateX.getQuote(tokenIn, tokenOut, amountIn);
+  console.log("Best quote:", quote);
+
+  const swapParams = await rateX.getSwapParameters(
+    tokenIn,
+    tokenOut,
+    amountIn,
+    1, // 1% slippage
+    "0xYourAddress",
+    30 // 30 minutes deadline
+  );
+  console.log("Swap parameters:", swapParams);
+}
+
+main().catch(console.error);
+```
+
+## 📚 API Reference
+
+### `RateX`
+
+#### Constructor
+
+```javascript
+new RateX(config: RateXConfig)
+```
+
+- `config.rpcUrl`: RPC URL for the Arbitrum network
+- `config.chainId`: Chain ID (42161 for Arbitrum One)
+- `config.dexes`: Array of DEXes to include in routing (optional)
+- `config.graphApiKey`: Your Graph API key
+
+#### Methods
+
+##### `getQuote`
+
+```javascript
+async getQuote(tokenIn: string, tokenOut: string, amountIn: bigint): Promise<Quote>
+```
+
+Finds the best swap route and returns a quote.
+
+##### `getSwapCalldata`
+
+```javascript
+async getSwapCalldata(
+  tokenIn: string,
+  tokenOut: string,
+  amountIn: bigint,
+  slippagePercentage: number,
+  recipient: string,
+  deadlineInMinutes: number
+): Promise<string>
+```
+
+Generates the calldata for executing the swap.
+
+##### `getSwapParameters`
+
+```javascript
+async getSwapParameters(
+  tokenIn: string,
+  tokenOut: string,
+  amountIn: bigint,
+  slippagePercentage: number,
+  recipient: string,
+  deadlineInMinutes: number
+): Promise<SwapParams>
+```
+
+Prepares the parameters for calling the RateX contract.
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE-MIT) file for details.
+
+## 🙏 Acknowledgements
+
+Special thanks to [Decenter](https://www.decenter.com/) internship teams for supporting this project and all the contributors who made this possible.
+
+## 📬 Contact
+
+For any questions or support, please open an issue on our [GitHub repository](https://github.com/your-repo-link).
+
+---
+
+Built with ❤️ by the RateX team

package/contracts/abi/BalancerHelperAbi.ts

@@ -0,0 +1 @@
+export const BalancerHelperAbi = [{"inputs":[{"internalType":"address","name":"_balancerVault","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"bytes32","name":"_poolId","type":"bytes32"}],"name":"getWeightedPoolInfo","outputs":[{"internalType":"uint8","name":"decimals","type":"uint8"},{"internalType":"address[]","name":"tokens","type":"address[]"},{"internalType":"uint256[]","name":"balances","type":"uint256[]"},{"internalType":"uint256[]","name":"weights","type":"uint256[]"},{"internalType":"uint256","name":"feePercentage","type":"uint256"}],"stateMutability":"view","type":"function"}]

package/contracts/abi/CamelotHelperAbi.ts

@@ -0,0 +1 @@
+export const CamelotHelperAbi = [{"inputs":[{"components":[{"internalType":"address","name":"poolId","type":"address"},{"internalType":"string","name":"dexId","type":"string"},{"components":[{"internalType":"address","name":"_address","type":"address"},{"internalType":"uint256","name":"decimals","type":"uint256"}],"internalType":"struct IHelperState.Token[]","name":"tokens","type":"tuple[]"}],"internalType":"struct IHelperState.PoolInfo[]","name":"poolsInfo","type":"tuple[]"}],"name":"getPoolsData","outputs":[{"components":[{"internalType":"address","name":"poolId","type":"address"},{"internalType":"string","name":"dexId","type":"string"},{"components":[{"internalType":"address","name":"_address","type":"address"},{"internalType":"uint256","name":"decimals","type":"uint256"}],"internalType":"struct IHelperState.Token[]","name":"tokens","type":"tuple[]"},{"internalType":"uint112[2]","name":"reserves","type":"uint112[2]"},{"internalType":"uint16[2]","name":"fees","type":"uint16[2]"},{"internalType":"bool","name":"stableSwap","type":"bool"}],"internalType":"struct CamelotHelper.CamelotPool[]","name":"pools","type":"tuple[]"}],"stateMutability":"view","type":"function"}]