Archive legacy status docs and canonicalize genesis entrypoints
This commit is contained in:
3
Makefile
3
Makefile
@@ -225,7 +225,8 @@ clean:
|
||||
|
||||
genesis:
|
||||
@echo "Generating genesis file..."
|
||||
./scripts/generate-genesis.sh
|
||||
./scripts/generate-genesis-proper.sh 4
|
||||
./scripts/validation/validate-genesis.sh
|
||||
|
||||
keys:
|
||||
@echo "Generating keys..."
|
||||
|
||||
64
README.md
64
README.md
@@ -1,15 +1,15 @@
|
||||
<div align="center">
|
||||
|
||||
# 🌐 DeFi Oracle Meta Mainnet
|
||||
## ChainID 138 | Production-Ready Blockchain Network
|
||||
## ChainID 138 | Operator-Focused Blockchain Workspace
|
||||
|
||||
[](https://github.com/Defi-Oracle-Tooling/smom-dbis-138)
|
||||
[](https://github.com/Defi-Oracle-Tooling/smom-dbis-138)
|
||||
[](https://explorer.d-bis.org)
|
||||
[](docs/architecture/ARCHITECTURE.md)
|
||||
[](LICENSE)
|
||||
[](docs/)
|
||||
|
||||
**Production-ready** Hyperledger Besu network with QBFT consensus, deployed on Azure Kubernetes Service (AKS). Complete with CCIP cross-chain oracle support, comprehensive security scanning, full observability, MetaMask integration, and extensive testing infrastructure.
|
||||
Hyperledger Besu workspace for ChainID 138 with QBFT consensus, deployment automation, CCIP and tokenization integrations, security tooling, and a cleaned active-vs-historical documentation surface.
|
||||
|
||||
[🚀 Quick Start](#-quick-start) • [📚 Documentation](#-documentation) • [🏗️ Architecture](#️-architecture) • [🔒 Security](#-security) • [📊 Features](#-features) • [🤝 Contributing](#-contributing)
|
||||
|
||||
@@ -32,7 +32,7 @@
|
||||
| **WETH9/WETH10 with CCIP** | ✅ Complete | Cross-chain ready |
|
||||
| **OpenZeppelin Dependencies** | ✅ Hybrid Approach | OpenZeppelin v4.9.6 installed |
|
||||
|
||||
**🎉 Status**: ✅ **PRODUCTION-READY WITH ALL ENHANCEMENTS**
|
||||
**Status**: ✅ Core implementation complete, with ongoing operator cleanup and deployment-hygiene work.
|
||||
|
||||
> **Note**: 30 deployment and integration tasks remain (operational procedures, external submissions). All code tasks are 100% complete. See [Next Steps](docs/operations/tasks/NEXT_STEPS_LIST.md) for deployment tasks.
|
||||
>
|
||||
@@ -358,7 +358,7 @@ curl -X POST https://rpc.d-bis.org \
|
||||
|
||||
### 📋 Deployment Checklist
|
||||
|
||||
See [Deployment Checklist](docs/DEPLOYMENT_CHECKLIST.md) for complete step-by-step instructions.
|
||||
See [Deployment Checklist](docs/deployment/DEPLOYMENT_CHECKLIST.md) for complete step-by-step instructions.
|
||||
|
||||
---
|
||||
|
||||
@@ -387,9 +387,9 @@ See [Deployment Checklist](docs/DEPLOYMENT_CHECKLIST.md) for complete step-by-st
|
||||
|
||||
### Security Documentation
|
||||
|
||||
- [Security Guide](docs/SECURITY.md) - Comprehensive security documentation
|
||||
- [Security Guide](docs/security/SECURITY.md) - Comprehensive security documentation
|
||||
- [Security Scanning Guide](docs/security/SECURITY_SCANNING_GUIDE.md) - Security scanning process
|
||||
- [Security Compliance](docs/SECURITY_COMPLIANCE.md) - Compliance documentation
|
||||
- [Security Compliance](docs/security/SECURITY_COMPLIANCE.md) - Compliance documentation
|
||||
- [Security Scores](docs/security/SECURITY_SCORES.md) - Interpreting security scores
|
||||
|
||||
---
|
||||
@@ -509,7 +509,7 @@ await addOrSwitchNetwork();
|
||||
2. Go to Settings → Networks → Add Network
|
||||
3. Enter the network details from above
|
||||
|
||||
See [MetaMask Integration Guide](docs/METAMASK_INTEGRATION.md) for complete instructions.
|
||||
See [MetaMask Integration Guide](docs/operations/integrations/METAMASK_INTEGRATION.md) for complete instructions.
|
||||
|
||||
---
|
||||
|
||||
@@ -551,31 +551,31 @@ See [ALL Mainnet Master Documentation](../docs/MASTER_INDEX.md) for complete int
|
||||
|
||||
- [Quick Start Guide](docs/guides/QUICKSTART.md) - Get started in 5 minutes
|
||||
- [Deployment Guide](docs/deployment/DEPLOYMENT.md) - Complete deployment instructions
|
||||
- [Next Steps List](docs/NEXT_STEPS_LIST.md) - **Complete checklist of all next steps (30 tasks)**
|
||||
- [Deployment Checklist](docs/DEPLOYMENT_CHECKLIST.md) - Step-by-step deployment checklist
|
||||
- [Next Steps List](docs/operations/tasks/NEXT_STEPS_LIST.md) - **Complete checklist of all next steps (30 tasks)**
|
||||
- [Deployment Checklist](docs/deployment/DEPLOYMENT_CHECKLIST.md) - Step-by-step deployment checklist
|
||||
- [Deployment Scripts](scripts/deployment/README.md) - Deployment automation scripts
|
||||
|
||||
### 🏗️ Architecture & Design
|
||||
|
||||
- [Architecture Documentation](docs/architecture/ARCHITECTURE.md) - Complete architecture overview
|
||||
- [Network Configuration](docs/NETWORK.md) - Network setup and configuration
|
||||
- [Azure Well-Architected Framework](docs/AZURE_WELL_ARCHITECTED_IMPLEMENTATION.md) - Best practices implementation
|
||||
- [Deployment Comparison](docs/DEPLOYMENT_COMPARISON.md) - AKS vs VM deployment
|
||||
- [Network Configuration](docs/architecture/NETWORK.md) - Network setup and configuration
|
||||
- [Azure Well-Architected Framework](docs/azure/AZURE_WELL_ARCHITECTED_IMPLEMENTATION.md) - Best practices implementation
|
||||
- [Deployment Comparison](docs/deployment/DEPLOYMENT_COMPARISON.md) - AKS vs VM deployment
|
||||
|
||||
### 🔒 Security & Compliance
|
||||
|
||||
- [Security Guide](docs/SECURITY.md) - Comprehensive security documentation
|
||||
- [Security Guide](docs/security/SECURITY.md) - Comprehensive security documentation
|
||||
- [Security Scanning Guide](docs/security/SECURITY_SCANNING_GUIDE.md) - Security scanning process
|
||||
- [Security Compliance](docs/SECURITY_COMPLIANCE.md) - Compliance documentation
|
||||
- [Governance Framework](docs/GOVERNANCE.md) - Governance and proposal process
|
||||
- [Security Compliance](docs/security/SECURITY_COMPLIANCE.md) - Compliance documentation
|
||||
- [Governance Framework](docs/governance/GOVERNANCE.md) - Governance and proposal process
|
||||
|
||||
### 🔗 Integration Guides
|
||||
|
||||
- [MetaMask Integration](docs/METAMASK_INTEGRATION.md) - Complete MetaMask integration guide
|
||||
- [MetaMask Developer Guide](docs/METAMASK_DEVELOPER_GUIDE.md) - Developer integration guide
|
||||
- [CCIP Integration Guide](docs/CCIP_INTEGRATION.md) - CCIP setup and usage
|
||||
- [Tatum SDK Integration](docs/TATUM_SDK.md) - SDK integration guide
|
||||
- [Financial Tokenization](docs/FINANCIAL_TOKENIZATION.md) - ISO-20022 and SWIFT FIN tokenization
|
||||
- [MetaMask Integration](docs/operations/integrations/METAMASK_INTEGRATION.md) - Complete MetaMask integration guide
|
||||
- [MetaMask Developer Guide](docs/operations/integrations/METAMASK_DEVELOPER_GUIDE.md) - Developer integration guide
|
||||
- [CCIP Integration Guide](docs/operations/integrations/CCIP_INTEGRATION.md) - CCIP setup and usage
|
||||
- [Tatum SDK Integration](docs/api/TATUM_SDK.md) - SDK integration guide
|
||||
- [Financial Tokenization (Archived)](docs/archive/status-reports/operations-legacy/FINANCIAL_TOKENIZATION.md) - Historical ISO-20022 and SWIFT FIN tokenization notes
|
||||
- [ALL Mainnet Integration](../docs/MASTER_INDEX.md) - Complete ALL Mainnet (651940) integration guide
|
||||
- [Multi-Chain Deployment](docs/deployment/MULTI_CHAIN_DEPLOYMENT_GUIDE.md) - Multi-chain deployment guide
|
||||
|
||||
@@ -584,7 +584,7 @@ See [ALL Mainnet Master Documentation](../docs/MASTER_INDEX.md) for complete int
|
||||
- [Operations Runbooks](runbooks/) - Complete operations runbooks
|
||||
- [Troubleshooting Guide](docs/guides/TROUBLESHOOTING.md) - Common issues and solutions
|
||||
- [Validation Guide](docs/guides/VALIDATION_GUIDE.md) - Deployment validation
|
||||
- [API Documentation](docs/API.md) - JSON-RPC API reference
|
||||
- [API Documentation](docs/api/API.md) - JSON-RPC API reference
|
||||
|
||||
### 📈 Monitoring & Observability
|
||||
|
||||
@@ -595,10 +595,10 @@ See [ALL Mainnet Master Documentation](../docs/MASTER_INDEX.md) for complete int
|
||||
|
||||
### 🎯 Project Management
|
||||
|
||||
- [Project Review](docs/COMPLETE_PROJECT_REVIEW.md) - Comprehensive project review
|
||||
- [Recommendations](docs/RECOMMENDATIONS.md) - Next steps and enhancements
|
||||
- [TODO List](docs/TODO.md) - Complete task tracking
|
||||
- [Completion Report](docs/COMPLETION_REPORT_FINAL.md) - Final completion status
|
||||
- [Project Review (Archived)](docs/archive/status-reports/docs-root-legacy/COMPLETE_PROJECT_REVIEW.md) - Historical comprehensive project review
|
||||
- [Documentation Recommendations](docs/DOCUMENTATION_REVIEW_AND_RECOMMENDATIONS.md) - Documentation review and next-step recommendations
|
||||
- [TODO List](docs/operations/tasks/TODO.md) - Active task tracking
|
||||
- [Current Deployment Status](docs/DEPLOYMENT_STATUS_AND_NEXT_STEPS.md) - Active deployment and follow-up status
|
||||
|
||||
---
|
||||
|
||||
@@ -858,7 +858,7 @@ terraform apply -var-file=terraform.tfvars.vm -var="vm_deployment_enabled=true"
|
||||
- ✅ Simpler setup
|
||||
- ✅ Cost-effective
|
||||
|
||||
See [VM Deployment Guide](docs/VM_DEPLOYMENT.md) for detailed instructions.
|
||||
See [VM Deployment Guide](docs/deployment/VM_DEPLOYMENT.md) for detailed instructions.
|
||||
|
||||
---
|
||||
|
||||
@@ -903,7 +903,7 @@ See [Configuration Guide](docs/configuration/AZURE_CLOUDFLARE_ENV_SETUP.md) for
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
We welcome contributions! Please see our [Contributing Guide](docs/CONTRIBUTING.md) for details.
|
||||
We welcome contributions! Please see our [Contributing Guide](docs/governance/CONTRIBUTING.md) for details.
|
||||
|
||||
### Contribution Process
|
||||
|
||||
@@ -918,7 +918,7 @@ We welcome contributions! Please see our [Contributing Guide](docs/CONTRIBUTING.
|
||||
|
||||
### Development Guidelines
|
||||
|
||||
- ✅ Follow [Security Guidelines](docs/SECURITY.md)
|
||||
- ✅ Follow [Security Guidelines](docs/security/SECURITY.md)
|
||||
- ✅ Run security scans before submitting PRs
|
||||
- ✅ Follow [Code Style Guide](docs/configuration/AZURE_CLOUDFLARE_ENV_SETUP.md)
|
||||
- ✅ Add tests for new features
|
||||
@@ -928,7 +928,7 @@ We welcome contributions! Please see our [Contributing Guide](docs/CONTRIBUTING.
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
Licensing details are not currently published in a top-level `LICENSE` file in this repository. Confirm redistribution terms with the maintainers before reuse.
|
||||
|
||||
---
|
||||
|
||||
@@ -957,7 +957,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
|
||||
- [Quick Start Guide](docs/guides/QUICKSTART.md) - Get started quickly
|
||||
- [Troubleshooting Guide](docs/guides/TROUBLESHOOTING.md) - Common issues and solutions
|
||||
- [API Documentation](docs/API.md) - API reference
|
||||
- [API Documentation](docs/api/API.md) - API reference
|
||||
- [Runbooks](runbooks/) - Operations runbooks
|
||||
|
||||
---
|
||||
@@ -1020,7 +1020,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
|
||||
### 📊 Complete Checklist
|
||||
|
||||
See [Next Steps List](docs/NEXT_STEPS_LIST.md) for complete checklist of all 30 tasks:
|
||||
See [Next Steps List](docs/operations/tasks/NEXT_STEPS_LIST.md) for complete checklist of all 30 tasks:
|
||||
- ✅ 15 Deployment tasks
|
||||
- ✅ 10 Integration tasks
|
||||
- ✅ 5 Pre-production tasks
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# Comprehensive Documentation Review - Final Report
|
||||
|
||||
**Date**: 2025-01-27
|
||||
**Status**: ✅ Complete - All Gaps Identified and Addressed
|
||||
**Status**: Historical review snapshot
|
||||
|
||||
## Executive Summary
|
||||
|
||||
A comprehensive review of the entire `docs/` directory has been completed. All identified gaps have been addressed, broken links fixed, and missing documentation created. The documentation is now complete, well-organized, and production-ready.
|
||||
A comprehensive review of the `docs/` directory was completed at the time of writing. Use this report as a historical checkpoint; the documentation set has continued to evolve through archive moves, link cleanup, and active-vs-historical separation.
|
||||
|
||||
---
|
||||
|
||||
@@ -259,9 +259,9 @@ The documentation is now:
|
||||
- ✅ **Comprehensive** - Guides for all major operations
|
||||
- ✅ **Maintainable** - Review schedule and processes established
|
||||
- ✅ **User-friendly** - Easy to navigate and find information
|
||||
- ✅ **Production-ready** - Ready for ongoing use
|
||||
- ✅ **Operationally usable** - Ready for ongoing maintenance and iteration
|
||||
|
||||
The documentation system is comprehensive, well-organized, and production-ready.
|
||||
The documentation system is comprehensive, well-organized, and suitable for ongoing operational use.
|
||||
|
||||
---
|
||||
|
||||
@@ -277,4 +277,3 @@ The documentation system is comprehensive, well-organized, and production-ready.
|
||||
**Review Date**: 2025-01-27
|
||||
**Status**: ✅ **COMPREHENSIVE REVIEW COMPLETE**
|
||||
**All Gaps**: Identified and Addressed
|
||||
|
||||
|
||||
@@ -1,13 +1,17 @@
|
||||
# Deployment Status and Next Steps
|
||||
|
||||
**Last Updated:** $(date +"%Y-%m-%d %H:%M:%S UTC")
|
||||
**Network:** ChainID 138 - DeFi Oracle Meta Mainnet
|
||||
**Last Reviewed:** 2026-04-13
|
||||
**Status:** Historical deployment snapshot
|
||||
**Network:** ChainID 138 - DeFi Oracle Meta Mainnet
|
||||
**Use for current operations:** `docs/deployment/MASTER_INDEX.md`, `docs/PROJECT_OPTIMIZATION_STATUS.md`, and `docs/operations/tasks/NEXT_STEPS_LIST.md`
|
||||
|
||||
This document preserves an earlier deployment checkpoint with environment-specific details. Keep it for context, but prefer the current deployment indexes and runbooks above for live operations.
|
||||
|
||||
## ✅ Completed Tasks
|
||||
|
||||
### Phase 1: Infrastructure Setup
|
||||
- ✅ Genesis.json updated with WETH9/WETH10 bytecode (31,213 bytes)
|
||||
- ✅ IBFT extraData generated and deployed (RLP-encoded, 300 chars)
|
||||
- ✅ QBFT extraData generated and deployed (RLP-encoded, 300 chars)
|
||||
- ✅ Data directories emptied on all 5 nodes
|
||||
- ✅ Besu containers restarted with new genesis
|
||||
- ✅ All 5 nodes verified running (ChainID 138)
|
||||
@@ -32,7 +36,7 @@
|
||||
## ⏳ Current Status
|
||||
|
||||
### Block Production
|
||||
- **Status**: Nodes at block 0 (IBFT validators initializing)
|
||||
- **Status**: Nodes at block 0 (QBFT validators initializing)
|
||||
- **Chain ID**: 138 ✅
|
||||
- **extraData**: Valid RLP-encoded (300 chars) ✅
|
||||
- **Next**: Wait for validators to initialize and start producing blocks
|
||||
@@ -54,7 +58,7 @@
|
||||
1. **Verify Block Production**
|
||||
```bash
|
||||
cast block-number --rpc-url http://localhost:8545
|
||||
# Should return > 0 once IBFT is producing blocks
|
||||
# Should return > 0 once QBFT is producing blocks
|
||||
```
|
||||
|
||||
2. **Establish RPC Tunnel**
|
||||
@@ -120,7 +124,7 @@
|
||||
- Verify extraData in genesis.json is valid (300+ chars)
|
||||
- Check Besu logs for validator errors
|
||||
- Ensure validator keys are configured on nodes
|
||||
- Verify IBFT validators match extraData addresses
|
||||
- Verify QBFT validators match extraData addresses
|
||||
|
||||
### RPC Connection Issues
|
||||
- Check SSH tunnel is active: `ps aux | grep ssh.*8545`
|
||||
@@ -136,7 +140,7 @@
|
||||
## 📊 Network Configuration
|
||||
|
||||
- **Chain ID**: 138
|
||||
- **Consensus**: IBFT 2.0
|
||||
- **Consensus**: QBFT
|
||||
- **Block Period**: 2 seconds
|
||||
- **Epoch Length**: 30,000 blocks
|
||||
- **Gas Limit**: 30,000,000 (0x1c9c380)
|
||||
@@ -162,4 +166,4 @@ forge script script/DeployCCIPRouter.s.sol:DeployCCIPRouter --rpc-url http://loc
|
||||
```
|
||||
|
||||
---
|
||||
**Note**: Block production initialization may take several minutes. Monitor Besu logs for validator initialization progress.
|
||||
**Note**: Block production initialization may take several minutes. Monitor Besu logs for validator initialization progress, and use the current deployment indexes above for active operational guidance.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
**Date**: 2025-11-17
|
||||
**Purpose**: Organize 466+ markdown files in `docs/` directory into logical subdirectories
|
||||
|
||||
**Current Note (2026-04-12)**: This log captures the 2025-11-17 reorganization pass. The large status-report grouping mentioned below was later archived; use `docs/operations/status-reports/STATUS_REPORTS_INDEX.md` for active status navigation and `docs/archive/status-reports/` for historical report collections.
|
||||
|
||||
## Actions Taken
|
||||
|
||||
### 1. Created Directory Structure
|
||||
@@ -10,7 +12,7 @@ Created the following organized subdirectories:
|
||||
- `architecture/` - Architecture and design documentation
|
||||
- `deployment/` - Deployment guides and procedures
|
||||
- `operations/integrations/` - Integration guides (CCIP, MetaMask, Firefly, Cacti)
|
||||
- `operations/status-reports/` - Status reports and completion summaries
|
||||
- `operations/status-reports/` - Active status navigation (legacy report piles were later archived)
|
||||
- `operations/tasks/` - Task management and next steps
|
||||
- `azure/` - Azure-specific documentation
|
||||
- `security/` - Security documentation
|
||||
@@ -51,7 +53,7 @@ Created the following organized subdirectories:
|
||||
- `WETH_*.md` files
|
||||
- `BLOCKSCOUT_METAMASK.md`
|
||||
|
||||
#### Operations - Status Reports (90+ files)
|
||||
#### Operations - Status Reports (historical pre-archive grouping)
|
||||
- All `*COMPLETE*.md` files
|
||||
- All `*COMPLETION*.md` files
|
||||
- All `*STATUS*.md` files
|
||||
@@ -158,7 +160,7 @@ Created `README.md` in `docs/` directory with:
|
||||
- `architecture/`: 6 files
|
||||
- `deployment/`: 40 files
|
||||
- `operations/integrations/`: 20 files
|
||||
- `operations/status-reports/`: 90+ files
|
||||
- `operations/status-reports/`: Active index and routing docs only; historical files now live in `docs/archive/status-reports/`
|
||||
- `operations/tasks/`: 8 files
|
||||
- `azure/`: 22 files
|
||||
- `security/`: 7 files
|
||||
@@ -188,4 +190,3 @@ Created `README.md` in `docs/` directory with:
|
||||
- No files were deleted during organization
|
||||
- Documentation index (`README.md`) provides quick access to all categories
|
||||
- Existing subdirectories (`ccip-integration/`, `project-reviews/`, etc.) were preserved
|
||||
|
||||
|
||||
@@ -446,10 +446,9 @@ This document provides a comprehensive gap analysis of the documentation, identi
|
||||
|
||||
- [Documentation Review & Recommendations](DOCUMENTATION_REVIEW_AND_RECOMMENDATIONS.md)
|
||||
- [Master Documentation Index](MASTER_DOCUMENTATION_INDEX.md)
|
||||
- [Final Completion Report](FINAL_COMPLETION_REPORT.md)
|
||||
- [Final Completion Report (Archived)](archive/status-reports/docs-root-legacy/FINAL_COMPLETION_REPORT.md)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Next Review**: After fixes applied
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
- [DEPLOYMENT_QUICK_START.md](DEPLOYMENT_QUICK_START.md) - Fast deployment guide
|
||||
|
||||
## Architecture & Design
|
||||
- [ARCHITECTURE.md](ARCHITECTURE.md) - System architecture
|
||||
- [ARCHITECTURE.md](architecture/ARCHITECTURE.md) - System architecture
|
||||
- [DOCKER_COMPOSE_GUIDE.md](DOCKER_COMPOSE_GUIDE.md) - Docker Compose structure and usage
|
||||
|
||||
## Configuration
|
||||
@@ -15,8 +15,7 @@
|
||||
- [Contract Deployment Environment Setup](configuration/CONTRACT_DEPLOYMENT_ENV_SETUP.md) - Contract deployment environment variables
|
||||
- [CLEANUP_PLAN.md](CLEANUP_PLAN.md) - Cleanup and optimization plan
|
||||
- [PROJECT_OPTIMIZATION_STATUS.md](PROJECT_OPTIMIZATION_STATUS.md) - Current optimization status
|
||||
- [CLEANUP_DEDUPLICATION_REPORT.md](CLEANUP_DEDUPLICATION_REPORT.md) - Script and documentation deduplication analysis
|
||||
- [CLEANUP_SUMMARY_2025_11_18.md](CLEANUP_SUMMARY_2025_11_18.md) - Cleanup summary and statistics
|
||||
- [Archived Cleanup Reports](archive/status-reports/docs-root-legacy/) - Historical cleanup and completion reports
|
||||
|
||||
## Deployment
|
||||
- [DEPLOYMENT_CHECKLIST.md](deployment/DEPLOYMENT_CHECKLIST.md) - Deployment checklist
|
||||
@@ -24,10 +23,11 @@
|
||||
|
||||
## Operations
|
||||
- [Runbooks](../runbooks/) - Operational procedures
|
||||
- [Status Reports](operations/status-reports/) - Current status reports
|
||||
- [Status Reports Index](operations/status-reports/STATUS_REPORTS_INDEX.md) - Active-vs-archive status navigation
|
||||
|
||||
## Archive
|
||||
- [Archive README](archive/README.md) - Archived files documentation
|
||||
- [Archived Status Reports](archive/status-reports/README.md) - Historical status-report collections
|
||||
- [Cleanup Summary](archive/CLEANUP_SUMMARY.md) - Cleanup actions summary
|
||||
|
||||
## Consensus Migration
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
**Created**: 2025-01-27
|
||||
**Priority**: Critical and High Priority Issues Only
|
||||
|
||||
**Current Note (2026-04-12)**: Several of the structural fixes below have since been completed. The active docs now route status and historical material separately via `docs/operations/status-reports/STATUS_REPORTS_INDEX.md` and `docs/archive/status-reports/`.
|
||||
|
||||
This document provides a quick reference for the most critical documentation issues that should be addressed immediately.
|
||||
|
||||
---
|
||||
@@ -11,11 +13,10 @@ This document provides a quick reference for the most critical documentation iss
|
||||
|
||||
### 1. Fix IBFT Reference in Architecture Doc
|
||||
**File**: `docs/architecture/ARCHITECTURE.md`
|
||||
**Issue**: Still references IBFT 2.0 instead of QBFT
|
||||
**Fix**:
|
||||
- Line 5: Change "IBFT 2.0 consensus" → "QBFT consensus"
|
||||
- Line 33: Update protocol name
|
||||
- Line 45: Update consensus reference
|
||||
**Current Status**: Completed
|
||||
**Result**:
|
||||
- Active architecture and network entry points now describe Chain 138 as QBFT-based
|
||||
- Remaining IBFT wording is limited to a shrinking set of legacy milestone or audit-style docs that still need review
|
||||
|
||||
### 2. Consolidate Index Files
|
||||
**Files**:
|
||||
@@ -58,13 +59,12 @@ This document provides a quick reference for the most critical documentation iss
|
||||
## 🟠 High Priority Fixes (Do Next)
|
||||
|
||||
### 5. Archive Old Status Reports
|
||||
**Location**: `docs/operations/status-reports/` (90+ files)
|
||||
**Current Status**: Completed on 2026-04-12
|
||||
|
||||
**Action**:
|
||||
- Identify reports older than 6 months
|
||||
- Move to `docs/archive/status-reports/`
|
||||
- Create `STATUS_REPORTS_INDEX.md` categorizing remaining reports
|
||||
- Consolidate similar reports (multiple "COMPLETE", "FINAL", "TODO" reports)
|
||||
**Result**:
|
||||
- Legacy status-report piles were moved into `docs/archive/status-reports/operations-legacy/`, `docs/archive/status-reports/docs-root-legacy/`, and `docs/archive/status-reports/repo-root-legacy/`
|
||||
- `docs/operations/status-reports/STATUS_REPORTS_INDEX.md` now routes readers to current status docs versus historical archives
|
||||
- The active documentation surface no longer depends on the older 90+ file report pile
|
||||
|
||||
### 6. Consolidate Deployment Guides
|
||||
**Location**: `docs/deployment/` (40+ files)
|
||||
@@ -94,11 +94,11 @@ This document provides a quick reference for the most critical documentation iss
|
||||
|
||||
## 📋 Quick Checklist
|
||||
|
||||
- [ ] Fix IBFT → QBFT in ARCHITECTURE.md
|
||||
- [ ] Consolidate 3 index files into 1 master index
|
||||
- [ ] Rename 3 configuration guides for clarity
|
||||
- [x] Fix IBFT → QBFT in active architecture docs
|
||||
- [x] Consolidate 3 index files into 1 master-led navigation surface
|
||||
- [x] Rename 3 configuration guides for clarity
|
||||
- [ ] Fix duplicate naming convention files
|
||||
- [ ] Archive status reports >6 months old
|
||||
- [x] Archive legacy status-report piles and separate active vs. historical routing
|
||||
- [ ] Consolidate deployment guides
|
||||
- [ ] Add cross-references to key docs
|
||||
- [ ] Add metadata headers to all docs
|
||||
@@ -112,5 +112,4 @@ For complete details and all recommendations, see:
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
|
||||
**Last Updated**: 2026-04-12
|
||||
|
||||
@@ -4,6 +4,8 @@
|
||||
**Reviewer**: Auto (AI Assistant)
|
||||
**Scope**: Complete review of `/docs/` directory (621+ files)
|
||||
|
||||
**Current Note (2026-04-12)**: This file is retained as the original audit baseline. The largest structural issue it identified, the oversized status-report surface, has since been cleaned up: active navigation now goes through `docs/operations/status-reports/STATUS_REPORTS_INDEX.md`, and historical reports live under `docs/archive/status-reports/`.
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
@@ -13,11 +15,11 @@ This document provides a comprehensive review of all documentation in the `docs/
|
||||
### Key Findings
|
||||
|
||||
- **Total Documentation Files**: 621+ markdown files
|
||||
- **Status Reports**: 90+ files in `operations/status-reports/` (many may be outdated)
|
||||
- **Index Files**: 3 different index files with overlapping content
|
||||
- **Configuration Guides**: 3 similar guides that could be consolidated
|
||||
- **Status Reports**: The legacy 90+ file pile from `operations/status-reports/` has been archived; active status navigation now uses `operations/status-reports/STATUS_REPORTS_INDEX.md`
|
||||
- **Index Files**: `MASTER_DOCUMENTATION_INDEX.md` is now the primary index, with `README.md` and `DOCUMENTATION_INDEX.md` acting as entry points
|
||||
- **Configuration Guides**: The similarly named setup guides were renamed and clarified
|
||||
- **Deployment Guides**: 40+ deployment-related files with significant overlap
|
||||
- **Architecture Docs**: 1 file still references IBFT 2.0 instead of QBFT
|
||||
- **Architecture Docs**: The active architecture guide now uses QBFT wording instead of the older IBFT 2.0 phrasing found during the original audit
|
||||
|
||||
---
|
||||
|
||||
@@ -27,17 +29,19 @@ This document provides a comprehensive review of all documentation in the `docs/
|
||||
|
||||
**Location**: `docs/architecture/ARCHITECTURE.md`
|
||||
|
||||
**Issue**: Line 5 states "built on Hyperledger Besu with IBFT 2.0 consensus" but the project has migrated to QBFT.
|
||||
**Current Status**: Resolved in the active architecture guide.
|
||||
|
||||
**Impact**: High - Misleading information for new users and developers
|
||||
**Historical Issue**: The original review found IBFT 2.0 wording in the architecture overview before the project documentation was updated to QBFT terminology.
|
||||
|
||||
**Impact**: Was high because it could mislead new users and developers.
|
||||
|
||||
**Recommendation**:
|
||||
- Update line 5 to reference QBFT instead of IBFT 2.0
|
||||
- Update line 33-34 to reflect QBFT protocol details
|
||||
- Verify all consensus-related references in this file
|
||||
- Keep the active architecture guide on QBFT wording
|
||||
- Treat any remaining IBFT references in historical docs as archive-only context
|
||||
- Verify consensus wording when promoting archived content back into the active surface
|
||||
|
||||
**Files to Update**:
|
||||
- `docs/architecture/ARCHITECTURE.md` (lines 5, 33-34, 45)
|
||||
- Active file already updated: `docs/architecture/ARCHITECTURE.md`
|
||||
|
||||
### 2. Multiple Conflicting Index Files
|
||||
|
||||
@@ -46,16 +50,17 @@ This document provides a comprehensive review of all documentation in the `docs/
|
||||
- `docs/DOCUMENTATION_INDEX.md`
|
||||
- `docs/MASTER_DOCUMENTATION_INDEX.md`
|
||||
|
||||
**Issue**: Three different index files with overlapping but not identical content. This creates confusion about which is the "source of truth."
|
||||
**Current Status**: Mostly resolved.
|
||||
|
||||
**Issue**: The review found three different index files with overlapping but not identical content, which created confusion about the "source of truth."
|
||||
|
||||
**Impact**: High - Users don't know which index to use
|
||||
|
||||
**Recommendation**:
|
||||
- **Consolidate into single master index**: Keep `MASTER_DOCUMENTATION_INDEX.md` as the primary index
|
||||
- **Update README.md**: Make it a simple entry point that links to the master index
|
||||
- **Archive or merge DOCUMENTATION_INDEX.md**: Either merge its unique content into the master index or archive it
|
||||
- **Add "Last Updated" dates** to all index files
|
||||
- **Cross-reference** between files if keeping multiple
|
||||
- Keep `MASTER_DOCUMENTATION_INDEX.md` as the primary index
|
||||
- Keep `README.md` and `DOCUMENTATION_INDEX.md` as lightweight entry points that route readers to the master index
|
||||
- Maintain "Last Updated" dates on the index files
|
||||
- Repoint links promptly when archive moves happen
|
||||
|
||||
### 3. Duplicate Configuration Guides
|
||||
|
||||
@@ -64,18 +69,19 @@ This document provides a comprehensive review of all documentation in the `docs/
|
||||
- `ENV_SETUP.md` - Environment variables setup (Azure/Cloudflare focused)
|
||||
- `ENVIRONMENT_SETUP.md` - Contract deployment environment setup
|
||||
|
||||
**Issue**: Three guides with overlapping but distinct purposes. Names are confusingly similar.
|
||||
**Current Status**: Resolved in the active docs.
|
||||
|
||||
**Issue**: The original guide names were confusingly similar even though the files served different purposes.
|
||||
|
||||
**Impact**: Medium-High - Users may not know which guide to follow
|
||||
|
||||
**Recommendation**:
|
||||
- **Rename for clarity**:
|
||||
- Keep the clearer filenames in place:
|
||||
- `CONFIGURATION_GUIDE.md` → `NETWORK_CONFIGURATION_GUIDE.md`
|
||||
- `ENV_SETUP.md` → `AZURE_CLOUDFLARE_ENV_SETUP.md`
|
||||
- `ENVIRONMENT_SETUP.md` → `CONTRACT_DEPLOYMENT_ENV_SETUP.md`
|
||||
- **Add clear purpose statements** at the top of each file
|
||||
- **Cross-reference** between related guides
|
||||
- **Create a configuration index** that explains when to use each guide
|
||||
- Keep purpose statements and cross-references near the top of each file
|
||||
- Use `configuration/CONFIGURATION_INDEX.md` as the routing entry point
|
||||
|
||||
### 4. Duplicate Naming Convention Files
|
||||
|
||||
@@ -83,39 +89,42 @@ This document provides a comprehensive review of all documentation in the `docs/
|
||||
- `NAMING_CONVENTION.md`
|
||||
- `NAMING_CONVENTIONS.md`
|
||||
|
||||
**Issue**: Two files with nearly identical names - likely duplicates or one is outdated.
|
||||
**Current Status**: Resolved in the active docs.
|
||||
|
||||
**Issue**: Two files with nearly identical names created uncertainty about which convention was authoritative.
|
||||
|
||||
**Impact**: Medium - Confusion about which file to reference
|
||||
|
||||
**Recommendation**:
|
||||
- **Compare both files** to identify differences
|
||||
- **Consolidate** if duplicates, or **rename** if they serve different purposes
|
||||
- **Update all references** to use the correct filename
|
||||
- Keep the explicit split between:
|
||||
- `AZURE_NAMING_CONVENTION_2CHAR.md`
|
||||
- `AZURE_NAMING_CONVENTION_3CHAR.md`
|
||||
- Preserve cross-references between the two conventions
|
||||
- Update links if additional naming docs are introduced
|
||||
|
||||
---
|
||||
|
||||
## 🟠 High Priority Issues (Should Fix Soon)
|
||||
|
||||
### 5. Excessive Status Reports (90+ Files)
|
||||
### 5. Excessive Status Reports (Resolved 2026-04-12)
|
||||
|
||||
**Location**: `docs/operations/status-reports/`
|
||||
**Current Location**:
|
||||
- Active navigation: `docs/operations/status-reports/STATUS_REPORTS_INDEX.md`
|
||||
- Historical collections: `docs/archive/status-reports/`
|
||||
|
||||
**Issue**: 90+ status report files, many likely outdated or redundant. Examples:
|
||||
- Multiple "COMPLETE" reports: `COMPLETE_ALL_TASKS_SUMMARY.md`, `COMPLETE_DEPLOYMENT_STATUS.md`, `COMPLETE_ENTERPRISE_TASK_SUMMARY.md`, `COMPLETE_NEXT_STEPS_REPORT.md`, `COMPLETE_TASK_SUMMARY.md`
|
||||
- Multiple "FINAL" reports: `FINAL_COMPLETE_REPORT.md`, `FINAL_COMPLETE_STATUS.md`, `FINAL_COMPLETION_REPORT.md`, `FINAL_COMPLETION_STATUS.md`, `FINAL_DEPLOYMENT_STATUS.md`, `FINAL_PROJECT_STATUS.md`, `FINAL_SUMMARY.md`
|
||||
- Multiple "TODO" reports: `TODO_COMPLETE_SUMMARY.md`, `TODO_COMPLETION_SUMMARY.md`, `TODO_STATUS_REPORT.md`
|
||||
**Historical Issue**: The review originally found 90+ status report files in `docs/operations/status-reports/`, including multiple overlapping "COMPLETE", "FINAL", and "TODO" summaries.
|
||||
|
||||
**Impact**: High - Difficult to find current status, many outdated reports
|
||||
**Impact**: High at the time because it was difficult to find the current status among redundant historical reports.
|
||||
|
||||
**Recommendation**:
|
||||
- **Create status report retention policy**: Archive reports older than 6 months
|
||||
- **Consolidate similar reports**: Merge multiple "COMPLETE" or "FINAL" reports into single documents
|
||||
- **Create a status report index**: `STATUS_REPORTS_INDEX.md` that categorizes reports by:
|
||||
- Date range
|
||||
- Topic (deployment, infrastructure, tasks, etc.)
|
||||
- Status (current vs. historical)
|
||||
- **Archive old reports**: Move reports older than 6 months to `docs/archive/status-reports/`
|
||||
- **Create a "Current Status" document**: Single source of truth for current project status
|
||||
**Current Outcome**:
|
||||
- Legacy report piles from `docs/operations/status-reports/`, `docs/`, and the repository root were archived into dedicated collections under `docs/archive/status-reports/`
|
||||
- `STATUS_REPORTS_INDEX.md` now routes readers to current status docs versus historical archives
|
||||
- Current status tracking now points to active deployment, routing, compile, and task documents instead of the older report pile
|
||||
|
||||
**Maintenance Guidance**:
|
||||
- Keep `docs/operations/status-reports/` limited to active routing/index content
|
||||
- Move narrative completion snapshots and superseded reports into `docs/archive/status-reports/`
|
||||
- Update central indexes whenever new archival moves happen
|
||||
|
||||
### 6. Deployment Guide Proliferation (40+ Files)
|
||||
|
||||
@@ -465,8 +474,8 @@ This document provides a comprehensive review of all documentation in the `docs/
|
||||
|
||||
- [Documentation Index](DOCUMENTATION_INDEX.md)
|
||||
- [Master Documentation Index](MASTER_DOCUMENTATION_INDEX.md)
|
||||
- [Cleanup Complete Summary](CLEANUP_COMPLETE_SUMMARY.md)
|
||||
- [All Recommendations and Suggestions](ALL_RECOMMENDATIONS_AND_SUGGESTIONS.md)
|
||||
- [Cleanup Complete Summary (Archived)](archive/status-reports/docs-root-legacy/CLEANUP_COMPLETE_SUMMARY.md)
|
||||
- [All Recommendations and Suggestions (Archived)](archive/status-reports/docs-root-legacy/ALL_RECOMMENDATIONS_AND_SUGGESTIONS.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -482,4 +491,3 @@ This document provides a comprehensive review of all documentation in the `docs/
|
||||
**Last Updated**: 2025-01-27
|
||||
**Next Review**: Quarterly or as needed
|
||||
**Status**: Active Review
|
||||
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
# Final Gap Analysis and Fixes - Complete Summary
|
||||
|
||||
**Date**: 2025-01-27
|
||||
**Status**: ✅ All Gaps Identified and Fixed
|
||||
**Status**: Historical documentation-review snapshot
|
||||
|
||||
This document captures an earlier documentation review milestone. The docs set has continued to evolve through archive moves, index cleanup, and terminology updates.
|
||||
|
||||
## Executive Summary
|
||||
|
||||
@@ -256,11 +258,10 @@ The documentation is now:
|
||||
- ✅ **Maintainable** - Processes and schedules established
|
||||
- ✅ **User-friendly** - Easy to navigate and find information
|
||||
|
||||
The documentation system is production-ready and comprehensive.
|
||||
The documentation system had reached a strong milestone at the time of this review and was comprehensive for its then-current scope.
|
||||
|
||||
---
|
||||
|
||||
**Completion Date**: 2025-01-27
|
||||
**Status**: ✅ **ALL GAPS ADDRESSED**
|
||||
**Total Issues Fixed**: 8 critical + 8 high priority = 16 issues resolved
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ A package manager for Kubernetes that simplifies deployment and management of ap
|
||||
## I
|
||||
|
||||
### IBFT 2.0
|
||||
**Istanbul Byzantine Fault Tolerance 2.0** - A previous consensus mechanism (deprecated, replaced by QBFT).
|
||||
**Istanbul Byzantine Fault Tolerance 2.0** - A legacy consensus mechanism retained in historical documentation. ChainID 138 uses QBFT in the current active configuration.
|
||||
|
||||
## K
|
||||
|
||||
@@ -153,4 +153,3 @@ An improved version of WETH with additional features.
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
**Date**: 2025-01-27
|
||||
**Status**: ✅ Complete
|
||||
|
||||
**Current Note (2026-04-12)**: This summary captures the original implementation pass. Since then, the documentation surface has been cleaned up further by archiving the large legacy status-report piles and keeping `docs/operations/status-reports/STATUS_REPORTS_INDEX.md` as the active router.
|
||||
|
||||
## Summary
|
||||
|
||||
All critical and high-priority documentation fixes have been implemented. The documentation is now better organized, more accurate, and easier to navigate.
|
||||
@@ -38,10 +40,10 @@ All critical and high-priority documentation fixes have been implemented. The do
|
||||
### High Priority Fixes
|
||||
|
||||
5. **✅ Created Status Reports Index**
|
||||
- Created `STATUS_REPORTS_INDEX.md` categorizing all 90+ status reports
|
||||
- Organized by category (Project Status, Deployment, Completion, etc.)
|
||||
- Added archive policy (reports >6 months should be archived)
|
||||
- Added to master index
|
||||
- Created `STATUS_REPORTS_INDEX.md` as the active status router
|
||||
- Later archival work moved the legacy 90+ file report piles into `docs/archive/status-reports/`
|
||||
- Current status navigation now distinguishes active docs from historical archives
|
||||
- Added to the master index and archive guidance
|
||||
|
||||
6. **✅ Created Deployment Guide Index**
|
||||
- Created `DEPLOYMENT_INDEX.md` categorizing all deployment guides
|
||||
@@ -158,4 +160,3 @@ The following recommendations from the review are still pending (lower priority)
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Status**: ✅ All Critical and High Priority Fixes Complete
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Master Documentation Index
|
||||
|
||||
**Last Updated**: 2026-01-31
|
||||
**Last Updated**: 2026-04-12
|
||||
**Project**: DeFi Oracle Meta Mainnet (ChainID 138)
|
||||
**Status**: Active - Primary Documentation Index
|
||||
|
||||
@@ -15,7 +15,7 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
- **[README.md](../README.md)** - Project overview, features, and quick start guide
|
||||
- **[Getting Started](guides/GETTING_STARTED.md)** - Getting started guide for different user types
|
||||
- **[DEPLOYMENT_QUICK_START.md](DEPLOYMENT_QUICK_START.md)** - Fast deployment guide
|
||||
- **[PARALLEL_COMPLETION_TASK_LIST.md](PARALLEL_COMPLETION_TASK_LIST.md)** - Complete task list for deployment
|
||||
- **[MASTER_TASK_LIST.md](operations/tasks/MASTER_TASK_LIST.md)** - Active master task list
|
||||
- **[Documentation Review](DOCUMENTATION_REVIEW_AND_RECOMMENDATIONS.md)** - Comprehensive documentation review and recommendations
|
||||
- **[Quick Fixes](DOCUMENTATION_QUICK_FIXES.md)** - Critical fixes checklist
|
||||
|
||||
@@ -61,7 +61,7 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
### Deployment Guides
|
||||
- **[Deployment Index](deployment/DEPLOYMENT_INDEX.md)** - Which deployment guide to use
|
||||
- **[DEPLOYMENT_CHECKLIST.md](deployment/DEPLOYMENT_CHECKLIST.md)** - Deployment checklist
|
||||
- **[DEPLOYMENT_STATUS_AND_NEXT_STEPS.md](deployment/DEPLOYMENT_STATUS_AND_NEXT_STEPS.md)** - Current deployment status
|
||||
- **[DEPLOYMENT_STATUS_AND_NEXT_STEPS.md](DEPLOYMENT_STATUS_AND_NEXT_STEPS.md)** - Current deployment status
|
||||
- **[VM_DEPLOYMENT.md](deployment/VM_DEPLOYMENT.md)** - VM deployment guide
|
||||
- **[36-REGION-BLUEPRINT.md](deployment/36-REGION-BLUEPRINT.md)** - 36-region deployment blueprint
|
||||
- **[DEPLOYMENT_CONFIGURATION_AUDIT.md](deployment/DEPLOYMENT_CONFIGURATION_AUDIT.md)** - Configuration audit
|
||||
@@ -75,12 +75,9 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
- **[Runbooks](../runbooks/)** - Operational procedures and runbooks
|
||||
|
||||
### Status Reports
|
||||
- **[Status Reports Index](operations/status-reports/STATUS_REPORTS_INDEX.md)** - Index of all status reports
|
||||
- **[Status Reports](operations/status-reports/)** - Current operational status reports
|
||||
- [COMMANDS_INDEX.md](operations/status-reports/COMMANDS_INDEX.md)
|
||||
- [SCRIPTS_INDEX.md](operations/status-reports/SCRIPTS_INDEX.md)
|
||||
- [PROJECT_REVIEW.md](operations/status-reports/PROJECT_REVIEW.md)
|
||||
- [REVIEW_AND_RECOMMENDATIONS.md](operations/status-reports/REVIEW_AND_RECOMMENDATIONS.md)
|
||||
- **[Status Reports Index](operations/status-reports/STATUS_REPORTS_INDEX.md)** - Active-vs-archive status navigation
|
||||
- **[Current Deployment Status](DEPLOYMENT_STATUS_AND_NEXT_STEPS.md)** - Current deployment posture
|
||||
- **[Current Routing & Service Status](STATUS_AND_TOKEN_ROUTING.md)** - Current routing, API, and service state
|
||||
|
||||
### Monitoring
|
||||
- **[Monitoring Setup Guide](operations/MONITORING_SETUP_GUIDE.md)** - Monitoring stack setup and configuration
|
||||
@@ -128,9 +125,9 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
|
||||
## 🧪 Testing & Quality
|
||||
|
||||
- **[E2E_TESTING_REPORT.md](E2E_TESTING_REPORT.md)** - End-to-end testing report
|
||||
- **[E2E_TESTING_AND_DEPLOYMENT_STATUS.md](E2E_TESTING_AND_DEPLOYMENT_STATUS.md)** - E2E testing status
|
||||
- **[FINAL_E2E_REPORT_AND_RECOMMENDATIONS.md](FINAL_E2E_REPORT_AND_RECOMMENDATIONS.md)** - Final E2E report
|
||||
- **[TESTING_GUIDE.md](TESTING_GUIDE.md)** - Active testing guidance
|
||||
- **[COMPILATION_STATUS.md](deployment/COMPILATION_STATUS.md)** - Current compile and test caveats
|
||||
- **[Archived Status Reports](archive/status-reports/README.md)** - Historical testing and rollout reports
|
||||
|
||||
---
|
||||
|
||||
@@ -148,9 +145,7 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
### Cleanup & Deduplication
|
||||
- **[PROJECT_OPTIMIZATION_STATUS.md](PROJECT_OPTIMIZATION_STATUS.md)** - Current optimization status
|
||||
- **[CLEANUP_PLAN.md](CLEANUP_PLAN.md)** - Cleanup and optimization plan
|
||||
- **[CLEANUP_DEDUPLICATION_REPORT.md](CLEANUP_DEDUPLICATION_REPORT.md)** - Script and documentation deduplication analysis
|
||||
- **[CLEANUP_SUMMARY_2025_11_18.md](CLEANUP_SUMMARY_2025_11_18.md)** - Cleanup summary and statistics
|
||||
- **[CLEANUP_COMPLETE.md](CLEANUP_COMPLETE.md)** - Cleanup completion report
|
||||
- **[Archived Cleanup Reports](archive/status-reports/docs-root-legacy/)** - Historical cleanup, completion, and deduplication reports
|
||||
- **[CLEANUP_STATS.md](CLEANUP_STATS.md)** - Cleanup statistics
|
||||
|
||||
---
|
||||
@@ -159,7 +154,7 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
|
||||
- **[Archive README](archive/README.md)** - Archived files documentation
|
||||
- **[Archive Policy](archive/ARCHIVE_POLICY.md)** - Archive retention policy and process
|
||||
- **[Archive Status Reports](archive/status-reports/)** - Historical status reports
|
||||
- **[Archive Status Reports](archive/status-reports/README.md)** - Historical status-report collections
|
||||
- **[Archive Old Configs](archive/old-configs/)** - Previous configuration structures
|
||||
|
||||
---
|
||||
@@ -167,11 +162,12 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
## 📊 Status & Reports
|
||||
|
||||
### Current Status
|
||||
- **[COMPLETE_STATUS_REPORT.md](COMPLETE_STATUS_REPORT.md)** - Complete status report
|
||||
- **[STATUS_AND_TOKEN_ROUTING.md](STATUS_AND_TOKEN_ROUTING.md)** - Current service and routing status
|
||||
- **[DEPLOYMENT_STATUS_AND_NEXT_STEPS.md](DEPLOYMENT_STATUS_AND_NEXT_STEPS.md)** - Deployment status
|
||||
- **[COMPILATION_STATUS.md](deployment/COMPILATION_STATUS.md)** - Current compilation status
|
||||
|
||||
### Task Lists
|
||||
- **[PARALLEL_COMPLETION_TASK_LIST.md](PARALLEL_COMPLETION_TASK_LIST.md)** - Full parallel completion task list
|
||||
- **[MASTER_TASK_LIST.md](operations/tasks/MASTER_TASK_LIST.md)** - Active master task list
|
||||
- **[TODO.md](operations/tasks/TODO.md)** - Current TODO list
|
||||
|
||||
---
|
||||
@@ -198,7 +194,7 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
|
||||
**Operations**
|
||||
- Runbooks: [../runbooks/](../runbooks/)
|
||||
- Status Reports: [operations/status-reports/](operations/status-reports/)
|
||||
- Status Reports: [operations/status-reports/STATUS_REPORTS_INDEX.md](operations/status-reports/STATUS_REPORTS_INDEX.md)
|
||||
|
||||
**Troubleshooting**
|
||||
- Guide: [TROUBLESHOOTING.md](guides/TROUBLESHOOTING.md)
|
||||
@@ -208,9 +204,9 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
|
||||
**Markdown Files**: All documentation is in Markdown format (.md)
|
||||
|
||||
**Scripts**: See [SCRIPTS_INDEX.md](operations/status-reports/SCRIPTS_INDEX.md)
|
||||
**Scripts**: See [docs/scripts/](scripts/)
|
||||
|
||||
**Commands**: See [COMMANDS_INDEX.md](operations/status-reports/COMMANDS_INDEX.md)
|
||||
**Commands**: See deployment/runbook command examples and active task docs
|
||||
|
||||
---
|
||||
|
||||
@@ -218,7 +214,7 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
|
||||
- All documentation is in Markdown format
|
||||
- Documentation is organized by topic in subdirectories
|
||||
- Status reports are in `docs/operations/status-reports/`
|
||||
- Current status navigation lives in `docs/operations/status-reports/STATUS_REPORTS_INDEX.md`; historical status reports live in `docs/archive/status-reports/`
|
||||
- Archived documentation is in `docs/archive/`
|
||||
- Guides are in `docs/guides/`
|
||||
|
||||
@@ -241,12 +237,10 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
- Established review schedule and archive policy
|
||||
- All critical, high, medium, and low priority items complete
|
||||
|
||||
**2025-11-18**:
|
||||
- Created master documentation index
|
||||
- Updated IBFT references to QBFT
|
||||
- Consolidated deployment scripts
|
||||
- Archived 52+ status reports
|
||||
- Created unified deployment scripts
|
||||
**2026-04-12**:
|
||||
- Archived legacy status-report piles from `docs/operations/status-reports/`, `docs/`, and the repository root
|
||||
- Reduced active status navigation to current runbooks, deployment docs, and reference pages
|
||||
- Added archive collection indexes for legacy report sets
|
||||
|
||||
---
|
||||
|
||||
@@ -260,7 +254,7 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Last Updated**: 2026-04-12
|
||||
**Maintained By**: Project Team
|
||||
**Version**: 1.1
|
||||
|
||||
@@ -271,11 +265,8 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
- **[Documentation Gap Analysis](DOCUMENTATION_GAP_ANALYSIS.md)** - Gap analysis and recommendations
|
||||
- **[Final Gap Analysis and Fixes](FINAL_GAP_ANALYSIS_AND_FIXES.md)** - Final gap analysis summary
|
||||
- **[Comprehensive Documentation Review](COMPREHENSIVE_DOCUMENTATION_REVIEW.md)** - Complete review report
|
||||
- **[All Additional Suggestions Complete](ALL_ADDITIONAL_SUGGESTIONS_COMPLETE.md)** - Additional suggestions completion
|
||||
- **[Remaining TODO Items](REMAINING_TODO_ITEMS.md)** - Remaining TODO items
|
||||
- **[Archived Documentation Review Reports](archive/status-reports/docs-root-legacy/)** - Historical completion and follow-up reports
|
||||
- **[Implementation Summary](IMPLEMENTATION_SUMMARY.md)** - Implementation summary
|
||||
- **[All TODO Items Complete](ALL_TODO_ITEMS_COMPLETE.md)** - Completion summary
|
||||
- **[Final Completion Report](FINAL_COMPLETION_REPORT.md)** - Final completion report
|
||||
|
||||
## 📖 Reference
|
||||
|
||||
@@ -289,4 +280,3 @@ This is the **master index** of all project documentation. Use this as your star
|
||||
|
||||
### SDK
|
||||
- **[SDK README](../sdk/README.md)** - Tatum SDK integration documentation
|
||||
|
||||
|
||||
@@ -104,7 +104,7 @@ cast call $USDW_ADDRESS "totalSupply()" --rpc-url $RPC_URL
|
||||
|
||||
### 1.4 Reserve and Stabilization Policies (VAULT_SYSTEM_MASTER_TECHNICAL_PLAN)
|
||||
|
||||
The following formulas and checklists are from [VAULT_SYSTEM_MASTER_TECHNICAL_PLAN](../../../docs/VAULT_SYSTEM_MASTER_TECHNICAL_PLAN.md). Use them for sizing and operational verification.
|
||||
The following formulas and checklists are from [VAULT_SYSTEM_MASTER_TECHNICAL_PLAN](../../docs/VAULT_SYSTEM_MASTER_TECHNICAL_PLAN.md). Use them for sizing and operational verification.
|
||||
|
||||
#### Reserve Sizing Model
|
||||
|
||||
@@ -126,12 +126,12 @@ The following formulas and checklists are from [VAULT_SYSTEM_MASTER_TECHNICAL_PL
|
||||
|
||||
#### Cross-chain parity and bridge buffer
|
||||
|
||||
- **Objective:** Maintain |Price138 − Price651940| < ArbitrageThreshold (see [CROSS_CHAIN_ARBITRAGE_DESIGN](../../../docs/07-ccip/CROSS_CHAIN_ARBITRAGE_DESIGN.md)). Cross-chain private arbitrage bots execute when deviation exceeds threshold; bridge reserve must be sized so outflows do not exhaust reserves during settlement.
|
||||
- **Objective:** Maintain |Price138 − Price651940| < ArbitrageThreshold (see [CROSS_CHAIN_ARBITRAGE_DESIGN](../../docs/07-ccip/CROSS_CHAIN_ARBITRAGE_DESIGN.md)). Cross-chain private arbitrage bots execute when deviation exceeds threshold; bridge reserve must be sized so outflows do not exhaust reserves during settlement.
|
||||
- **Bridge buffer formula:** BridgeReserve ≥ PeakBridgeOutflow × Latency.
|
||||
- **PeakBridgeOutflow:** Measure from bridge events (e.g. lock/release or TransferInitiated volume) over a rolling window (e.g. peak hourly or daily outflow in USD or token units).
|
||||
- **Latency:** Bridge settlement time (e.g. typical time from lock on source chain to release on destination, in minutes or blocks). Use historical median or P95.
|
||||
- **Sizing steps:** (1) Query bridge contract events for initiated/released amounts per time window; (2) compute peak outflow; (3) measure typical settlement latency; (4) set minimum reserve = Peak × Latency; (5) add safety factor (e.g. 1.5–2×) and document in runbook.
|
||||
- **Alert when reserve below:** If BridgeReserve < PeakBridgeOutflow × Latency (or below safety threshold), trigger **Warning** alert. If reserve is falling and may breach within one settlement window, escalate to **Critical**. Integrate with existing monitoring (e.g. Prometheus + PagerDuty when monitoring stack is deployed). See [VAULT_SYSTEM_MASTER_TECHNICAL_PLAN](../../../docs/VAULT_SYSTEM_MASTER_TECHNICAL_PLAN.md) §9.
|
||||
- **Alert when reserve below:** If BridgeReserve < PeakBridgeOutflow × Latency (or below safety threshold), trigger **Warning** alert. If reserve is falling and may breach within one settlement window, escalate to **Critical**. Integrate with existing monitoring (e.g. Prometheus + PagerDuty when monitoring stack is deployed). See [VAULT_SYSTEM_MASTER_TECHNICAL_PLAN](../../docs/VAULT_SYSTEM_MASTER_TECHNICAL_PLAN.md) §9.
|
||||
|
||||
#### Flash Loan Containment Checklist
|
||||
|
||||
@@ -140,7 +140,7 @@ The following formulas and checklists are from [VAULT_SYSTEM_MASTER_TECHNICAL_PL
|
||||
- Require **sustained deviation for N blocks** before rebalancing.
|
||||
- **Cap per-block stabilization volume** to limit flash-driven execution.
|
||||
- **Target:** Flash drain recovery <3 blocks (per Master Plan §16).
|
||||
- **On-chain:** The [Stabilizer](../../contracts/bridge/trustless/integration/Stabilizer.sol) (Phase 3 + 6) implements block delay, sustained-deviation buffer, per-block volume cap, and slippage/gas checks; deploy and configure per [CONTRACT_DEPLOYMENT_RUNBOOK](../../../docs/03-deployment/CONTRACT_DEPLOYMENT_RUNBOOK.md) § Stabilizer.
|
||||
- **On-chain:** The [Stabilizer](../contracts/bridge/trustless/integration/Stabilizer.sol) (Phase 3 + 6) implements block delay, sustained-deviation buffer, per-block volume cap, and slippage/gas checks; deploy and configure per [CONTRACT_DEPLOYMENT_RUNBOOK](../../docs/03-deployment/CONTRACT_DEPLOYMENT_RUNBOOK.md) § Stabilizer.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Project Optimization Status
|
||||
|
||||
**Last Updated**: 2025-11-18
|
||||
**Status**: In Progress
|
||||
**Last Updated**: 2026-04-13
|
||||
**Status**: Active
|
||||
|
||||
## Summary
|
||||
|
||||
@@ -12,8 +12,15 @@ This document tracks the ongoing optimization and cleanup of the smom-dbis-138 p
|
||||
### ✅ Documentation Cleanup
|
||||
- **Archived 30+ status reports** from `terraform/phases/phase1/` to `docs/archive/status-reports/phase1/`
|
||||
- **Removed 4 genesis.json backup files** (moved to archive)
|
||||
- **Updated README.md**: All IBFT 2.0 references changed to QBFT
|
||||
- **Updated active entry points**: High-traffic README and operator docs now point at QBFT/current workflows
|
||||
- **Created archive structure** with proper organization
|
||||
- **Archived legacy status-report piles** from the active docs surface:
|
||||
- `docs/operations/status-reports/` → `docs/archive/status-reports/operations-legacy/`
|
||||
- report-style files from `docs/` → `docs/archive/status-reports/docs-root-legacy/`
|
||||
- report-style files from the repository root → `docs/archive/status-reports/repo-root-legacy/`
|
||||
- **Repointed active indexes and runbooks** to current docs or archive collections
|
||||
- **Archived trustless bridge milestone stack** from `docs/bridge/trustless/` into `docs/archive/bridge-trustless-milestones/`
|
||||
- **Added active trustless bridge overview** at `docs/bridge/trustless/README.md`
|
||||
|
||||
### ✅ Configuration Consolidation
|
||||
- **Archived old IBFT2 config structure**: `config/validators/`, `config/sentries/`, `config/rpc/` → `docs/archive/old-configs/ibft2/`
|
||||
@@ -29,6 +36,12 @@ This document tracks the ongoing optimization and cleanup of the smom-dbis-138 p
|
||||
- **Legacy**: `docker/besu-*/docker-compose.yml` (per-node-type, may still be used for reference)
|
||||
- **Phase2**: `docker/phase2/docker-compose.*.yml` (regional deployments)
|
||||
|
||||
### ✅ Canonical Operator Paths
|
||||
- **Genesis generation**: `scripts/generate-genesis-proper.sh`
|
||||
- **Genesis validation**: `scripts/validation/validate-genesis.sh`
|
||||
- **Compatibility wrapper**: `scripts/generate-genesis.sh` now forwards to the canonical QBFT generator
|
||||
- **Docker Compose**: `docker-compose/docker-compose.template.yml` is the active template; older per-node compose files remain reference material
|
||||
|
||||
## Current Project Structure
|
||||
|
||||
### Active Configuration Files
|
||||
@@ -56,13 +69,19 @@ docker-compose/
|
||||
└── vm5.env # VM5 configuration
|
||||
```
|
||||
|
||||
## Recent Cleanup Actions (2025-11-18)
|
||||
## Recent Cleanup Actions (2026-04-12)
|
||||
|
||||
### Documentation Surface Cleanup
|
||||
- **Status Reports Archived**:
|
||||
- `94` historical files moved to `docs/archive/status-reports/operations-legacy/`
|
||||
- `33` report-style docs moved to `docs/archive/status-reports/docs-root-legacy/`
|
||||
- `13` report-style root docs moved to `docs/archive/status-reports/repo-root-legacy/`
|
||||
- **Active status navigation slimmed down**: `docs/operations/status-reports/` now routes through `STATUS_REPORTS_INDEX.md`
|
||||
- **Deduplication Report**: Archived at `docs/archive/status-reports/docs-root-legacy/CLEANUP_DEDUPLICATION_REPORT.md`
|
||||
|
||||
### Script Deduplication
|
||||
- **Status Reports Archived**: 52 files total (22 new + 30 previous) moved to `docs/archive/status-reports/`
|
||||
- **Duplicate CCIP Scripts**: Archived 3 duplicate CCIP scripts from `terraform/phases/phase1/scripts/ccip/` to `scripts/archive/duplicate-ccip/`
|
||||
- **Unified WETH Script**: Created `scripts/deployment/deploy-weth-unified.sh` to consolidate WETH deployment methods
|
||||
- **Deduplication Report**: Created `docs/CLEANUP_DEDUPLICATION_REPORT.md` documenting cleanup efforts
|
||||
|
||||
### Script Analysis
|
||||
- **Total Shell Scripts**: 260
|
||||
@@ -75,35 +94,37 @@ docker-compose/
|
||||
|
||||
### 🔄 In Progress
|
||||
- [ ] Continue script deduplication (82 deployment scripts to review)
|
||||
- [ ] Update remaining IBFT references in documentation (10+ files)
|
||||
- [ ] Create consolidated documentation index
|
||||
- [ ] Review remaining milestone-style docs that should be archived or explicitly marked historical
|
||||
- [ ] Keep archive indexes and active links aligned as legacy docs move
|
||||
|
||||
### ⏳ Pending
|
||||
- [ ] Document docker-compose file usage and migration path
|
||||
- [ ] Consolidate duplicate genesis generation scripts
|
||||
- [ ] Review and optimize script organization
|
||||
- [ ] Prune or archive remaining completion-style bridge and deployment reports outside `docs/archive/`
|
||||
|
||||
## Files Requiring IBFT → QBFT Updates
|
||||
|
||||
The following files still contain IBFT references:
|
||||
- `scripts/configure-network-decision-tree.md`
|
||||
- `runbooks/parameter-change.md`
|
||||
- `docs/azure/QUOTA_ISSUE_RESOLUTION.md`
|
||||
- `docs/configuration/CONFIGURATION_FIXES_APPLIED.md`
|
||||
- `docs/governance/CHANGELOG.md`
|
||||
- `terraform/phases/phase1/CONTAINERS_AND_SERVICES_REPORT.md`
|
||||
- `terraform/phases/phase1/HIGH_PRIORITY_TASKS_COMPLETE.md`
|
||||
- `docs/guides/INTEGRATION_GUIDE.md`
|
||||
- `docs/operations/status-reports/*.md` (multiple files)
|
||||
- Historical files under `docs/archive/status-reports/` may still contain legacy IBFT-era wording and should stay archived unless refreshed
|
||||
|
||||
## Archive Location
|
||||
|
||||
All archived files are in `docs/archive/`:
|
||||
- `status-reports/phase1/` - Historical status reports
|
||||
- `status-reports/operations-legacy/` - Historical files formerly in `docs/operations/status-reports/`
|
||||
- `status-reports/docs-root-legacy/` - Historical report-style docs formerly in `docs/`
|
||||
- `status-reports/repo-root-legacy/` - Historical report-style docs formerly in the repository root
|
||||
- `old-configs/ibft2/` - Previous IBFT2 configuration structure
|
||||
- `old-scripts/deprecated/` - Obsolete scripts (to be populated)
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Complete script review and deduplication
|
||||
2. Update remaining IBFT references
|
||||
3. Create master documentation index
|
||||
4. Document migration paths for old configurations
|
||||
|
||||
2. Finish the last active terminology cleanups and historical-status banners
|
||||
3. Keep archive routing and active index links synchronized
|
||||
4. Consolidate transitional genesis helpers around the canonical QBFT path
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Documentation Index
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Last Updated**: 2026-04-12
|
||||
**Status**: Active
|
||||
|
||||
This is the entry point for all project documentation. For the complete documentation index, see [MASTER_DOCUMENTATION_INDEX.md](MASTER_DOCUMENTATION_INDEX.md).
|
||||
@@ -42,12 +42,10 @@ Integration guides:
|
||||
- WETH deployment
|
||||
|
||||
#### [operations/status-reports/](operations/status-reports/)
|
||||
Status reports, completion summaries, and analysis documents:
|
||||
- Deployment status reports
|
||||
- Completion summaries
|
||||
- Final reports
|
||||
- Task completion reports
|
||||
- Project reviews
|
||||
Status-report navigation:
|
||||
- Active-vs-archive index
|
||||
- Pointers to current deployment and routing status docs
|
||||
- Links into archived historical report collections
|
||||
|
||||
#### [operations/tasks/](operations/tasks/)
|
||||
Task management and next steps:
|
||||
@@ -151,6 +149,7 @@ Documentation tags and metadata
|
||||
- [Troubleshooting](guides/TROUBLESHOOTING.md)
|
||||
- [Next Steps](operations/tasks/NEXT_STEPS.md)
|
||||
- [Task List](operations/tasks/TODO.md)
|
||||
- [Status Reports Index](operations/status-reports/STATUS_REPORTS_INDEX.md)
|
||||
|
||||
### Azure Resources
|
||||
- [Azure Setup](azure/AZURE_REGION_SETUP.md)
|
||||
@@ -167,4 +166,3 @@ Documentation tags and metadata
|
||||
## 🔄 Maintenance
|
||||
|
||||
This documentation structure is maintained as part of the project cleanup process. For questions or suggestions about documentation organization, please refer to the [Contributing Guidelines](governance/CONTRIBUTING.md).
|
||||
|
||||
|
||||
@@ -49,7 +49,7 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The DeFi Oracle Meta Mainnet (ChainID 138) is a production-ready blockchain network built on Hyperledger Besu with QBFT (Quorum Byzantine Fault Tolerance) consensus. The network is designed as a read network with public RPC endpoints and internal oracle publishers.
|
||||
The DeFi Oracle Meta Mainnet (ChainID 138) is an operator-focused blockchain network built on Hyperledger Besu with QBFT (Quorum Byzantine Fault Tolerance) consensus. The network is designed as a read network with public RPC endpoints and internal oracle publishers.
|
||||
|
||||
## Network Architecture
|
||||
|
||||
@@ -276,4 +276,3 @@ The network is organized into three tiers:
|
||||
- DeFi protocol integrations
|
||||
- Layer 2 solutions
|
||||
- Privacy features (Tessera)
|
||||
|
||||
|
||||
@@ -236,7 +236,7 @@ Diagrams are tracked in Git:
|
||||
|
||||
## References
|
||||
|
||||
- [Assets Guide](ASSETS_GUIDE.md)
|
||||
- [Assets Guide](../guides/ASSETS_GUIDE.md)
|
||||
- [Azure Architecture Center](https://docs.microsoft.com/azure/architecture/)
|
||||
- [Azure Architecture Icons](https://docs.microsoft.com/azure/architecture/icons/)
|
||||
- [Azure Architecture Patterns](https://docs.microsoft.com/azure/architecture/patterns/)
|
||||
@@ -267,4 +267,3 @@ make -f Makefile.assets download-icons
|
||||
- Network: `assets/diagrams/network/`
|
||||
- Deployment: `assets/diagrams/deployment/`
|
||||
- Templates: `assets/diagrams/templates/`
|
||||
|
||||
|
||||
@@ -38,9 +38,10 @@ This document explains the directory structure of the project, particularly the
|
||||
#### `scripts/` - Shell Scripts
|
||||
- **Purpose**: Contains utility shell scripts for deployment, key management, etc.
|
||||
- **File Pattern**: `*.sh`
|
||||
- **Usage**: `./scripts/generate-genesis.sh`
|
||||
- **Usage**: `./scripts/generate-genesis-proper.sh 4`
|
||||
- **Contents**:
|
||||
- `generate-genesis.sh` - Genesis file generation script
|
||||
- `generate-genesis-proper.sh` - Canonical QBFT genesis file generation script
|
||||
- `generate-genesis.sh` - Compatibility wrapper for the canonical generator
|
||||
- `deployment/` - Deployment scripts
|
||||
- `deploy-weth.sh` - WETH deployment script
|
||||
- `deploy-multicall.sh` - Multicall deployment script
|
||||
@@ -104,7 +105,7 @@ RPC_URL=https://rpc.d-bis.org ./tests/health-check.sh
|
||||
### Running Shell Scripts
|
||||
```bash
|
||||
# Generate genesis
|
||||
./scripts/generate-genesis.sh
|
||||
./scripts/generate-genesis-proper.sh 4
|
||||
|
||||
# Generate validator keys
|
||||
./scripts/key-management/generate-validator-keys.sh 4
|
||||
|
||||
@@ -9,7 +9,7 @@ The DeFi Oracle Meta Mainnet uses a tiered architecture with validators, sentrie
|
||||
- **Count**: 4+ validators
|
||||
- **Location**: Private subnets, no public IPs
|
||||
- **Peering**: Only to sentries (via static-nodes.json)
|
||||
- **Consensus**: IBFT 2.0
|
||||
- **Consensus**: QBFT
|
||||
- **RPC**: Disabled for security
|
||||
|
||||
### Sentries
|
||||
@@ -86,7 +86,7 @@ accounts-allowlist=[
|
||||
]
|
||||
```
|
||||
|
||||
## IBFT 2.0 Configuration
|
||||
## QBFT Configuration
|
||||
|
||||
### Genesis Parameters
|
||||
|
||||
@@ -98,7 +98,7 @@ accounts-allowlist=[
|
||||
|
||||
### Validator Set
|
||||
|
||||
Validators are specified in the genesis `extraData` field. The validator set can be updated via IBFT transitions.
|
||||
Validators are specified in the genesis `extraData` field. The validator set can be updated via QBFT transitions.
|
||||
|
||||
### Consensus Parameters
|
||||
|
||||
@@ -170,7 +170,7 @@ Monitor network topology to ensure proper peering:
|
||||
|
||||
### Updating Consensus Parameters
|
||||
|
||||
1. Create IBFT transition block
|
||||
1. Create QBFT transition block
|
||||
2. Update block period, epoch length, or request timeout
|
||||
3. All validators must accept the transition
|
||||
|
||||
@@ -189,4 +189,3 @@ Monitor network topology to ensure proper peering:
|
||||
- Validator failure: Remove failed validator
|
||||
- Chain stall: Restart validators
|
||||
- Security incident: Isolate affected nodes
|
||||
|
||||
|
||||
@@ -99,6 +99,7 @@ Maintain an archive index at `docs/archive/README.md` that lists:
|
||||
## Related Documentation
|
||||
|
||||
- [Archive README](README.md)
|
||||
- [Archived Status Reports](status-reports/README.md)
|
||||
- [Master Documentation Index](../MASTER_DOCUMENTATION_INDEX.md)
|
||||
- [Status Reports Index](../operations/status-reports/STATUS_REPORTS_INDEX.md)
|
||||
|
||||
@@ -106,4 +107,3 @@ Maintain an archive index at `docs/archive/README.md` that lists:
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Next Review**: 2025-04-27
|
||||
|
||||
|
||||
@@ -6,6 +6,10 @@ This directory contains archived files that are no longer actively used but are
|
||||
|
||||
- `status-reports/phase1/` - Archived status reports from Phase 1 deployment
|
||||
- `status-reports/phase1-old/` - Additional historical status reports
|
||||
- `status-reports/operations-legacy/` - Former contents of `docs/operations/status-reports/`
|
||||
- `status-reports/docs-root-legacy/` - Historical report-style files formerly in `docs/`
|
||||
- `status-reports/repo-root-legacy/` - Historical report-style files formerly in the repository root
|
||||
- `bridge-trustless-milestones/` - Archived trustless bridge completion and status-report stack
|
||||
- `old-configs/ibft2/` - Old IBFT2-based configuration files (migrated to QBFT)
|
||||
|
||||
## Scripts Archive
|
||||
@@ -18,10 +22,11 @@ Files are archived rather than deleted to:
|
||||
- Maintain historical context
|
||||
- Enable rollback if needed
|
||||
- Provide reference for similar future work
|
||||
- Keep the active docs surface focused on current runbooks, deployment state,
|
||||
and reference material
|
||||
|
||||
## Cleanup Policy
|
||||
|
||||
- Files older than 6 months may be considered for permanent deletion
|
||||
- Critical configuration backups are retained indefinitely
|
||||
- Status reports can be removed after 1 year if not referenced
|
||||
|
||||
|
||||
30
docs/archive/bridge-trustless-milestones/README.md
Normal file
30
docs/archive/bridge-trustless-milestones/README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Trustless Bridge Milestone Archive
|
||||
|
||||
**Last Updated**: 2026-04-13
|
||||
**Status**: Archived
|
||||
|
||||
This archive contains historical trustless-bridge milestone and completion reports that were removed from the active docs surface to keep `docs/bridge/trustless/` focused on evergreen operator guidance.
|
||||
|
||||
## Archived Milestone Files
|
||||
|
||||
- `ALL_NEXT_STEPS_COMPLETE.md`
|
||||
- `ALL_TASKS_COMPLETE.md`
|
||||
- `COMPLETE_IMPLEMENTATION_FINAL.md`
|
||||
- `DEPLOYMENT_STATUS.md`
|
||||
- `DEPLOYMENT_SUMMARY.md`
|
||||
- `FINAL_IMPLEMENTATION_COMPLETE.md`
|
||||
- `FINAL_STATUS_REPORT.md`
|
||||
- `IMPLEMENTATION_COMPLETE_SUMMARY.md`
|
||||
- `IMPLEMENTATION_STATUS.md`
|
||||
- `NEXT_ACTIONS_COMPLETE.md`
|
||||
- `OPERATIONAL_TASKS_STATUS.md`
|
||||
- `PRODUCTION_READY_SUMMARY.md`
|
||||
- `SECTION_7.2_COMPLETE.md`
|
||||
|
||||
## Active Docs
|
||||
|
||||
For current trustless bridge documentation, use:
|
||||
|
||||
- [docs/bridge/trustless/README.md](../../bridge/trustless/README.md)
|
||||
|
||||
That overview points to the current architecture, security, deployment, and operations guides.
|
||||
26
docs/archive/status-reports/README.md
Normal file
26
docs/archive/status-reports/README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Archived Status Reports
|
||||
|
||||
**Last Updated**: 2026-04-12
|
||||
**Status**: Active archive index
|
||||
|
||||
This directory contains historical status-report collections that were removed
|
||||
from the active documentation surface to keep current runbooks and reference
|
||||
docs easier to navigate.
|
||||
|
||||
## Collections
|
||||
|
||||
- `operations-legacy/` - Former contents of `docs/operations/status-reports/`.
|
||||
- `docs-root-legacy/` - Historical report-style files formerly located directly
|
||||
under `docs/`.
|
||||
- `repo-root-legacy/` - Historical report-style files formerly located at the
|
||||
repository root.
|
||||
- `phase1/` - Earlier archived phase-1 status reports.
|
||||
- `phase1-old/` - Additional early legacy reports retained for reference.
|
||||
|
||||
## Notes
|
||||
|
||||
- Archived documents may preserve historical paths, naming, or assumptions.
|
||||
- Not every internal link inside archived material is kept current.
|
||||
- Use active docs such as `docs/STATUS_AND_TOKEN_ROUTING.md`,
|
||||
`docs/deployment/DEPLOYMENT_STATUS_AND_NEXT_STEPS.md`, and
|
||||
`docs/MASTER_CONTRACTS_AND_INFRASTRUCTURE_LIST.md` for current state.
|
||||
9
docs/archive/status-reports/docs-root-legacy/README.md
Normal file
9
docs/archive/status-reports/docs-root-legacy/README.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Docs Root Legacy Reports
|
||||
|
||||
**Archived**: 2026-04-12
|
||||
**Original Location**: `docs/`
|
||||
**Reason for Archiving**: Historical report-style and completion-summary files
|
||||
were moved out of the primary docs surface to keep active documentation smaller
|
||||
and easier to navigate.
|
||||
|
||||
This directory preserves those files as reference material.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user