README.md

📈 DEX MVP

🔧 Setting up Local Development

Required:

• Node v16
• Yarn
• Git

Refer to .env for required keys.

$ git clone https://github.com/vasemkin/dex.git
$ cd dex

# install dependancies
$ yarn
$ yarn chain

The chain is now running at http://localhost:8545! The contracts are deployed automatically. This network is reffered to as localhost. Open the source code and start editing!

Make sure your Metamask chainId is 31337. It is 1337 by default.

Testing

$ yarn typechain
$ yarn test

The tests are run on the hardhat network. It is different from localhost.

Deployment

$ yarn deploy:testnet

This code is not audited. It is not recommended to deploy to mainnet.

Architecture / Main Layout

./
├── contracts/    // Solidity smart contracts
├── deploy/       // Contract deployments
├── test/         // Unit tests
├── diagrams/     // mermaid.js diagrams
├── deployments/  // ABI, deployment address (autogenerated)
└── typechain/    // Typescript interfaces (autogenerated)