@airdao/astra-cl-periphery/README.md

🎚 Peripheral smart contracts for interacting with AstraDEX Concentrated Liquidity version

# Astra DEX Concentrated Liquidity (CL) Periphery

[![Tests](https://github.com/ambrosus/astra-cl-periphery/workflows/Tests/badge.svg)](https://github.com/ambrosus/astra-cl-periphery/actions?query=workflow%3ATests)
[![Lint](https://github.com/ambrosus/astra-cl-periphery/workflows/Lint/badge.svg)](https://github.com/ambrosus/astra-cl-periphery/actions?query=workflow%3ALint)

This repository contains the periphery smart contracts for the Astra DEX CL Protocol.
For the lower level core contracts, see the [astra-cl-core](https://github.com/ambrosus/astra-cl-core)
repository.

## Local deployment

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

```typescript
import {
  abi as SWAP_ROUTER_ABI,
  bytecode as SWAP_ROUTER_BYTECODE,
} from '@airdao/astra-cl-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 Astra DEX code will correctly interoperate with
your local deployment.

## Using solidity interfaces

The Astra DEX CL periphery interfaces are available for import into solidity smart contracts
via the npm artifact `@airdao/astra-cl-periphery`, e.g.:

```solidity
import '@airdao/astra-cl-periphery/contracts/interfaces/ISwapRouter.sol';

contract MyContract {
  ISwapRouter router;

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