ZIP 302: Structured memos#638
Draft
str4d wants to merge 5 commits into
Draft
Conversation
This was referenced Oct 6, 2022
str4d
commented
Oct 6, 2022
str4d
commented
Oct 6, 2022
str4d
commented
Oct 6, 2022
daira
reviewed
Oct 26, 2022
dconnolly
approved these changes
Nov 23, 2022
Collaborator
Author
|
In ZIP Sync today, we decided that:
|
str4d
force-pushed
the
zip302-structured-memos
branch
from
ef5529a to
2824c4b
Compare
Collaborator
Author
|
I've replaced the old contents of this PR (which just reverted the prior content that was removed from the original ZIP 302 PR) with an initial draft following what was decided in ZIP Sync almost 2 years ago. |
Merged
str4d
force-pushed
the
zip302-structured-memos
branch
from
2824c4b to
ff9b60e
Compare
str4d
dismissed stale reviews from daira and nuttycom
The base branch was changed.
str4d
commented
Oct 17, 2025
str4d
commented
Oct 17, 2025
Also switches to using a table for the part types registry
str4d
force-pushed
the
zip302-structured-memos
branch
from
b1c32ef to
369dba1
Compare
daira
reviewed
Oct 17, 2025
str4d
commented
Oct 21, 2025
Comment on lines
+101
to
+125
| - Read the next ``partLength`` bytes to obtain ``partValue``. If ``partLength`` would | ||
| require the reader to read past the end of the memo bytes, return an error. | ||
| - Store ``(partType, partVersion, partValue)`` and continue parsing. | ||
|
|
||
| If an error occurs, readers MUST treat the entire memo as invalid (ignoring any | ||
| ``MemoPart`` that was successfully parsed prior to the error). | ||
|
|
||
| Defined memo part types | ||
| ``````````````````````` | ||
|
|
||
| The following memo part types (and corresponding versioned value encodings) are defined: | ||
|
|
||
| +--------------+-----------------+-------------------------------------------------------------------------------------+ | ||
| | ``partType`` | ``partVersion`` | ``partValue`` encoding | | ||
| +==============+=================+=====================================================================================+ | ||
| | 160 | 0 | A UTF-8 string. | | ||
| | | | If decoding fails then return an error; readers MUST NOT replace invalid sequences. | | ||
| +--------------+-----------------+-------------------------------------------------------------------------------------+ | ||
| | 255 | 0 | Unconstrained data, for private use (like ``0xFF`` outside structured memos). | | ||
| | | | Readers should not make any assumptions about the encoding or content of this data. | | ||
| +--------------+-----------------+-------------------------------------------------------------------------------------+ | ||
| | 10000-19999 | Currently unassigned range for "assigned private use". | | ||
| +--------------+-----------------+-------------------------------------------------------------------------------------+ | ||
| | 65530-65535 | For temporary experimentation. | | ||
| +--------------+-----------------+-------------------------------------------------------------------------------------+ |
Collaborator
Author
There was a problem hiding this comment.
In ZIP Sync, we decided to require that the parser default to "unknown-reject": if a partType is unknown, error and do not return any understood part types to the wallet. We will then define that any partType in the range 30000-65535 is "optional" and can be stored in an Unknown handler (and then move the "assigned private use" section to the start of this range).
Collaborator
|
This is pending resolution of @str4d's #638 (comment), so moving to draft. |
4 tasks
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
5 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.
Closes #1208.
Closes COR-1074.