seanbhart/uni-v2-twap-demo

TWAP Calculations (UniswapV2)

This package tests various uses of the UniswapV2 TWAP oracle, including the block proof method to avoid requiring the storage of historical prices manually.

SETUP

nvm install 12
nvm use 12
nvm alias default 12
npm install npm --global

npm init --yes
npm install --save-dev hardhat
npx hardhat

List Hardhat Tasks:

• npx hardhat
• npx hardhat help [task]

Ethers & Waffle:

• npm install --save-dev @nomiclabs/hardhat-ethers ethers @nomiclabs/hardhat-waffle ethereum-waffle chai

Other Libraries:

npm i dotenv
npm i hardhat-gas-reporter
npm install --save-dev @openzeppelin/hardhat-upgrades
npm install --save-dev @nomiclabs/hardhat-ethers ethers # peer dependencies

Directories:

• mkdir contracts scripts test

Compile:

• npx hardhat compile

Deploy:

• npx hardhat run scripts/deploy.ts
• npx hardhat run scripts/deploy.ts --network [network]

Local Faucet:

• npx hardhat --network localhost faucet [address]

Enable TS

• npm install --save-dev ts-node typescript
• npm install --save-dev chai @types/node @types/mocha @types/chai
• mv hardhat.config.js hardhat.config.ts
• Plugins must be loaded with import instead of require.
• Explicitly import the Hardhat config functions
• Defining tasks need to access the Hardhat Runtime Environment explicitly, as a parameter.

TS Custom Path Mapping

In tsconfig.json:

{
    "compilerOptions": {
      "target": "es2018",
      "module": "commonjs",
      "strict": true,
      "esModuleInterop": true,
      "outDir": "dist"
    },
    "include": ["./scripts", "./test"],
    "files": ["./hardhat.config.ts"]
}

Add to config file: import 'tsconfig-paths/register';

More Hardhat TS setup info: https://hardhat.org/guides/typescript.html

Custom packages:

npm i dotenv

Other commands:

hh
hh compile
hh test
hh test test/UniTWAP.test.ts
hh run scripts/deploy.ts --network local
hh run scripts/deploy.ts --network kovan