Git Product home page Git Product logo

zothix / uniswap-v3-interface Goto Github PK

View Code? Open in Web Editor NEW

This project forked from uniswap/interface

0.0 0.0 1.0 305.92 MB

๐Ÿฆ„ Open source interfaces for the Uniswap protocol

Home Page: https://app.uniswap.org

License: GNU General Public License v3.0

Shell 0.22% JavaScript 0.92% Ruby 0.03% Python 0.08% Objective-C 0.18% Java 0.04% Prolog 0.01% Kotlin 1.16% TypeScript 95.60% Swift 1.68% HTML 0.06% MDX 0.02%

uniswap-v3-interface's Introduction

UniswapV3 Interface Customization Documentation

This documentation provides step-by-step instructions on how to customize and run the UniswapV3 Interface for a specific blockchain network. The process involves replacing contract addresses and chain IDs to match the target blockchain.

Prerequisites

  • Node.js and npm must be installed on your system.
  • Yarn package manager must be installed on your system.

Setup Instructions

  1. Environment Setup

    Begin by cloning the repository.

  2. Add Chain Logo

    Place your logo as an SVG image inside the post_install_scripts directory. Ensure the filename is logo.svg.

  3. Replace Contract Addresses

    Modify the replace_addresses.sh script located in the post_install_scripts directory. Replace the placeholder contract addresses mentioned below with the deployed contract addresses for your target blockchain.

    # ADDRESSES TO REPLACE WITH
    WETH_ADDRESS=""
    USDC_ADDRESS=""
    USDT_ADDRESS=""
    WBTC_ADDRESS=""
    DAI_ADDRESS=""
    FACTORY_ADDRESS=""
    SWAP_ROUTER_ADDRESS=""
    NFT_DESCRIPTOR_ADDRESS=""
    POSITION_DESCRIPTOR_ADDRESS=""
    POSITION_MANAGER_ADDRESS=""
    MULTICALL_ADDRESS=""
    QUOTER_ADDRESS=""
    V3_MIGRATOR_ADDRESS=""
    TICK_LENS_ADDRESS=""
    SUBGRAPH_URL=""
    RPC_URL=""
    SCAN_URL=""
    UNIVERSAL_ROUTER_ADDRESS=""
  4. Replace Chain ID and Chain name

    Modify the replace_chainid.sh script located in the post_install_scripts directory. Add the chain id in CHAIN_ID of your target blockchain.

    CHAIN_ID=
    CHAIN_NAME=""
    CHAIN_BRIDGE=""
  5. Install dependencies

    Run the following command to install project dependencies:

    yarn
  6. Run post install scripts

    Run the following command to execute post-install scripts to replace addresses and chain ID:

    yarn replace-chain
  7. Prepare Project

    yarn web prepare
  8. Start Project

    For Development

    yarn web start

    For Production

    yarn web build:production
    yarn web serve

Tested Environment

This customization has been tested for Optimism Sepolia (L2) network using the following environment:

  • Node.js version: 20.2
  • Yarn version: 3.6.3

Conclusion

By following these steps, you should be able to customize and run the UniswapV3 Interface project for your blockchain network. This enables you to leverage Uniswap's decentralized exchange functionality within your custom environment.

uniswap-v3-interface's People

Contributors

moodysalem avatar zzmp avatar crowdin-bot avatar vm avatar jfrankfurt avatar noahzinsmeister avatar cbachmeier avatar ianlapham avatar lynnshaoyu avatar just-toby avatar jackshort avatar cartcrom avatar haydenadams avatar chikeichan avatar grabbou avatar callil avatar lunreclipse avatar tinaszheng avatar github-actions[bot] avatar kennyt avatar kayleegeorge avatar natew avatar cmcewen avatar gbugyis avatar kristiehuang avatar aballerr avatar dependabot[bot] avatar pp-hh-ii-ll avatar hello-happy-puppy avatar lint-action avatar

Forkers

mshafimalik

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.