Files

defiQUG 1fb7266469 Add Oracle Aggregator and CCIP Integration

- Introduced Aggregator.sol for Chainlink-compatible oracle functionality, including round-based updates and access control.
- Added OracleWithCCIP.sol to extend Aggregator with CCIP cross-chain messaging capabilities.
- Created .gitmodules to include OpenZeppelin contracts as a submodule.
- Developed a comprehensive deployment guide in NEXT_STEPS_COMPLETE_GUIDE.md for Phase 2 and smart contract deployment.
- Implemented Vite configuration for the orchestration portal, supporting both Vue and React frameworks.
- Added server-side logic for the Multi-Cloud Orchestration Portal, including API endpoints for environment management and monitoring.
- Created scripts for resource import and usage validation across non-US regions.
- Added tests for CCIP error handling and integration to ensure robust functionality.
- Included various new files and directories for the orchestration portal and deployment scripts.

2025-12-12 14:57:48 -08:00

13 KiB

Raw Blame History

Master Documentation Index

Last Updated: 2025-01-27
Project: DeFi Oracle Meta Mainnet (ChainID 138)
Status: Active - Primary Documentation Index

This is the master index of all project documentation. Use this as your starting point to find any documentation in the project.

Note

: This is the primary documentation index. For a simple entry point, see README.md.

🚀 Quick Start

README.md - Project overview, features, and quick start guide
Getting Started - Getting started guide for different user types
DEPLOYMENT_QUICK_START.md - Fast deployment guide
PARALLEL_COMPLETION_TASK_LIST.md - Complete task list for deployment
Documentation Review - Comprehensive documentation review and recommendations
Quick Fixes - Critical fixes checklist

📐 Architecture & Design

Core Architecture

ARCHITECTURE.md - System architecture overview
ARCHITECTURE_DIAGRAM.md - Visual architecture diagrams
SERVICES_ARCHITECTURE.md - Off-chain services architecture
NETWORK.md - Network topology and design
DOCKER_COMPOSE_GUIDE.md - Docker Compose structure and usage

Azure Infrastructure

MULTI_REGION_VALIDATOR_DEPLOYMENT.md - Multi-region deployment guide
GEO-AWARE-COMMITTEE-CONFIG.md - Geographic configuration
KUBERNETES-36REGION-MAPPING.md - Kubernetes region mapping
QUOTA_ISSUE_RESOLUTION.md - Azure quota resolution

⚙️ Configuration

Configuration Guides

Configuration Index - Which configuration guide to use
Network Configuration Guide - Besu network configuration
Azure/Cloudflare Environment Setup - Azure and Cloudflare environment variables
Contract Deployment Environment Setup - Contract deployment environment variables
Azure Naming Convention (3 Char) - Standard 3-character region codes
Azure Naming Convention (2-3 Char) - Alternative 2-3 character region codes
CONFIGURATION_FIXES_APPLIED.md - Configuration fixes

Consensus

Current: QBFT (Quorum Byzantine Fault Tolerance)
Previous: IBFT 2.0 (archived)
See PROJECT_OPTIMIZATION_STATUS.md for migration details

🚢 Deployment

Deployment Guides

Deployment Index - Which deployment guide to use
DEPLOYMENT_CHECKLIST.md - Deployment checklist
DEPLOYMENT_STATUS_AND_NEXT_STEPS.md - Current deployment status
VM_DEPLOYMENT.md - VM deployment guide
36-REGION-BLUEPRINT.md - 36-region deployment blueprint
DEPLOYMENT_CONFIGURATION_AUDIT.md - Configuration audit

🔧 Operations

Runbooks

Runbooks Index - Index of all operational runbooks
Runbooks - Operational procedures and runbooks

Status Reports

Status Reports Index - Index of all status reports
Status Reports - Current operational status reports

Monitoring

Monitoring Setup Guide - Monitoring stack setup and configuration

Integrations

Integrations Index - Index of all integrations
CCIP Integration - CCIP integration guide
MetaMask Integration - MetaMask integration guide
Firefly Integration - Firefly integration
Cacti Integration - Cacti integration
METAMASK_BD.md - MetaMask integration details

📚 Guides

Getting Started - Getting started for different user types
INTEGRATION_GUIDE.md - Integration guide
TROUBLESHOOTING.md - Troubleshooting guide
QUICKSTART.md - Detailed quick start guide
Makefile Usage - Makefile usage guide
FAQ - Frequently asked questions
Best Practices - Best practices guide
Testing Guide - Testing infrastructure guide
Automated Link Checking - Link checking guide

