Giter Club home page Giter Club logo

ratex-sdk's Introduction

๐Ÿ’ก RateX SDK

Decenter Logo

๐ŸŒŸ 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 โœ…

Requirements

Before you begin, ensure you have the following tools installed:

๐Ÿ“ฆ Installation

npm install ratex-sdk

or with yarn

yarn add ratex-sdk

๐Ÿš€ Quick Start

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

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

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
async getQuote(tokenIn: string, tokenOut: string, amountIn: bigint): Promise<Quote>

Finds the best swap route and returns a quote.

getSwapCalldata
async getSwapCalldata(
  tokenIn: string,
  tokenOut: string,
  amountIn: bigint,
  slippagePercentage: number,
  recipient: string,
  deadlineInMinutes: number
): Promise<string>

Generates the calldata for executing the swap.

getSwapParameters
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 file for details.

๐Ÿ™ Acknowledgements

Special thanks to Decenter 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.


Built with โค๏ธ by the RateX team

ratex-sdk's People

Contributors

vaniiiii avatar skocimis avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.