docs: document SAC recognition and SEP-41 event decoding - #347
docs: document SAC recognition and SEP-41 event decoding#347joan-bisbal wants to merge 3 commits into
Conversation
| @@ -0,0 +1,3 @@ | |||
| # SAC Recognition & Decoding Spec | |||
|
|
|||
| Implements first-class recognition and binary decoding for Stellar Asset Contracts. | |||
There was a problem hiding this comment.
This PR's title and commit message say it implements SAC recognition and binary decoding, but the diff is only this three-line file restating the description. No recognition logic, no decoder, no tests.
That work also already exists on dev: crates/indexer/src/parser/sac.rs is ~220 lines with 11 unit tests, landed under issue #262, and SacRegistry is wired into Parser::with_sac_registry. So there is nothing here to add on top of it.
Two more things to fix if you reopen this: the base branch should be dev (that is where all feature work lands, main trails it), and the file starts with a UTF-8 BOM, which we do not use anywhere else in docs/.
If you want to contribute to this area, the useful next step would be extending the existing decoder rather than re-describing it. Happy to point you at an open issue that still needs work.
|
Hey @joan-bisbal — thanks for this, the doc itself is genuinely useful and I'd like to get it merged. Two things to sort out first, both about framing rather than content. The title says Could you retitle it to The description could also do more work. Right now it says "Implements first-class recognition and binary decoding" — which repeats the same wrong implication. Something like this would be more accurate and more useful to a reviewer:
That way the title, the description, and the diff all agree with each other. Once that's updated I'm happy to merge. Let me know if you'd rather I just push the retitle myself. |
|
Thanks for the review. Both changes done:
Ready for re-review. |
Documents the existing SAC recognition and SEP-41 decoding path in the indexer (implemented in #262).
Covers how SacRegistry maps Soroban contract addresses to their underlying classic assets, which SEP-41 events the parser decodes (transfer, mint, burn, clawback), and how to extend the decoder for additional token standards.
No code changes -- documentation only.