CryptoSwap V3

This repository contains the core smart contracts for the CryptoSwap V3 Protocol.
For higher level contracts, see the v3-periphery
repository.

Local deployment

In order to deploy this code to a local testnet, you should install the npm package
@cryptoswapdex/v3-core
and import the factory bytecode located at
@cryptoswapdex/v3-core/artifacts/contracts/CryptoV3Factory.sol/CryptoV3Factory.json.
For example:

``typescript
import {
abi as FACTORY_ABI,
bytecode as FACTORY_BYTECODE,
} from '@cryptoswapdex/v3-core/artifacts/contracts/CryptoV3Factory.sol/CryptoV3Factory.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 CryptoSwap code will correctly interoperate with
your local deployment.

Using solidity interfaces

The CryptoSwap v3 interfaces are available for import into solidity smart contracts
via the npm artifact @cryptoswapdex/v3-core, e.g.:

`solidity
import '@cryptoswapdex/v3-core/contracts/interfaces/ICryptoV3Pool.sol';

contract MyContract {
ICryptoV3Pool pool;

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