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
+21-9Lines changed: 21 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,37 @@
1
1
# LooksRare Staking
2
2
3
-
This project contains all smart contracts used for staking and other token economics (excluding the airdrop contract).
3
+
This project contains all smart contracts used for staking and other token-related contracts (excluding the airdrop contract!).
4
4
5
-
It is a hybrid Hardhat repo that also requires Forge to run Solidity tests powered by the [ds-test library](https://github.com/dapphub/ds-test/).
5
+
## NPM package
6
6
7
-
To install Forge, please follow the instructions [here](https://onbjerg.github.io/foundry-book/getting-started/installation.html#using-foundryup).
7
+
The NPM package contains the following:
8
8
9
-
## Tests
9
+
- Solidity smart contracts (_".sol"_)
10
+
- ABI files (_".json"_)
10
11
11
-
TypeScript tests are included in the `test` folder at the root of this repo.
12
+
## About this repo
12
13
13
-
Solidity tests are included in the `test` folder in the `contracts` folder.
14
+
### Structure
14
15
15
-
## Example of Forge commands
16
+
It is a hybrid [Hardhat](https://hardhat.org/) repo that also requires [Forge](https://onbjerg.github.io/foundry-book/index.html) to run Solidity tests powered by the [ds-test library](https://github.com/dapphub/ds-test/).
17
+
18
+
> To install Forge, please follow the instructions [here](https://onbjerg.github.io/foundry-book/getting-started/installation.html#using-foundryup).
19
+
20
+
### Run tests
21
+
22
+
- TypeScript tests are included in the `test` folder at the root of this repo.
23
+
- Solidity tests are included in the `test` folder in the `contracts` folder.
0 commit comments