/NSwap

Primary LanguageSolidity

Simple Swap

Swapping from token A to token B.

Using this Project

Clone this repository, then install the dependencies with npm install, then compile contracts with npm run compile.

Run Contract Tests & Get Callstacks

npm run test

Run Coverage Report for Tests

npm run coverage

Run docgen

npm run doc or npx hardhat docgen

The document will be created in the docs folder.

Check about NatSpec to know how to describe your contract to docgen.

Deploy example

Script to deploy SimpleSwap in rinkeby.

create .env before.

npx hardhat run --network rinkeby scripts/deploySimpleSwap.ts