Skip to content

feat: add typed compliance readiness checker - #215

Open
woahwhattheheck wants to merge 8 commits into
Raegis-RWA:mainfrom
woahwhattheheck:fix/143-compliance-readiness-20261008-sol56
Open

woahwhattheheck wants to merge 8 commits into
Raegis-RWA:mainfrom
woahwhattheheck:fix/143-compliance-readiness-20261008-sol56

Conversation

@woahwhattheheck

@woahwhattheheck woahwhattheheck commented Oct 8, 2026 •

Copy link
Copy Markdown

Closes #143.

Adds checkReadiness(address), public readiness types and reason codes, state mapping, and dashboard/API documentation. Approved, blocked, revoked, pending, unknown and unavailable remain distinct; only approved is eligible. Readiness reports protocol state and does not assert legal KYC completion.

Unsuccessful, result-less and restoration-required RPC simulations return unavailable with verified:false. Successful parsed ScVal booleans map to approved or blocked; unexpected values map to unknown. The existing checkWhitelist false fallback is preserved.

Both compliance reads fetch the configured keypair public key as the simulation source, or the checked address for a read-only client, and build a real unsigned transaction with the configured network passphrase. The simulation source must exist on that network; an unavailable source yields unavailable readiness or a legacy read rejection. Neither read signs or submits a transaction.

Validation: npm test -- --runInBand tests/compliance-readiness.test.ts passed one suite with 18 tests using the locked official @stellar/stellar-sdk 12.3.0. The added regression cases execute TransactionBuilder and real transaction XDR serialization for both simulation-source choices, assert no signatures or transaction submission, and verify the legacy parsed-ScVal positive/negative boolean results. Existing readiness failure/restoration/unknown cases also pass. Broad lint/build/full-suite/compatibility checks were not run; no green CI status is asserted.

I am claiming this contribution under woahwhattheheck and requesting the applicable GrantFox/FWC26 reward. Please confirm assignment/evaluation, the reward amount and the settlement process.

/claim #143

I, @woahwhattheheck, affirmatively request evaluation and any applicable GrantFox OSS / Official Campaign (FWC26) reward and payment for this original contribution. Please preserve @woahwhattheheck as claimant and payee.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement Aegis SDK compliance readiness checker

1 participant