docs(client): correct closeSubscriptionAuthority description - #219
docs(client): correct closeSubscriptionAuthority description#219dev-jodee wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Greptile SummaryThis docs-only PR corrects a misleading description for
Confidence Score: 5/5Docs-only change with no code or behavior modification; safe to merge. The change is limited to a single table row in a README. The corrected description accurately reflects the on-chain semantics of closeSubscriptionAuthority (PDA close + rent only, no SPL delegate revocation) and appropriately steers users to revokeSubscriptionAuthority for spend revocation. No logic, tests, or generated code are touched. No files require special attention. Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant closeSubscriptionAuthority
participant revokeSubscriptionAuthority
participant SubscriptionAuthorityPDA
participant ATA_SPLDelegate
Note over User: Wants to stop all spending
User->>closeSubscriptionAuthority: call (old, incorrect "kill switch")
closeSubscriptionAuthority->>SubscriptionAuthorityPDA: close PDA + reclaim rent
Note over ATA_SPLDelegate: SPL delegate still active!
ATA_SPLDelegate-->>User: delegations remain live
Note over User: Correct approach
User->>revokeSubscriptionAuthority: call
revokeSubscriptionAuthority->>ATA_SPLDelegate: revoke SPL delegate
revokeSubscriptionAuthority->>SubscriptionAuthorityPDA: close PDA + reclaim rent
ATA_SPLDelegate-->>User: spending stopped
Reviews (6): Last reviewed commit: "docs(client): correct closeSubscriptionA..." | Re-trigger Greptile |
Compute Unit Report
🔺 increase · 🔻 decrease · – unchanged · 🆕 new · 🗑 removed (vs Generated: 2026-07-24 |
94f690d to
14c7aa4
Compare
14c7aa4 to
9970aa2
Compare
9970aa2 to
9030ae1
Compare
9030ae1 to
c30d417
Compare
Pull Request is not mergeable
Pull Request is not mergeable
Pull Request is not mergeable
closeSubscriptionAuthority only closes the SubscriptionAuthority PDA and returns rent; it does not revoke the ATA's SPL delegate, and a same-slot re-init reuses init_id to keep delegations live. Drop the "kill switch" wording and point spend-revocation to revokeSubscriptionAuthority.
c30d417 to
7388d07
Compare
Stacked on #218.
Summary
Docs-only (
clients/typescript/README.md). ThecloseSubscriptionAuthorityrow called it a "kill switch (invalidating all delegations)", but that instruction only closes theSubscriptionAuthorityPDA and returns rent — it does not revoke the ATA's SPL delegate, and a same-slot re-init reusesinit_idto keep delegations live. The actual spend kill switch isrevokeSubscriptionAuthority(which revokes the SPL delegate).closeSubscriptionAuthorityentry to state PDA-close + rent only, steer spend-revocation torevokeSubscriptionAuthority, and note theinit_id/slot caveat.Test Plan
just fmtclean. No code/behavior change.