txnbuild: Add helper to calculate claimable balance IDs without submitting transactions. #3122
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
This is a cleaner design than returning a list of IDs, because it actually enforces a correlation between the returned ID and a specific operation. Otherwise, it's strange to have the returned array be different that the list of operations in the transaction.
Shaptic
force-pushed
the
balanceid-helper
branch
from
6523a47 to
ede3b89
Compare
This was referenced Oct 13, 2020
howardtw
reviewed
Oct 13, 2020
There was a problem hiding this comment.
Thanks for doing this! I left a couple of nitpicks. This PR looks good to me, but I'd defer the approval to @leighmcculloch to make sure it looks good to him too before you merge the PR.
leighmcculloch
approved these changes
Oct 13, 2020
Docstrings and return values are cleaned up Co-authored-by: Howard Tinghao Chen <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]>
3 tasks
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.
PR Checklist
PR Structure
otherwise).
services/friendbot, orallordocif the changes are broad or impact manypackages.
Thoroughness
.mdfiles, etc... affected by this change). Take a look in the
docsfolder for a given service,like this one.
Release planning
needed with deprecations, added features, breaking changes, and DB schema changes.
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
What
Balance IDs are a crucial piece of information when dealing with claimable balances. They are highly predictable by design, and so SDK users shouldn't need to submit the transaction to determine the ID.
This PR introduces a helper within the txnbuild package:
It returns a claimable balance ID for the particular operation within the transaction, assuming it is of the type
CREATE_CLAIMABLE_BALANCE.It also introduces an integration test to confirm this behavior. Since it's appended to an existing test, this only adds a few extra seconds of running time. I believe this also only can be integration tested since we need Core to actually run the calculation as well, but I'd love to be wrong.
Why
Closes #3116.
Known limitations
Obviously, this only applies to the Go SDK.
(added @jonjove to review to sanity-check the balance ID calculation and @leighmcculloch purely for visibility on the txnbuild changelog)