Writing Skills
writing-skills
效率与协作技能,来自 obra/superpowers,查看原文获取完整用途和操作说明。
smart-contract-security【部署与运维】Build Smart Contract Security expertise for blockchain and Web3 development. Use when developing smart contracts, building DeFi protocols, or creating decentralized applications. This skill covers development, security, and deployment strategies.
独立 GitHub 快照 · 自动分类 · 以原作者文档为准
Smart Contract Security represents a critical skill in the modern technology landscape. This comprehensive guide provides everything you need to master smart contract security, from foundational concepts to advanced implementation techniques.
Build Smart Contract Security expertise for blockchain and Web3 development. Use when developing smart contracts, building DeFi protocols, or creating decentralized applications. This skill covers development, security, and deployment strategies.
This skill is essential when:
Understanding the fundamental principles of smart contract security is essential for building robust solutions. The theoretical framework combines concepts from smart-contracts with practical implementation patterns.
┌─────────────────────────────────────────────────────────────┐
│ SMART CONTRACT SECURITY │
│ Architecture │
├─────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
│ │ Input │ -> │ Process │ -> │ Output │ │
│ │ Layer │ │ Layer │ │ Layer │ │
│ └─────────┘ └─────────┘ └─────────┘ │
│ │
│ ┌─────────────────────────────────────────────────────┐ │
│ │ Supporting Services │ │
│ └─────────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
Before implementing smart contract security, ensure you have:
# Initial setup for smart contract security
class Smart_Contract_Security:
"""
Implementation of smart contract security with best practices.
"""
def __init__(self, config: dict = None):
self.config = config or {}
self._initialize()
def _initialize(self):
"""Initialize the system with configuration."""
# Setup code here
pass
def execute(self, input_data):
"""Execute the main processing logic."""
# Implementation here
return result
# Advanced implementation with optimization
from typing import Optional, List, Dict, Any
from dataclasses import dataclass
@dataclass
class Config:
"""Configuration for smart contract security."""
param1: str = "default"
param2: int = 100
enabled: bool = True
class AdvancedSmartcontractsecurity:
"""
Advanced smart contract security implementation with optimization.
Features:
- Configurable parameters
- Performance optimization
- Comprehensive error handling
- Production-ready design
"""
def __init__(self, config: Optional[Config] = None):
self.config = config or Config()
self._setup()
def _setup(self):
"""Internal setup and validation."""
# Setup logic
pass
def process(self, data: List[Dict[str, Any]]) -> Dict[str, Any]:
"""Process data through the system."""
try:
results = self._process_batch(data)
return {"success": True, "data": results}
except Exception as e:
return {"success": False, "error": str(e)}
def _process_batch(self, data: List[Dict]) -> List[Any]:
"""Process a batch of items."""
return [self._process_item(item) for item in data]
def _process_item(self, item: Dict) -> Any:
"""Process a single item."""
# Item processing logic
return processed_item
# Comprehensive testing approach
import pytest
class TestSmartcontractsecurity:
"""Test suite for smart contract security."""
def test_initialization(self):
"""Test proper initialization."""
system = Smartcontractsecurity()
assert system is not None
def test_basic_processing(self):
"""Test basic processing functionality."""
system = Smartcontractsecurity()
result = system.execute(test_input)
assert result is not None
def test_edge_cases(self):
"""Test edge cases and boundary conditions."""
# Edge case testing
pass
def test_error_handling(self):
"""Test error handling and recovery."""
# Error handling tests
pass
| Parameter | Type | Default | Description |
|---|---|---|---|
| param1 | string | "default" | Primary configuration parameter |
| param2 | integer | 100 | Secondary numeric parameter |
| enabled | boolean | true | Enable/disable flag |
| timeout | integer | 30 | Operation timeout in seconds |
Start with Clear Requirements Define clear objectives and success criteria before implementation. This ensures focused development and measurable outcomes.
Follow Established Patterns Use proven design patterns and architectural principles. This reduces risk and improves maintainability.
Implement Comprehensive Testing Write tests for all critical functionality. Testing catches issues early and provides confidence in changes.
Document Everything Maintain thorough documentation of architecture, decisions, and implementation details.
Monitor Performance Establish performance baselines and monitor for degradation in production.
Don't Over-Engineer Avoid unnecessary complexity. Start simple and iterate based on actual requirements.
Don't Skip Testing Untested code is a liability. Always implement comprehensive testing.
Don't Ignore Security Security should be built in from the start, not added as an afterthought.
Don't Neglect Documentation Undocumented systems become legacy problems. Document as you build.
| Metric | Target | Production |
|---|---|---|
| Latency | <100ms | <50ms |
| Throughput | >1000/s | >5000/s |
| Error Rate | <0.1% | <0.01% |
| Availability | >99.9% | >99.99% |
| Vulnerability | Mitigation |
|---|---|
| Injection | Parameterized queries, input validation |
| Auth Bypass | Multi-factor authentication, secure sessions |
| Data Exposure | Encryption, access controls |
| DoS | Rate limiting, resource quotas |
| Issue | Cause | Solution |
|---|---|---|
| Performance issues | Resource exhaustion | Scale resources, optimize queries |
| Connection errors | Network issues | Check connectivity, verify config |
| Data inconsistency | Race conditions | Implement transactions, validation |
| Memory leaks | Unclosed resources | Proper cleanup, profiling |
| Skill | Level | Description |
|---|---|---|
| Understanding Smart Contract Security Fundamentals | Intermediate | Core competency in Understanding smart contract security fundamentals |
| Implementing Smart Contract Security Solutions | Intermediate | Core competency in Implementing smart contract security solutions |
| Optimizing Smart Contract Security Performance | Intermediate | Core competency in Optimizing smart contract security performance |
| Debugging Smart Contract Security Issues | Intermediate | Core competency in Debugging smart contract security issues |
| Best Practices For Smart Contract Security | Intermediate | Core competency in Best practices for smart contract security |
| Tool | Purpose | Level |
|---|---|---|
| solidity | Primary tool for smart contract security | Advanced |
| foundry | Primary tool for smart contract security | Advanced |
| hardhat | Primary tool for smart contract security | Advanced |
| ethers | Primary tool for smart contract security | Advanced |
| web3js | Primary tool for smart contract security | Advanced |
Foundation (Weeks 1-2)
Intermediate (Weeks 3-6)
Advanced (Weeks 7-12)
Expert (Weeks 13+)
| Version | Date | Changes |
|---|---|---|
| 1.0.0 | 2026-03-27 | Initial documentation |
Smart Contract Security is an essential skill for professionals working in blockchain. Mastery requires understanding both theoretical foundations and practical implementation techniques.
Key takeaways:
Part of the SkillGalaxy project - comprehensive skills for AI-assisted development.