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: add AddSignatureDecorated to FeeBumpTransaction #4174

Merged
merged 3 commits into from
Jan 12, 2022
Merged

txnbuild: add AddSignatureDecorated to FeeBumpTransaction #4174

merged 3 commits into from
Jan 12, 2022

Conversation

leighmcculloch
Copy link
Member

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

Add AddSignatureDecorated to FeeBumpTransaction.

Why

The function exists on Transaction but not on FeeBumpTransaction. I am writing some code that needs to be able to add decorated signatures to fee bump transactions in the same way we can add them to regular transactions.

Known limitations

N/A

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
chenrui333 Rui Chen
@leighmcculloch leighmcculloch changed the title txnbuild: add AddSignatureDecorate to FeeBumpTransaction txnbuild: add AddSignatureDecorated to FeeBumpTransaction Jan 11, 2022

Verified

This commit was signed with the committer’s verified signature.
Copy link
Contributor

@nikhilsaraf nikhilsaraf left a comment

Choose a reason for hiding this comment

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

LGTM! 🎉

func (t *FeeBumpTransaction) AddSignatureDecorated(signature ...xdr.DecoratedSignature) (*FeeBumpTransaction, error) {
extendedSignatures, err := concatSignatureDecorated(t.envelope, t.Signatures(), signature)
if err != nil {
return nil, err
Copy link
Contributor

Choose a reason for hiding this comment

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

generally prefer wrapping errors so the context isn't lost

Copy link
Member Author

@leighmcculloch leighmcculloch Jan 12, 2022

Choose a reason for hiding this comment

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

I often do that too, but there is a series of add signature functions of which this is just one variation that was missing on this type and this is how they all work, with the errors being well defined within the concat functions.

kp0 := newKeypair0()
kp1 := newKeypair1()

tx, err := NewTransaction(TransactionParams{
Copy link
Contributor

Choose a reason for hiding this comment

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

this new transaction creation could go into a helper function since it seems to be used as the standard transaction across multiple tests

Copy link
Member Author

Choose a reason for hiding this comment

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

It could, but then the tests would become more coupled together. I've found it is easier to maintain tests in the long run if they are mostly independent of each other. Helper functions can be helpful, but they will also narrow the inputs to tests, or balloon into big configurable things of their own. Also this way they act as an example of the public API as much as possible.

@leighmcculloch leighmcculloch enabled auto-merge (squash) January 12, 2022 00:07
@leighmcculloch leighmcculloch merged commit ce5f636 into stellar:master Jan 12, 2022
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.

None yet

2 participants