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

protocols/horizon: Add memo_bytes field to transaction response #2485

Merged
merged 5 commits into from
Apr 17, 2020

Conversation

tamirms
Copy link
Contributor

@tamirms tamirms commented Apr 14, 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

Close #2458

Add memo_bytes field to the Horizon transaction response. memo_bytes contains the base64 encoding of the original byte sequence set in the transaction envelope's memo field.

Why

As noted in #2022 , the memo value in a transaction can be an arbitrary binary blob even if the memo type is text. When horizon ingests transactions, it tries to store the memo field as a utf8 string even if the memo value is not valid utf8.

The Java SDK tries to recover the original byte representation of the memo by decoding the XDR. See lightsail-network/java-stellar-sdk#259 . However, we would like to avoiding XDR decoding in the SDKs when deserializing Horizon responses. The XDR definitions are subject to change so the SDKs should be relying on Horizon's API to avoid manually parsing XDR.

If we can include a memo_bytes field in the Horizon transaction resource, which is present alongside the memo field when memo_type is "text", then the Java SDK can use memo_bytes to recover the original memo value without having to parse envelope_xdr.

Known limitations

[N/A]

@cla-bot cla-bot bot added the cla: yes label Apr 14, 2020
Copy link
Member

@ire-and-curses ire-and-curses left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -30,6 +30,7 @@ To learn more about the concept of transactions in the Stellar network, take a l
| fee_meta_xdr | string | A base64 encoded string of the raw `LedgerEntryChanges` xdr struct produced by taking fees for this transaction. |
| memo_type | string | |
| memo | string | |
Copy link
Member

Choose a reason for hiding this comment

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

Could you also add a comment to the original memo line, so that the reader can understand the difference between the two?

@tamirms tamirms merged commit 708ca21 into stellar:release-horizon-v1.2.0 Apr 17, 2020
@tamirms tamirms deleted the memo-bytes branch April 17, 2020 17:17
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