# PancakeSwap V3

This repository contains the core smart contracts for the PancakeSwap V3 Protocol.
For higher level contracts, see the [v3-periphery](../v3-periphery/)
repository.

## Local deployment

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

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

## Using solidity interfaces

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

```solidity
import '@pancakeswap/v3-core/contracts/interfaces/IPancakeV3Pool.sol';

contract MyContract {
  IPancakeV3Pool pool;

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

```