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 ToXDR functions which do not return errors #2651

Merged
merged 2 commits into from
Jun 3, 2020

Conversation

tamirms
Copy link
Contributor

@tamirms tamirms commented Jun 2, 2020

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 ToXDR() functions for Transaction and FeeBumpTransaction instances which return xdr transaction envelopes without errors.

Why

The reason why TxEnvelope() returns an error is that it copies the internal transaction envelope by marshaling and unmarshaling the value. However, if we return a reference to the internal transaction we do not need to handle any error cases. Most users probably will not be modifying the contents of the returned transaction envelope. Having a function which returns a transaction envelope without a possible error is more ergonomic.

Known limitations

[N/A]

@tamirms tamirms merged commit 911cb5f into stellar:release-horizonclient-v3.2.0 Jun 3, 2020
@tamirms tamirms deleted the to-xdr branch June 3, 2020 15:54
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