# @uniswap/v3-periphery

> 🎚 Peripheral smart contracts for interacting with Uniswap V3

Latest version **1.4.4** (published 2023-09-27) · GPL-2.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @uniswap/v3-periphery
pnpm add @uniswap/v3-periphery
yarn add @uniswap/v3-periphery
bun add @uniswap/v3-periphery
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.4.4 |
| Published | 2023-09-27 |
| First published | 2021-03-02 |
| Weekly downloads | 0 |
| License | GPL-2.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 5 |
| Unpacked size | 683.9 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1334 |
| Maintainers | mtoda, alicehenshaw, sarareynolds, emag3m, willpote, akarys01, ezhong1900, zachyang_uniswap |
| Keywords | uniswap, periphery, v3 |

## Links

- npm: https://www.npmjs.com/package/@uniswap/v3-periphery
- Repository: https://github.com/Uniswap/uniswap-v3-periphery
- Homepage: https://uniswap.org
- Issues: https://github.com/Uniswap/uniswap-v3-periphery/issues
- npm.io page: https://npm.io/package/@uniswap/v3-periphery

## Dependencies (5)

- [base64-sol](https://npm.io/package/base64-sol.md) 1.0.1
- [@uniswap/lib](https://npm.io/package/@uniswap/lib.md) ^4.0.1-alpha
- [@uniswap/v2-core](https://npm.io/package/@uniswap/v2-core.md) ^1.0.1
- [@uniswap/v3-core](https://npm.io/package/@uniswap/v3-core.md) ^1.0.0
- [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) 3.4.2-solc-0.7

## Recent versions

- 1.4.4 (latest) — 2023-09-27
- 1.4.3 — 2022-10-26
- 1.4.2 — 2022-09-16
- 1.4.1 — 2022-04-22
- 1.4.0 — 2022-01-11
- 1.3.0 — 2021-11-05
- 1.2.1 — 2021-09-28
- 1.2.0 — 2021-09-15
- 1.1.1 — 2021-07-02
- 1.1.0 — 2021-06-04
- 1.0.1 — 2021-05-20
- 1.0.0 — 2021-05-04
- 1.0.0-rc.0 — 2021-05-04
- 1.0.0-beta.23 — 2021-04-28
- 1.0.0-beta.22 — 2021-04-22
- … 20 more at https://npm.io/package/@uniswap/v3-periphery/versions

## 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(...);
  }
}

```

---
_Source: https://npm.io/package/@uniswap/v3-periphery · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._