@oakxswap/v3-core

oakx V3

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

Bug bounty

This repository is subject to the oakx 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 @oakx/v3-core and import the factory bytecode located at @oakx/v3-core/artifacts/contracts/OakxSwapV3Factory.sol/OakxSwapV3Factory.json. For example:

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

Using solidity interfaces

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

import '@oakx/v3-core/contracts/interfaces/IOakxSwapV3Pool.sol';

contract MyContract {
  IOakxSwapV3Pool pool;

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

Licensing

The primary license for oakx V3 Core is the Business Source License 1.1 (BUSL-1.1), see LICENSE. However, some files are dual licensed under GPL-2.0-or-later:

• All files in contracts/interfaces/ may also be licensed under GPL-2.0-or-later (as indicated in their SPDX headers), see contracts/interfaces/LICENSE
• Several files in contracts/libraries/ may also be licensed under GPL-2.0-or-later (as indicated in their SPDX headers), see contracts/libraries/LICENSE

Other Exceptions

• 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 (as indicated in their SPDX headers).