Giter Club home page Giter Club logo

simple-swap's Introduction

SimpleSwap

SimpleSwap is a Solidity smart contract that enables token swaps using the Uniswap V3 protocol. It allows users to swap a fixed amount of a spend token for a maximum possible amount of a received token or swap a fixed amount of a received token for a minimum possible amount of a spend token.

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/mohitchandel/simple-swap.git
  2. Install the dependencies:

    npm i or yarn
  3. Compile the contracts:

    npx hardhat compile

Usage

  1. Deploy the contract by providing the address of the Uniswap V3 SwapRouter as a constructor argument.

  2. Call the inputSwap function to swap a fixed amount of a spend token for a maximum possible amount of a receive token.

function inputSwap(IERC20 spendToken, IERC20 receiveToken, uint256 amountIn) public returns (uint256)
  1. Call the outputSwap function to swap a fixed amount of a receive token for a minimum possible amount of a spend token.
function outputSwap(IERC20 spendToken, IERC20 receiveToken, uint256 amountInMax, uint256 amountOut) public returns (uint256)

Testing

Run the contract tests:

npx hardhat test

simple-swap's People

Contributors

mohitchandel 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.