Files
aitbc/docs/scenarios/_TEMPLATE.md
aitbc 19d415a235
Some checks failed
Blockchain Synchronization Verification / sync-verification (push) Failing after 3s
CLI Tests / test-cli (push) Failing after 3s
Cross-Chain Functionality Tests / test-cross-chain-sync (push) Successful in 2s
Cross-Chain Functionality Tests / test-cross-chain-transactions (push) Successful in 3s
Cross-Chain Functionality Tests / test-cross-chain-bridge (push) Has been skipped
Cross-Chain Functionality Tests / test-multi-chain-consensus (push) Successful in 2s
Cross-Chain Functionality Tests / aggregate-results (push) Has been skipped
Deploy to Testnet / deploy-testnet (push) Successful in 1m12s
Documentation Validation / validate-docs (push) Failing after 8s
Documentation Validation / validate-policies-strict (push) Successful in 3s
Integration Tests / test-service-integration (push) Successful in 2m6s
Multi-Chain Island Architecture Tests / test-multi-chain-island (push) Successful in 2s
Multi-Node Blockchain Health Monitoring / health-check (push) Failing after 4s
P2P Network Verification / p2p-verification (push) Successful in 4s
Package Tests / Python package - aitbc-agent-sdk (push) Successful in 32s
Package Tests / Python package - aitbc-core (push) Successful in 14s
Package Tests / Python package - aitbc-crypto (push) Successful in 12s
Package Tests / Python package - aitbc-sdk (push) Successful in 9s
Package Tests / JavaScript package - aitbc-sdk-js (push) Successful in 8s
Package Tests / JavaScript package - aitbc-token (push) Successful in 17s
Python Tests / test-python (push) Successful in 15s
Security Scanning / security-scan (push) Successful in 27s
Node Failover Simulation / failover-test (push) Successful in 7s
Multi-Node Stress Testing / stress-test (push) Successful in 6s
Cross-Node Transaction Testing / transaction-test (push) Successful in 4s
feat: add SQLCipher database encryption support and consolidate agent documentation
- Add SQLCipher encryption for ait-mainnet database with configurable flag
- Add db_encryption_enabled and db_encryption_key_path config settings
- Implement encryption key loading and PRAGMA key setup via connection events
- Add shutdown_db function for proper database cleanup
- Export middleware classes in aitbc/__init__.py
- Fix import path in sync.py for settings
- Remove duplicate agent documentation from docs
2026-05-03 12:00:38 +02:00

159 lines
3.1 KiB
Markdown

# [SCENARIO TITLE]
**Level**: [Getting Started/Blockchain/Expert]
**Prerequisites**: [List prerequisites]
**Estimated Time**: [X minutes]
**Last Updated**: 2026-05-02
**Version**: 1.0
## 🧭 **Navigation Path:**
**🏠 [Documentation Home](../README.md)** → **🎭 [Agent Scenarios](./README.md)** → *You are here*
**breadcrumb**: Home → Scenarios → [Scenario Name]
---
## 🎯 **See Also:**
- **📖 Related Scenario**: [Link to related scenario]
- **🤖 Agent SDK**: [Agent SDK Documentation](../agent-sdk/README.md)
- **🧩 Feature Documentation**: [Link to relevant feature docs]
---
## 📚 **Scenario Overview**
[Brief description of what this scenario demonstrates and what the agent will accomplish]
### **Use Case**
[Describe the real-world use case this scenario addresses]
### **What You'll Learn**
- [Learning objective 1]
- [Learning objective 2]
- [Learning objective 3]
---
## 📋 **Prerequisites**
### **Knowledge Required**
- [Prerequisite knowledge 1]
- [Prerequisite knowledge 2]
### **Tools Required**
- [Tool 1]
- [Tool 2]
### **Setup Required**
- [Setup step 1]
- [Setup step 2]
---
## 🔧 **Step-by-Step Workflow**
### **Step 1: [Step Title]**
[Description of step 1]
```bash
# Command examples
command_here
```
### **Step 2: [Step Title]**
[Description of step 2]
```bash
# Command examples
command_here
```
[Continue with additional steps as needed]
---
## 🧪 **Validation**
Validate this scenario with the shared 3-node harness:
```bash
bash scripts/workflow/44_comprehensive_multi_node_scenario.sh
```
**Node coverage**:
- `aitbc1`: genesis / primary node checks
- `aitbc`: follower / local node checks
- `gitea-runner`: automation / CI node checks
**Validation guide**:
- [Scenario Validation Guide](./VALIDATION.md)
**Expected result**:
- Scenario-specific commands complete successfully
- Cross-node health checks pass
- Blockchain heights remain in sync
- Any node-specific step is documented in the scenario workflow
---
## 💻 **Code Examples Using Agent SDK**
### **Example 1: [Example Title]**
```python
from aitbc_agent_sdk import Agent, AgentConfig
# Code example
config = AgentConfig(
name="my-agent",
blockchain_network="mainnet"
)
agent = Agent(config)
agent.start()
```
### **Example 2: [Example Title]**
```python
# Additional code example
```
---
## 🎯 **Expected Outcomes**
After completing this scenario, you should be able to:
- [Outcome 1]
- [Outcome 2]
- [Outcome 3]
---
## 🔗 **Related Resources**
### **AITBC Documentation**
- [Related documentation link 1]
- [Related documentation link 2]
### **External Resources**
- [External resource 1]
- [External resource 2]
### **Next Scenarios**
- [Next beginner scenario]
- [Related intermediate scenario]
- [Related advanced scenario]
---
## 📊 **Quality Metrics**
- **Structure**: 10/10 - Clear workflow with step-by-step instructions
- **Content**: 10/10 - Comprehensive coverage of scenario topic
- **Code Examples**: 10/10 - Working Agent SDK code examples
- **Status**: Active scenario
---
*Last updated: 2026-05-02*
*Version: 1.0*
*Status: Active scenario document*