@mean-finance/dca-v2-periphery
Version:
💱 Periphery smart contracts of DCA V2 by mean.finance
82 lines (49 loc) • 2.03 kB
Markdown
# DCA V2 - Periphery
[](https://github.com/Mean-Finance/dca-v2-periphery/actions/workflows/lint.yml)
[](https://github.com/Mean-Finance/dca-v2-periphery/actions/workflows/tests.yml)
[](https://www.npmjs.com/package/@mean-finance/dca-v2-periphery/v/latest)
This repository contains the periphery smart contracts for the DCA V2 Protocol.
## 💰 Bug bounty
This repository is subject to the DCA V2 bug bounty program, per the terms defined [here](./BUG_BOUNTY.md).
## 📖 Docs
Check our docs at [docs.mean.finance](https://docs.mean.finance)
## 📦 NPM/YARN Package
- NPM Installation
```bash
npm install @mean-finance/dca-v2-periphery
```
- Yarn installation
```bash
yarn add @mean-finance/dca-v2-periphery
```
## 👨💻 Development environment
- Copy environment file
```bash
cp .env.example .env
```
- Fill environment file with your information
```bash
nano .env
```
## 🧪 Testing
### Unit
```bash
yarn test:unit
```
Will run all tests under [test/unit](./test/unit)
### Integration
You will need to set up the development environment first, please refer to the [development environment](#-development-environment) section.
```bash
yarn test:integration
```
Will run all tests under [test/integration](./test/integration)
## 🚢 Deployment
You will need to set up the development environment first, please refer to the [development environment](#-development-environment) section.
```bash
yarn deploy --network [network]
```
The plugin `hardhat-deploy` is used to deploy contracts.
## Licensing
The primary license for DCA V2 Periphery is the GNU General Public License v2.0 (`GPL-2.0-or-later`), see [`LICENSE`](./LICENSE).
### Exceptions
- All files in `contracts/mocks` remain unlicensed.