-
Notifications
You must be signed in to change notification settings - Fork 81
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for moving this guide forward. I left a couple comments.
Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>
Thank you @leighmcculloch for the review. I addressed your suggestions 😃 Let me know if I can do more to help. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a really great PR! Thanks for the excellent additions!
Hope you don't I pushed a couple commits to your branch:
The PR looks good to me! If @leighmcculloch is happy with it, I'm happy with it! |
Co-authored-by: Elliot Voris <elliot@voris.me>
Thank you @ElliotFriend for the review and the commits. I do prefer such active collaborations. From my perspective I would still like to have a short description about
But as I said above, I don't really understand it to explain it myself 😅 This could be kept for a follow up too of course. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple small tweaks otherwise LGTM! Thank you!
Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>
We should say I think something along the lines that the token::Client is a client for accessing the functions exposed by any SEP-41 compatible token contract. The token::StellarAssetClient exposes the functions of the Stellar Asset Contract that are not part of SEP-41 and not expected or required to be found on compatible token contracts. So other contracts integrating with SEP-41 token contracts should ideally not dependent on the Stellar Asset Contract's additional functions, otherwise they won't be able to support custom tokens that implement SEP-41. |
Oh and so this is why then burn and mint are not doubled in these 2 interfaces, they are exclusive. Got it, I will try to add that tomorrow (off for the day 😅, though feel free to not wait for me). But thanks, I thought I was doing something hacky by using two different clients! (From a pure DX perspective, that would be handy to have a client that would sort of merge both, if that makes sense.) I think we need to add 2 paragraph: on the Token page discuss the |
I debated this, and I think it'd be convenient. My reason for not including it is I thought it would end up with folks writing code that uses the Stellar Asset Client everywhere, and never the token client, and so building integrations with tokens that are dependent on Stellar Assets by accident when they otherwise might work fine without the additional functions. |
I did a suggestion for the clients. In the end, I only modified the SAC page, as I think it's fitting more. Otherwise the info would have been spread on 2 different pages, then it could be harder to connect the 2 things together.
Is it because that could mean additional cost as the WASM would need to pack more code if only the SEP-41 part is needed? |
@leighmcculloch @ElliotFriend is there anything else I can help with? |
I pushed a little tweak, will merge once verifying the preview deployment. |
cc @sisuresh |
@tupui Thanks for leading the charge on improving these docs!!! |
Thank you all for the help and collaborative work here, really enjoyed the process 😃 🚀 |
Closes #716
The "wrap" terminology has been changed to "deploy". This PR proposes a refactoring of the doc which correct the terminology. I also removed some duplication as to ease future maintenance. I also found it confusing to have multiple times the same info with slightly different explanation.
One thing I think should also be present is the clarification between
token::Client
andtoken::StellarAssetClient
. But here I actually don't really get the difference 😅In the doc example, there is this
which to me means that I could just use
token::Client
. But if I do that, I can justburn
but notmint
. And withtoken::StellarAssetClient
, I canmint
but notburn
.Last thing, I am also not sure if the SAC guide should not be integrated into the SAC page itself.
Let me know how I should modify this. Please feel free to to anything with this PR or push directly on the branch 😃
cc @leighmcculloch