23 KiB
23 KiB
Documentation — Master Index
Last Updated: 2026-03-28
Purpose: Single entry point for all project documentation. Use this index to find canonical sources and avoid deprecated or duplicate content.
Status: Preflight and Chain 138 next steps completed (59/59 on-chain per check-contracts-on-chain-138.sh, 12 c* GRU-registered). 2026-03-06: Contract check list expanded to 59 addresses (PMM, vault/reserve, CompliantFiatTokens); doc refs updated. 2026-03-04: Celo CCIP bridges deployed; Phase A–D tracked in 03-deployment/REMAINING_DEPLOYMENTS_FOR_FULL_NETWORK_COVERAGE.md. Phase C: PHASE_C_CW_AND_EDGE_POOLS_RUNBOOK.md; Phase D: PHASE_D_OPTIONAL_CHECKLIST.md. On-chain verification: DODOPMMIntegration canonical cUSDT/cUSDC — EXPLORER_TOKEN_LIST_CROSSCHECK §8. Remaining: Wemix 0.4 WEMIX, LINK fund, cW* + edge pools — see 00-meta/TODOS_CONSOLIDATED.md.
Continue and complete (operator/LAN): (1) ./scripts/run-completable-tasks-from-anywhere.sh then (2) ./scripts/run-all-operator-tasks-from-lan.sh (use --skip-backup if NPM_PASSWORD not set; add --deploy or --create-vms as needed). Operator scripts load dotenv from repo .env and smom-dbis-138/.env automatically.
Start here
| Purpose | Document |
|---|---|
| Agent / IDE instructions | AGENTS.md (repo root) |
| Git submodule hygiene + explorer remotes | 00-meta/SUBMODULE_HYGIENE.md — detached HEAD, push order, Gitea/GitHub, submodules-clean.sh |
| What to do next | 00-meta/NEXT_STEPS_INDEX.md — ordered actions, by audience, execution plan |
| Your personal checklist | 00-meta/NEXT_STEPS_FOR_YOU.md |
| Operator runbook (LAN/creds) | 00-meta/NEXT_STEPS_OPERATOR.md |
| Operator copy-paste commands | 00-meta/OPERATOR_READY_CHECKLIST.md — exact commands for Blockscout, NPMplus, CCIP, 502 fix, backup, deploy |
| Required / optional / recommended (full plan) | 00-meta/COMPLETE_REQUIRED_OPTIONAL_RECOMMENDED_INDEX.md |
| Single task list | 00-meta/TODOS_CONSOLIDATED.md |
| Execution: multiple routes + liquidity (all + optional, suggested order) | 00-meta/EXECUTION_CHECKLIST_MULTIPLE_ROUTES_AND_LIQUIDITY.md |
| Source to CEX execution plan | 03-deployment/SOURCE_TO_CEX_EXECUTION_PLAN.md — operator bridge, normalization, and exchange-handoff plan |
| Source to CEX production readiness | 03-deployment/SOURCE_TO_CEX_PRODUCTION_READINESS.md — repo-native readiness gate for immediate production |
| Immediate live production task list: source to CEX | 03-deployment/IMMEDIATE_LIVE_PRODUCTION_TASK_LIST_SOURCE_TO_CEX.md — task list with remaining live blockers called out |
| Crypto.com OTC before vs after matrix | 03-deployment/CRYPTO_COM_OTC_BEFORE_AFTER_OPERATOR_MATRIX.md — strict operator comparison of the current ecosystem versus the state after a real Crypto.com OTC sink is connected |
| Provider-facing source to CEX package | 03-deployment/PROVIDER_FACING_PACKAGE_SOURCE_TO_CEX.md — strict provider-facing package covering expectations, flow presentation, questions, and a first 30-day ramp plan |
| Mr. Promod Uniswap V2 liquidity program | 03-deployment/PROMOD_UNISWAP_V2_LIQUIDITY_PROGRAM.md — wrapped-depth-first Uniswap V2 rollout for cW* and cWAUSDT on bridged public networks |
| Mr. Promod Uniswap V2 promotion gates | 03-deployment/PROMOD_UNISWAP_V2_PROMOTION_GATES.md — exact per-chain env vars and registry records required before any live Uniswap V2 pool can be promoted |
| Mr. Promod Uniswap V2 live pair discovery | 03-deployment/PROMOD_UNISWAP_V2_LIVE_PAIR_DISCOVERY.md — env-ready chain scan for live cW Uniswap V2-compatible pairs and the path to record them |
| Mr. Promod Uniswap V2 first deployment target matrix | 03-deployment/PROMOD_UNISWAP_V2_FIRST_DEPLOYMENT_TARGET_MATRIX.md — exact first pair per chain, why it goes first, required tokens, and post-deploy commands |
| Mr. Promod Uniswap V2 phase order | 03-deployment/PROMOD_UNISWAP_V2_PHASE_ORDER.md — strict rollout order: phase 1 core rail, phase 2 full cW* wrapped mesh, phase 3 settlement rails |
| Mr. Promod Uniswap V2 phase 2 operator sequence | 03-deployment/PROMOD_UNISWAP_V2_PHASE2_OPERATOR_SEQUENCE.md — exact chain-by-chain phase-2 cW* wrapped-mesh rollout with per-pair probe, create, and deploy blocks |
| Mr. Promod Uniswap V2 phase 2 wave 2 operator sequence | 03-deployment/PROMOD_UNISWAP_V2_PHASE2_WAVE2_OPERATOR_SEQUENCE.md — exact chain-by-chain rollout for the remaining wrapped-mesh assets after wave 1 |
| Mr. Promod Uniswap V2 phase 2 wave 2 operator paste pack | 03-deployment/PROMOD_UNISWAP_V2_PHASE2_WAVE2_OPERATOR_PASTE_PACK.md — flat paste-ready operator pack for every remaining wrapped-mesh pair in wave 2 |
| Mr. Promod Uniswap V2 phase 2 wave 2 shell paste pack | 03-deployment/PROMOD_UNISWAP_V2_PHASE2_WAVE2_SHELL_PASTE_PACK.sh — pure shell-only sequence for every remaining wrapped-mesh pair in wave 2 |
| Mr. Promod Uniswap V2 phase 2 operator paste pack | 03-deployment/PROMOD_UNISWAP_V2_PHASE2_OPERATOR_PASTE_PACK.md — flat paste-ready operator pack for every phase-2 wrapped-mesh pair in execution order |
| Mr. Promod Uniswap V2 phase 2 shell paste pack | 03-deployment/PROMOD_UNISWAP_V2_PHASE2_SHELL_PASTE_PACK.sh — pure shell-only sequence for phase-2 wrapped-mesh pair creation and seeding |
| Mr. Promod Uniswap V2 phase 2 wave 1 completion status | 03-deployment/PROMOD_UNISWAP_V2_PHASE2_WAVE1_COMPLETION_STATUS.md — live reserve-backed completion report for the six wave-1 wrapped pairs on all target networks, plus current explorer-publication blockers |
| Mr. Promod GRU v2 full mesh gap report | 03-deployment/PROMOD_GRU_V2_FULL_MESH_GAP_REPORT.md — strict per-network gap report for the remaining cW mesh across DODO PMM, Uniswap V2, Balancer, Curve, and other venue surfaces |
| Chain 138 -> Wemix 1111 bridge completion checklist | 03-deployment/CHAIN_138_TO_WEMIX_1111_BRIDGE_COMPLETION_CHECKLIST.md — exact operator checklist for deploying the WEMIX WETH bridges, wiring destinations, funding LINK, and promoting 1111 out of deferred state |
| WEMIX bridge verification status | 03-deployment/WEMIX_BRIDGE_VERIFICATION_STATUS.md — current explorer-publication state for the deployed WEMIX bridges and the repo-native verification command |
| Mr. Promod Uniswap V2 phase 1 execution checklist | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_EXECUTION_CHECKLIST.md — exact chain-by-chain operator checklist for the first full cWUSDT/cWUSDC rollout |
| Mr. Promod Uniswap V2 phase 1 funding readiness | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_FUNDING_READINESS.md — live deployer-wallet balances and max equal-sided seed size for each cWUSDT/cWUSDC target chain |
| Mr. Promod Uniswap V2 phase 1 funding bundle | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_FUNDING_BUNDLE.md — per-chain missing-token/gas bundle and exact post-funding deploy block for phase 1 |
| Mr. Promod Uniswap V2 phase 1 funding actions | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_FUNDING_ACTIONS.md — strict per-chain mint-before-seed or seed-now action plan, with bridge-possible notes tied to the cW bridge runbooks |
| Mr. Promod Uniswap V2 phase 1 bridge-from-138 matrix | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_BRIDGE_FROM_138_MATRIX.md — strict destination shortfall matrix showing how much cUSDT/cUSDC Chain 138 inventory could source for the remaining phase-1 rollout |
| Mr. Promod Uniswap V2 phase 1 bridge 3x matrix | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_BRIDGE_3X_MATRIX.md — strict 3x bridge sizing plan from Chain 138 for the remaining phase-1 destination shortfalls |
| Mr. Promod Uniswap V2 phase 1 bridge 3x operator packet | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_BRIDGE_3X_OPERATOR_PACKET.md — strict operator packet with 3x bridge amounts, destination cW addresses, bridge env, and post-funding deploy block per chain |
| Mr. Promod Uniswap V2 phase 1 bridge-or-mint runbook | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_BRIDGE_OR_MINT_RUNBOOK.md — strict runbook that ties the 3x operator packet to bridge preflight, exact mint fallback blocks, and post-funding deploy blocks |
| Mr. Promod Uniswap V2 phase 1 remaining 8 operator paste pack | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_REMAINING_8_OPERATOR_PASTE_PACK.md — one flat paste-ready pack for the remaining eight phase-1 chains after 1 and 137 |
| Mr. Promod Uniswap V2 phase 1 remaining 8 shell paste pack | 03-deployment/PROMOD_UNISWAP_V2_PHASE1_REMAINING_8_SHELL_PASTE_PACK.sh — pure shell-only paste pack for the remaining eight phase-1 chains with no markdown headings |
| All additional recommendations (table) | 00-meta/ADDITIONAL_RECOMMENDATIONS_TABLE.md — consolidated table of every recommendation with description and command/doc |
| Dotenv & markdown audit (gaps + recommendations) | 00-meta/DOTENV_AND_MARKDOWN_AUDIT_GAPS_AND_RECOMMENDATIONS.md — required env/markdown info, run results, gaps, recommendations |
| Next steps (concise) | 00-meta/NEXT_STEPS_LIST.md — bridge/swap/Phase C status, quick commands |
| Still not done (operator/external) | 00-meta/STILL_NOT_DONE_EXECUTION_CHECKLIST.md |
| Remaining tasks (one page) | 00-meta/REMAINING_TASKS.md |
| Contract next steps (Chain 138) | 11-references/CONTRACT_NEXT_STEPS_LIST.md — on-chain check (59 addr), Blockscout, env |
| Task check report (verify before completing) | 00-meta/TASK_CHECK_REPORT.md |
| Gaps status (all gap sources + fixes) | 00-meta/GAPS_STATUS.md |
Master lists (canonical)
By area
Deprecated / superseded (do not use as primary source)
| Document | Use instead |
|---|---|
| ALL_IMPROVEMENTS_AND_GAPS_INDEX.md | 00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md |
| CONTRACT_INVENTORY_AND_VERIFICATION, SMART_CONTRACTS_INVENTORY | 11-references/ADDRESS_MATRIX_AND_STATUS.md |
| Dated one-off reviews (e.g. DOCUMENTATION_REVIEW_20260216) | Superseded — use 00-meta/DOCUMENTATION_CONSOLIDATION_PLAN.md and 00-meta/ARCHIVE_CANDIDATES.md (inventory only; do not link into docs/archive/ from runbooks) |
Consolidation and maintenance
- Archive inventory (paths on disk; do not link into
docs/archive/from runbooks): 00-meta/ARCHIVE_CANDIDATES.md - Consolidation plan: 00-meta/DOCUMENTATION_CONSOLIDATION_PLAN.md
- Task list review (deprecated/duplicates resolved): 00-meta/TASK_LIST_REVIEW_2026_03_01.md