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

docs(adr): Change Textual SignDoc to struct #15282

Merged
merged 8 commits into from
Mar 14, 2023
Merged

Conversation

amaury1093
Copy link
Contributor

Description

When discussing today about Spec updates, we came up with the argument that structs are more backwards-compatible than arrays. Propose to switch the sign doc to a struct containing one field (the old array).


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@github-actions github-actions bot added the C:x/tx label Mar 7, 2023
@@ -1,19 +1,19 @@
[
{
"screens": [],
"encoding": "80"
"encoding": "a10180"
Copy link
Contributor Author

@amaury1093 amaury1093 Mar 7, 2023

Choose a reason for hiding this comment

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

All CBOR encodings now have a101 prepended. Looking at the RFC Appendix B, this makes sense:

 | 0xa0..0xb7 | map (0x00..0x17 pairs of data items follow)    |
  • a1: map with 1 item
  • 01: key of first item

@amaury1093 amaury1093 marked this pull request as ready for review March 7, 2023 07:08
@amaury1093 amaury1093 requested a review from a team as a code owner March 7, 2023 07:08
@github-prbot github-prbot requested review from a team, aaronc and julienrbrt and removed request for a team March 7, 2023 07:08
@amaury1093 amaury1093 changed the title docs(adr): Change SignDoc to struct docs(adr): Change Textual SignDoc to struct Mar 7, 2023
@amaury1093
Copy link
Contributor Author

I'll enable auto-merge once it's tested with Zondax's new ledger app

@amaury1093
Copy link
Contributor Author

Tested, merging.

@amaury1093 amaury1093 merged commit a539a03 into main Mar 14, 2023
@amaury1093 amaury1093 deleted the am/textual-struct branch March 14, 2023 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants