Files
proxmox/docs/OPTIONAL_RECOMMENDATIONS_INDEX.md

88 lines
5.4 KiB
Markdown
Raw Normal View History

# Optional, Recommendations, and Suggestions — Master Index
**Last Updated:** 2026-03-01
**Purpose:** Single entry point for all optional tasks, recommendations, and suggestions across the repo.
---
## Quick links
| Document | Description |
|----------|-------------|
| **[00-meta/COMPLETE_REQUIRED_OPTIONAL_RECOMMENDED_INDEX.md](00-meta/COMPLETE_REQUIRED_OPTIONAL_RECOMMENDED_INDEX.md)** | **Full plan — required, optional, recommended (Wave 03, execution order)** |
| **[00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md](00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md)** | **Canonical list — all recommendations/gaps 1139 (20 sections)** |
| **[00-meta/ALL_RECOMMENDATIONS_HIGH_PRIORITY.md](00-meta/ALL_RECOMMENDATIONS_HIGH_PRIORITY.md)** | High-priority only (filtered view) |
| **[00-meta/ALL_RECOMMENDATIONS_OPERATOR_ONLY.md](00-meta/ALL_RECOMMENDATIONS_OPERATOR_ONLY.md)** | Operator-only checklist (LAN/Proxmox) |
| [ALL_IMPROVEMENTS_AND_GAPS_INDEX.md](ALL_IMPROVEMENTS_AND_GAPS_INDEX.md) | **Deprecated** — redirect only; use [00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md](00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md) |
| [RECOMMENDATIONS_AND_SUGGESTIONS.md](10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md) | Security, ops, performance, monitoring, scripts, docs, testing |
| [IMPLEMENTATION_CHECKLIST.md](10-best-practices/IMPLEMENTATION_CHECKLIST.md) | Checklist by priority (High/Medium/Low/Quick Wins) |
| [REMAINING_TASKS.md](REMAINING_TASKS.md) | Optional/enhancement tasks (MetaMask, Explorer, Token-Aggregation, Snap) |
| [REMAINING_TASKS_MASTER_20260201.md](../reports/REMAINING_TASKS_MASTER_20260201.md) | Master remaining tasks (deployment, codebase, optional) |
| [NEXT_STEPS_MASTER.md](00-meta/NEXT_STEPS_MASTER.md) | Consolidated next steps (immediate, phases, codebase) |
| [TEZOS_CCIP_REMAINING_ITEMS.md](07-ccip/TEZOS_CCIP_REMAINING_ITEMS.md) | Tezos/Etherlink CCIP and bridge remaining items |
---
## Completed (optional / recommendations)
| Item | Location | Status |
|------|----------|--------|
| Feature flags in routing (Tezos/Etherlink) | alltra-lifi-settlement | ✅ Done — `isBridgeDestinationEnabled` in LiFi + Jumper |
| CowSwap / Jumper / Wagmi / Viem networks | alltra-lifi-settlement, smom-dbis-138/frontend-dapp | ✅ Done — chains.ts, networks.ts, wagmi config |
| Retry with backoff utility | scripts/utils/retry_with_backoff.sh | ✅ Added |
| Dry-run example pattern | scripts/utils/dry-run-example.sh | ✅ Added |
| Config validation script | scripts/validation/validate-config-files.sh | ✅ Added |
| Quick Wins (secure .env, backup, metrics, snapshots, health check) | IMPLEMENTATION_CHECKLIST | ✅ Marked complete |
| TransactionMirror + DODO pool Chain 138 (nonce-fix deploy, .env, frontend config) | smom-dbis-138/.env, frontend-dapp contracts.ts, CONTRACT_DEPLOYMENT_RUNBOOK, RPC_2101_READONLY_FIX | ✅ Done — 0x7131F887DBEEb2e44c1Ed267D2A68b5b83285afc; chain138.TRANSACTION_MIRROR in contracts.ts |
| Optional batch (2026-02-27 / 2026-03-01) | DeployCompliantFiatTokens (10 tokens); MCP allowlist-138; add-liquidity runbook; token-aggregation fallbacks; ENV_EXAMPLE; E2E routing verify; PMM/REQUIRED_FIXES docs; cCADT (commented) in script | ✅ Done — see TODOS_CONSOLIDATED, PMM_DEX_ROUTING_STATUS |
---
## Optional / enhancement tasks by area
### MetaMask & Explorer
- Token-aggregation deployment; Snap market data / swap / bridge; CoinGecko submission; Wallet link on explorer.
- **See:** [REMAINING_TASKS.md](REMAINING_TASKS.md) § Optional/Enhancement.
### Tezos / Etherlink / Jumper
- Rate limits per destination; Jumper API integration; relay services; DON registration; monitoring.
- **See:** [TEZOS_CCIP_REMAINING_ITEMS.md](07-ccip/TEZOS_CCIP_REMAINING_ITEMS.md).
### High priority (implementation checklist)
- Security (validator keys, SSH, firewall, VLAN); monitoring; backup; testing; runbooks.
- **See:** [IMPLEMENTATION_CHECKLIST.md](10-best-practices/IMPLEMENTATION_CHECKLIST.md) § High Priority.
### Medium / low priority
- Error handling, logging, performance, automation, tooling; advanced features, UI, security.
- **See:** [IMPLEMENTATION_CHECKLIST.md](10-best-practices/IMPLEMENTATION_CHECKLIST.md).
---
## Scripts added for recommendations
| Script | Purpose |
|--------|---------|
| `scripts/utils/retry_with_backoff.sh` | Retry command with exponential backoff (source or run) |
| `scripts/utils/dry-run-example.sh` | Example `DRY_RUN` / `--dry-run` pattern for scripts |
| `scripts/validation/validate-config-files.sh` | Validate required config files and optional env (set `VALIDATE_REQUIRED_FILES`) |
---
## Quick win: Explorer “Wallet” link
To add a Wallet link to the Blockscout/explorer navbar (e.g. on VMID 5000):
1. SSH to the explorer VM.
2. Edit the main HTML (e.g. `/var/www/html/index.html`).
3. Add in the nav: `<a href="/wallet">Wallet</a>`.
**See:** [REMAINING_TASKS.md](REMAINING_TASKS.md) § Quick Wins.
---
## Maintenance
- Update this index when new optional/recommendation docs are added or items are completed.
- **Updated:** Canonical list and derived views (ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST, HIGH_PRIORITY, OPERATOR_ONLY) are linked above and from [MASTER_INDEX.md](MASTER_INDEX.md). Do not use [ALL_IMPROVEMENTS_AND_GAPS_INDEX.md](ALL_IMPROVEMENTS_AND_GAPS_INDEX.md) as primary—it is deprecated (redirect only).
- Link from [00-meta/NEXT_STEPS_MASTER.md](00-meta/NEXT_STEPS_MASTER.md) if desired.