feat: implement allowance expiry alert script (#78) - #730
Open
Abdullahi-Code9 wants to merge 2 commits into
Open
feat: implement allowance expiry alert script (#78)#730Abdullahi-Code9 wants to merge 2 commits into
Abdullahi-Code9 wants to merge 2 commits into
Conversation
|
@Abdullahi-Code9 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #584
📝 Description
This PR introduces
scripts/alert-expiring-allowances.ts, a proactive alerting system for expiring Stellar token allowances. By inspecting Soroban ledger keys directly, it detects upcoming allowance expiries before charges fail, generates structured reports, supports webhook dispatching, and provides an actionable exit code for CI/cron execution.🚀 Changes Made
1. Allowance Expiry Detection & Script
scripts/alert-expiring-allowances.ts: Implemented a new script that queries active subscribers and inspects their underlyingContractDataledger entries (liveUntilLedgerSeq) to identify allowances expiring within a configurable ledger window (ALERT_WINDOW_LEDGERS).2. Subscriber Optimization & Filtering
liveUntilLedgerSeq = 0) to prevent false alarms.SIM_SOURCEfor simulation sources to remove unnecessary RPC round-trips per subscriber check.3. Webhook Delivery & Automation Output
stdoutwith dry-run support (--dry-run).WEBHOOK_URLPOST alerts while maintaining exit code1whenever expiring allowances are detected (allowing for CI pipeline integration).4. Compiler Bug Fixes
scripts/health-check.ts: Updated top-level import to includeAccountfrom@stellar/stellar-sdkinstead of an invalid non-async dynamic import.scripts/export-merchant-report.ts: UpdatedledgerCloseTimetoDate.parse(event.ledgerClosedAt)to match the@stellar/stellar-sdkAPI update.🧪 Verification & Testing
Type Safety Verification
Verified strict TypeScript types across scripts without compiler errors: