Files
smom-dbis-138/services/checkpoint-indexer/README.md
defiQUG c336809676
Some checks failed
CI/CD Pipeline / Solidity Contracts (push) Failing after 1m3s
CI/CD Pipeline / Security Scanning (push) Successful in 2m18s
CI/CD Pipeline / Lint and Format (push) Failing after 34s
CI/CD Pipeline / Terraform Validation (push) Failing after 20s
CI/CD Pipeline / Kubernetes Validation (push) Successful in 22s
Deploy ChainID 138 / Deploy ChainID 138 (push) Failing after 40s
HYBX OMNL TypeScript & anchor / token-aggregation build + reconcile artifact (push) Failing after 49s
OMNL reconcile anchor / Run omnl:reconcile and upload artifacts (push) Failing after 21s
Validation / validate-genesis (push) Successful in 25s
Validation / validate-terraform (push) Failing after 21s
Validation / validate-kubernetes (push) Failing after 8s
Validation / validate-smart-contracts (push) Failing after 8s
Validation / validate-security (push) Failing after 1m11s
Validation / validate-documentation (push) Failing after 14s
Verify Deployment / Verify Deployment (push) Failing after 45s
Add mainnet checkpoint stack: ISO attestation, participant Etherscan surface, and services.
Ship AddressActivityRegistry V1/V2, ISO20022IntakeGateway, Chain138ParticipantSurface,
checkpoint hub contracts, checkpoint-core package, aggregator/indexer/sdk services,
relay profile guards, M00 diamond bridge facet, and OMNL compliance contracts.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-25 00:30:45 -07:00

49 lines
2.3 KiB
Markdown

# Checkpoint indexer REST API
Exposes v2 hub reads for wallets and explorers, plus an **Etherscan V2-shaped shim** for Chain 138 (unsupported on [official Etherscan V2 chainlist](https://api.etherscan.io/v2/chainlist)).
See: `docs/04-configuration/etherscan/CHAIN138_ETHERSCAN_V2_UNSUPPORTED_NETWORK_FRAMEWORK.md`
## Endpoints (v1)
| Method | Path | Description |
|--------|------|-------------|
| GET | `/health` | Liveness |
| GET | `/v1/checkpoint/latest` | Latest batch header |
| GET | `/v1/checkpoint/:batchId` | Historical batch |
| GET | `/v1/tx/:txHash/attestation` | Inclusion in batch |
| GET | `/v1/account/:address` | Account summary + attested activity |
| GET | `/v1/account/:address/transactions` | Batch-indexed txs for address |
| GET | `/v1/account/:address/activity` | Attested activity rows |
| GET | `/v1/tx/:txHash/logs` | Receipt logs from batch payload |
## Endpoints (v2 — Etherscan supplement)
| Method | Path | Description |
|--------|------|-------------|
| GET | `/v2/chainlist-supplement` | Supplemental chainlist (chain 138 + mainnet attestation layer) |
| GET | `/v2/api?chainid=138&module=account&action=balance` | Chain 138 balance (RPC) |
| GET | `/v2/api?chainid=138&module=account&action=txlist` | Blockscout tx list proxy |
| GET | `/v2/api?chainid=138&module=chain138&action=participantactivity` | Attested activity from batch index |
| GET | `/v2/api?chainid=138&module=chain138&action=attestation&txhash=0x…` | Per-tx attestation |
| GET | `/v2/api?chainid=138&module=proxy&action=eth_blockNumber` | Chain 138 block number |
| GET | `/v2/api?chainid=1&module=chain138mirror&action=contracts` | Mainnet mirror/registry/hub map |
| GET | `/v2/api?chainid=1&module=chain138mirror&action=participantlogs` | Etherscan V2 log proxy (credited topic2, debited topic3) |
| GET | `/v2/api?chainid=1&module=chain138mirror&action=mirrorlogs` | v1 TransactionMirror logs |
Env: `ADDRESS_ACTIVITY_REGISTRY_MAINNET`, `ETHERSCAN_API_KEY` (for mainnet log proxy).
## Run
```bash
cd smom-dbis-138/services/checkpoint-indexer
pnpm install && pnpm build
CHAIN138_MAINNET_CHECKPOINT_PROXY=0x… pnpm start
```
From repo root: `bash scripts/deployment/start-checkpoint-services.sh` (builds aggregator + indexer).
Default port: `3099` (`CHECKPOINT_INDEXER_PORT`).
Public NPM path (when configured): `https://explorer.d-bis.org/checkpoint/v2/...` → indexer.