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
parent a1466e4005
commit 1fb7266469
1720 changed files with 241279 additions and 16 deletions
--- a/docs/guides/GETTING_STARTED.md
+++ b/docs/guides/GETTING_STARTED.md
@@ -0,0 +1,184 @@
+# Getting Started
+
+**Last Updated**: 2025-01-27  
+**Status**: Active
+
+This guide helps you get started with the DeFi Oracle Meta Mainnet (ChainID 138) project.
+
+## Table of Contents
+
+- [Quick Start](#quick-start)
+- [For Developers](#for-developers)
+- [For Operators](#for-operators)
+- [For Integrators](#for-integrators)
+- [Next Steps](#next-steps)
+
+## Quick Start
+
+### I want to deploy the network
+
+1. Read [Deployment Quick Start](../DEPLOYMENT_QUICK_START.md)
+2. Follow the step-by-step [Deployment Guide](../deployment/DEPLOYMENT.md)
+3. Use the [Deployment Checklist](../deployment/DEPLOYMENT_CHECKLIST.md)
+
+### I want to understand the architecture
+
+1. Read [Architecture Documentation](../architecture/ARCHITECTURE.md)
+2. View [Architecture Diagrams](../architecture/ARCHITECTURE_DIAGRAM.md)
+3. Review [Network Topology](../architecture/NETWORK.md)
+
+### I want to configure the network
+
+1. Check [Configuration Index](../configuration/CONFIGURATION_INDEX.md)
+2. Follow [Network Configuration Guide](../configuration/NETWORK_CONFIGURATION_GUIDE.md)
+3. Set up [Environment Variables](../configuration/AZURE_CLOUDFLARE_ENV_SETUP.md)
+
+### I want to integrate with the network
+
+1. Read [Integration Guide](INTEGRATION_GUIDE.md)
+2. Review [API Documentation](../api/API.md)
+3. Check [Tatum SDK](../api/TATUM_SDK.md)
+
+## For Developers
+
+### Prerequisites
+
+- Foundry (forge, cast, anvil)
+- Node.js and npm
+- Git
+- Basic knowledge of Solidity and TypeScript
+
+### Getting Started
+
+1. **Clone the repository**
+   ```bash
+   git clone <repository-url>
+   cd smom-dbis-138
+   ```
+
+2. **Set up environment**
+   ```bash
+   cp .env.example .env
+   # Edit .env with your values
+   ```
+
+3. **Install dependencies**
+   ```bash
+   # Install Foundry
+   curl -L https://foundry.paradigm.xyz | bash
+   foundryup
+   
+   # Install Node.js dependencies
+   cd sdk
+   npm install
+   ```
+
+4. **Compile contracts**
+   ```bash
+   forge build
+   ```
+
+5. **Run tests**
+   ```bash
+   forge test
+   ```
+
+### Next Steps
+
+- [Deploy Contracts](../deployment/DEPLOYMENT.md#step-6-deploy-contracts)
+- [Integration Guide](INTEGRATION_GUIDE.md)
+- [API Documentation](../api/API.md)
+
+## For Operators
+
+### Prerequisites
+
+- Azure CLI installed and configured
+- Terraform >= 1.0
+- kubectl configured
+- Helm 3.x
+
+### Getting Started
+
+1. **Review architecture**
+   - [Architecture Documentation](../architecture/ARCHITECTURE.md)
+   - [Network Topology](../architecture/NETWORK.md)
+
+2. **Configure infrastructure**
+   - [Configuration Index](../configuration/CONFIGURATION_INDEX.md)
+   - [Azure Setup](../azure/AZURE_REGION_SETUP.md)
+
+3. **Deploy infrastructure**
+   - [Deployment Quick Start](../DEPLOYMENT_QUICK_START.md)
+   - [Deployment Guide](../deployment/DEPLOYMENT.md)
+
+4. **Monitor and maintain**
+   - [Troubleshooting Guide](TROUBLESHOOTING.md)
+   - [Operations Documentation](../operations/)
+
+### Next Steps
+
+- [Deployment Checklist](../deployment/DEPLOYMENT_CHECKLIST.md)
+- [Monitoring Setup](../deployment/DEPLOYMENT.md#step-4-deploy-monitoring)
+- [Troubleshooting Guide](TROUBLESHOOTING.md)
+
+## For Integrators
+
+### Prerequisites
+
+- Access to RPC endpoint
+- Basic knowledge of JSON-RPC
+- API key (if required)
+
+### Getting Started
+
+1. **Get RPC endpoint**
+   - Production: `https://rpc.d-bis.org`
+   - Testnet: Check deployment documentation
+
+2. **Test connection**
+   ```bash
+   curl -X POST https://rpc.d-bis.org \
+     -H "Content-Type: application/json" \
+     -d '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}'
+   ```
+
+3. **Use SDK (optional)**
+   ```bash
+   cd sdk
+   npm install
+   npm run example:basic
+   ```
+
+### Next Steps
+
+- [Integration Guide](INTEGRATION_GUIDE.md)
+- [API Documentation](../api/API.md)
+- [Tatum SDK](../api/TATUM_SDK.md)
+
+## Next Steps
+
+### Common Tasks
+
+- **Deploy contracts**: See [Deployment Guide](../deployment/DEPLOYMENT.md)
+- **Configure network**: See [Configuration Index](../configuration/CONFIGURATION_INDEX.md)
+- **Troubleshoot issues**: See [Troubleshooting Guide](TROUBLESHOOTING.md)
+- **Integrate applications**: See [Integration Guide](INTEGRATION_GUIDE.md)
+
+### Documentation
+
+- [Master Documentation Index](../MASTER_DOCUMENTATION_INDEX.md) - Complete documentation index
+- [Quick Start Guide](QUICKSTART.md) - Detailed quick start
+- [Architecture Documentation](../architecture/ARCHITECTURE.md) - System architecture
+
+### Support
+
+- Check [Troubleshooting Guide](TROUBLESHOOTING.md) for common issues
+- Review [FAQ](FAQ.md) for frequently asked questions
+- Review [Best Practices](BEST_PRACTICES.md) for guidance
+- Open an issue on the repository
+
+---
+
+**Last Updated**: 2025-01-27
+