mirror of
https://github.com/Instadapp/dsa-connectors.git
synced 2024-07-29 22:37:00 +00:00
updated readme.md
This commit is contained in:
parent
593fb86367
commit
7283c20a88
41
README.md
41
README.md
|
@ -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)
|
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
|
## 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.
|
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.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user