# @pollum-io/v2-periphery

> 🎚 Peripheral smart contracts for interacting with Pegasys V2

Latest version **0.0.2** (published 2023-05-04) · gpl-3.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @pollum-io/v2-periphery
pnpm add @pollum-io/v2-periphery
yarn add @pollum-io/v2-periphery
bun add @pollum-io/v2-periphery
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-05-04 |
| First published | 2023-04-24 |
| Weekly downloads | 0 |
| License | gpl-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 5 |
| Unpacked size | 700.5 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | clausss, leozera14, lucasgabrielgsp, thomgabriel, lucasbitt, gabrielprediger, canokaue |
| Keywords | pegasys, periphery, v2 |

## Links

- npm: https://www.npmjs.com/package/@pollum-io/v2-periphery
- Repository: https://github.com/pegasys-fi/v2-periphery
- Homepage: https://pegasys.fi
- Issues: https://github.com/pegasys-fi/v2-periphery/issues
- npm.io page: https://npm.io/package/@pollum-io/v2-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
- [@pollum-io/v2-core](https://npm.io/package/@pollum-io/v2-core.md) 0.0.2
- [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) 3.4.2-solc-0.7
- [@pollum-io/pegasys-protocol](https://npm.io/package/@pollum-io/pegasys-protocol.md) 0.0.17

## Recent versions

- 0.0.2 (latest) — 2023-05-04
- 0.0.1 — 2023-04-24

## README

# Pegasys V2 Periphery

[![Tests](https://github.com/pegasys-fi/v2-phperiphery/workflows/Tests/badge.svg)](https://github.com/pegasys-fi/v2-phperiphery/actions?query=workflow%3ATests)
[![Lint](https://github.com/pegasys-fi/v2-phperiphery/workflows/Lint/badge.svg)](https://github.com/pegasys-fi/v2-phperiphery/actions?query=workflow%3ALint)

This repository contains the periphery smart contracts for the Pegasys V2 Protocol.
For the lower level core contracts, see the [v2-core](https://github.com/pegasys-fi/v2-core)
repository.


## Local deployment

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

```typescript
import {
  abi as SWAP_ROUTER_ABI,
  bytecode as SWAP_ROUTER_BYTECODE,
} from '@pollum-io/v2-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 Pegasys code will correctly interoperate with
your local deployment.

## Using solidity interfaces

The Pegasys V2 periphery interfaces are available for import into solidity smart contracts
via the npm artifact `@pollum-io/v2-periphery`, e.g.:

```solidity
import '@pollum-io/v2-periphery/contracts/interfaces/ISwapRouter.sol';

contract MyContract {
  ISwapRouter router;

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

```

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