vyper-best-practices

Enforce naming, layout, and security best practices in Vyper contracts.

Updated Apr 9, 2026
One-click install
npx skills add https://github.com/rafael-abuawad/skills --skill vyper-best-practices
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vyper-best-practices
Source: https://github.com/rafael-abuawad/skills/tree/main/vyper-best-practices
Command: npx skills add https://github.com/rafael-abuawad/skills --skill vyper-best-practices

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Vyper contracts often suffer from inconsistent patterns, security pitfalls, and maintenance challenges. This skill consolidates official guidance and community best practices to improve code quality and safety.

Core Features & Use Cases

  • Naming conventions for modules (.vy files), interfaces (.vyi), constants, and internal items.
  • Enforced contract layout and module usage, NatSpec documentation, and security patterns.
  • Use cases include writing new Vyper contracts, auditing existing code, and refactoring for readability and security.

Quick Start

Apply these guidelines when writing, reviewing, or refactoring Vyper contracts to produce modular, secure, and readable code.

Frequently Asked Questions about vyper-best-practices

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the best practices for writing secure Vyper smart contracts?

Best practices for secure Vyper smart contracts include enforcing naming conventions, structuring module layout order, applying NatSpec documentation, and following established security patterns during contract writing and refactoring.

How do I enforce naming conventions and module layout in Vyper projects?

To enforce naming conventions and module layout in Vyper projects, apply standardized rules for .vy files, .vyi interfaces, constants, and internal items, ensuring consistent contract structure and decorator order across the codebase.

Can I use these guidelines to audit or refactor existing Vyper contracts?

Yes, you can use these guidelines to audit or refactor existing Vyper contracts by evaluating coding standards, identifying security pitfalls, and restructuring code for improved readability, modularity, and safety.

What NatSpec guidelines should I follow when documenting Vyper modules?

NatSpec guidelines for Vyper modules involve applying standardized documentation practices to describe contract functions and interfaces, ensuring code is readable and maintainable during the writing and reviewing process.

How does Vyper module pattern usage improve contract security and maintainability?

Vyper module pattern usage improves contract security and maintainability by enforcing consistent layout order, separating interfaces, and codifying community best practices to prevent common security pitfalls and maintenance challenges.