f3d2961b97
Some checks failed
CI/CD Pipeline / Lint and Format (push) Failing after 46s
CI/CD Pipeline / Terraform Validation (push) Failing after 35s
CI/CD Pipeline / Kubernetes Validation (push) Successful in 37s
Deploy ChainID 138 / Deploy ChainID 138 (push) Failing after 1m50s
HYBX OMNL TypeScript & anchor / token-aggregation build + reconcile artifact (push) Failing after 2m19s
Validation / validate-genesis (push) Successful in 51s
Validation / validate-terraform (push) Failing after 39s
Validation / validate-kubernetes (push) Failing after 10s
CI/CD Pipeline / Solidity Contracts (push) Failing after 12m56s
Validation / validate-smart-contracts (push) Failing after 12s
CI/CD Pipeline / Security Scanning (push) Failing after 15m52s
Validation / validate-security (push) Failing after 10m59s
Validation / validate-documentation (push) Failing after 17s
Validate Token List / validate (push) Failing after 30s
OMNL reconcile anchor / Run omnl:reconcile and upload artifacts (push) Failing after 26s
Verify Deployment / Verify Deployment (push) Failing after 56s
68 lines
3.1 KiB
Markdown
68 lines
3.1 KiB
Markdown
# OMNL IPSAS / GL validation API (token-aggregation)
|
|
|
|
Endpoints are served under **`/api/v1`** when the token-aggregation service is running. They tie **on-chain OMNL compliance** to **IPSAS-aligned GL codes** documented for OMNL Hybx (Fineract).
|
|
|
|
**Discovery:** `GET /api/v1/omnl/catalog` — machine-readable list of all OMNL routes, auth notes, and query parameters.
|
|
|
|
**OpenAPI 3:** `GET /api/v1/omnl/openapi.json` — static OpenAPI 3.0 document for Swagger UI, Postman import, and codegen.
|
|
|
|
## Configuration files (smom-dbis-138)
|
|
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| [`config/omnl-ipsas-gl-registry.json`](../../config/omnl-ipsas-gl-registry.json) | Canonical GL codes (1000, 1050, 2000, 2100, 3000), IPSAS references, allowed pairs, monetary-layer hints |
|
|
| [`config/omnl-journal-matrix.json`](../../config/omnl-journal-matrix.json) | T-001…T-008 journal lines |
|
|
|
|
Override paths with `OMNL_IPSAS_GL_REGISTRY` and `OMNL_JOURNAL_MATRIX_PATH` if needed.
|
|
|
|
## Fineract (live compare & health)
|
|
|
|
Set:
|
|
|
|
- `OMNL_FINERACT_BASE_URL`
|
|
- `OMNL_FINERACT_TENANT` (default `omnl`)
|
|
- `OMNL_FINERACT_USER` (default `app.omnl`) — or legacy **`OMNL_FINERACT_USERNAME`**
|
|
- `OMNL_FINERACT_PASSWORD`
|
|
- `OMNL_FINERACT_GL_PAGE_LIMIT` (pagination for large tenants)
|
|
|
|
| Method | Path | Description |
|
|
|--------|------|-------------|
|
|
| GET | `/omnl/ipsas/fineract-health` | Probe `/glaccounts?limit=1` — returns `ok`, `statusCode`, `configured` |
|
|
| GET | `/omnl/ipsas/fineract-compare` | Full GL list vs registry (requires **`OMNL_API_KEY`** when that env is set) |
|
|
|
|
## IPSAS validation
|
|
|
|
| Method | Path | Description |
|
|
|--------|------|-------------|
|
|
| GET | `/omnl/ipsas/registry` | Full IPSAS GL registry JSON |
|
|
| GET | `/omnl/ipsas/matrix` | Journal matrix entries |
|
|
| GET | `/omnl/ipsas/validate-pair?debitGlCode=&creditGlCode=` | Validate one pair (registry + matrix) |
|
|
| POST | `/omnl/ipsas/validate-pairs` | Body: `{ "pairs": [{ "debitGlCode", "creditGlCode" }, ...] }` — batch validation |
|
|
| GET | `/omnl/ipsas/layer/:layer` | `m0_reserve` \| `m1_liability` \| `settlement` \| `equity` |
|
|
| GET | `/omnl/ipsas/compliance-context/:lineId?aggregated=1` | Compliance snapshot + IPSAS guidance (**`OMNL_API_KEY`** when set) |
|
|
|
|
## Cross-cutting OMNL APIs (same `/api/v1` prefix)
|
|
|
|
| Method | Path | Description |
|
|
|--------|------|-------------|
|
|
| GET | `/omnl/reconcile-anchor` | SHA-256 of canonical IPSAS registry + journal matrix (same as `omnl-reconcile-report.mjs`) |
|
|
| GET | `/omnl/integration-status` | Booleans for configured env groups (no secrets) |
|
|
| GET | `/omnl/cross-chain-lines` | `hybx-omnl-cross-chain-lines.json` content + path |
|
|
| GET | `/omnl/zk-verifier` | Address from `OMNL_ZK_VERIFIER` |
|
|
| GET | `/omnl/mirror-coordinator?chainId=138` | On-chain `mirrorChainSelector`, `mirrorReceiver`, `feeToken` |
|
|
|
|
## Example
|
|
|
|
```http
|
|
GET /api/v1/omnl/ipsas/validate-pair?debitGlCode=1050&creditGlCode=2000
|
|
```
|
|
|
|
```http
|
|
POST /api/v1/omnl/ipsas/validate-pairs
|
|
Content-Type: application/json
|
|
|
|
{"pairs":[{"debitGlCode":"1050","creditGlCode":"2000"}]}
|
|
```
|
|
|
|
Expect `ipsasCompliantPair: true` when the pair is allowed in the registry or matrix.
|