f0fb00987a
- MASTER_PLAN gaps + §3.1 table rows for the-order / cutover - MASTER_TODO_EXPANDED: R21 [x]; Config/DNS GAPS tasks [x] - NOT_IMPLEMENTED: Sankofa/Order row = routing done, scope note - HIGH_PRIORITY R21–R24 line; BLITZKRIEG R21–R22 blurb Made-with: Cursor
104 lines
8.4 KiB
Markdown
104 lines
8.4 KiB
Markdown
# Not Implemented — Full Scope Reference
|
||
|
||
**Purpose:** Single entry point for "what is not implemented and what is the full scope."
|
||
**Related:** [VAULT_SYSTEM_MASTER_TECHNICAL_PLAN](../VAULT_SYSTEM_MASTER_TECHNICAL_PLAN.md), Phases 2–6; design plan (Cursor plan: not_implemented_full_scope_design).
|
||
|
||
---
|
||
|
||
## 1. CMC / CoinGecko submission
|
||
|
||
**Design summary:** No code change. Process: prepare payload from report API or existing package → submit via CoinGecko/CMC forms or partner API when available. Single canonical runbook ties prerequisites, step-by-step for Chain 138 then 651940, CMC in parallel, and "where to update when done."
|
||
|
||
| Deliverable | Path / description |
|
||
|-------------|--------------------|
|
||
| Runbook | [CMC_COINGECKO_SUBMISSION_RUNBOOK](../04-configuration/coingecko/CMC_COINGECKO_SUBMISSION_RUNBOOK.md) — prerequisites, export from report API, CoinGecko/CMC submission, when-done updates |
|
||
| Cross-references | [REQUIRED_FIXES_UPDATES_GAPS](../REQUIRED_FIXES_UPDATES_GAPS.md) §9, [PLACEHOLDERS_AND_TBD](../PLACEHOLDERS_AND_TBD.md) CMC/CoinGecko → link to runbook |
|
||
|
||
**Dependencies:** None. Can be done anytime.
|
||
|
||
---
|
||
|
||
## 2. Private XAU-anchored pools (Phase 2) and Stabilizer + executePrivateSwap (Phase 3)
|
||
|
||
**Design summary:**
|
||
- **Phase 2:** N pools (cUSDT↔XAU, cUSDC↔XAU, cEURT↔XAU); "private" = only Stabilizer/whitelisted keeper may execute swaps; liquidity provision optionally restricted. Option A: PrivatePoolRegistry records which pool IDs are private and restricts executePrivateSwap to those pools.
|
||
- **Phase 3:** Stabilizer contract implements Appendix A of [VAULT_SYSTEM_MASTER_TECHNICAL_PLAN](../VAULT_SYSTEM_MASTER_TECHNICAL_PLAN.md): `checkDeviation()`, `executePrivateSwap()` with block delay, per-block cap, slippage, gas check; routes via PrivatePoolRegistry / DODOPMMIntegration.
|
||
- **Phase 6:** Flash containment in same Stabilizer: TWAP source, sustained N-block deviation, per-block volume cap, recovery <3 blocks.
|
||
|
||
| Phase | Deliverable | Path / description |
|
||
|-------|-------------|--------------------|
|
||
| 2 | PrivatePoolRegistry.sol | `smom-dbis-138/contracts/` — register (tokenA, tokenB, poolAddress), `getPrivatePool(tokenIn, tokenOut)`, optional LP role |
|
||
| 2 | Deploy script + runbook | Script: create XAU-anchored pools via DODOPMMIntegration.createPool, register in PrivatePoolRegistry. Runbook: "Private stabilization pools (Phase 2)" with XAU_ADDRESS_138, cEURT_ADDRESS_138 |
|
||
| 3 | Stabilizer.sol | checkDeviation (peg manager + sustained N-block), executePrivateSwap (block delay, cap, slippage, gas), routing to PrivatePoolRegistry; STABILIZER_KEEPER_ROLE, ADMIN |
|
||
| 3 | Tests | Unit tests: checkDeviation below/above threshold, sustained vs single-block; executePrivateSwap reverts (delay, cap, slippage) |
|
||
| 3 | Runbook | "Stabilizer deployment and configuration" — thresholdBps, minBlocksBetweenExecution, maxStabilizationVolumePerBlock, maxSlippageBps, maxGasPriceForStabilizer; grant STABILIZER_KEEPER_ROLE |
|
||
| 6 | Flash containment | In Stabilizer: TWAP source, sustainedDeviationBlocks, per-block cap; document "flash drain recovery <3 blocks" in runbook |
|
||
|
||
**Dependencies:** Phase 2 before Phase 3 (Stabilizer needs private pools). Phase 6 extends Phase 3 (same contract).
|
||
|
||
---
|
||
|
||
## 3. Cross-chain arbitrage (Phase 4)
|
||
|
||
**Design summary:** Off-chain bot recommended: poll price on Chain 138 and 651940 (report API or RPC + DEX), if |Price138 − Price651940| > ArbitrageThreshold then execute (bridge + swap via AlltraAdapter/AlltraCustomBridge). Optional on-chain: contract emitting CrossChainDeviation for bot to listen. Bridge buffer: BridgeReserve ≥ PeakBridgeOutflow × Latency (runbook + optional alert).
|
||
|
||
| Deliverable | Path / description |
|
||
|-------------|--------------------|
|
||
| Design doc | [CROSS_CHAIN_ARBITRAGE_DESIGN](../07-ccip/CROSS_CHAIN_ARBITRAGE_DESIGN.md) — architecture, data flow, env (RPC_URL_138, RPC_URL_651940, AlltraAdapter, ArbitrageThreshold), failure modes, bridge buffer formula |
|
||
| Bot skeleton (optional) | TypeScript/Node in `smom-dbis-138/services/` or dbis_core — config, loop: fetch prices → deviation → if over threshold call AlltraAdapter + swap on destination |
|
||
| Runbook section | "Cross-chain parity and bridge buffer" in [OPERATIONS_RUNBOOK](../../smom-dbis-138/docs/OPERATIONS_RUNBOOK.md): BridgeReserve ≥ PeakBridgeOutflow × Latency; measure peak outflow and latency; alert when reserve below |
|
||
|
||
**Dependencies:** AlltraAdapter/AlltraCustomBridge deployed; report API or price source on both chains.
|
||
|
||
---
|
||
|
||
## 4. Full on-chain flash containment (Phase 6)
|
||
|
||
**Design summary:** Implement inside Stabilizer (Phase 3 contract): (1) TWAP from DODO pool or external oracle; (2) sustained deviation via circular buffer (last N blocks all > thresholdBps); (3) per-block volume cap; (4) document "flash drain recovery <3 blocks" and optional cooldown after large deviation.
|
||
|
||
| Deliverable | Path / description |
|
||
|-------------|--------------------|
|
||
| Implementation | Same as Phase 3 Stabilizer + extension: TWAP source, sustained-deviation buffer, per-block cap in [Stabilizer](../../smom-dbis-138/contracts/) (when implemented) |
|
||
| Runbook / Master Plan | [OPERATIONS_RUNBOOK](../../smom-dbis-138/docs/OPERATIONS_RUNBOOK.md), [VAULT_SYSTEM_MASTER_TECHNICAL_PLAN](../VAULT_SYSTEM_MASTER_TECHNICAL_PLAN.md) §8/§16 — recovery target, Flash Loan Containment Checklist |
|
||
|
||
**Dependencies:** Phase 3 Stabilizer implemented first.
|
||
|
||
---
|
||
|
||
## 5. GAPS and other projects (Sankofa, the-order, dbis_core, network placeholders)
|
||
|
||
**Design summary:** Per-area checklists and specs; no new code in this plan except docs. Replace TBDs with real IPs/ports when deployed; document SDK/legal/vendor options and "when to implement" for Redis/Prometheus/PagerDuty; reserve or assign network blocks #2–#6.
|
||
|
||
| Area | Deliverables |
|
||
|------|--------------|
|
||
| **Sankofa / The Order** | **Routing done 2026-03** (NPM, ALL_VMIDS, RPC_ENDPOINTS_MASTER, SANKOFA_CUTOVER_PLAN v1.1, [SANKOFA_THE_ORDER_CHECKLIST](../04-configuration/SANKOFA_THE_ORDER_CHECKLIST.md)). This row retained for design-scope doc; implementation of app features (OMNIS SDK, legal vendors, etc.) remains separate. |
|
||
| **OMNIS — Sankofa Phoenix SDK** | Integration spec: required SDK interface (getAuthUrl, validateToken, getUserInfo), env vars, fallback. See [OMNIS_SANKOFA_PHOENIX_SDK_INTEGRATION_SPEC](../04-configuration/OMNIS_SANKOFA_PHOENIX_SDK_INTEGRATION_SPEC.md). Dependency note in PLACEHOLDERS_AND_TBD / PLACEHOLDERS_AND_COMPLETION_MASTER_LIST: "Blocked on Sankofa Phoenix SDK availability." |
|
||
| **the-order — legal-documents** | Vendor/implementation matrix (court-efiling, e-signature, document-security): Option, Prerequisites, Steps, "Where to update when done." See [LEGAL_DOCUMENTS_IMPLEMENTATION](LEGAL_DOCUMENTS_IMPLEMENTATION.md). Update GAPS_AND_RECOMMENDATIONS_CONSOLIDATED, PLACEHOLDERS_AND_COMPLETION_MASTER_LIST when done. |
|
||
| **dbis_core** | Runbook or comment "When to implement": Prometheus when monitoring stack is up; Redis when caching needed. See [DBIS_CORE_WHEN_TO_IMPLEMENT](DBIS_CORE_WHEN_TO_IMPLEMENT.md). No new code; doc/checklist only. |
|
||
| **Network placeholders** | Blocks #2–#6: decision "Reserved" or assign; doc update in NETWORK_ARCHITECTURE / NETWORK_CONFIGURATION_MASTER. See [NETWORK_PLACEHOLDERS_DECISION](NETWORK_PLACEHOLDERS_DECISION.md); "where to update when done" in REMAINING_COMPONENTS. |
|
||
|
||
**Dependencies:** None for documentation; implementation depends on each project’s timeline.
|
||
|
||
---
|
||
|
||
## 6. Dependency and execution order
|
||
|
||
- **No dependencies (can do in parallel):** CMC/CoinGecko runbook; NOT_IMPLEMENTED_FULL_SCOPE (this doc); GAPS per-area checklists; Cross-chain arbitrage design + optional bot.
|
||
- **Phase 2 → Phase 3:** PrivatePoolRegistry + private pool deploy/runbook before Stabilizer.
|
||
- **Phase 3 → Phase 6:** Stabilizer implementation before flash containment extension.
|
||
|
||
---
|
||
|
||
## 7. Summary table
|
||
|
||
| Item | Primary deliverable | Type |
|
||
|------|---------------------|------|
|
||
| CMC/CoinGecko | CMC_COINGECKO_SUBMISSION_RUNBOOK.md | Doc (process) |
|
||
| Private XAU pools | PrivatePoolRegistry.sol + deploy/runbook | Contract + doc |
|
||
| Stabilizer + executePrivateSwap | Stabilizer.sol + tests + runbook | Contract + tests + doc |
|
||
| Flash containment | Stabilizer extension + runbook | Contract + doc |
|
||
| Cross-chain arbitrage | CROSS_CHAIN_ARBITRAGE_DESIGN.md + optional bot | Doc + optional code |
|
||
| GAPS / other | NOT_IMPLEMENTED_FULL_SCOPE.md (this doc) + per-area checklists/specs | Doc |
|
||
|
||
All deliverables are scoped so implementation can proceed without ambiguity.
|