Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/balmy-protocol/dca-v2-periphery

Last synced: 5 days 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 (about 3 years ago)
Default Branch: main
Last Pushed: 2024-03-19T11:47:16.000Z (8 months ago)
Last Synced: 2024-11-08T08:09:05.478Z (9 days ago)
Language: TypeScript
Size: 2.88 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

[![Lint](https://github.com/Mean-Finance/dca-v2-periphery/actions/workflows/lint.yml/badge.svg)](https://github.com/Mean-Finance/dca-v2-periphery/actions/workflows/lint.yml)

[![Tests (unit, integration)](https://github.com/Mean-Finance/dca-v2-periphery/actions/workflows/tests.yml/badge.svg)](https://github.com/Mean-Finance/dca-v2-periphery/actions/workflows/tests.yml)

[![npm version](https://img.shields.io/npm/v/@mean-finance/dca-v2-periphery/latest.svg)](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.