Docs and examples: CHANGELOG, README, API_REFERENCE, RECOMMENDATIONS, OMNL/transfer examples

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
defiQUG
2026-02-23 03:48:39 -08:00
parent 8df772fab0
commit 439a5d9e51
8 changed files with 529 additions and 8 deletions

39
docs/examples/README.md Normal file
View File

@@ -0,0 +1,39 @@
# FQBM Examples
Canonical, referenceable examples for the Four-Quadrant Balance Sheet Matrix (FQBM) and its integrations.
## Stored example: Transfer due diligence, M1 creation, and FQBM → MIFOS/Fineract API
**Primary reference:** [TRANSFER_DUE_DILIGENCE_AND_M1_CREATION.md](TRANSFER_DUE_DILIGENCE_AND_M1_CREATION.md)
This document stores the full end-to-end example and is the **single reference** for:
1. **Narrative** — Due diligence PDF with MT-103 (900B USD M0); GRU exchange (309B M00 USD); OMNL ledger (900B USD M0 + 350B M00 EUR); M1 EUR/USD creation under GRU Monetary Policies.
2. **Distribution** — 15 entities each receive a portion of the M1 (funds downloaded).
3. **Transmission** — Each entity can transmit the fully compliant SWIFT DOT-FIN file and appropriate ISO 20022 messages **in whole or in parts**.
4. **FQBM mapping** — State variables (B, R, C, Loans, Deposits, E_cb, E_b, L_cb, etc.), identities, and DOT-FIN integration.
5. **Proper entries: FQBM → MIFOS/Fineract via API** — How to post matrix state (and DOT-FIN-derived entries) to Apache Fineract as GL journal entries; mapping table (FQBM variable → Fineract GL); double-entry and idempotency rules; flow for 15-entity distribution.
Use this example when implementing:
- SWIFT DOT-FIN parsing and application to FQBM state.
- Multi-entity serialization (DOT-FIN and ISO 20022, whole or in parts).
- **API integration from the Quadrant Balance Sheet Matrix to MIFOS/Fineract** (proper GL entries from FQBM deltas).
---
## OMNL Central Bank ledger (GRU M1 conversion & allocations)
**Operational ledger:** [OMNL_CENTRAL_BANK_LEDGER_GRU_M1.md](OMNL_CENTRAL_BANK_LEDGER_GRU_M1.md)
Cleaned, compliance-ready detailed transactional ledger for OMNL Central Bank:
- **Chart of accounts** with **FQBM quadrant and state-variable mapping** (GL → FQBM).
- **Section A:** Opening balance (T-001) — 900B USD M0.
- **Section B:** Treasury conversion (T-100, T-101) — 250B M0 segregated, 1,250B M1 created (1:5 GRU ratio); T-101 is a compound double-entry balanced entry.
- **Section C:** M1 distributions (T-201A/B, T-202A/B, T-203T-207) — allocations to Shamrayan, HYBX, TAJ, Aseret, Mann Li, OSJ (Client 7), Alltra; total allocated 568B.
- **Section D:** Post-transaction summary (reconciled); Client 1 remaining M0 650B, M1 Treasury 682B.
- **Section E:** Client 7 sub-entity structure (7A7D) and internal transfer protocol.
- **§6:** Double-entry check for all entries, FQBM identity note, **idempotency references** for FQBM → MIFOS/Fineract API posting.
Use this ledger as the source of truth for posting the same entries to Fineract via API (see idempotency refs and GL mapping in the doc).