@escswap/v3-core
v1.0.2
Published
🦄 Core smart contracts of Escswap V3
Downloads
2
Readme
Escswap V3
This repository contains the core smart contracts for the Escswap V3 Protocol. For higher level contracts, see the escswap-v3-periphery repository.
Bug bounty
This repository is subject to the Escswap 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
@escswap/v3-core
and import the factory bytecode located at
@escswap/v3-core/artifacts/contracts/EscswapV3Factory.sol/EscswapV3Factory.json
.
For example:
import {
abi as FACTORY_ABI,
bytecode as FACTORY_BYTECODE,
} from '@escswap/v3-core/artifacts/contracts/EscswapV3Factory.sol/EscswapV3Factory.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 Escswap code will correctly interoperate with your local deployment.
Using solidity interfaces
The Escswap v3 interfaces are available for import into solidity smart contracts
via the npm artifact @escswap/v3-core
, e.g.:
import '@escswap/v3-core/contracts/interfaces/IEscswapV3Pool.sol';
contract MyContract {
IEscswapV3Pool pool;
function doSomethingWithPool() {
// pool.swap(...);
}
}
Licensing
The primary license for Escswap V3 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.