Skip to content

Peripheral smart contracts for interacting with Uniswap v3 with Chinese notes

License

Notifications You must be signed in to change notification settings

alphafitz11/uniswap-v3-periphery-diy

 
 

Repository files navigation

Uniswap V3 Periphery

Tests Lint

This repository contains the periphery smart contracts for the Uniswap V3 Protocol. For the lower level core contracts, see the uniswap-v3-core repository.

Code analysis

The code analysis of this project in Chinese is in here. White papers and official website are recommended for you to better learn this project.

Bug bounty

This repository is subject to the Uniswap V3 bug bounty program, per the terms defined here.

Local deployment

In order to deploy this code to a local testnet, you should install the npm package @uniswap/v3-periphery and import bytecode imported from artifacts located at @uniswap/v3-periphery/artifacts/contracts/*/*.json. For example:

import {
  abi as SWAP_ROUTER_ABI,
  bytecode as SWAP_ROUTER_BYTECODE,
} from '@uniswap/v3-periphery/artifacts/contracts/SwapRouter.sol/SwapRouter.json'

// deploy the bytecode

This will ensure that you are testing against the same bytecode that is deployed to mainnet and public testnets, and all Uniswap code will correctly interoperate with your local deployment.

Using solidity interfaces

The Uniswap v3 periphery interfaces are available for import into solidity smart contracts via the npm artifact @uniswap/v3-periphery, e.g.:

import '@uniswap/v3-periphery/contracts/interfaces/ISwapRouter.sol';

contract MyContract {
  ISwapRouter router;

  function doSomethingWithSwapRouter() {
    // router.exactInput(...);
  }
}

About

Peripheral smart contracts for interacting with Uniswap v3 with Chinese notes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 57.1%
  • Solidity 42.9%