Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/balmy-protocol/dca-v1
https://github.com/balmy-protocol/dca-v1
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/balmy-protocol/dca-v1
- Owner: Balmy-protocol
- License: other
- Created: 2021-04-26T17:52:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-04T13:07:57.000Z (about 3 years ago)
- Last Synced: 2024-11-08T18:51:11.334Z (9 days ago)
- Language: TypeScript
- Size: 2.2 MB
- Stars: 26
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# DCA V1
[](https://github.com/Mean-Finance/dca-v1/actions/workflows/lint.yml)
[](https://github.com/Mean-Finance/dca-v1/actions/workflows/tests.yml)
[](https://www.npmjs.com/package/@mean-finance/dca-v1/v/latest)
This repository contains all the smart contracts pertaining to DCA V1 Protocol.
## ⚠️ Audit
These contracts have not been audited yet, use at your own risk.
## 💰 Bug bounty
This repository is subject to the DCA V1 bug bounty program, per the terms defined [here](./BUG_BOUNTY.md).
## 📖 Docs
Documentations live under [docs.mean.finance](https://docs.mean.finance)
## 🛠️ Keeper Job
For detailed instructions on how to execute our keep3r job go to [docs.mean.finance](https://docs.mean.finance/guides/keep3r-job)
## 📦 NPM/YARN Package
- NPM Installation
```bash
npm --save-dev --save-exact @mean-finance/dca-v1
```
- Yarn installation
```bash
yarn add --dev --exact @mean-finance/dca-v1
```
## 👨💻 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 V1 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.