📡 API Documentation

API Reference - Complete JSON-RPC API reference
API.md - API overview
BLOCKSCOUT_API.md - Blockscout API
TATUM_SDK.md - Tatum SDK integration

Templates

New Guide Template - Template for new guides
Status Report Template - Template for status reports
Deployment Guide Template - Template for deployment guides
API Reference Template - Template for API references

🧪 Testing & Quality

E2E_TESTING_REPORT.md - End-to-end testing report
E2E_TESTING_AND_DEPLOYMENT_STATUS.md - E2E testing status
FINAL_E2E_REPORT_AND_RECOMMENDATIONS.md - Final E2E report

🏛️ Governance

CHANGELOG.md - Project changelog
Documentation Style Guide - Documentation style guide
Documentation Review Schedule - Review schedule and process
Documentation Metrics - Documentation metrics and tracking

🧹 Project Optimization

Cleanup & Deduplication

PROJECT_OPTIMIZATION_STATUS.md - Current optimization status
CLEANUP_PLAN.md - Cleanup and optimization plan
CLEANUP_DEDUPLICATION_REPORT.md - Script and documentation deduplication analysis
CLEANUP_SUMMARY_2025_11_18.md - Cleanup summary and statistics
CLEANUP_COMPLETE.md - Cleanup completion report
CLEANUP_STATS.md - Cleanup statistics

📦 Archive

Archive README - Archived files documentation
Archive Policy - Archive retention policy and process
Archive Status Reports - Historical status reports
Archive Old Configs - Previous configuration structures

📊 Status & Reports

Current Status

COMPLETE_STATUS_REPORT.md - Complete status report
DEPLOYMENT_STATUS_AND_NEXT_STEPS.md - Deployment status

Task Lists

PARALLEL_COMPLETION_TASK_LIST.md - Full parallel completion task list
TODO.md - Current TODO list

🔍 Finding Documentation

By Topic

Deployment

Quick Start: DEPLOYMENT_QUICK_START.md
Checklist: DEPLOYMENT_CHECKLIST.md
Status: DEPLOYMENT_STATUS_AND_NEXT_STEPS.md

Configuration

Index: Configuration Index
Network: Network Configuration Guide
Azure/Cloudflare: Azure/Cloudflare Environment Setup
Contracts: Contract Deployment Environment Setup
Docker Compose: DOCKER_COMPOSE_GUIDE.md

Architecture

Overview: ARCHITECTURE.md
Network: NETWORK.md

Operations

Runbooks: ../runbooks/
Status Reports: operations/status-reports/

Troubleshooting

Guide: TROUBLESHOOTING.md
Integration: INTEGRATION_GUIDE.md

By File Type

Markdown Files: All documentation is in Markdown format (.md)

Scripts: See SCRIPTS_INDEX.md

Commands: See COMMANDS_INDEX.md

📝 Documentation Standards

All documentation is in Markdown format
Documentation is organized by topic in subdirectories
Status reports are in docs/operations/status-reports/
Archived documentation is in docs/archive/
Guides are in docs/guides/

🔄 Recent Updates

2025-01-27:

Comprehensive documentation review completed
Fixed all broken links in README.md
Created Makefile usage guide
Created runbooks index
Created integrations index
Created security scanning guide
Created monitoring setup guide
Added Terraform and SDK documentation references
Added glossary and API reference
Added architecture diagrams
Created documentation templates
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

📞 Getting Help

Quick Start: See README.md
Deployment Issues: See DEPLOYMENT_QUICK_START.md
Configuration: See Configuration Index
Troubleshooting: See TROUBLESHOOTING.md
Operations: See runbooks/

Last Updated: 2025-01-27
Maintained By: Project Team
Version: 1.1

📋 Documentation Review

Documentation Review & Recommendations - Comprehensive documentation review
Documentation Quick Fixes - Critical fixes checklist
Documentation Gap Analysis - Gap analysis and recommendations
Final Gap Analysis and Fixes - Final gap analysis summary
Comprehensive Documentation Review - Complete review report
All Additional Suggestions Complete - Additional suggestions completion
Remaining TODO Items - Remaining TODO items
Implementation Summary - Implementation summary
All TODO Items Complete - Completion summary
Final Completion Report - Final completion report

📖 Reference

Glossary - Technical terms glossary
API Reference - Complete API reference

🛠️ Infrastructure

Terraform

Terraform README - Terraform documentation and usage

SDK

SDK README - Tatum SDK integration documentation

13 KiB Raw Blame History