@planq-fi/contracts

PlanqFi

This repository contains the core smart contracts for the PlanqFi Protocol. For higher level contracts, see the planq-fi-periphery repository.

Bug bounty

This repository is subject to the PlanqFi 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 @planq-fi/contracts and import the factory bytecode located at @planq-fi/contracts/artifacts/contracts/PlanqFiFactory.sol/PlanqFiFactory.json. For example:

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

Using solidity interfaces

The PlanqFi interfaces are available for import into solidity smart contracts via the npm artifact @planq-fi/contracts, e.g.:

import '@planq-fi/contracts/contracts/interfaces/IPlanqFiPool.sol';

contract MyContract {
  IPlanqFiPool pool;

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

Licensing

The primary license for PlanqFi is 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).