guidelines-advisor
Smart contract development advisor based on Trail of Bits' best practices. Analyzes codebase to generate documentation/specifications, review architecture, check upgradeability patterns, assess implementation quality, identify pitfalls, review dependencies, and evaluate testing.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Smart contract development advisor based on Trail of Bits' best practices. Analyzes codebase to generate documentation/specifications, review architecture, check upgradeability patterns, assess implementation quality, identify pitfalls, review dependencies, and evaluate testing. Provides actionable recommendations.
How to use
Zainstaluj skill guidelines-advisor w swoim środowisku Claude/Copilot, wskazując repozytorium z kodem smart kontraktów, który chcesz przeanalizować.
Uruchom analizę, podając ścieżkę do folderu zawierającego pliki kontraktów (Solidity, Vyper lub inny obsługiwany format). Narzędzie automatycznie eksploruje strukturę projektu, istniejącą dokumentację i konfigurację testów.
Przejrzyj wygenerowaną dokumentację i diagramy architektoniczne — otrzymasz opis systemu w języku naturalnym oraz wizualizacje wzorców on-chain i off-chain (jeśli dotyczy).
Przeanalizuj raport dotyczący upgradeability — jeśli projekt zawiera proxy lub delegatecall, narzędzie oceni poprawność implementacji i zasugeruje ulepszenia.
Zbadaj ocenę jakości implementacji: przejrzyj uwagi dotyczące składu funkcji, dziedziczenia, logowania zdarzeń oraz typowych zagrożeń. Narzędzie sprawdzi również jakość zależności i pokrycie testami.
Zastosuj rekomendacje — każda sugestia jest konkretna i oparta na wytycznych Trail of Bits, co pozwala na szybkie wdrożenie popraw w kodzie.