Skip to content

Commit 01e3248

Browse files
author
Jani Anttonen
committed
Trade DX for UX, update Readme
1 parent 2940303 commit 01e3248

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ curl --compressed -o- -L https://yarnpkg.com/install.sh | bash
1414

1515
We use [Hardhat](https://hardhat.org/) as a build tool.
1616

17-
To build, `yarn install` (generates Typechain bindings), and run model tests:
17+
On first `yarn install` the typechain generation will fail, as the contracts aren't built on `postinstall`. Just run
18+
19+
To build, `yarn install`, build contracts with `yarn run compile:sol`, generate Typechain bindings with `yarn run generate:typechain`, and run model tests:
1820
```
1921
yarn install
22+
yarn run compile:sol
23+
yarn run generate:typechain
2024
yarn test
2125
```
2226

package.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "@vanilladefi/trade-contracts",
3-
"version": "1.1.15",
3+
"version": "1.1.16",
44
"description": "Smart contracts for vanilladefi.com",
55
"main": "./typechain/vanilla_v1.1/index.ts",
66
"scripts": {
77
"prepare": "npm run compile:sol",
8-
"postinstall": "npm run compile:sol && npm run generate:typechain-wo-test",
8+
"postinstall": "npm run generate:typechain-wo-test",
99
"test": "npm run generate:test-types && npx hardhat test",
1010
"format:js": "eslint --fix test/ utils/ hardhat/ deploy/",
1111
"format:sol": "prettier --write contracts/",
@@ -34,9 +34,7 @@
3434
"url": "https://github.com/vanilladefi/contracts"
3535
},
3636
"files": [
37-
"artifacts/**/*",
38-
"hardhat.*.ts",
39-
"network.*.ts"
37+
"artifacts/**/*"
4038
],
4139
"devDependencies": {
4240
"@ethereum-waffle/chai": "^3.4.0",

0 commit comments

Comments
 (0)