This repository contains the core smart contracts for the Firefly V3 Protocol. For higher level contracts, see the firefly-v3-periphery repository.
This repository is subject to the Firefly V3 bug bounty program, per the terms defined here.
In order to deploy this code to a local testnet, you should install the npm package
@firefly-dex/core-v3
and import the factory bytecode located at
@firefly-dex/core-v3/artifacts/contracts/FireflyV3Factory.sol/FireflyV3Factory.json
.
For example:
import {
abi as FACTORY_ABI,
bytecode as FACTORY_BYTECODE,
} from '@firefly-dex/core-v3/artifacts/contracts/FireflyV3Factory.sol/FireflyV3Factory.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 Firefly code will correctly interoperate with your local deployment.
The Firefly v3 interfaces are available for import into solidity smart contracts
via the npm artifact @firefly-dex/core-v3
, e.g.:
import '@firefly-dex/core-v3/contracts/interfaces/IFireflyV3Pool.sol';
contract MyContract {
IFireflyV3Pool pool;
function doSomethingWithPool() {
// pool.swap(...);
}
}
The primary license for Firefly 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 underGPL-2.0-or-later
(as indicated in their SPDX headers), seecontracts/interfaces/LICENSE
- Several files in
contracts/libraries/
may also be licensed underGPL-2.0-or-later
(as indicated in their SPDX headers), seecontracts/libraries/LICENSE
-
contracts/libraries/FullMath.sol
is licensed underMIT
(as indicated in its SPDX header), seecontracts/libraries/LICENSE_MIT
- All files in
contracts/test
remain unlicensed (as indicated in their SPDX headers).