Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

txnbuild: Use correct account in ClaimableBalanceID() #3406

Merged
merged 2 commits into from
Feb 16, 2021

Conversation

tamirms
Copy link
Contributor

@tamirms tamirms commented Feb 12, 2021

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    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

ClaimableBalanceID() builds an xdr.OperationId using the operation source account and the sequence number of the operation source account. It seems like we should be using the transaction source account and the sequence number found in the transaction. That is my understanding based on https://github.com/stellar/stellar-core/blob/b0cc4a9b8c3423358d1881b991834cf658bc38f5/src/transactions/CreateClaimableBalanceOpFrame.cpp#L278[…]L288

This fix was actually included in the v6 release #3393 . However, @leighmcculloch and @marcelosalloum would like to create a patch release for just this fix instead of including it in a major version release.

Known limitations

[N/A]

Copy link
Contributor

@Shaptic Shaptic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Minor notes added.


balanceId, err := tx.ClaimableBalanceID(0)
assert.NoError(t, err)
assert.Equal(t, "0000000095001252ab3b4d16adbfa5364ce526dfcda03cb2258b827edbb2e0450087be51", balanceId)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How did you determine this ID to compare against?

This depends on your answer to the above, but do you think it'd be possible to make/modify one of the integration tests such that it actually fails without your changes? The existing TestProtocol15Basics/BalanceIDs test passes without this change, which obviously led to a false sense of security in the feature's correctness, so it'd be good to have deeper validation for this fix in future test runs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this test will fail without my changes because the claimable balance operation source account is different from the transaction source account

txnbuild/transaction.go Show resolved Hide resolved
txnbuild/CHANGELOG.md Show resolved Hide resolved
@tamirms tamirms merged commit ad5f790 into stellar:release-txnbuild-v5.0.1 Feb 16, 2021
@tamirms tamirms deleted the horizonclient-v5.0.1 branch February 16, 2021 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants