110 lines
4.2 KiB
Markdown
110 lines
4.2 KiB
Markdown
|
|
# Project Optimization Status
|
||
|
|
|
||
|
|
**Last Updated**: 2025-11-18
|
||
|
|
**Status**: In Progress
|
||
|
|
|
||
|
|
## Summary
|
||
|
|
|
||
|
|
This document tracks the ongoing optimization and cleanup of the smom-dbis-138 project.
|
||
|
|
|
||
|
|
## Completed Actions
|
||
|
|
|
||
|
|
### ✅ 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
|
||
|
|
- **Created archive structure** with proper organization
|
||
|
|
|
||
|
|
### ✅ Configuration Consolidation
|
||
|
|
- **Archived old IBFT2 config structure**: `config/validators/`, `config/sentries/`, `config/rpc/` → `docs/archive/old-configs/ibft2/`
|
||
|
|
- **Current config structure**: Standardized `config/config-*.toml` files (QBFT-based)
|
||
|
|
- `config-validator.toml`
|
||
|
|
- `config-rpc-perm.toml`
|
||
|
|
- `config-rpc-core.toml`
|
||
|
|
- `config-member.toml`
|
||
|
|
- `config-rpc-public.toml`
|
||
|
|
|
||
|
|
### ✅ Docker Compose Structure
|
||
|
|
- **Current**: `docker-compose/docker-compose.template.yml` (Option A pattern with profiles)
|
||
|
|
- **Legacy**: `docker/besu-*/docker-compose.yml` (per-node-type, may still be used for reference)
|
||
|
|
- **Phase2**: `docker/phase2/docker-compose.*.yml` (regional deployments)
|
||
|
|
|
||
|
|
## Current Project Structure
|
||
|
|
|
||
|
|
### Active Configuration Files
|
||
|
|
```
|
||
|
|
config/
|
||
|
|
├── genesis.json # Current QBFT genesis
|
||
|
|
├── static-nodes.json # Network peer configuration
|
||
|
|
├── config-validator.toml # Validator node config
|
||
|
|
├── config-rpc-perm.toml # Permissioned RPC config
|
||
|
|
├── config-rpc-core.toml # Core/admin RPC config
|
||
|
|
├── config-member.toml # Member node config
|
||
|
|
├── config-rpc-public.toml # Public RPC config
|
||
|
|
└── permissions-*.toml # Permissioning configs
|
||
|
|
```
|
||
|
|
|
||
|
|
### Docker Compose Files
|
||
|
|
```
|
||
|
|
docker-compose/
|
||
|
|
├── docker-compose.template.yml # ✅ CURRENT: Option A template
|
||
|
|
└── env/
|
||
|
|
├── vm1.env # VM1 configuration
|
||
|
|
├── vm2.env # VM2 configuration
|
||
|
|
├── vm3.env # VM3 configuration
|
||
|
|
├── vm4.env # VM4 configuration
|
||
|
|
└── vm5.env # VM5 configuration
|
||
|
|
```
|
||
|
|
|
||
|
|
## Recent Cleanup Actions (2025-11-18)
|
||
|
|
|
||
|
|
### 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
|
||
|
|
- **Total Lines of Code**: 28,089 lines
|
||
|
|
- **WETH-related Scripts**: 16 (consolidation in progress)
|
||
|
|
- **CCIP Scripts**: 16 (duplicates removed)
|
||
|
|
- **Deployment Scripts**: 82 (review needed)
|
||
|
|
|
||
|
|
## Remaining Tasks
|
||
|
|
|
||
|
|
### 🔄 In Progress
|
||
|
|
- [ ] Continue script deduplication (82 deployment scripts to review)
|
||
|
|
- [ ] Update remaining IBFT references in documentation (10+ files)
|
||
|
|
- [ ] Create consolidated documentation index
|
||
|
|
|
||
|
|
### ⏳ Pending
|
||
|
|
- [ ] Document docker-compose file usage and migration path
|
||
|
|
- [ ] Consolidate duplicate genesis generation scripts
|
||
|
|
- [ ] Review and optimize script organization
|
||
|
|
|
||
|
|
## Files Requiring IBFT → QBFT Updates
|
||
|
|
|
||
|
|
The following files still contain IBFT references:
|
||
|
|
- `scripts/configure-network-decision-tree.md`
|
||
|
|
- `runbooks/parameter-change.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)
|
||
|
|
|
||
|
|
## Archive Location
|
||
|
|
|
||
|
|
All archived files are in `docs/archive/`:
|
||
|
|
- `status-reports/phase1/` - Historical status reports
|
||
|
|
- `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
|
||
|
|
|