d-bis/proxmox
4
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
fbda1b4bebd0be1036952f8343d54298f6026865
proxmox/DIRECTORY_REFERENCE.md
defiQUG fbda1b4beb
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
Details
docs: Ledger Live integration, contract deploy learnings, NEXT_STEPS updates 
- ADD_CHAIN138_TO_LEDGER_LIVE: Ledger form done; public code review repo bis-innovations/LedgerLive; init/push commands
- CONTRACT_DEPLOYMENT_RUNBOOK: Chain 138 gas price 1 gwei, 36-addr check, TransactionMirror workaround
- CONTRACT_*: AddressMapper, MirrorManager deployed 2026-02-12; 36-address on-chain check
- NEXT_STEPS_FOR_YOU: Ledger done; steps completable now (no LAN); run-completable-tasks-from-anywhere
- MASTER_INDEX, OPERATOR_OPTIONAL, SMART_CONTRACTS_INVENTORY_SIMPLE: updates
- LEDGER_BLOCKCHAIN_INTEGRATION_COMPLETE: bis-innovations/LedgerLive reference

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-12 15:46:57 -08:00

13 KiB
Raw Blame History

Project Root Directory Reference

This document provides a comprehensive overview of all directories in the project root with descriptions of their function and content.

Last Updated: 2026-01-31

📋 Table of Contents

Core Infrastructure

mcp-proxmox/

Type: Git Submodule
Purpose: Proxmox MCP (Model Context Protocol) Server - Node.js-based server for interacting with Proxmox hypervisors
Content: MCP server implementation providing 55+ tools for Proxmox management, including VM/container operations, storage management, snapshots, backups, and cluster management. Supports configurable permission levels (basic vs elevated).
Key Files: index.js, README.md

ProxmoxVE/

Type: Git Submodule
Purpose: ProxmoxVE Helper Scripts - Collection of scripts and frontend for managing Proxmox containers and VMs
Content: Next.js frontend application for browsing and managing Proxmox helper scripts, installation scripts, utility tools, and documentation.
Key Components: frontend/, install/, tools/, docs/

smom-dbis-138-proxmox/

Type: Git Submodule
Purpose: Deployment scripts and configurations for Proxmox VE LXC container deployment of SMOM-DBIS-138 blockchain network
Content: Complete automation for deploying ChainID 138 blockchain infrastructure on Proxmox VE, including Besu validator/sentry/RPC nodes, network configuration, and maintenance scripts.
Key Components: Deployment scripts, configuration templates, inventory management

Model Context Protocol (MCP) Servers

mcp-unifi/

Type: Workspace Package
Purpose: UniFi MCP Server - Model Context Protocol server for managing Ubiquiti UniFi/UDM Pro devices
Content: Node.js MCP server that provides tools for interacting with UniFi network devices, including controller management, device configuration, and network monitoring.
Related: unifi-api/

mcp-omada/

Type: Workspace Package
Purpose: Omada MCP Server - Model Context Protocol server for managing TP-Link Omada network devices
Content: Node.js MCP server for managing Omada SDN controllers and network devices, providing configuration and monitoring capabilities.
Related: omada-api/

mcp-site-manager/

Type: Workspace Package
Purpose: Site Manager MCP Server - Model Context Protocol server for managing site infrastructure
Content: Node.js MCP server for site management operations, infrastructure monitoring, and configuration management.
Related: site-manager-api/

API Packages

unifi-api/

Type: Workspace Package
Purpose: UniFi API Client Library - Type-safe TypeScript client for Ubiquiti UniFi/UDM Pro devices
Content: Full-featured API client with dual mode support (Official Local API and Private Controller API), CLI tool, utility scripts, and TypeScript type definitions.
Related: mcp-unifi/

omada-api/

Type: Workspace Package
Purpose: Omada API Client Library - API client for TP-Link Omada SDN controllers
Content: API client library for interacting with Omada cloud controllers and network devices.
Related: mcp-omada/

site-manager-api/

Type: Workspace Package
Purpose: Site Manager API Client Library - API client for site infrastructure management
Content: API client library for site management operations and infrastructure monitoring.
Related: mcp-site-manager/

Blockchain & DeFi Projects

smom-dbis-138/

