protocols/horizon: Add memo_bytes field to transaction response #2485
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
, orall
ordoc
if the changes are broad or impact manypackages.
Thoroughness
.md
files, etc... affected by this change). Take a look in the
docs
folder 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
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]