v3-core v1.0.1

SumSwap V3

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

Bug bounty

This repository is subject to the SumSwap V3 bug bounty program, per the terms defined here.

Local deployment

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

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

Using solidity interfaces

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

import 'v3-core/contracts/interfaces/ISummaSwapV3Pool.sol';

contract MyContract {
  ISummaSwapV3Pool pool;

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

Licensing

The primary license for SumSwap V3 Core is the Business Source License 3.0 (GPL-3.0-or-later), see LICENSE.

Exceptions

• All files in contracts/interfaces/ are licensed under GPL-3.0-or-later (as indicated in their SPDX headers), see contracts/interfaces/LICENSE
• Several files in contracts/libraries/ are licensed under GPL-3.0-or-later (as indicated in their SPDX headers), see contracts/libraries/LICENSE_GPL
• contracts/libraries/FullMath.sol is licensed under MIT (as indicated in its SPDX header), see contracts/libraries/LICENSE_MIT
• All files in contracts/test remain unlicensed.