safe-global / safe-client-gateway / 36135650865

65%

Build Type

push

github

Committed by web-flow

Commit Message

feat(policies): add the policy indexer client for allowance-module state (#3392)

* feat(policies): add the policy indexer client for allowance-module state

The Policy Indexer aggregates module and guard logs into current-state rows, so
CGW reads state and folds no events itself. This client reads the
allowance-module half: SafeAllowance and SafeDelegate, and nothing else. Guard
bindings live in SafePolicy, which is a field this PR deliberately does not
request - a type it cannot report is a field it should not pay for, and the PR
that reports them adds it.

One request covers any number of Safes on any number of chains, which is what
lets a Space-level read cost one round-trip instead of one per Safe.

Five properties of the read contract, each verified against the live endpoint,
shape the code - and each is silently wrong if ignored:

- `numeric` columns serialise as decimal strings. Base units stay strings all
  the way to the wire, because parsing an 18-decimal amount into a number
  truncates it into a plausible, wrong figure. Seconds and minutes are
  converted, and rejected rather than truncated if they would not fit.
- `chainId` is an Int upstream and a string everywhere in CGW, converted once at
  the schema boundary.
- addresses are stored checksummed, and a lower-cased address in a filter
  matches nothing *and returns no error* - so the repository checksums before
  asking, or a Safe silently reads as having no policies.
- `resetphase` and the other enum-looking columns are custom scalars rather than
  GraphQL enums, so their value sets are validated here. An unrecognised reset
  phase reads as ASSUMED - the pessimistic answer - rather than as exact.
- pairs are grouped per chain under `_or`. A flat chainId/safe pair of `_in`
  filters is a cross-product, which returns rows for a Safe on a chain it is not
  held on.

Per-row validation is lenient and logged: a row shape added by a newer indexer
release must not blank a Safe's policies. A ... (continued)

Coverage Stats

4410 of 5194 branches covered (84.91%)

Branch coverage included in aggregate %.

127 of 137 new or added lines in 11 files covered. (92.7%)

2 existing lines in 2 files now uncovered.

11246 of 12365 relevant lines covered (90.95%)

537.35 hits per line