@mean-finance/dca-v1 v1.0.1

DCA V1

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.

📖 Docs

Documentations live under docs.mean.finance

🛠️ Keeper Job

For detailed instructions on how to execute our keep3r job go to docs.mean.finance

📦 NPM/YARN Package

• NPM Installation

npm --save-dev --save-exact @mean-finance/dca-v1

• Yarn installation

yarn add --dev --exact @mean-finance/dca-v1

👨‍💻 Development environment

• Copy environment file

cp .env.example .env

• Fill environment file with your information

nano .env

🧪 Testing

Unit

yarn test:unit

Will run all tests under /test/unit

E2E

yarn test:e2e

Will run all tests under /test/e2e

Integration

You will need to set up the development environment first, please refer to the development environment section.

yarn test:integration

Will run all tests under /test/integration

🚢 Deployment

You will need to set up the development environment first, please refer to the development environment section.

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.

Exceptions

• All files in contracts/interfaces/ are licensed under GPL-2.0-or-later (as indicated in their SPDX headers), see 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
• All files in contracts/mocks remain unlicensed.