@squadswap/v3-core

SquadSwap V3

This repository contains the core smart contracts for the SquadSwap V3 Protocol. For higher level contracts, see the v3-periphery repository.

Local deployment

In order to deploy this code to a local testnet, you should install the npm package @squadswap/v3-core and import the factory bytecode located at @squadswap/v3-core/artifacts/contracts/SquadV3Factory.sol/SquadV3Factory.json. For example:

import {
  abi as FACTORY_ABI,
  bytecode as FACTORY_BYTECODE,
} from '@squadswap/v3-core/artifacts/contracts/SquadV3Factory.sol/SquadV3Factory.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 SquadSwap code will correctly interoperate with your local deployment.

Using solidity interfaces

The SquadSwap v3 interfaces are available for import into solidity smart contracts via the npm artifact @squadswap/v3-core, e.g.:

import '@squadswap/v3-core/contracts/interfaces/ISquadV3Pool.sol';

contract MyContract {
  ISquadV3Pool pool;

  function doSomethingWithPool() {
    // pool.swap(...);
  }
}