Git Product home page Git Product logo

swapex's Introduction

SwapEx

A decentralized exchange (DEX) powered by a Constant Product AMM. Seamlessly swap tokens, provide liquidity, and utilize token faucets. Stake ETH with the Synthetic Staking Rewards Contract to earn rewards. Join SwapEx for a secure, censorship-resistant, and intermediary-free trading experience.

The contract is deployed on Goerli Network:

Main Contract, Faucet 0, Faucet 1, Staker Contract

Table of Contents

Features

  • Smart contract deployment and interaction using Hardhat in Typescript
  • Smart contract tests in Typescript
  • User-friendly interface built with ReactJS in Typescript
  • Web3 integration with Wagmi and EthersJS for seamless interaction with Ethereum network

Prerequisites

Before running the dApp, ensure that you have the following installed:

  • Node.js
  • npm (Node Package Manager)
  • MetaMask extension for your browser

Getting Started

Follow the steps below to get the dApp up and running:

  1. Clone this repository to your local machine.
  2. Install the project dependencies by running npm install in the root directory as well as in client directory.
  3. Configure your MetaMask extension to connect to the desired Ethereum network.
  4. Deploy the smart contracts to the Ethereum network using Hardhat: npx hardhat run scripts/deploy.js --network <network-name>.
  5. Update the addresses in files in client/src/contracts/.
  6. Start the client: cd client && npm run dev.
  7. Access the dApp by opening your browser and visiting http://localhost:5173.

Usage

  • Connect your desired wallet and approve the connection.
  • Get the tokens from the faucet.
  • Swap the tokens.
  • Provide the liqudity and earn rewards.
  • Stake ETH and earn rewards.
  • View transaction history and account details.

Development

To contribute to the development of this dApp, follow the steps below:

  1. Fork this repository and clone it to your local machine.
  2. Create a new branch for your changes: git checkout -b my-new-feature.
  3. Get the dApp up and running following steps in Getting Started.
  4. Make the necessary modifications and additions.
  5. Test Smart Contract with npx hardhat test in the root directory.
  6. Commit and push your changes: git commit -m 'Add some feature' && git push origin my-new-feature.
  7. Submit a pull request detailing your changes and their benefits.

Contact

For any questions or inquiries, please contact Nika Khachiashvili.

swapex's People

Contributors

nikakhachi avatar

Watchers

 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.