https://github.com/0xjonaseb11/passwd_store
Solidity passwordStore - codehawks
https://github.com/0xjonaseb11/passwd_store
audits blockchain codehawks foundry security solidity tests web3
Last synced: about 1 year ago
JSON representation
Solidity passwordStore - codehawks
- Host: GitHub
- URL: https://github.com/0xjonaseb11/passwd_store
- Owner: 0xJonaseb11
- License: mit
- Created: 2023-10-19T07:45:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-14T02:42:06.000Z (over 2 years ago)
- Last Synced: 2025-01-20T14:58:42.455Z (over 1 year ago)
- Topics: audits, blockchain, codehawks, foundry, security, solidity, tests, web3
- Language: Solidity
- Homepage:
- Size: 912 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### @Jonas-sebera
# PasswordStore
A smart contract applicatoin 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 depending on Contract Ownership.
- [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)
- [Compatibilities](#compatibilities)
- [Roles](#roles)
- [Known Issues](#known-issues)
- [Create the audit report](#create-the-audit-report)
- [@Jonas-sebera](#jonas-sebera-1)
# Getting Started
## Requirements
- [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/Jonas-sebera/PasswordStore
cd PasswordStore
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.
# 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
```
## Compatibilities
- Solc Version: 0.8.18
- Chain(s) to deploy contract to: Ethereum
# Roles
Owner - Only the owner may set and retrieve their password
# Known Issues
None
## 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
```
### @Jonas-sebera