Skip to content

Sync SAC event doc-comments to CAP-67 shapes - #2704

Merged
leighmcculloch merged 1 commit into
mainfrom
sac-cap67-event-doc-comments
Jul 28, 2026
Merged

Sync SAC event doc-comments to CAP-67 shapes#2704
leighmcculloch merged 1 commit into
mainfrom
sac-cap67-event-doc-comments

Conversation

@leighmcculloch

@leighmcculloch leighmcculloch commented Jul 27, 2026

Copy link
Copy Markdown
Member

What

Update the set_authorized, mint, and clawback event doc-comments in the embedded StellarAssetInterface code block on the Stellar Asset Contract page to the CAP-67 event shapes.

Why

CAP-0067 removed the admin topic from these SAC events and appended a trailing SEP-11 asset topic, but this page's embedded copy of the interface still showed the pre-CAP-67 shapes. stellar/rs-soroban-sdk#1956 fixed this in the soroban-sdk. This change syncs the docs to match the sdk.

Close #2593

@stellar-jenkins-ci

Copy link
Copy Markdown

Something went wrong with PR preview build please check

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Syncs three embedded SAC event comments with CAP-67 and the Rust SDK.

Changes:

  • Adds the SEP-11 asset topic.
  • Removes the obsolete clawback admin topic.
  • However, #2593’s broader event-schema documentation remains incomplete.

Recommendation: NEEDS-CHANGES — fully address #2593 or leave it open.

Comment on lines +193 to +194
/// Emits an event with topics `["mint", to: Address,
/// sep0011_asset: String], data = amount: i128`

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Defer to @kalepail on this. I'll still link this issue and let it close, and then I'll defer to him if he wants to reopen it for that part of it. I think this PR resolves the immediate inconsistency, but we might want to do something here wrt comparison tables.

@ElliotFriend ElliotFriend added the raven issues discovered by Stellar Raven QA passes label Jul 28, 2026
@leighmcculloch
leighmcculloch merged commit 0252331 into main Jul 28, 2026
9 of 10 checks passed
@leighmcculloch
leighmcculloch deleted the sac-cap67-event-doc-comments branch July 28, 2026 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

raven issues discovered by Stellar Raven QA passes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the SAC and CAP-67 asset event schema

4 participants