generated from ScopeLift/foundry-template
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e7f405a
commit f0070f1
Showing
2 changed files
with
22 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,13 +11,9 @@ This repo is developed using [Foundry](https://book.getfoundry.sh/). | |
|
||
### Setup | ||
|
||
1. Install [Foundry](https://book.getfoundry.sh/getting-started/installation) on your local machine by opening the terminal and running the following command: | ||
1. Install Foundry on your local machine by following the [instructions here](https://book.getfoundry.sh/getting-started/installation). | ||
|
||
```sh | ||
curl -L https://foundry.paradigm.xyz | bash | ||
``` | ||
|
||
2. Clone the repo and navigate to the root directory of the repo. | ||
2. Clone the repo and navigate to the root directory of the repo: | ||
|
||
```sh | ||
git clone [email protected]:ScopeLift/stealth-address-erc-contracts.git | ||
|
@@ -45,23 +41,35 @@ forge test | |
forge coverage | ||
``` | ||
|
||
### Specifications | ||
### Linting and Specifications | ||
|
||
#### Pre-requisites | ||
This project uses [scopelint](https://github.com/ScopeLift/scopelint) for linting and spec generation. Follow [these instructions](https://github.com/ScopeLift/scopelint?tab=readme-ov-file#installation) to install it. | ||
|
||
1. Install the [rust toolchain](https://www.rust-lang.org/tools/install). | ||
2. Run `cargo install scopelint` | ||
#### Lint | ||
|
||
#### See contract specifications | ||
```bash | ||
# Check formatting | ||
scopelint check | ||
# Apply formatting changes | ||
scopelint fmt | ||
``` | ||
|
||
```sh | ||
#### Spec | ||
|
||
```bash | ||
scopelint spec | ||
``` | ||
|
||
This command will use the names of the contract's unit tests to generate a human readable spec. It will list each contract, its constituent functions, and the human readable description of functionality each unit test aims to assert. | ||
|
||
## Deployments | ||
|
||
Coming soon. | ||
|
||
## Security | ||
|
||
Coming soon. | ||
|
||
## License | ||
|
||
Contracts in this repository are released under the [MIT License](https://github.com/ScopeLift/stealth-address-erc-contracts/blob/main/LICENSE). |