Type: Main Project Directory
Purpose: SMOM-DBIS-138 Blockchain Network - Main blockchain project with smart contracts, services, and infrastructure
Content: Complete blockchain ecosystem including:

  • Smart contracts (Solidity)
  • Frontend dApp applications
  • Backend services (oracle publisher, CCIP monitor, financial tokenization)
  • Deployment scripts and configurations
  • Comprehensive documentation (550+ markdown files)
  • Terraform infrastructure as code
  • Bridge implementations and monitoring
  • MetaMask integration

Key Subdirectories:

  • contracts/ - Smart contracts source code
  • scripts/ - Deployment and utility scripts
  • docs/ - Comprehensive documentation
  • services/ - Backend microservices
  • frontend/ - Frontend applications
  • test/ - Test suites
  • terraform/ - Infrastructure as code

dbis_core/

Type: Core Business Logic
Purpose: DBIS Core - Core settlement and business logic system
Content: Core business logic including:

  • Database migrations
  • Settlement logic (AS4)
  • Frontend console applications
  • Monitoring dashboards (Grafana)
  • Legal documentation
  • Operational runbooks
  • API references

Key Components: Settlement system, member rulebooks, threat models, PKI/CA model, directory services

rpc-translator-138/

Type: Service
Purpose: RPC Translator for Chain 138 - Translation service for RPC endpoints
Content: RPC translation service for the SMOM-DBIS-138 network, handling protocol translations and endpoint routing.

explorer-monorepo/

Type: Monorepo
Purpose: Blockchain Explorer Monorepo - Blockscout-based blockchain explorer
Content: Complete explorer implementation for ChainID 138, including frontend, backend services, and configuration. Contains deployment completion reports and status documentation.

token-lists/

Type: Token List Management
Purpose: Token List Management - Token list authoring, validation, and hosting
Content:

  • Token list files for ChainID 138 (Uniswap Token Lists specification)
  • Validation scripts and CI/CD integration
  • Chainlists submission scripts
  • Logo assets
  • Documentation for token list authoring

Key Files: lists/dbis-138.tokenlist.json, validation scripts, hosting guides

metamask-integration/

Type: Integration Project
Purpose: MetaMask Integration - MetaMask wallet integration for Chain 138
Content: MetaMask SDK integration, React examples, configuration guides, and deployment scripts for wallet connectivity.

pr-workspace/

Type: Workspace
Purpose: PR Workspace - Pull request workspace for Ethereum app integration
Content: Ethereum ledger app workspace, including test suites (Ragger), configuration tools, and Ethereum-specific functionality.

Documentation

docs/

Type: Documentation Hub
Purpose: Central project documentation organized into logical sections
Content: Comprehensive documentation structure:

  • 00-meta/ - Documentation metadata and relationships
  • 01-getting-started/ - Getting started guides
  • 02-architecture/ - Architecture and design documentation
  • 03-deployment/ - Deployment guides and procedures
  • 04-configuration/ - Configuration guides (MCP setup, environment variables)
  • 05-network/ - Network architecture and configuration
  • 06-besu/ - Besu blockchain node documentation
  • 07-ccip/ - Cross-chain interoperability documentation
  • 08-monitoring/ - Monitoring and observability
  • 09-troubleshooting/ - Troubleshooting guides
  • 10-best-practices/ - Best practices
  • 11-references/ - Reference documentation
  • 12-quick-reference/ - Quick reference guides
  • archive/ - Archived documentation

Key Features: Master index, search guide, print-ready documentation

gru-docs/

Type: Documentation Project
Purpose: GRU Documentation - Multi-language documentation site
Content: Documentation site with internationalization support, including:

  • Multi-language documentation (Arabic, French, Indonesian, Portuguese, etc.)
  • Subgraph documentation
  • Contract documentation
  • Build configuration
  • Analytics setup

info-defi-oracle/

Type: Information Directory
Purpose: DeFi Oracle Information - DeFi Oracle related information
Content: Directory for DeFi Oracle information and resources (currently minimal content).

Operations & Management

scripts/

Type: Utility Scripts
Purpose: Project root utility scripts for automation and management
Content: 260+ shell scripts and Python scripts for:

  • Deployment automation (incl. CCIP WETH9 Bridge: scripts/deploy-and-configure-weth9-bridge-chain138.sh; set CCIPWETH9_BRIDGE_CHAIN138 after deploy)
  • Infrastructure management
  • Monitoring and health checks
  • Configuration management
  • Network configuration
  • Besu node management
  • BlockScout deployment
  • Cloudflare DNS/SSL configuration
  • Certificate management
  • Container/VM operations
  • Bridge deployments
  • Troubleshooting and diagnostics

