@chaoswap/chaoswap-core
v0.0.6
Published
Core smart contracts of Chaoswap
Downloads
6
Readme
Chaoswap
This repository contains the core smart contracts for the Chaoswap Protocol. For higher level contracts, see the chaoswap-periphery repository.
Bug bounty
This repository is subject to the Chaoswap 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
@chaoswap/chaoswap-core
and import the factory bytecode located at
@chaoswap/chaoswap-core/artifacts/contracts/ChaoswapFactory.sol/ChaoswapFactory.json
.
For example:
import {
abi as FACTORY_ABI,
bytecode as FACTORY_BYTECODE,
} from '@chaoswap/chaoswap-core/artifacts/contracts/ChaoswapFactory.sol/ChaoswapFactory.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 Chaoswap code will correctly interoperate with your local deployment.
Using solidity interfaces
The Chaoswap v3 interfaces are available for import into solidity smart contracts
via the npm artifact @chaoswap/chaoswap-core
, e.g.:
import '@chaoswap/chaoswap-core/contracts/interfaces/IChaoswapPool.sol';
contract MyContract {
IChaoswapPool pool;
function doSomethingWithPool() {
// pool.swap(...);
}
}
Licensing
The primary license for Chaoswap Core is the Business Source License 1.1 (BUSL-1.1
), see LICENSE
.
Exceptions
- All files in
contracts/interfaces/
are licensed underGPL-2.0-or-later
(as indicated in their SPDX headers), seecontracts/interfaces/LICENSE
- Several files in
contracts/libraries/
are licensed underGPL-2.0-or-later
(as indicated in their SPDX headers), seecontracts/libraries/LICENSE_GPL
contracts/libraries/FullMath.sol
is licensed underMIT
(as indicated in its SPDX header), seecontracts/libraries/LICENSE_MIT
- All files in
contracts/test
remain unlicensed.