https://github.com/balmy-protocol/dca-v2-periphery
https://github.com/balmy-protocol/dca-v2-periphery
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/balmy-protocol/dca-v2-periphery
- Owner: Balmy-protocol
- License: gpl-2.0
- Created: 2021-10-27T18:49:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-15T19:31:04.000Z (about 1 year ago)
- Last Synced: 2025-05-15T10:48:56.644Z (about 1 year ago)
- Language: TypeScript
- Size: 3.14 MB
- Stars: 11
- Watchers: 5
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DCA V2 - Periphery
[](https://github.com/Balmy-protocol/dca-v2-periphery/actions/workflows/lint.yml)
[](https://github.com/Balmy-protocol/dca-v2-periphery/actions/workflows/tests.yml)
[](https://www.npmjs.com/package/@balmy/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.balmy.xyz](https://docs.balmy.xyz)
## ๐ฆ NPM/YARN Package
- NPM Installation
```bash
npm install @balmy/dca-v2-periphery
```
- Yarn installation
```bash
yarn add @balmy/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.