Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/allwin199/password-store-review
https://github.com/allwin199/password-store-review
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/allwin199/password-store-review
- Owner: allwin199
- Created: 2024-02-25T05:58:06.000Z (9 months ago)
- Default Branch: passwordstore-audit
- Last Pushed: 2024-02-29T08:31:07.000Z (9 months ago)
- Last Synced: 2024-05-29T17:23:47.847Z (6 months ago)
- Language: HTML
- Size: 1.86 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Audit: audit-data/finding-layout.md
Awesome Lists containing this project
README
# PasswordStore
A smart contract application for storing a password. Users should be able to store a password and then retrieve it later. Others should not be able to access the password.
- [PasswordStore](#passwordstore)
- [Getting Started](#getting-started)
- [Requirements](#requirements)
- [Quickstart](#quickstart)
- [Optional Gitpod](#optional-gitpod)
- [Usage](#usage)
- [Deploy (local)](#deploy-local)
- [Testing](#testing)
- [Test Coverage](#test-coverage)
- [Audit Scope Details](#audit-scope-details)
- [Create the audit report](#create-the-audit-report)
# Getting Started
## Requirements
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- You'll know you did it right if you can run `git --version` and you see a response like `git version x.x.x`
- [foundry](https://getfoundry.sh/)
- You'll know you did it right if you can run `forge --version` and you see a response like `forge 0.2.0 (816e00b 2023-03-16T00:05:26.396218Z)`
## Quickstart
```
git clone https://github.com/Cyfrin/3-passwordstore-audit
cd 3-passwordstore-audit
forge build
```
### Optional Gitpod
If you can't or don't want to run and install locally, you can work with this repo in Gitpod. If you do this, you can skip the `clone this repo` part.
[](https://gitpod.io/#github.com/Cyfrin/3-passwordstore-audit)
# Usage
## Deploy (local)
1. Start a local node
```
make anvil
```
2. Deploy
This will default to your local node. You need to have it running in another terminal in order for it to deploy.
```
make deploy
```
## Testing
```
forge test
```
### Test Coverage
```
forge coverage
```
and for coverage based testing:
```
forge coverage --report debug
```
# Audit Scope Details
- Commit Hash: 2e8f81e263b3a9d18fab4fb5c46805ffc10a9990
- In Scope:
```
./src/
└── PasswordStore.sol
```
- Solc Version: 0.8.18
- Chain(s) to deploy contract to: Ethereum
## Create the audit report
View the [audit-report-templating](https://github.com/Cyfrin/audit-report-templating) repo to install all dependencies.
```bash
cd audits
pandoc 2023-09-01-password-store-report.md -o report.pdf --from markdown --template=eisvogel --listings
```