https://github.com/cawfree/mycroft
🕵️♀️ Mycroft is a self-populating flashcard deck for Watsons.
https://github.com/cawfree/mycroft
audit defi ethereum research security sherlock smart-contract solidity
Last synced: 4 months ago
JSON representation
🕵️♀️ Mycroft is a self-populating flashcard deck for Watsons.
- Host: GitHub
- URL: https://github.com/cawfree/mycroft
- Owner: cawfree
- License: cc0-1.0
- Created: 2024-01-27T23:43:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-04T00:19:09.000Z (over 2 years ago)
- Last Synced: 2025-12-08T23:31:42.297Z (7 months ago)
- Topics: audit, defi, ethereum, research, security, sherlock, smart-contract, solidity
- Language: TypeScript
- Homepage: https://sherlock.xyz
- Size: 566 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mycroft
[__Mycroft__](https://github.com/cawfree/Mycroft) is a self-populating flashcard deck designed to help [__watsons__](https://audits.sherlock.xyz/leaderboard) study.
It detects the contests that a watson has participated in and randomizes through the issues raised in each contest, to help improve learning through repetition. Over time, this will aid you to become increasingly familiar with the root causes, ways of thinking and subtle implementation flaws you'd missed for a previous audit - and make sure you don't miss it the next time.
### 🤔 What does it do?
Quite little - in fact, just enough to be _barely_ useful.
But it does make it a lot easier for you to revisit contests where you have context to understand the issues raised and try to test your memory.
- 🕵️♀️ Browse the issues raised in contests for other watsons.
- 🔀 Shuffle through issues.
- 🚫 Ignore issues you don't want to see again.
## ✏️ Usage
You'll need to have [__Google Chrome__](https://blog.google/products/chrome/) installed, since this relies upon [`puppeteer`](https://github.com/puppeteer/puppeteer) for both web-scraping and rendering.
Once that's done, you can initialize the project like so:
```shell
git clone https://github.com/cawfree/Mycroft
cd Mycroft
yarn
```
To prepare a deck of contest issues for a given `$AUDITOR_NAME`, you can use:
```shell
yarn start $AUDITOR_NAME
```
That should be everything!
## ✌️ License
[__CC0-1.0__](LICENSE.md)