← Explore all skills

SECURITY / trailofbits

Smart Contract Development Guidelines

Review smart-contract architecture, implementation and verification against a structured guideline set.

“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. Use when asking whether a smart contract project follows development best practices, reviewing on-chain/off-chain split, upgradeability, or delegatecall proxy patterns against guidelines, or seeking recommendations on contract design, inheritance, events, documentation, dependencies, or test strategy.”

01 / THE REASONING

Why this made the selection.

  • The detailed assessment distinguishes storage layout, inheritance order, initializer front-running, function shadowing and direct implementation use.
  • Check a proxy upgrade plan for storage layout, initialization and administrative call-routing risks.

02 / THE REVIEW RECORD

What we actually inspected.

Source review has boundaries.
A clear record is more useful than a “safe” badge.

Material inspected

  • plugins/building-secure-contracts/skills/guidelines-advisor/SKILL.md
  • plugins/building-secure-contracts/skills/guidelines-advisor/resources/ASSESSMENT_AREAS.md
  • LICENSE
  • README.md

Our findings

  • The detailed assessment distinguishes storage layout, inheritance order, initializer front-running, function shadowing and direct implementation use.

Not established by this review

  • Third-party instructions and helpers were not executed; service access, host compatibility and outcomes remain untested.

The review applies to the material and revision named here. A newer upstream release can change its behavior.

03 / PUT IT TO WORK

Add a skill to your workflow.

Upstream setup instructions ↗

DOCUMENTED COMMAND

npx skills add trailofbits/skills/plugins/building-secure-contracts/skills/guidelines-advisor

Run in your terminal to choose your AI tools, project or global scope, and installation method. This short command follows the current upstream version; the review covers the revision shown above.

Optional: install the reviewed revision

Keeps the original source and installer version where recorded, while leaving your AI tools and installation scope for you to choose.

npx skills add https://github.com/trailofbits/skills/tree/0f44fe01dcb00bd6929b4ba82a257d305de04554/plugins/building-secure-contracts/skills/guidelines-advisor
  1. Install the pinned directory interactively and retain its referenced files; inspect the source before granting tool access.
  2. Identify platform and architecture, retain the assessment reference and verify whether each upgrade/proxy check applies before generating project-specific findings.

Before you start

  • Contract source and tests; compatible compiler and optional Slither tooling

04 / FOLLOW THE EVIDENCE

The source trail.

Our notes are separate from the original resource.
Check upstream before adopting a new version.

  1. https://github.com/trailofbits/skills/blob/0f44fe01dcb00bd6929b4ba82a257d305de04554/plugins/building-secure-contracts/skills/guidelines-advisor/SKILL.md

    Supports: summary, review, install, access, limitations

  2. https://github.com/trailofbits/skills/blob/0f44fe01dcb00bd6929b4ba82a257d305de04554/plugins/building-secure-contracts/skills/guidelines-advisor/resources/ASSESSMENT_AREAS.md

    Supports: summary, review, install, access, limitations

  3. Pinned LICENSE ↗Checked

    https://github.com/trailofbits/skills/blob/0f44fe01dcb00bd6929b4ba82a257d305de04554/LICENSE

    Supports: license

  4. Pinned README.md ↗Checked

    https://github.com/trailofbits/skills/blob/0f44fe01dcb00bd6929b4ba82a257d305de04554/README.md

    Supports: summary, review, install, access, limitations

Evidence & Ask