This repository contains the core smart contracts for the btcswap Protocol. For higher level contracts, see the btcswap-v3-periphery repository.
In order to deploy this code to a local testnet, you should install the npm package
@btcswap/v3-core
and import the factory bytecode located at
@btcswap/v3-core/artifacts/contracts/btcswapV3Factory.sol/btcswapV3Factory.json
.
For example:
import {
abi as FACTORY_ABI,
bytecode as FACTORY_BYTECODE,
} from '@btcswap/v3-core/artifacts/contracts/btcswapV3Factory.sol/btcswapV3Factory.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 btcswap code will correctly interoperate with your local deployment.
The btcswap v3 interfaces are available for import into solidity smart contracts
via the npm artifact @btcswap/v3-core
, e.g.:
import '@btcswap/v3-core/contracts/interfaces/IbtcswapV3Pool.sol';
contract MyContract {
IbtcswapV3Pool pool;
function doSomethingWithPool() {
// pool.swap(...);
}
}
The primary license for btcswap 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).