docs: document forwarded RGB issuance methods on the account#23
Draft
Zhekinmaksim wants to merge 1 commit into
Draft
docs: document forwarded RGB issuance methods on the account#23Zhekinmaksim wants to merge 1 commit into
Zhekinmaksim wants to merge 1 commit into
Conversation
The README states RGB issuance 'is not part of this module's API', but WalletAccountRgbLightning forwards issueAssetNia/Uda/Cfa/Ifa and inflate straight to the binding (src/wallet-account-rgb-lightning.js L667-L670, L705), under a section comment labelled 'RGB asset issuance + transfers - wired'. That left the documented surface and the actual surface out of sync. This is a docs-only change that makes the README match the code: - add a 'RGB issuance (forwarded)' row to the Account API table - reword the two 'not part of this module' lines to say the calls are forwarded here, while keeping @utexo/wdk-wallet-rgb as the recommended issuance path No code changes; behaviour is unchanged.
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
1 participant
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.
Follow-up to #22.
The README says RGB issuance "is not part of this module's API," but
WalletAccountRgbLightningforwardsissueAssetNia/issueAssetUda/issueAssetCfa/issueAssetIfaandinflatestraight to the binding (src/wallet-account-rgb-lightning.jsL667-L670, L705), under a section comment labelledRGB asset issuance + transfers — ✅ wired.This is the documentation resolution from that issue — the smaller of the two options. It makes the README describe the surface that actually exists:
RGB issuance (forwarded)row to the Account API table@utexo/wdk-wallet-rgbDocs-only, no behaviour change. If you'd rather go the other way — drop or deprecate the forwarders so issuance lives only in
wdk-wallet-rgb— I'm happy to swap this for that diff instead.