You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-18
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
## INSTALL
4
4
5
5
```bash
6
-
yarn
6
+
pnpm i
7
7
```
8
8
9
9
## TEST
@@ -15,7 +15,7 @@ There are 3 flavors of tests: hardhat, dapptools and forge
15
15
- One using hardhat that can leverage hardhat-deploy to reuse deployment procedures and named accounts:
16
16
17
17
```bash
18
-
yarntest
18
+
pnnpmtest
19
19
```
20
20
21
21
### [dapptools](https://dapp.tools)
@@ -59,88 +59,88 @@ Here is the list of npm scripts you can execute:
59
59
Some of them relies on [./\_scripts.js](./_scripts.js) to allow parameterizing it via command line argument (have a look inside if you need modifications)
60
60
<br/><br/>
61
61
62
-
### `yarn prepare`
62
+
### `pnpm prepare`
63
63
64
64
As a standard lifecycle npm script, it is executed automatically upon install. It generate config file and typechain to get you started with type safe contract interactions
65
65
<br/><br/>
66
66
67
-
### `yarn format` and `yarn format:fix`
67
+
### `pnpm format` and `pnpm format:fix`
68
68
69
69
These will format check your code. the `:fix` version will modifiy the files to match the requirement specified in `.prettierrc.`
70
70
<br/><br/>
71
71
72
-
### `yarn compile`
72
+
### `pnpm compile`
73
73
74
74
These will compile your contracts
75
75
<br/><br/>
76
76
77
-
### `yarn void:deploy`
77
+
### `pnpm void:deploy`
78
78
79
79
This will deploy your contracts on the in-memory hardhat network and exit, leaving no trace. quick way to ensure deployments work as intended without consequences
80
80
<br/><br/>
81
81
82
-
### `yarn test [mocha args...]`
82
+
### `pnpm test [mocha args...]`
83
83
84
84
These will execute your tests using mocha. you can pass extra arguments to mocha
85
85
<br/><br/>
86
86
87
-
### `yarn coverage`
87
+
### `pnpm coverage`
88
88
89
89
These will produce a coverage report in the `coverage/` folder
90
90
<br/><br/>
91
91
92
-
### `yarn gas`
92
+
### `pnpm gas`
93
93
94
94
These will produce a gas report for function used in the tests
95
95
<br/><br/>
96
96
97
-
### `yarn dev`
97
+
### `pnpm dev`
98
98
99
99
These will run a local hardhat network on `localhost:8545` and deploy your contracts on it. Plus it will watch for any changes and redeploy them.
100
100
<br/><br/>
101
101
102
-
### `yarn local:dev`
102
+
### `pnpm local:dev`
103
103
104
104
This assumes a local node it running on `localhost:8545`. It will deploy your contracts on it. Plus it will watch for any changes and redeploy them.
105
105
<br/><br/>
106
106
107
-
### `yarn execute <network> <file.ts> [args...]`
107
+
### `pnpm execute <network> <file.ts> [args...]`
108
108
109
109
This will execute the script `<file.ts>` against the specified network
110
110
<br/><br/>
111
111
112
-
### `yarn deploy <network> [args...]`
112
+
### `pnpm deploy <network> [args...]`
113
113
114
114
This will deploy the contract on the specified network.
115
115
116
116
Behind the scene it uses `hardhat deploy` command so you can append any argument for it
117
117
<br/><br/>
118
118
119
-
### `yarn export <network> <file.json>`
119
+
### `pnpm export <network> <file.json>`
120
120
121
121
This will export the abi+address of deployed contract to `<file.json>`
0 commit comments