Canary Smart Contracts
This repo contains all of the smart contracts used to run Canary.
Running
These contracts are compiled and deployed using Hardhat. They can also be run using the Remix IDE. A tutorial for using Remix is located here.
To prepare the dev environment, run yarn install. To compile the contracts, run yarn compile. Yarn is available to install here if you need it.
Accessing the ABI
If you need to use any of the contract ABIs, you can install this repo as an npm package with npm install --dev @canarydex/exchange-contracts. Then import the ABI like so: import { abi as ICanaryPairABI } from '@canarydex/exchange-contracts/artifacts/contracts/canary-core/interfaces/ICanaryPair.sol/ICabnaryPair.json'.
Attribution
These contracts were adapted from these Uniswap repos: uniswap-v2-core, uniswap-v2-periphery, and uniswap-lib.