swifydex-swap-router-contracts v1.0.0

SwifyDex Swap Router

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

Local deployment

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

import {
  abi as SWAP_ROUTER_ABI,
  bytecode as SWAP_ROUTER_BYTECODE,
} from 'swifydex-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 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 swifydex-swap-router-contracts, e.g.:

import 'swifydex-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