@pancakeswap/v3-periphery

1.0.2ย โ€ขย Publicย โ€ขย Published

PancakeSwap V3 Periphery

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

Local deployment

In order to deploy this code to a local testnet, you should install the npm package @pancakeswap/v3-periphery and import bytecode imported from artifacts located at @pancakeswap/v3-periphery/artifacts/contracts/*/*.json. For example:

import {
  abi as SWAP_ROUTER_ABI,
  bytecode as SWAP_ROUTER_BYTECODE,
} from '@pancakeswap/v3-periphery/artifacts/contracts/SwapRouter.sol/SwapRouter.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 periphery interfaces are available for import into solidity smart contracts via the npm artifact @pancakeswap/v3-periphery, e.g.:

import '@pancakeswap/v3-periphery/contracts/interfaces/ISwapRouter.sol';

contract MyContract {
  ISwapRouter router;

  function doSomethingWithSwapRouter() {
    // router.exactInput(...);
  }
}

Package Sidebar

Install

npm i @pancakeswap/v3-periphery

Weekly Downloads

728

Version

1.0.2

License

GPL-2.0-or-later

Unpacked Size

829 kB

Total Files

93

Last publish

Collaborators

  • chefjackson
  • chef-jojo
  • pancakeswapadmin