Key Subdirectories:

  • backup/ - Backup scripts
  • besu/ - Besu-specific scripts
  • deployment/ - Deployment orchestration
  • npmplus/ - NPMplus proxy management
  • unifi/ - UniFi management scripts
  • verify/ - Verification scripts
  • cloudflare-tunnels/ - Cloudflare tunnel management

reports/

Type: Reports & Analysis
Purpose: Generated reports, analysis documents, and status reports
Content:

  • Deployment reports and summaries
  • Network configuration reviews
  • Container inventory reports
  • Migration reports
  • Troubleshooting analysis
  • Test results
  • Markdown analysis reports
  • JSON export files (endpoints, comparisons)

Key Subdirectories:

  • analyses/ - Analysis reports
  • archive/ - Archived reports
  • inventories/ - Inventory reports
  • status/ - Status reports
  • storage/ - Storage-related reports

logs/

Type: Log Files
Purpose: Log files from various operations and scripts
Content: Execution logs from:

  • Documentation organization scripts
  • Markdown cleanup operations
  • Script execution logs
  • Chain 138 operations logs

backups/

Type: Backup Storage
Purpose: Backup files and snapshots
Content:

  • Timestamped backup directories
  • IP conversion backups
  • Dependency update backups
  • NPMplus configuration backups

output/

Type: Script Output
Purpose: Output files from script executions
Content: Time-stamped output directories from various script executions, including:

  • Chain 138 configuration outputs
  • Deployment outputs
  • Generated files from automation scripts

Build & Development

node_modules/

Type: Dependencies
Purpose: Node.js dependencies installed via pnpm
Content: All npm packages required by workspace packages. Managed by pnpm workspaces.

venv/

Type: Python Environment
Purpose: Python virtual environment
Content: Python virtual environment with installed packages for Python scripts (e.g., proxmoxer, etc.).

__pycache__/

Type: Python Cache
Purpose: Python bytecode cache files
Content: Compiled Python bytecode files (.pyc) for faster module loading.

Testing

tests/

Type: Test Directory
Purpose: Test files and test infrastructure
Content: Test suites and test infrastructure, including:

  • Disaster recovery tests
  • Integration tests
  • Test utilities and helpers

Configuration & Data

config/

Type: Configuration Files
Purpose: Configuration files and templates
Content:

  • production/ - Production configuration files
  • Configuration templates and examples
  • Environment-specific configurations

examples/

Type: Example Files
Purpose: Example code and demonstration files
Content: HTML example files demonstrating:

  • MetaMask integration examples
  • RPC network addition examples
  • Wallet connection examples
  • Price feed examples

Specialized Projects

metaverseDubai/

Type: Specialized Project
Purpose: Metaverse Dubai Project - 3D metaverse environment
Content:

  • Art bible and asset catalog
  • 3D asset tracking
  • Houdini integration
  • Scripts for NPC dialogue, texture validation, performance audits
  • GIS to Unreal integration
  • Content organization
  • Multi-language support

miracles_in_motion/

Type: Specialized Project
Purpose: Miracles in Motion - Specialized application project
Content:

  • API implementations
  • Documentation (phases, deployment)
  • Asset management
  • Contributing guidelines

Git & Version Control

.git/

Type: Git Repository
Purpose: Git version control data
Content: Git repository metadata, objects, and refs.

.github/

Type: GitHub Configuration
Purpose: GitHub-specific configuration
Content: GitHub Actions workflows, issue templates, pull request templates, and GitHub-specific settings.

.secure/

Type: Secure Storage
Purpose: Secure files and credentials (git-ignored)
Content: Secure files that should not be committed to version control (typically git-ignored).

Summary

This monorepo workspace manages:

  • 4 MCP Servers (Proxmox, UniFi, Omada, Site Manager)
  • 3 API Packages (UniFi, Omada, Site Manager)
  • 1 Major Blockchain Project (SMOM-DBIS-138)
  • 1 Core Business System (DBIS Core)
  • 260+ Utility Scripts
  • 500+ Documentation Files
  • Multiple Integration Projects (MetaMask, Explorer, Token Lists)

The workspace uses pnpm workspaces for package management and Git submodules for major components.

Reference in New Issue View Git Blame Copy Permalink