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.
The `guidelines-advisor` skill is a specialized tool designed to assist developers in evaluating and improving smart contract codebases. It addresses the challenges of maintaining secure, well-documented, and efficient smart contracts by providing systematic guidance based on Trail of Bits' best practices. The skill helps teams identify architectural weaknesses, implementation pitfalls, dependency risks, and testing gaps, ensuring that smart contracts are robust, maintainable, and aligned with industry standards.
This skill offers a range of capabilities, including generating plain English documentation and specifications, creating architectural diagrams, reviewing upgradeability patterns and proxy implementations, and assessing function composition, inheritance structures, and event logging. It also evaluates testing coverage, dependency quality, and platform-specific considerations like compiler warnings or Solidity version recommendations. Each analysis phase—from discovery and documentation generation to architecture review and actionable recommendations—is designed to provide comprehensive insights and prioritized improvement suggestions.
`guidelines-advisor` is particularly useful for smart contract developers, auditors, and project teams seeking to enhance code quality, security, and maintainability. It can be applied during development to guide best practices, prior to audits to identify potential issues, or for educational purposes to train developers on secure smart contract patterns. The skill targets users working with Solidity and other smart contract platforms, helping them optimize both on-chain and off-chain components while mitigating common vulnerabilities.
You provide the codebase for analysis, and the skill systematically reviews the project structure, documentation, architecture, upgrade patterns, and test coverage to generate detailed recommendations and actionable guidance.
The skill is primarily designed for Solidity-based projects and platforms that support similar development patterns. It focuses on patterns like proxies, upgrades, and delegatecall implementations commonly used in Ethereum and EVM-compatible chains.
No, the skill provides assessments, documentation, and prioritized recommendations but does not modify the code automatically. Developers must implement suggested improvements manually.
A basic understanding of smart contract development, project structure, and Solidity concepts is required. Familiarity with testing, upgrades, and proxy patterns will help interpret and apply the recommendations effectively.
Yes, it can produce architectural diagrams using analysis tools such as Slither printers for Solidity, providing clear visualizations of system components and their interactions.
Quick Setup:
.claude/skills/Repository
trailofbits/skills