elektrik-swap-router-contracts/README.md

Smart contracts for swapping on Elektrik V1

# Elektrik Swap Router

[![Tests](https://github.com/Elektrik/swap-router-contracts/workflows/Tests/badge.svg)](https://github.com/Elektrik/swap-router-contracts/actions?query=workflow%3ATests)
[![Lint](https://github.com/Elektrik/swap-router-contracts/workflows/Lint/badge.svg)](https://github.com/Elektrik/swap-router-contracts/actions?query=workflow%3ALint)

This repository contains smart contracts for swapping on the Elektrik V2 and V3 protocols.

## Bug bounty

This repository is subject to the Elektrik V1 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/swap-router-contracts`
and import bytecode imported from artifacts located at
`uniswap/swap-router-contracts/artifacts/contracts/*/*.json`.
For example:

```typescript
import {
  abi as SWAP_ROUTER_ABI,
  bytecode as SWAP_ROUTER_BYTECODE,
} from 'uniswap/swap-router-contracts/artifacts/contracts/SwapRouter02.sol/SwapRouter02.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 Elektrik code will correctly interoperate with
your local deployment.

## Using solidity interfaces

The swap router contract interfaces are available for import into solidity smart contracts
via the npm artifact `uniswap/swap-router-contracts`, e.g.:

```solidity
import 'uniswap/swap-router-contracts/contracts/interfaces/ISwapRouter02.sol';

contract MyContract {
  ISwapRouter02 router;

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

```

## Tests

Some tests use Hardhat mainnet forking and therefore require an archive node.
Either create a `.env` file in the workspace root containing:

```
ARCHIVE_RPC_URL='...'
```

Or set the variable when running tests:

```
export ARCHIVE_RPC_URL='...' && npm run test
```