5c69993ce9
- Add naming-conventions/ with UTRNF reference and DBIS namespace mapping - Index from 04-configuration README and MASTER_INDEX - check-cstar-v2-transport-stack: CompliantWrappedToken + JurisdictionalGovernance suites - gitignore: config/production/dbis-identity-public-did-secrets.env Made-with: Cursor
23 KiB
23 KiB
Documentation — Master Index
Last Updated: 2026-03-31
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 (64/64 on-chain per check-contracts-on-chain-138.sh when LAN RPC reachable; includes ISO20022Router, canonical + legacy CCIP router/WETH9 bridge, config/smart-contracts-master.json). 2026-03-30: Live verification — LIVE_VERIFICATION_LOG_2026-03-30.md (public + private E2E Failed: 0, config validation, run-all-validation.sh --skip-genesis). 2026-03-06: Prior doc pass referred to 59 addresses; script list grew through 61 → 62 → 64 (PMM, vault/reserve, CompliantFiatTokens, ISO router, CCIP legacy pair). 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. P1 local slice: bash scripts/verify/run-p1-local-verification.sh (--with-iru-tests optional); full P1 IDs in TODOS_CONSOLIDATED.md.
Start here
| Purpose | Document |
|---|---|
| Agent / IDE instructions | AGENTS.md (repo root) |
| Local green-path tests | Root pnpm test → scripts/verify/run-repo-green-test-path.sh |
| 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 |
| Live verification evidence (dated) | 00-meta/LIVE_VERIFICATION_LOG_2026-03-30.md |
| 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 |
| 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 (64 addr), Blockscout, env |
| Integration gaps (OMNL / Core / RTGS / ISO) | 00-meta/INTEGRATION_GAPS_AND_NEXT_STEPS_2026-03-30.md |
| 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)
| Topic | Canonical document | Do not use (deprecated/superseded) |
|---|---|---|
| Next steps | 00-meta/NEXT_STEPS_INDEX.md, 00-meta/NEXT_STEPS_AND_REMAINING_TODOS.md | — |
| Recommendations (139+ items) | 00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md | ALL_IMPROVEMENTS_AND_GAPS_INDEX.md — superseded; redirect only |
| Optional / recommendations index | OPTIONAL_RECOMMENDATIONS_INDEX.md | — |
| Task list | 00-meta/TODO_TASK_LIST_MASTER.md, 00-meta/TODOS_CONSOLIDATED.md | — |
| Deployment order | 03-deployment/DEPLOYMENT_ORDER_OF_OPERATIONS.md, 03-deployment/REMAINING_DEPLOYMENTS_FOR_FULL_NETWORK_COVERAGE.md (Phases A–D) | — |
| Phase C (cW* + edge pools) | 03-deployment/PHASE_C_CW_AND_EDGE_POOLS_RUNBOOK.md | — |
| Phase D (optional XAU/vaults/trustless) | 03-deployment/PHASE_D_OPTIONAL_CHECKLIST.md | — |
| OMNL + DBIS Core + Chain 138 + Smart Vault + external RTGS | 03-deployment/OMNL_DBIS_CORE_CHAIN138_SMART_VAULT_RTGS_RUNBOOK.md | — |
| Chain 138 as SWIFT-replacement rail (UETR vs on-chain ids, audit scope) | 03-deployment/OJK_BI_AUDIT_JVMTM_REMEDIATION_AND_UETR_POLICY.md | — |
| JVMTM / regulatory closure JSON (3-way recon, prefunding, ACK, exceptions, KYT/BCP/DR templates) | config/jvmtm-regulatory-closure/README.md, INAAUDJVMTM_2025_AUDIT_CLOSURE_MATRIX.md (Tables B/C/D vs archive), scripts/validation/validate-jvmtm-regulatory-closure-schemas.sh, scripts/omnl/build-omnl-e2e-settlement-audit-archive.sh (JVMTM_CLOSURE_DIR) |
— |
| Reserve provenance / funding attestation (3FR staged package) | config/reserve-provenance-package/README.md, scripts/validation/validate-reserve-provenance-package.sh |
— |
| DBIS institutional JSON (settlement, registry, trust/governance/policy) | config/dbis-institutional/README.md, scripts/validation/validate-dbis-institutional-schemas.sh, scripts/verify/sync-blockscout-address-labels-from-registry.sh |
— |
| ISO-20022 → on-chain (methodology + multi-network intake) | 04-configuration/SMART_CONTRACTS_ISO20022_FIN_METHODOLOGY.md, 04-configuration/ISO20022_INTAKE_GATEWAY_CONTRACT_MULTI_NETWORK.md; Rail: dbis-rail/ISO_GATEWAY_AND_RELAYER_SPEC.md | — |
| GRU c V2 standards and implementation plan* | 04-configuration/GRU_C_STAR_V2_STANDARDS_MATRIX_AND_IMPLEMENTATION_PLAN.md | — |
| GRU standards profile | 04-configuration/GRU_STANDARDS_PROFILE.md, ../config/gru-standards-profile.json |
— |
| GRU FX onboarding checklist | 04-configuration/GRU_FX_CURRENCY_ONBOARDING_CHECKLIST.md | — |
| GRU ISO-4217 currency manifest | ../config/gru-iso4217-currency-manifest.json |
— |
| UTRNF / naming (symbols, registries) | 04-configuration/naming-conventions/README.md, 04-configuration/naming-conventions/01_UTRNF_REFERENCE.md, 04-configuration/naming-conventions/02_DBIS_NAMESPACE_AND_UTRNF_MAPPING.md | Complements GRU c* V2 matrix; 03–04 planned |
| Operational runbooks | 03-deployment/OPERATIONAL_RUNBOOKS.md | RUNBOOKS_MASTER_INDEX.md — use OPERATIONAL_RUNBOOKS as single source |
| Contract / address status | 11-references/ADDRESS_MATRIX_AND_STATUS.md, 11-references/CONTRACT_ADDRESSES_REFERENCE.md, 11-references/CONTRACT_NEXT_STEPS_LIST.md (64-addr check) | CONTRACT_INVENTORY_AND_VERIFICATION (deleted) |
| Proxmox VMIDs, LAN IPs, NPM targets | 04-configuration/ALL_VMIDS_ENDPOINTS.md (includes Proxmox Mail Proxy VMID 100 / 192.168.11.32), config/ip-addresses.conf, 11-references/NETWORK_CONFIGURATION_MASTER.md, config/proxmox-operational-template.json |
Dated inventories under docs/archive/ (paths on disk only) |
| FQDN → expected content (web / API / RPC) | 04-configuration/FQDN_EXPECTED_CONTENT.md | — |
| Sankofa / Phoenix public vs portal vs admin endpoints (fix list) | 03-deployment/SANKOFA_PHOENIX_PUBLIC_PORTAL_ADMIN_ENDPOINT_CORRECTION_TASKS.md | — |
| Sankofa marketplace surfaces (native vs partner offerings; IRU catalog vs portal SSO vs Studio landing) | 03-deployment/SANKOFA_MARKETPLACE_SURFACES.md | — |
| IP conflict resolutions | reports/status/IP_CONFLICTS_RESOLUTION_COMPLETE.md, scripts/resolve-ip-conflicts.sh |
— |
| Wormhole AI docs (LLM / MCP / RAG) | 04-configuration/WORMHOLE_AI_RESOURCES_LLM_PLAYBOOK.md, 04-configuration/WORMHOLE_AI_RESOURCES_RAG.md, scripts/doc/sync-wormhole-ai-resources.sh, scripts/verify/verify-wormhole-ai-docs-setup.sh, mcp-wormhole-docs/ |
Wormhole protocol reference only — not Chain 138 canonical addresses (use 11-references/EXPLORER_TOKEN_LIST_CROSSCHECK.md, CCIP runbooks for 138) |
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