Specify requirements for Valid and Deterministic Encodings #57
Conversation
This file contains 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
Add Serialization Considerations section and specify - Valid CCF Encoding Requirements - Deterministic CCF Encoding Requirements These requirements are necessary and have an impact on CCF codec speed and memory use. Prior formats didn't specify requirements for validity or deterministic encoding. Updated benchmark comparisons (coming soon) should be viewed with this in mind. For example, sorting (as part of deterministic encoding) isn't free.
turbolent
reviewed
Feb 13, 2023
Under "Serialization Considerations", create a section to clarify encoding of Cadence types and values. - Mention that for compactness, CCF encoding skips Cadence type encoding when type can be inferred. - Describe CCF encoding when type can be inferred by using array of String to illustrate. - Describe CCF encoding when type cannot be inferred by using array of AnyStruct to illustrate. - Remove 4 bullet points in "Deterministic CCF Encoding Requirements" because they are replaced by the new section, "Cadence Types and Values Encoding".
In "Valid CCF Encoding Requirements", add a line mentioning CCF encodings must comply with "CCF Specified in CDDL Notation" section of this document.
Mention all parameter lists MUST be unique as suggested by Bastian.
Co-authored-by: Bastian Müller <bastian@axiomzen.co>
Elements MUST be unique in `restricted-type` or `restricted-type-value`.
Mention that: - `restricted-type.restrictions` MUST be sorted by restriction's `cadence-type-id`. - `restricted-type-value.restrictions` MUST be sorted by restriction's `cadence-type-id`. Thanks @dsainati1 for answering question about Cadence restricted type!
|
@turbolent @j1010001 thanks for the meeting today! Feel free to add comments here from our meeting. I think we're on the same page about everything and just need to document it for clarity. I'll incorporate feedback from our meeting into CCF specs and continue ongoing work on CCF codec. |
turbolent
reviewed
Feb 15, 2023
Update "Deterministic CCF Encoding Requirements": - Separate bullet points for field names and parameter lists because they are unrelated. - Generalize to "all parameter lists" instead of just listing a specific case. - Add `function-value.parameters` as another example of parameter list. Co-authored-by: Bastian Müller <bastian@axiomzen.co>
A CCF-based protocol for encoding transaction arguments might want to specify that encoders MUST produce deterministic encodings. Whereas, a CCF-based protocol for encoding script return values might want to specify that encoders don't need to produce deterministic encodings if the recipient doesn't care about values being encoded deterministically. Co-authored-by: Bastian Müller <bastian@axiomzen.co>
fxamacker
changed the title
For compactness, use more concise examples for omitting type info. Co-authored-by: Bastian Müller <bastian@axiomzen.co>
This was referenced Feb 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add Serialization Considerations section and specify
Replace "ABRIDGED DRAFT" with "DRAFT" in Status of this Document section.
These requirements are necessary and have an impact on CCF codec speed and memory use.
Prior formats (JSON-Cadence Data Interchange and CBF) didn't specify requirements for validity or deterministic encoding. Updated benchmark comparisons (coming soon) should be viewed with this in mind. For example, sorting (as part of deterministic encoding) isn't free.