Files
smom-dbis-138/docs/guides/MAKEFILE_USAGE.md
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

4.6 KiB

Makefile Usage Guide

Last Updated: 2025-01-27
Status: Active

This guide explains how to use the Makefile for common project tasks.

Table of Contents

Overview

The project includes a comprehensive Makefile with targets for deployment, development, monitoring, and maintenance tasks.

Prerequisites

  • Make installed
  • Azure CLI (for deployment targets)
  • Terraform (for infrastructure targets)
  • kubectl (for Kubernetes targets)
  • Foundry (for contract targets)

Common Targets

Help

make help

Displays all available targets and their descriptions.

Deployment Targets

Full Deployment

# Deploy everything (infrastructure, k8s, contracts, DNS)
make deploy-all

Infrastructure Deployment

# Deploy Azure infrastructure only
make deploy-infra

Kubernetes Deployment

# Deploy Kubernetes resources only
make deploy-k8s

Contract Deployment

# Deploy contracts only
make deploy-contracts

WETH Deployment

# Deploy WETH9 contract
make deploy-weth

# Deploy WETH10 contract
make deploy-weth10

# Deploy all WETH contracts and CCIP bridges
make deploy-weth-ccip

CCIP Bridge Deployment

# Deploy CCIPWETH9Bridge
make deploy-ccip-weth9-bridge

# Deploy CCIPWETH10Bridge
make deploy-ccip-weth10-bridge

Blockscout Deployment

# Deploy Blockscout explorer
make deploy-blockscout

DNS Configuration

# Configure Cloudflare DNS
make deploy-dns

Development Targets

Compile Contracts

# Compile and test contracts
make contracts

Run Tests

# Run all tests
make test

Generate Keys

# Generate validator and oracle keys
make keys

Generate Genesis

# Generate genesis file
make genesis

Monitoring Targets

Monitor Deployment

# Monitor deployment status (consolidated)
make monitor

# Continuous deployment monitoring
make monitor-continuous

# Deployment dashboard view
make monitor-dashboard

Maintenance Targets

Key Vault Management

# Deploy all Key Vaults
make keyvaults

# Check Key Vault deployment status
make keyvaults-status

# Grant Key Vault permissions
make keyvaults-permissions

# Store validator keys in Key Vaults
make keyvaults-store-keys

# Run complete Key Vault setup
make keyvaults-complete

Azure Resource Management

# List all Azure resources
make azure-list-resources

# Check Azure resource naming conventions
make azure-check-naming

# Authenticate with Azure CLI
make azure-login

Cost Management

# Calculate deployment costs
make calculate-costs

Verification

# Verify deployment
make verify

Cleanup

# Clean up temporary files
make clean

Parallel Deployment

# Parallel deployment (infrastructure)
make deploy-parallel

Examples

Complete Deployment Workflow

# 1. Authenticate with Azure
make azure-login

# 2. Deploy infrastructure
make deploy-infra

# 3. Deploy Kubernetes resources
make deploy-k8s

# 4. Deploy contracts
make deploy-contracts

# 5. Configure DNS
make deploy-dns

# 6. Verify deployment
make verify

# 7. Monitor status
make monitor

Development Workflow

# 1. Generate keys
make keys

# 2. Generate genesis
make genesis

# 3. Compile contracts
make contracts

# 4. Run tests
make test

WETH Deployment Workflow

# Deploy WETH9 and WETH10 with CCIP bridges
make deploy-weth-ccip

# Or deploy individually
make deploy-weth
make deploy-weth10
make deploy-ccip-weth9-bridge
make deploy-ccip-weth10-bridge

Target Categories

Deployment

  • deploy, deploy-all, deploy-infra, deploy-k8s
  • deploy-contracts, deploy-blockscout, deploy-dns
  • deploy-weth, deploy-weth10, deploy-weth-ccip
  • deploy-ccip-weth9-bridge, deploy-ccip-weth10-bridge

Development

  • contracts, test, keys, genesis

Monitoring

  • monitor, monitor-continuous, monitor-dashboard

Maintenance

  • keyvaults*, azure-*, calculate-costs, verify, clean

Last Updated: 2025-01-27