@bonsaiswapv3/swap-router-contracts v2.0.2

Bonsaiswap Swap Router

This repository contains smart contracts for swapping on the Bonsaiswap V3 protocols.

Local deployment

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

import {
  abi as SWAP_ROUTER_ABI,
  bytecode as SWAP_ROUTER_BYTECODE,
} from '@bonsaiswapv3/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 Bonsaiswap code will correctly interoperate with your local deployment.

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