Co-authored-by: Cursor <cursoragent@cursor.com>
61 KiB
Master Documentation Index
Last Updated: 2026-02-18
Document Version: 6.4
Status: Active Documentation
Project: Sankofa / Phoenix / PanTel · ChainID 138 · Proxmox + Cloudflare DNS + NPMplus
Current network topology: Edge is UDM Pro (76.53.10.34; replaced ER605). Proxmox hosts: ml110 (192.168.11.10), r630-01 (192.168.11.11), r630-02 (192.168.11.12). (pve/pve2 do not exist.) NPMplus LXC (VMID 10233) has 192.168.11.166 and 192.168.11.167; only 192.168.11.167 is used in UDM Pro port forwarding: 76.53.10.36:80/443 → 192.168.11.167:80/443. NPMplus secondary (10234): 192.168.11.168. Public path: Web/api: Fastly or direct → UDM Pro (76.53.10.36) → NPMplus → internal services. RPC (6 hostnames): Option B — Cloudflare Tunnel (cloudflared, e.g. VMID 102) → NPMplus (https://192.168.11.167:443); DNS for those 6 is CNAME to tunnel; see 05-network/OPTION_B_RPC_VIA_TUNNEL_RUNBOOK.md. Cloudflare DNS retained for all public hostnames. NPMplus Fourth (10236): 192.168.11.170 — 76.53.10.40 (dev/Codespaces, Gitea, Proxmox admin). Dev VM (5700): 192.168.11.59. Dev/Codespaces checklist: 04-configuration/DEV_CODESPACES_NEXT_STEPS_CHECKLIST.md. CCIP interim range 192.168.11.171-212. See 11-references/NETWORK_CONFIGURATION_MASTER.md and 05-network/EDGE_PORT_VERIFICATION_RUNBOOK.md.
📑 Table of Contents
- Quick Start
- Directory Structure
- Core Architecture
- Deployment Guides
- Configuration & Setup
- Network Infrastructure
- Besu & Blockchain
- CCIP & Chainlink
- Monitoring & Observability
- Troubleshooting
- Best Practices
- Technical References
- Exchange Integrations
- Quick References
- GRU M1 Listing & Validation
📁 Directory Structure
docs/
├── MASTER_INDEX.md # This file - Complete index
├── RUNBOOKS_MASTER_INDEX.md # All runbooks across repo (deployment, CCIP, monitoring, config)
├── README.md # Documentation overview
├── 00-meta/ # Documentation meta (style, reviews, task list)
│ ├── MASTER_PLAN.md # Single Master Plan (gaps, protection layer, admin panels, phased execution)
│ ├── COMPLETION_MASTER_PLAN.md # All incomplete + missing items; ordered execution (Phase 0–8)
│ ├── BLITZKRIEG_SUPER_PRO_MAX_MASTER_PLAN.md # Token-and-bridge rollout, marching ants, all recommendations
│ ├── BLITZKRIEG_SOURCE_DOCUMENT_INDEX.md # Where to update when completed (source doc index)
│ ├── ALL_REQUIREMENTS.md # All requirements (security, deployment, waves, validation)
│ ├── E2E_COMPLETION_TASKS_DETAILED_LIST.md # All E2E tasks by part; blockers; validation commands
│ ├── REMAINING_WORK_DETAILED_STEPS.md # Step-by-step instructions for each remaining task
│ ├── FULL_PARALLEL_EXECUTION_ORDER.md # Execution order: full parallel (Wave 0–3)
│ ├── WAVE1_COMPLETION_SUMMARY.md # Wave 1 task status (Done/Operator/Documented)
│ ├── WAVE2_WAVE3_OPERATOR_CHECKLIST.md # Checklist for Wave 2/3 and Wave 0
│ ├── REMAINING_TASKS_NEXT_STEPS_PHASES_REVIEW.md # Consolidated review
│ ├── PLACEHOLDERS_AND_REQUIRED_ADDITIONS_LIST.md # Placeholders, required env, API keys, waves
│ ├── ARCHIVE_CANDIDATES.md # Archive consolidation; 32 files moved to archive/00-meta-status (2026-02-05)
│ ├── DOCUMENTATION_STYLE_GUIDE.md
│ ├── DOCUMENTATION_REVIEW.md
│ ├── DOCUMENTATION_QUALITY_REVIEW.md
│ ├── DOCUMENTATION_ENHANCEMENTS_RECOMMENDATIONS.md
│ ├── DOCUMENTATION_FIX_TASK_LIST.md
│ ├── DOCUMENT_RELATIONSHIP_MAP.md
│ ├── COMPREHENSIVE_DOCUMENTATION_REVIEW_2026-01-31.md
│ ├── MASTER_DOCUMENTATION_REVIEW_20260205.md # Master docs consistency (missing containers, inventory)
│ ├── DOCUMENTATION_REVIEW_20260216.md # 2026-02-16 full review (links, pruning, consistency)
│ └── DOCUMENTATION_REVIEW_CONTINUED_20260216.md # 2026-02-16 content, updates, submodules
│
├── 01-getting-started/ # Getting started guides
│ ├── README.md
│ ├── README_START_HERE.md
│ └── PREREQUISITES.md
│
├── 02-architecture/ # Core architecture & design
│ ├── README.md
│ ├── NETWORK_ARCHITECTURE.md
│ ├── ORCHESTRATION_DEPLOYMENT_GUIDE.md
│ ├── PHYSICAL_HARDWARE_INVENTORY.md
│ ├── VMID_ALLOCATION_FINAL.md
│ ├── DOMAIN_STRUCTURE.md
│ └── HOSTNAME_MIGRATION_GUIDE.md
│
├── 03-deployment/ # Deployment & operations
│ ├── README.md
│ ├── OPERATIONAL_RUNBOOKS.md
│ ├── MISSING_CONTAINERS_LIST.md # 2506–2508 destroyed 2026-02-08; RPC range 2500–2505
│ ├── DEPLOYMENT_STATUS_MASTER.md # Container inventory by host (reconciled with SSH)
│ ├── VALIDATED_SET_DEPLOYMENT_GUIDE.md
│ ├── DEPLOYMENT_STATUS_CONSOLIDATED.md
│ ├── DEPLOYMENT_READINESS.md
│ ├── INFRA_DEPLOYMENT_LOCKED_AND_LOADED.md # Repo/host ready vs operator steps to unblock
│ ├── PROXMOX_TEMPLATES_REFERENCE.md # Templates + push script (all 3 hosts)
│ ├── RUN_DEPLOYMENT.md
│ ├── REMOTE_DEPLOYMENT.md
│ ├── CONTRACT_DEPLOYMENT_RUNBOOK.md
│ ├── BLOCKSCOUT_FIX_RUNBOOK.md # Blockscout VMID 5000 troubleshooting
│ ├── MIGRATE_CT_R630_01_TO_R630_02.md # Migrate LXC r630-01 → r630-02 (free thin pool)
│ ├── BLOCKSCOUT_FORGE_VERIFICATION_EVALUATION.md # Forge→Blockscout proxy design
│ ├── DISASTER_RECOVERY.md
│ ├── BACKUP_AND_RESTORE.md
│ └── CHANGE_MANAGEMENT.md
│
├── 04-configuration/ # Configuration & setup
│ ├── README.md
│ ├── DEV_CODESPACES_76_53_10_40.md # Dev/Codespaces: 76.53.10.40, fourth NPMplus, tunnel, Proxmox admin
│ ├── DEV_CODESPACES_NEXT_STEPS_CHECKLIST.md # Full ordered checklist to complete dev/Codespaces
│ ├── DEV_VM_GITOPS_PLAN.md # Dev VM (5700), Gitea, four users
│ ├── UDM_PRO_DEV_CODESPACES_PORT_FORWARD.md # UDM: 76.53.10.40 → 192.168.11.170 (80/81/443, optional 22)
│ ├── MCP_SETUP.md
│ ├── ER605_ROUTER_CONFIGURATION.md
│ ├── OMADA_API_SETUP.md
│ ├── OMADA_HARDWARE_CONFIGURATION_REVIEW.md
│ ├── cloudflare/ # Cloudflare configuration
│ │ ├── README.md
│ │ ├── CLOUDFLARE_ZERO_TRUST_GUIDE.md
│ │ ├── CLOUDFLARE_DNS_TO_CONTAINERS.md
│ │ ├── CLOUDFLARE_DNS_SPECIFIC_SERVICES.md
│ │ ├── CLOUDFLARE_TUNNEL_CONFIGURATION_GUIDE.md
│ │ ├── CLOUDFLARE_TUNNEL_INSTALLATION.md
│ │ ├── CLOUDFLARE_TUNNEL_QUICK_SETUP.md
│ │ ├── CLOUDFLARE_TUNNEL_RPC_SETUP.md
│ │ ├── CLOUDFLARE_TUNNEL_502_FIX_RUNBOOK.md
│ │ ├── TUNNEL_SFVALLEY01_INSTALL.md # Option B tunnel connector install (sfvalley01)
│ │ ├── CLOUDFLARE_EXPLORER_CONFIG.md
│ │ └── CLOUDFLARE_EXPLORER_QUICK_SETUP.md
│ ├── SECRETS_KEYS_CONFIGURATION.md
│ ├── ENV_STANDARDIZATION.md
│ ├── CREDENTIALS_CONFIGURED.md
│ ├── SSH_SETUP.md
│ └── FINALIZE_TOKEN.md
│
├── 05-network/ # Network infrastructure
│ ├── README.md
│ ├── EDGE_PORT_VERIFICATION_RUNBOOK.md
│ ├── E2E_CLOUDFLARE_DOMAINS_RUNBOOK.md # E2E success for all Cloudflare-facing endpoints
│ ├── E2E_RPC_EDGE_LIMITATION.md # When edge blocks RPC POST; ACCEPT_ANY_DNS / Option B
│ ├── CLOUDFLARE_ROUTING_MASTER.md # Fastly/Direct + Option B (RPC via tunnel)
│ ├── OPTION_B_RPC_VIA_TUNNEL_RUNBOOK.md # RPC via Cloudflare Tunnel (6 hostnames → NPMplus)
│ ├── NETWORK_STATUS.md
│ ├── NGINX_ARCHITECTURE_RPC.md
│ ├── CLOUDFLARE_NGINX_INTEGRATION.md
│ ├── RPC_NODE_TYPES_ARCHITECTURE.md
│ └── RPC_TEMPLATE_TYPES.md
│
├── 06-besu/ # Besu & blockchain
│ ├── README.md
│ ├── BESU_ALLOWLIST_RUNBOOK.md
│ ├── BESU_ALLOWLIST_QUICK_START.md
│ ├── BESU_NODES_FILE_REFERENCE.md
│ ├── MASTER_DOCS_AND_NODE_LISTS_REVIEW.md # Master docs + static-nodes + permissions-nodes review
│ ├── BESU_OFFICIAL_REFERENCE.md
│ ├── BESU_OFFICIAL_UPDATES.md
│ ├── QUORUM_GENESIS_TOOL_REVIEW.md
│ ├── VALIDATOR_KEY_DETAILS.md
│ └── COMPREHENSIVE_CONSISTENCY_REVIEW.md
│
├── 07-ccip/ # CCIP & Chainlink
│ ├── README.md
│ ├── CCIP_DEPLOYMENT_SPEC.md
│ ├── TEZOS_NETWORK_CONFIG_ENV_MATRIX.md
│ ├── TEZOS_JUMPER_SUPPORT_MATRIX.md
│ ├── TEZOS_CCIP_RUNBOOKS_INDEX.md
│ └── TEZOS_ETHERLINK_*.md
│
├── 08-monitoring/ # Monitoring & observability
│ ├── README.md
│ ├── MONITORING_SUMMARY.md
│ ├── BLOCK_PRODUCTION_MONITORING.md
│ ├── RPC_AND_VALIDATOR_TESTING_RUNBOOK.md # RPC 2101 + validators fix/verify
│ └── PEER_CONNECTIONS_PLAN.md # Full-mesh peering (32 nodes, max-peers=32)
│
├── 09-troubleshooting/ # Troubleshooting
│ ├── README.md
│ ├── TROUBLESHOOTING_FAQ.md
│ ├── QBFT_TROUBLESHOOTING.md
│ └── SECURITY_INCIDENT_RESPONSE.md
│
├── 10-best-practices/ # Best practices
│ ├── README.md
│ ├── CONFIGURATION_DECISION_TREE.md # Canonical decision tree (VLAN, service, deployment)
│ ├── RECOMMENDATIONS_AND_SUGGESTIONS.md
│ ├── IMPLEMENTATION_CHECKLIST.md
│ ├── BEST_PRACTICES_SUMMARY.md
│ ├── QUICK_WINS.md
│ └── PERFORMANCE_TUNING.md
│
├── 11-references/ # Technical references
│ ├── README.md
│ ├── NETWORK_CONFIGURATION_MASTER.md # Single source of truth: UDM Pro, Proxmox, NPMplus, port forward
│ ├── VMID_IP_FIXED_REFERENCE.md # Fixed permanent VMID→IP (2101, 2201, 5000)
│ ├── APT_PACKAGES_CHECKLIST.md
│ ├── PATHS_REFERENCE.md
│ ├── SCRIPT_REVIEW.md
│ └── TEMPLATE_BASE_WORKFLOW.md
│
├── 12-quick-reference/ # Quick references
│ ├── README.md
│ ├── QUICK_REFERENCE.md
│ ├── QUICK_REFERENCE_CARDS.md
│ ├── VALIDATED_SET_QUICK_REFERENCE.md
│ └── QUICK_START_TEMPLATE.md
│
├── gru-m1/ # GRU M1 listing & validation
│ ├── README.md
│ ├── GRU_M1_MASTER_IMPLEMENTATION_PLAN.md
│ ├── GRU_M1_REAL_DATA_DOMINANCE_ADDENDUM.md
│ └── PEG_STRESS_TEST_WORKSHEET.md
├── compliance/ # Compliance tracking
│ ├── COMPLIANCE_TRACKING.md
│ └── GRU_M1_LISTING_VALIDATION.md
├── runbooks/ # Procedural runbooks
│ └── GRU_M1_LISTING_DRY_RUN_RUNBOOK.md
│
└── archive/ # Historical documents
├── README.md
├── 00-meta-status/ # 32 status/complete/final reports moved from 00-meta (2026-02-05)
├── 00-meta-pruned/ # 27 one-off status/planning/script docs (2026-02-08, 2 batches)
├── 05-network-superseded/ # CLOUDFLARE_TUNNEL_ROUTING_ARCHITECTURE, CENTRAL_NGINX (2026-02-08)
└── verification-evidence-old/ # Pruned verification runs before 2026-02-06 (72 folders)
🚀 Quick Start
First Time Setup
| Step | Document | Description |
|---|---|---|
| 1 | 01-getting-started/README_START_HERE.md | Complete getting started guide - START HERE |
| 2 | 01-getting-started/PREREQUISITES.md | System requirements and prerequisites |
| 3 | 04-configuration/MCP_SETUP.md | MCP Server configuration for Claude Desktop |
| 4 | 04-configuration/CREDENTIALS_CONFIGURED.md | Credentials configuration guide |
Deployment Paths
Enterprise Deployment (Recommended):
- 02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md - Complete enterprise deployment orchestration
- 02-architecture/NETWORK_ARCHITECTURE.md - Network architecture reference
- 03-deployment/DEPLOYMENT_READINESS.md - Pre-deployment validation
Validated Set Deployment:
- 03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md - Validated set deployment procedures
- 12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md - Quick reference for validated set
- 03-deployment/RUN_DEPLOYMENT.md - Deployment execution guide
Related: 03-deployment/OPERATIONAL_RUNBOOKS.md | 03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md | 03-deployment/CONTRACT_DEPLOYMENT_RUNBOOK.md
🏗️ Core Architecture & Design
Network Architecture
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 11-references/NETWORK_CONFIGURATION_MASTER.md | ⭐⭐⭐ | Single source of truth for network: UDM Pro (76.53.10.34), Proxmox hosts .10–.12, NPMplus .166/.167, port forward .36→.167 | 02-architecture/NETWORK_ARCHITECTURE.md, 04-configuration/DNS_NPMPLUS_VM_STREAMLINED_TABLE.md |
| 02-architecture/NETWORK_ARCHITECTURE.md | ⭐⭐⭐ | Complete network architecture with 6×/28 blocks, VLANs, NAT pools | 04-configuration/ER605_ROUTER_CONFIGURATION.md, 04-configuration/cloudflare/CLOUDFLARE_ZERO_TRUST_GUIDE.md |
| 05-network/NETWORK_STATUS.md | ⭐⭐ | Current network status and configuration | 02-architecture/NETWORK_ARCHITECTURE.md |
System Architecture
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md | ⭐⭐⭐ | Enterprise-grade deployment orchestration guide | 02-architecture/NETWORK_ARCHITECTURE.md, 07-ccip/CCIP_DEPLOYMENT_SPEC.md |
| 02-architecture/VMID_ALLOCATION_FINAL.md | ⭐⭐⭐ | Complete VMID allocation registry (11,000 VMIDs) | 02-architecture/NETWORK_ARCHITECTURE.md, 03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md |
| 07-ccip/CCIP_DEPLOYMENT_SPEC.md | ⭐⭐⭐ | CCIP fleet deployment specification (41-43 nodes) | 02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md, 02-architecture/NETWORK_ARCHITECTURE.md |
See also: 05-network/ | 07-ccip/
🚀 Deployment & Operations
Deployment Guides
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md | ⭐⭐⭐ | Complete enterprise deployment orchestration | 02-architecture/NETWORK_ARCHITECTURE.md, 03-deployment/DEPLOYMENT_READINESS.md |
| 03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md | ⭐⭐⭐ | Validated set deployment procedures | 12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md, 03-deployment/RUN_DEPLOYMENT.md |
| 03-deployment/DEPLOYMENT_READINESS.md | ⭐⭐ | Pre-deployment validation checklist | 02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md |
| 03-deployment/RUN_DEPLOYMENT.md | ⭐⭐ | Deployment execution guide | 03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md |
| 03-deployment/REMOTE_DEPLOYMENT.md | ⭐ | Remote deployment procedures | 04-configuration/SSH_SETUP.md |
Operational Runbooks
See also: 09-troubleshooting/ | 10-best-practices/
⚙️ Configuration & Setup
Initial Setup
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 04-configuration/MCP_SETUP.md | ⭐⭐ | MCP Server configuration for Claude Desktop | 01-getting-started/PREREQUISITES.md |
| 04-configuration/ENV_STANDARDIZATION.md | ⭐⭐ | Environment variable standardization | 04-configuration/SECRETS_KEYS_CONFIGURATION.md |
| 04-configuration/CREDENTIALS_CONFIGURED.md | ⭐ | Credentials configuration guide | 04-configuration/SECRETS_KEYS_CONFIGURATION.md |
| 04-configuration/FINALIZE_TOKEN.md | ⭐ | Token finalization guide | 04-configuration/MCP_SETUP.md |
| 04-configuration/CONFIGURATION_TEMPLATES.md | ⭐ | ER605, Proxmox, Cloudflare, Besu config templates | 11-references/NETWORK_CONFIGURATION_MASTER.md |
Security & Keys
See also: 05-network/ | 10-best-practices/
🌐 Network Infrastructure
Router Configuration
Network Architecture Details
See also: 02-architecture/ | 04-configuration/
⛓️ Besu & Blockchain Operations
Besu Configuration
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 06-besu/BESU_ALLOWLIST_RUNBOOK.md | ⭐⭐ | Besu allowlist generation and management | 06-besu/BESU_ALLOWLIST_QUICK_START.md, 06-besu/BESU_NODES_FILE_REFERENCE.md |
| 06-besu/BESU_ALLOWLIST_QUICK_START.md | ⭐⭐ | Quick start for allowlist issues | 06-besu/BESU_ALLOWLIST_RUNBOOK.md, 09-troubleshooting/TROUBLESHOOTING_FAQ.md |
| 06-besu/BESU_NODES_FILE_REFERENCE.md | ⭐⭐ | Besu nodes file reference | 06-besu/BESU_ALLOWLIST_RUNBOOK.md |
| 06-besu/MASTER_DOCS_AND_NODE_LISTS_REVIEW.md | ⭐ | Master docs, static-nodes, permissions-nodes consistency review | 06-besu/BESU_NODES_FILE_REFERENCE.md |
Besu References
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 06-besu/BESU_OFFICIAL_REFERENCE.md | ⭐ | Official Besu references | 06-besu/BESU_OFFICIAL_UPDATES.md |
| 06-besu/BESU_OFFICIAL_UPDATES.md | ⭐ | Official Besu updates | 06-besu/BESU_OFFICIAL_REFERENCE.md |
| 06-besu/QUORUM_GENESIS_TOOL_REVIEW.md | ⭐ | Genesis tool review | 06-besu/VALIDATOR_KEY_DETAILS.md |
| 06-besu/COMPREHENSIVE_CONSISTENCY_REVIEW.md | ⭐ | Comprehensive consistency review | 09-troubleshooting/QBFT_TROUBLESHOOTING.md |
See also: 09-troubleshooting/ | 03-deployment/OPERATIONAL_RUNBOOKS.md
🔗 CCIP & Chainlink
CCIP Deployment
Tezos / Etherlink / Jumper
| Document | Priority | Description |
|---|---|---|
| 07-ccip/TEZOS_NETWORK_CONFIG_ENV_MATRIX.md | ⭐⭐⭐ | Network config (138, 651940, 42793, Tezos); RPC and env vars |
| 07-ccip/TEZOS_JUMPER_SUPPORT_MATRIX.md | ⭐⭐ | Jumper API support; route selection fallback |
| 07-ccip/TEZOS_CCIP_RUNBOOKS_INDEX.md | ⭐⭐ | Runbooks index: Tezos L1, Etherlink, Jumper, incident response |
| 07-ccip/TEZOS_ETHERLINK_PRODUCTION_CONFIG.md | ⭐⭐ | Feature flags, rate limits, caps for go-live |
| 08-monitoring/TEZOS_ETHERLINK_BRIDGE_MONITORING.md | ⭐ | Dashboards and alerts for Tezos/Etherlink bridges |
RPC Configuration
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 05-network/RPC_TEMPLATE_TYPES.md | ⭐ | RPC template types | 05-network/RPC_NODE_TYPES_ARCHITECTURE.md |
See also: 02-architecture/ | 05-network/
📊 Monitoring & Observability
Monitoring Setup
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 08-monitoring/MONITORING_SUMMARY.md | ⭐⭐ | Monitoring setup and configuration | 08-monitoring/BLOCK_PRODUCTION_MONITORING.md |
| 08-monitoring/BLOCK_PRODUCTION_MONITORING.md | ⭐⭐ | Block production monitoring | 08-monitoring/MONITORING_SUMMARY.md, 09-troubleshooting/QBFT_TROUBLESHOOTING.md |
| 08-monitoring/RPC_AND_VALIDATOR_TESTING_RUNBOOK.md | ⭐⭐ | RPC 2101 and validators: fix, verify, health (SSH + no-SSH) | 08-monitoring/PEER_CONNECTIONS_PLAN.md |
| 08-monitoring/PEER_CONNECTIONS_PLAN.md | ⭐⭐ | Peer topology, full-mesh (32 nodes, max-peers=32), deploy/restart steps | 06-besu/BESU_NODES_FILE_REFERENCE.md |
See also: 09-troubleshooting/ | 03-deployment/OPERATIONAL_RUNBOOKS.md
🔧 Troubleshooting
Troubleshooting Guides
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 09-troubleshooting/TROUBLESHOOTING_FAQ.md | ⭐⭐⭐ | Common issues and solutions - Start here for problems | 03-deployment/OPERATIONAL_RUNBOOKS.md, 09-troubleshooting/QBFT_TROUBLESHOOTING.md |
| 09-troubleshooting/QBFT_TROUBLESHOOTING.md | ⭐⭐ | QBFT consensus troubleshooting | 09-troubleshooting/TROUBLESHOOTING_FAQ.md, 08-monitoring/BLOCK_PRODUCTION_MONITORING.md |
| 09-troubleshooting/RPC_NODES_BLOCK_PRODUCTION_FIX.md | ⭐⭐ | RPC nodes not returning chain 138 / current block — status check, fixes, runbook | 08-monitoring/BLOCK_PRODUCTION_MONITORING.md, 03-deployment/OPERATIONAL_RUNBOOKS.md |
| 06-besu/BESU_ALLOWLIST_QUICK_START.md | ⭐⭐ | Quick start for allowlist issues | 06-besu/BESU_ALLOWLIST_RUNBOOK.md, 09-troubleshooting/TROUBLESHOOTING_FAQ.md |
See also: 03-deployment/OPERATIONAL_RUNBOOKS.md | 10-best-practices/
✅ Best Practices & Recommendations
Recommendations
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md | ⭐⭐⭐ | Comprehensive recommendations (100+ items) | 10-best-practices/IMPLEMENTATION_CHECKLIST.md, 10-best-practices/BEST_PRACTICES_SUMMARY.md |
| 10-best-practices/IMPLEMENTATION_CHECKLIST.md | ⭐⭐ | Implementation checklist - Track progress here | 10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md |
| 10-best-practices/BEST_PRACTICES_SUMMARY.md | ⭐⭐ | Best practices summary | 10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md |
| 10-best-practices/QUICK_WINS.md | ⭐ | Quick wins implementation guide | 10-best-practices/IMPLEMENTATION_CHECKLIST.md |
| 10-best-practices/CONFIGURATION_DECISION_TREE.md | ⭐ | Which VLAN, service, deployment path | 02-architecture/NETWORK_ARCHITECTURE.md, 11-references/NETWORK_CONFIGURATION_MASTER.md |
See also: 04-configuration/ | 09-troubleshooting/
💱 Exchange Integrations
DBIS Core Exchange Hub
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 11-references/DBIS_CORE_API_REFERENCE.md | ⭐⭐ | DBIS Core API - Exchange Registry, Crypto.com OTC, Binance, Kraken, Oanda, FXCM | 04-configuration/MASTER_SECRETS_INVENTORY.md |
Base Paths (dbis-api.d-bis.org):
/api/v1/crypto-com-otc- Crypto.com OTC 2.0 (RFQ, deals, settle-later)/api/v1/exchange- Exchange Registry (price, providers) - Binance, Kraken, Oanda, FXCM
Fiat On/Off Ramps (metamask-integration)
| Component | Description | API |
|---|---|---|
| Ramp API | MoonPay, Ramp Network, Onramper, Transak, Banxa, Coinbase, Stripe, Cybrid, Sardine, HoneyCoin | POST /ramps/on-ramp/session, POST /ramps/off-ramp/session, GET /ramps/quote, GET /ramps/providers |
| Location | metamask-integration/src/ramps/ |
Standalone server: pnpm ramps:dev (port 3080) |
DeFi Routing (alltra-lifi-settlement)
| Component | Description | Providers |
|---|---|---|
| DefiRouterService | Best-route aggregation | 1inch, ParaSwap, 0x (Uniswap, Curve stubs for future) |
| Location | alltra-lifi-settlement/src/payments/ |
Used with Li.Fi for cross-chain swaps |
📚 Technical References
Reference Documents
Token Lists
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| token-lists/README.md | ⭐⭐⭐ | Token lists project documentation | 11-references/TOKEN_LIST_AUTHORING_GUIDE.md |
| token-lists/lists/dbis-138.tokenlist.json | ⭐⭐⭐ | ChainID 138 token list (6 tokens) | 11-references/CHAIN138_TOKEN_ADDRESSES.md |
| token-lists/lists/ethereum-mainnet.tokenlist.json | ⭐⭐ | Ethereum Mainnet token list (1 token: USDT) | - |
| token-lists/lists/all-mainnet.tokenlist.json | ⭐⭐ | ALL Mainnet token list (9 tokens including AUSDT) | - |
📋 Quick References
Quick Reference Guides
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| 12-quick-reference/QUICK_REFERENCE.md | ⭐⭐ | Quick reference for ProxmoxVE scripts | 12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md |
| 12-quick-reference/QUICK_REFERENCE_CARDS.md | ⭐⭐ | Network, VMID, commands, troubleshooting quick reference cards | 02-architecture/NETWORK_ARCHITECTURE.md, 09-troubleshooting/TROUBLESHOOTING_FAQ.md |
| 12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md | ⭐⭐ | Quick reference for validated set | 03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md |
| 12-quick-reference/QUICK_START_TEMPLATE.md | ⭐ | Quick start template guide | 01-getting-started/README_START_HERE.md |
GRU M1 Listing & Validation
GRU M1 Documentation
| Document | Priority | Description | Related Documents |
|---|---|---|---|
| gru-m1/README.md | ⭐⭐ | GRU M1 listing & validation index | runbooks/GRU_M1_LISTING_DRY_RUN_RUNBOOK.md, compliance/GRU_M1_LISTING_VALIDATION.md |
| gru-m1/GRU_M1_MASTER_IMPLEMENTATION_PLAN.md | ⭐⭐⭐ | End-to-end listing framework (6 phases) | gru-m1/GRU_M1_REAL_DATA_DOMINANCE_ADDENDUM.md, 04-configuration/coingecko/COINGECKO_SUBMISSION_GUIDE.md |
| gru-m1/GRU_M1_REAL_DATA_DOMINANCE_ADDENDUM.md | ⭐⭐ | Dominance simulation (S0-S5) & peg stress-test | gru-m1/PEG_STRESS_TEST_WORKSHEET.md |
| runbooks/GRU_M1_LISTING_DRY_RUN_RUNBOOK.md | ⭐⭐ | Procedural runbook for dry-runs | gru-m1/README.md |
| compliance/GRU_M1_LISTING_VALIDATION.md | ⭐⭐ | Acceptance gates (peg, recovery, supply) | compliance/COMPLIANCE_TRACKING.md |
Scripts
- Dominance simulation:
scripts/gru-m1/dominance-simulation.sh— Top-25 dominance (S0-S5) - Supply check:
scripts/gru-m1/check-ciso-supply.sh— On-chain cUSDC/cUSDT supply reconciliation
📈 Documentation Status
Recent Updates
- ✅ 2026-02-20: Documentation consolidation and root cleanup — NEXT_STEPS_INDEX, DOCUMENTATION_CONSOLIDATION_PLAN. Batch 4+5 → 00-meta-pruned. ALL_TASKS_COMPLETE → root-status-reports. Project root: 40+ files → archive/root-cleanup-20260220/; fix-wsl-ip.sh → scripts/. See ARCHIVE_CANDIDATES, archive/README.
- ✅ 2026-02-18: Besu full-mesh peering — Allowlist cleaned (203/204 removed; 30 nodes in list, 32 total with self). All repo configs set max-peers=32 (validators, sentries, RPC). Full-mesh steps: deploy node lists, apply max-peers on nodes, restart Besu. See 08-monitoring/PEER_CONNECTIONS_PLAN.md, 08-monitoring/RPC_AND_VALIDATOR_TESTING_RUNBOOK.md. Scripts:
scripts/deploy-besu-node-lists-to-all.sh,scripts/besu/restart-besu-reload-node-lists.sh,scripts/maintenance/apply-peer-plan-fixes.sh. - ✅ 2026-02-16: Documentation review — README "See" links fixed (05-network, 07-ccip, 09-troubleshooting). DOCUMENTATION_FIXES_COMPLETE reference updated to DOCUMENTATION_FIX_TASK_LIST. Blitzkrieg dated exports archived; canonical plan: BLITZKRIEG_SUPER_PRO_MAX_MASTER_PLAN.md. Continued review: Submodules reconciled with .gitmodules (SUBMODULE_RELATIONSHIP_MAP, docs/README submodule section). See archive/00-meta-pruned/DOCUMENTATION_REVIEW_20260216.md, archive/00-meta-pruned/DOCUMENTATION_REVIEW_CONTINUED_20260216.md.
- ✅ 2026-02-12: Chain 138 contract deployments (mirror/channels) — AddressMapper (
0x439Fcb2d2ab2f890DCcAE50461Fa7d978F9Ffe1A) and MirrorManager (0x6eD905A30c552a6e003061A38FD52A5A427beE56) deployed. On-chain check:./scripts/verify/check-contracts-on-chain-138.sh(address list from config/smart-contracts-master.json when available). Learnings: Allforge script/forge createon Chain 138 must use--with-gas-price 1000000000(chain minimum). TransactionMirror deploy can hit Forge constructor-args decode bug; useforge createwith encoded constructor when needed. Canonical addresses: CONTRACT_ADDRESSES_REFERENCE, CONTRACT_INVENTORY_AND_VERIFICATION. - ✅ 2026-02-12: CCIP Relay Service deployed — Chain 138 → Mainnet relay running on r630-01 (192.168.11.11) at
/opt/smom-dbis-138/services/relay. Uses VMID 2201 (192.168.11.221:8545) for Chain 138 RPC. Config:START_BLOCK=latest. See 07-ccip/CCIP_RELAY_DEPLOYMENT.md, OPERATIONAL_RUNBOOKS.md, DEPLOYMENT_STATUS_MASTER.md. - ✅ 2026-02-08: Besu node lists (32 nodes) — Canonical
static-nodes.jsonandpermissions-nodes.tomlinconfig/besu-node-lists/; deploy to all 32 Besu nodes (validators, sentries, RPC) including 2402, 2403 (ThirdWeb RPC on ml110). Scripts:scripts/deploy-besu-node-lists-to-all.sh,scripts/verify/verify-static-permissions-on-all-besu-nodes.sh(use--checksumto match canonical),scripts/besu/restart-besu-reload-node-lists.sh(restart Besu to reload lists). Host mapping: r630-01 (1000–1002, 1500–1502, 2101, 2500–2505), r630-02 (2201, 2303, 2401), ml110 (1003–1004, 1503–1508, 2102, 2301, 2304–2306, 2400, 2402, 2403). See 06-besu/BESU_NODES_FILE_REFERENCE.md, OPERATIONAL_RUNBOOKS.md. Validator/block health:scripts/monitoring/monitor-blockchain-health.sh(RPC + block production + all 5 validators active); 08-monitoring/BLOCK_PRODUCTION_MONITORING.md, BLOCK_PRODUCTION_FIX_RUNBOOK.md. Run 2026-02-08: all 5 validators active; see VALIDATOR_AND_BLOCK_HEALTH_20260208.md. - ✅ 2026-02-08: Doc prune/archive — 05-network superseded → archive/05-network-superseded/. 00-meta: 27 docs → archive/00-meta-pruned/. Verification-evidence: 72 old run folders → archive/verification-evidence-old/. Deployment status: MASTER = authoritative inventory; CONSOLIDATED = legacy. See ARCHIVE_CANDIDATES and archive/README.
- ✅ 2026-02-08: Master docs + block production — BESU_NODES_FILE_REFERENCE (2500–2502 → ALLTRA .172–.174; production RPC 2101/2201/2301). Permissioning: all Besu docs use permissions-nodes.toml (not JSON). RPC_DNS_CONFIGURATION + CLOUDFLARE_TUNNEL_ROUTING_ARCHITECTURE: RPC targets .211 (prv) / .221 (pub). CHAIN138_BESU_CONFIGURATION + BESU_PATH_REFERENCE: TOML only. BLOCK_PRODUCTION_FIX_RUNBOOK: full restart checklist; OPERATIONAL_RUNBOOKS + MASTER_DOCS_AND_NODE_LISTS_REVIEW updated. Validation: VALIDATION_REVIEW_20260208.md.
- ✅ 2026-02-06: Master documentation consistency — Option B (RPC via Cloudflare Tunnel) reflected in MASTER_INDEX, NETWORK_CONFIGURATION_MASTER, CLOUDFLARE_ROUTING_MASTER, RPC_ENDPOINTS_MASTER, OPERATIONAL_RUNBOOKS; directory trees updated (OPTION_B_RPC_VIA_TUNNEL_RUNBOOK, E2E_RPC_EDGE_LIMITATION, TUNNEL_SFVALLEY01_INSTALL, CLOUDFLARE_TUNNEL_502_FIX_RUNBOOK, CONFIGURATION_DECISION_TREE, NETWORK_CONFIGURATION_MASTER); E2E script auto ACCEPT_ANY_DNS when CLOUDFLARE_TUNNEL_ID set; QUICK_WINS + PRE_START_CHECKLIST snapshot/backup/health refs.
- ✅ 2026-02-05: Master documentation update — 32 files archived to
docs/archive/00-meta-status/; REMAINING_WORK_DETAILED_STEPS.md completed (W1-11–W1-26, validations, CCIP checklist); NETWORK_ARCHITECTURE runbook cross-links; QUICK_REFERENCE_CARDS decision tree + CoinGecko/Snap/Explorer; 04-config README + ENV_STANDARDIZATION config validation ref; API_KEYS_REQUIRED + PLACEHOLDERS canonical env; ARCHIVE_CANDIDATES consolidation note. - ✅ 2026-01-31: Exchanges, Ramps, DeFi integration - Exchange Registry (Binance, Kraken, Oanda, FXCM), Ramp API (10 providers), DefiRouter (1inch, ParaSwap, 0x)
- ✅ 2026-01-31: Crypto.com OTC 2.0 API integration - DBIS Core exchange module, FX integration, settle-later tracking
- ✅ 2026-01-31: DBIS Core API Reference created (11-references/DBIS_CORE_API_REFERENCE.md)
- ✅ 2025-01-20: Documentation quality fixes complete (duplicates eliminated, formats standardized)
- ✅ 2025-01-20: Cloudflare routing consolidated into master reference document
- ✅ 2025-01-20: Network architecture duplication resolved
- ✅ 2025-01-20: All cross-references added and standardized
- ✅ 2025-01-20: Complete documentation reorganization (340 files organized)
- ✅ 2025-01-20: Created missing documentation (disaster recovery, backup/restore, security, change management, performance)
- ✅ 2025-01-20: Organized Cloudflare documentation into subdirectory
- ✅ 2025-01-20: Standardized file naming convention
- ✅ 2025-01-20: Created documentation style guide
- ✅ 2025-01-20: Network architecture upgraded to v2.0
- ✅ 2025-01-20: Orchestration deployment guide created
- ✅ 2025-01-20: 75+ documents archived, organized structure
Document Statistics
- Total Active Documents: 48 (organized in 12 directories)
- Archived Documents: 75+
- Core Architecture Documents: 3
- Deployment Guides: 6
- Troubleshooting Guides: 2
- Best Practices: 4
Maintenance
- Update Frequency: Critical documents updated weekly, others monthly
- Review Cycle: Quarterly for architecture, monthly for operations
- Archive Policy: Historical documents moved to
archive/
🔗 Cross-Reference Map
By Workflow
Deployment Workflow:
- 01-getting-started/PREREQUISITES.md →
- 03-deployment/DEPLOYMENT_READINESS.md →
- 02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md →
- 03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md
Network Setup Workflow:
- 02-architecture/NETWORK_ARCHITECTURE.md →
- 04-configuration/ER605_ROUTER_CONFIGURATION.md →
- 04-configuration/cloudflare/CLOUDFLARE_ZERO_TRUST_GUIDE.md
Troubleshooting Workflow:
- 09-troubleshooting/TROUBLESHOOTING_FAQ.md →
- 03-deployment/OPERATIONAL_RUNBOOKS.md →
- 09-troubleshooting/QBFT_TROUBLESHOOTING.md (if consensus issues)
Contract Verification Workflow:
- CONTRACT_DEPLOYMENT_RUNBOOK.md →
- scripts/verify/run-contract-verification-with-proxy.sh (orchestrated; starts proxy if needed)
Or manual: forge-verification-proxy/README.md → scripts/verify-contracts-blockscout.sh
📞 Support & Help
Getting Help
- Common Issues: Check 09-troubleshooting/TROUBLESHOOTING_FAQ.md
- Operational Procedures: See 03-deployment/OPERATIONAL_RUNBOOKS.md
- Architecture Questions: Review 02-architecture/NETWORK_ARCHITECTURE.md
- Deployment Questions: See 02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md
Related Documentation
Blitzkrieg / Marching Ants (single-path execution spine)
- BLITZKRIEG_SUPER_PRO_MAX_MASTER_PLAN.md ⭐⭐⭐ - Token-and-bridge rollout (marching ants); §2 three-column flow, §3 numbered trail (Steps 0–19), §5 recommendations by phase/category, §8–§11 Supreme Command + Absolute Air Superiority
- BLITZKRIEG_SOURCE_DOCUMENT_INDEX.md - Where to update when completed (REMAINING_COMPONENTS, PLACEHOLDERS, CONTRACT_NEXT_STEPS, etc.)
Master plan and requirements
- MASTER_PLAN.md ⭐⭐⭐ - Single Master Plan (gaps, protection layer, admin panels, phased execution)
- ALL_REQUIREMENTS.md ⭐⭐⭐ - All requirements (security, deployment, waves, validation, optional)
- DOCUMENTATION_STYLE_GUIDE.md ⭐⭐⭐ - Documentation standards
- DOCUMENTATION_QUALITY_REVIEW.md ⭐⭐ - Quality review findings
- DOCUMENTATION_FIX_TASK_LIST.md ⭐⭐ - Task list and completed fixes (DOCUMENTATION_FIXES_COMPLETE was consolidated here)
- DOCUMENTATION_ENHANCEMENTS_RECOMMENDATIONS.md ⭐⭐⭐ - Enhancement recommendations and visual elements
- COMPREHENSIVE_DOCUMENTATION_REVIEW_2026-01-31.md ⭐⭐ - Comprehensive documentation review (methodology, findings, recommendations)
- MASTER_DOCUMENTATION_REVIEW_20260205.md ⭐⭐ - Master docs consistency (2506–2508 destroyed 2026-02-08; inventory vs SSH)
- DOCUMENTATION_FIX_TASK_LIST.md ⭐⭐⭐ - Task list to fix all documentation issues (links, trees, consistency, enhancements)
- DOCUMENTATION_METRICS.md ⭐ - Documentation health metrics (broken links, headers, review date)
- DOCUMENT_RELATIONSHIP_MAP.md ⭐ - Optional doc relationship diagram (Mermaid + ASCII)
- CLEANUP_SUMMARY.md - Documentation cleanup summary
- DOCUMENTATION_UPGRADE_SUMMARY.md - Documentation upgrade summary
- FULL_PARALLEL_EXECUTION_ORDER.md ⭐⭐⭐ - Execution order for full maximum parallel mode (Wave 0→1→2→3)
- FULL_PARALLEL_RUN_LOG.md — Archived (archive/00-meta-pruned); historical run log. Execution order: FULL_PARALLEL_EXECUTION_ORDER.md.
- WAVE1_COMPLETION_SUMMARY.md - Wave 1 task status (Done / Operator / Documented)
- WAVE2_WAVE3_OPERATOR_CHECKLIST.md - Operator checklist for Wave 0, Wave 2, Wave 3, Ongoing
- REMAINING_WORK_DETAILED_STEPS.md ⭐⭐⭐ - Step-by-step instructions for each remaining task (Wave 0–3, cron, API keys); includes "Can be accomplished now" and 2026-02-05 completion note
- REMAINING_TASKS_AND_API_FEATURES.md — Consolidated remaining tasks (Phoenix, OMNL, Explorer, Mifos, codebase) and inventory of new/additional API features (Phoenix Deploy, OMNL Fineract, Explorer API)
- REMAINING_TASKS_NEXT_STEPS_PHASES_REVIEW.md ⭐⭐⭐ - Consolidated review of all remaining tasks, next steps, and phases
- PHASES_AND_TASKS_MASTER.md - Deployment and codebase task checklist (dbis_core TS Phases 1-4 done)
- PARALLEL_TASK_STRUCTURE.md - Parallel execution cohorts (A/B/C/D)
- reports/ - PRIORITIZED_TASKS_20260131.md, API_KEYS_REQUIRED.md, status/VM_RESTART_AND_VERIFICATION_20260203.md
- archive/README.md - Archived documentation index
- archive/00-meta-status/ - Status/complete/final reports moved from 00-meta (2026-02-05)
Last Updated: 2026-02-16
Maintained By: Infrastructure Team
Review Cycle: Monthly
Version: 6.3