feat(core, proto)!: make bridge unlock memo string#1244
Merged
SuperFluffy merged 1 commit intomainfrom Jul 9, 2024
Merged
Conversation
github-actions
bot
added
proto
SuperFluffy
force-pushed
the
superfluffy/memo-is-string
branch
from
9209cee to
67ff04a
Compare
noot
approved these changes
Jul 9, 2024
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
steezeburger
added a commit
that referenced
this pull request
Jul 15, 2024
* main: feat(cli): add cmd to collect withdrawal events and submit as actions (#1261) fix(core, bridge, sequencer)!: dismabiguate return addresses (#1266) fix(withdrawer): support withdrawer address that differs from bridge address (#1262) (core, sequencer)!: generate serde traits impls for all protocol protobufs (#1260) fix(charts): add resources for sequencer/cometbft (#1254) chore(sequencer)!: add metrics (#1248) fix(sequencer-utils): fixes issue in `parse_blob` tests (#1243) feat(core, proto)!: make bridge unlock memo string (#1244) fix(conductor): don't panic during panic (#1252) feat(core)!: lowerCamelCase for protobuf json mapping (#1250) refactor(bridge-withdrawer)!: refactor startup to a separate subtask and remove balance check from startup (#1190) fix: rollup archive node configurations (#1249) refactor(core, bridge-withdrawer)!: move bridge-unlock memo to core (#1245) fix(sequencer)!: store native asset ibc->trace mapping in init_chain (#1242)
steezeburger
added a commit
that referenced
this pull request
Jul 19, 2024
* main: (24 commits) chore: update `bytes` and `ics23` crates (#1279) fix(sequencer): improve and fix instrumentation (#1255) feature(charts): hermes chart fixes, bech32 updates, ibc bridge test (#1130) chore(cli): remove unused rollup cli code (#1275) chore(test): use a temporary file to not pollute the workspace (#1269) chore(sequencer): add mempool benchmarks (#1238) fix(bridge-withdrawer)!: fix nonce handling (#1215) feat(cli, bridge-withdrawer)!: share code between cli and service (#1270) feat(cli): add cmd to collect withdrawal events and submit as actions (#1261) fix(core, bridge, sequencer)!: dismabiguate return addresses (#1266) fix(withdrawer): support withdrawer address that differs from bridge address (#1262) (core, sequencer)!: generate serde traits impls for all protocol protobufs (#1260) fix(charts): add resources for sequencer/cometbft (#1254) chore(sequencer)!: add metrics (#1248) fix(sequencer-utils): fixes issue in `parse_blob` tests (#1243) feat(core, proto)!: make bridge unlock memo string (#1244) fix(conductor): don't panic during panic (#1252) feat(core)!: lowerCamelCase for protobuf json mapping (#1250) refactor(bridge-withdrawer)!: refactor startup to a separate subtask and remove balance check from startup (#1190) fix: rollup archive node configurations (#1249) ...
bharath-123
pushed a commit
that referenced
this pull request
Jul 25, 2024
## Summary Changes the memo field of bridge unlock actions from `bytes` to `string`. ## Background IBC convention is to format all memos as json and encode as `string` rather than `bytes` when sending them over the wire. The `astria.protocol.transactions.v1alpha1.Ics20Withdrawal.memo` field is also `string`, so this change brings `astria.protocol.transactions.v1alpha1.BridgeUnlockAction.memo` in line. ## Changes - Change `astria.protocol.transactions.v1alpha1.BridgeUnlockAction.memo` from `bytes` to `string` ## Testing All tests are updated and pass. ## Breaking Changelist This constitutes a breaking protobuf-change (as flagged by `buf`) but very likely neither a deployment nor network breaking change: + `bytes` and `string` are wire-compatible (from a protobuf point of view) + `sequencer` only passes the memo field through + `bridge-withdrawer` will be able to parse both formats as a Rust `String` is just `Vec<u8>` with extra checks for utf8 under the hood. This change is only cosmetic, but marked as breaking due to `buf`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Changes the memo field of bridge unlock actions from
bytestostring.Background
IBC convention is to format all memos as json and encode as
stringrather thanbyteswhen sending them over the wire. Theastria.protocol.transactions.v1alpha1.Ics20Withdrawal.memofield is alsostring, so this change bringsastria.protocol.transactions.v1alpha1.BridgeUnlockAction.memoin line.Changes
astria.protocol.transactions.v1alpha1.BridgeUnlockAction.memofrombytestostringTesting
All tests are updated and pass.
Breaking Changelist
This constitutes a breaking protobuf-change (as flagged by
buf) but very likely neither a deployment nor network breaking change:bytesandstringare wire-compatible (from a protobuf point of view)sequenceronly passes the memo field throughbridge-withdrawerwill be able to parse both formats as a RustStringis justVec<u8>with extra checks for utf8 under the hood.This change is only cosmetic, but marked as breaking due to
buf.