https://github.com/Uniswap/uniswap-v3-periphery

🦄 🦄 🦄 Peripheral smart contracts for interacting with Uniswap v3
https://github.com/Uniswap/uniswap-v3-periphery

automated-market-maker bug-bounty ethereum periphery smart-contracts uniswap

Last synced: 3 months ago
JSON representation

🦄 🦄 🦄 Peripheral smart contracts for interacting with Uniswap v3

• Host: GitHub
• URL: https://github.com/Uniswap/uniswap-v3-periphery
• Owner: Uniswap
• License: gpl-2.0
• Created: 2021-02-19T19:50:11.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-11T07:50:12.000Z (4 months ago)
• Last Synced: 2024-07-18T13:48:03.662Z (4 months ago)
• Topics: automated-market-maker, bug-bounty, ethereum, periphery, smart-contracts, uniswap
• Language: TypeScript
• Homepage: https://uniswap.org
• Size: 1.93 MB
• Stars: 1,145
• Watchers: 59
• Forks: 1,060
• Open Issues: 71
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Audit: audits/abdk/audit.pdf

Awesome Lists containing this project

• awesome-solidity - Uniswap/uniswap-v3-periphery - Peripheral smart contracts for interacting with Uniswap V3. (Libraries)
• awesome-uniswap - Uniswap v3 Periphery Contracts - Uniswap v3 Periphery Contracts (Implementations / Uniswap V3)
• awesome-solidity - Uniswap/uniswap-v3-periphery - Peripheral smart contracts for interacting with Uniswap V3. (Libraries)
• awesome-uniswap-v3 - Uniswap v3 Periphery Contracts - Uniswap v3 Periphery Contracts (Uniswap Properties / Uniswap Official)
• awesome-solidity - Uniswap/uniswap-v3-periphery - Peripheral smart contracts for interacting with Uniswap V3. (Libraries)

README

        
# Uniswap V3 Periphery

[![Tests](https://github.com/Uniswap/uniswap-v3-periphery/workflows/Tests/badge.svg)](https://github.com/Uniswap/uniswap-v3-periphery/actions?query=workflow%3ATests)

[![Lint](https://github.com/Uniswap/uniswap-v3-periphery/workflows/Lint/badge.svg)](https://github.com/Uniswap/uniswap-v3-periphery/actions?query=workflow%3ALint)

This repository contains the periphery smart contracts for the Uniswap V3 Protocol.

For the lower level core contracts, see the [uniswap-v3-core](https://github.com/Uniswap/uniswap-v3-core)

repository.

## Bug bounty

This repository is subject to the Uniswap V3 bug bounty program,

per the terms defined [here](./bug-bounty.md).

## 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:

```typescript

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

```solidity

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

contract MyContract {

  ISwapRouter router;

  function doSomethingWithSwapRouter() {

    // router.exactInput(...);

  }

}

```