https://github.com/balmy-protocol/dca-v2-core
https://github.com/balmy-protocol/dca-v2-core
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/balmy-protocol/dca-v2-core
- Owner: Balmy-protocol
- License: other
- Created: 2021-08-16T19:09:21.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-15T19:33:52.000Z (about 1 year ago)
- Last Synced: 2025-04-15T20:38:31.572Z (about 1 year ago)
- Language: TypeScript
- Size: 4.75 MB
- Stars: 45
- Watchers: 6
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Audit: audits/PeckShield.pdf
Awesome Lists containing this project
README
# DCA V2
[](https://github.com/Balmy-protocol/dca-v2-core/actions/workflows/lint.yml)
[](https://github.com/Balmy-protocol/dca-v2-core/actions/workflows/tests.yml)
[](https://www.npmjs.com/package/@mean-finance/dca-v2-core/v/latest)
This repository contains the core smart contracts for the DCA V2 Protocol.
## ⚠️ Audit
These contracts have been audited. Read all performed audits in [here](./audits).
## 💰 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-core
```
- Yarn installation
```bash
yarn add @balmy/dca-v2-core
```
## 👨💻 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)
### E2E
```bash
yarn test:e2e
```
Will run all tests under [test/e2e](./test/e2e)
### 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 is the Business Source License 1.1 (`BUSL-1.1`), see [`LICENSE`](./LICENSE).
### Exceptions
- All files in `contracts/interfaces/` are licensed under `GPL-2.0-or-later` (as indicated in their SPDX headers), see [`contracts/interfaces/LICENSE`](./contracts/interfaces/LICENSE)
- All files in `contracts/libraries/` are licensed under `GPL-2.0-or-later` (as indicated in their SPDX headers), see [`contracts/libraries/LICENSE`](./contracts/libraries/LICENSE)
- All files in `contracts/mocks` remain unlicensed.