https://github.com/kybernetwork/katalyst_dao_sc

https://github.com/kybernetwork/katalyst_dao_sc

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/kybernetwork/katalyst_dao_sc
• Owner: KyberNetwork
• License: mit
• Created: 2020-08-19T08:32:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-20T17:25:59.000Z (almost 4 years ago)
• Last Synced: 2023-09-05T20:26:11.885Z (over 1 year ago)
• Language: JavaScript
• Size: 437 KB
• Stars: 5
• Watchers: 10
• Forks: 69
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Introduction

[![built-with openzeppelin](https://img.shields.io/badge/built%20with-OpenZeppelin-3677FF)](https://docs.openzeppelin.com/)

[![Build Status](https://api.travis-ci.com/KyberNetwork/kyber_dao_sc.svg?branch=master&status=passed)](https://travis-ci.com/github/KyberNetwork/kyber_dao_sc)

This repository contains the KyberDao smart contracts.

For more details, please visit the KyberDao section of our [developer portal](https://developer.kyber.network/docs/API_ABI-KyberDao/)

## Package Manager

We use `yarn` as the package manager. You may use `npm` and `npx` instead, but commands in bash scripts may have to be changed accordingly.

## Setup

1. Clone this repo

2. `yarn install`

## Compilation

`yarn compile` to compile contracts for all solidity versions.

## Contract Deployment / Interactions

For interactions or contract deployments on public testnets / mainnet, create a `.env` file specifying your private key and infura api key, with the following format:

```

PRIVATE_KEY=0x****************************************************************

INFURA_API_KEY=********************************

```

## Testing with Hardhat

1. If contracts have not been compiled, run `yarn compile`. This step can be skipped subsequently.

2. Run `yarn test`

3. Use `./tst.sh -f` for running a specific test file.

### Example Commands

- `yarn test` (Runs all tests)

- `./tst.sh -f ./test/kyberDao.js` (Test only kyberDao.js)

### Example

`yarn hardhat test --no-compile ./test/kyberDao.js`

## Coverage

`yarn coverage` (Runs coverage for all applicable files)