Instadapp/dsa-connectors
1
0
Fork 0
mirror of https://github.com/Instadapp/dsa-connectors.git synced 2024-07-29 22:37:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #131 from Instadapp/update-readme

Browse Source 
updated readme.md
This commit is contained in:
Thrilok kumar 2021-12-12 19:23:56 +05:30 committed by GitHub
commit e90d3b025b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -8,6 +8,47 @@ You can create a PR to request a support for specific protocol or external contr
List of all the mainnet connector for referrence is [here](https://github.com/Instadapp/dsa-connectors/tree/main/contracts/mainnet/connectors)
## Usage
### Pre Requisites
Before running any command, make sure to install dependencies:
```sh
$ npm install
```
### Compile
Compile the smart contracts with Hardhat:
```sh
$ npm run compile
```
### TypeChain
Compile the smart contracts and generate TypeChain artifacts:
```sh
$ npm run typechain
```
### Test
Run tests using interactive CLI
```sh
$ npm run test:runner
```
Run all the tests:
```sh
$ npm run test
```
(Striclty use this envirnment to test, or otherwise make suitable changes in config file before testing).
## How to add a new connector
You can create a new PR to add a new connector. To get the PR merged, certain requirements needs to be met which will be explained here.