Encode claimable balance ids to match Horizon in JSON #368
Conversation
This file contains 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
|
I'd like to merge this change to accompany #347 and #360, and release them all in a minor release. However, since this change changes the JSON format, it is a breaking change. We've always said internally that the JSON format was experimental and unstable, but never actually said that in the docs for the crate. In any case it's pretty important not to introduce a breaking change into the JSON anywhere it'd cause the CLI to break with data it caches to disk. Given claimable balances don't overlap with Soroban usage at all and the only CLI usage is for Soroban only txs, it's probably an extremely low likelihood and low impact change to make. |
dmkozh
approved these changes
May 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Encode claimable balance ids to match Horizon in JSON
Why
Claimable balances are rendered as a hex string contained in an object with the v0 discriminant.
In Horizon, claimable balance IDs are rendered by hex encoding the XDR for the object structure.
Given that folks are used to the Horizon rendering, we should use that in the JSON <> XDR as well.
Close #367