Web3 Integration

Web3 Integration

Skill Profile

(Select at least one profile to enable specific modules)

• DevOps
• Backend
• Frontend
• AI-RAG
• Security Critical

Overview

Web3 enables decentralized applications to interact with blockchain networks. This guide covers Web3.js, Ethers.js, provider setup, and blockchain interactions for building decentralized applications that interact with Ethereum and other blockchain networks.

Why This Matters

• Decentralization: Direct interaction with blockchain without intermediaries
• Transparency: All transactions and data are publicly verifiable
• Immutability: Blockchain data cannot be altered
• Interoperability: Standard protocols for cross-platform compatibility

Core Concepts & Rules

1. Core Principles

• Follow established patterns and conventions
• Maintain consistency across codebase
• Document decisions and trade-offs

2. Implementation Guidelines

• Start with the simplest viable solution
• Iterate based on feedback and requirements
• Test thoroughly before deployment

Inputs / Outputs / Contracts

• Inputs:
  • Provider configuration
  • Wallet address
  • Transaction data
  • Contract address and ABI
• Entry Conditions:
  • Web3 provider configured (Infura, Alchemy, etc.)
  • RPC endpoint available
  • Frontend application ready
  • Wallet with gas funds ready
• Outputs:
  • Blockchain data
  • Transaction hash
  • Transaction receipt
  • Contract return values
• Artifacts Required (Deliverables):
  • Provider service
  • Blockchain reader service
  • Transaction service
  • Event listener service
  • Error handling utilities
• Acceptance Evidence:
  • Provider connects successfully
  • Blockchain data retrieved correctly
  • Transactions sent and confirmed
  • Events listened to properly
• Success Criteria:
  • Provider connection success rate 99%
  • Data retrieval latency < 2s
  • Transaction confirmation < 5min
  • Event listening accuracy 100%

Skill Composition

• Depends on: Wallet Connection (35-blockchain-web3/wallet-connection/)
• Compatible with: Smart Contracts (35-blockchain-web3/smart-contracts/), Blockchain Authentication (35-blockchain-web3/blockchain-authentication/)
• Conflicts with: None
• Related Skills: wallet-connection, smart-contracts

Quick Start / Implementation Example

1. Review requirements and constraints
2. Set up development environment
3. Implement core functionality following patterns
4. Write tests for critical paths
5. Run tests and fix issues
6. Document any deviations or decisions

# Example implementation following best practices
def example_function():
    # Your implementation here
    pass

Assumptions / Constraints / Non-goals

• Assumptions:
  • Development environment is properly configured
  • Required dependencies are available
  • Team has basic understanding of domain
• Constraints:
  • Must follow existing codebase conventions
  • Time and resource limitations
  • Compatibility requirements
• Non-goals:
  • This skill does not cover edge cases outside scope
  • Not a replacement for formal training

Compatibility & Prerequisites

• Supported Versions:
  • Python 3.8+
  • Node.js 16+
  • Modern browsers (Chrome, Firefox, Safari, Edge)
• Required AI Tools:
  • Code editor (VS Code recommended)
  • Testing framework appropriate for language
  • Version control (Git)
• Dependencies:
  • Language-specific package manager
  • Build tools
  • Testing libraries
• Environment Setup:
  • .env.example keys: API_KEY, DATABASE_URL (no values)

Test Scenario Matrix (QA Strategy)

Technical Guardrails & Security Threat Model

1. Security & Privacy (Threat Model)

• Top Threats: Injection attacks, authentication bypass, data exposure

• Data Handling: Sanitize all user inputs to prevent Injection attacks. Never log raw PII
• Secrets Management: No hardcoded API keys. Use Env Vars/Secrets Manager
• Authorization: Validate user permissions before state changes

2. Performance & Resources

• Execution Efficiency: Consider time complexity for algorithms
• Memory Management: Use streams/pagination for large data
• Resource Cleanup: Close DB connections/file handlers in finally blocks

3. Architecture & Scalability

• Design Pattern: Follow SOLID principles, use Dependency Injection
• Modularity: Decouple logic from UI/Frameworks

4. Observability & Reliability

• Logging Standards: Structured JSON, include trace IDs request_id
• Metrics: Track error_rate, latency, queue_depth
• Error Handling: Standardized error codes, no bare except
• Observability Artifacts:
  • Log Fields: timestamp, level, message, request_id
  • Metrics: request_count, error_count, response_time
  • Dashboards/Alerts: High Error Rate > 5%

Agent Directives & Error Recovery

(ข้อกำหนดสำหรับ AI Agent ในการคิดและแก้ปัญหาเมื่อเกิดข้อผิดพลาด)

• Thinking Process: Analyze root cause before fixing. Do not brute-force.
• Fallback Strategy: Stop after 3 failed test attempts. Output root cause and ask for human intervention/clarification.
• Self-Review: Check against Guardrails & Anti-patterns before finalizing.
• Output Constraints: Output ONLY the modified code block. Do not explain unless asked.

Definition of Done (DoD) Checklist

• Tests passed + coverage met
• Lint/Typecheck passed
• Logging/Metrics/Trace implemented
• Security checks passed
• Documentation/Changelog updated
• Accessibility/Performance requirements met (if frontend)

Anti-patterns / Pitfalls

• ⛔ Don't: Log PII, catch-all exception, N+1 queries
• ⚠️ Watch out for: Common symptoms and quick fixes
• 💡 Instead: Use proper error handling, pagination, and logging

Reference Links & Examples

• Internal documentation and examples
• Official documentation and best practices
• Community resources and discussions

Versioning & Changelog

• Version: 1.0.0
• Changelog:
  • 2026-02-22: Initial version with complete template structure

Converted and distributed by TomeVault — claim your Tome and manage your conversions.