Thanks to visit codestin.com
Credit goes to github.com

Skip to content

BREAKING: human readable de/ser for versioned message#381

Open
jstarry wants to merge 2 commits intoanza-xyz:masterfrom
jstarry:fix/versioned-message-hr-deser
Open

BREAKING: human readable de/ser for versioned message#381
jstarry wants to merge 2 commits intoanza-xyz:masterfrom
jstarry:fix/versioned-message-hr-deser

Conversation

@jstarry
Copy link
Contributor

@jstarry jstarry commented Oct 15, 2025 •
edited
Loading

Versioned messages are not properly supported for human readable de/ser due to special handling of the version prefix byte. This is a breaking change to how versioned messages (including v0 and legacy) are serialized and deserialized when using a human readable serialization format. More context about the consequences of this lack of support can be found in #311

Old serialization:

[
  128,
  {
    "header": {
      "numRequiredSignatures": 0,
      "numReadonlySignedAccounts": 0,
      "numReadonlyUnsignedAccounts": 0
    },
    "accountKeys": [..],
    "recentBlockhash": [..],
    [..]
  }
]

New serialization:

{                                                                                                                                                                                                          
  "version": "0",                                                                                                                                                                                          
  "message": {                                                                                                                                                                                             
    "header": {                                                                                                                                                                                            
      "numRequiredSignatures": 0,                                                                                                                                                                          
      "numReadonlySignedAccounts": 0,                                                                                                                                                                      
      "numReadonlyUnsignedAccounts": 0                                                                                                                                                                     
    },                                                                                                                                                                                                     
    "accountKeys": [..]              
    "recentBlockhash": [..],
    [..]
  }
}

@jstarry jstarry requested a review from a team as a code owner October 15, 2025 04:36
@jstarry jstarry force-pushed the fix/versioned-message-hr-deser branch 2 times, most recently from a0d108f to 29ad202 Compare October 15, 2025 04:46
@jstarry jstarry mentioned this pull request Oct 15, 2025
Closed
@apfitzge
Copy link
Contributor

apfitzge commented Oct 15, 2025

@jstarry can you add a description to the PR?

apfitzge
apfitzge previously approved these changes Oct 15, 2025
View reviewed changes
Copy link
Contributor

@apfitzge apfitzge left a comment

Choose a reason for hiding this comment

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

lgtm - please just add a description before merging. title is descriptive, but still weird to not have one imo

@jstarry jstarry changed the title fix: human readable de/ser for versioned message BREAKING: human readable de/ser for versioned message Oct 16, 2025
@jstarry jstarry changed the title BREAKING: human readable de/ser for versioned message fix: human readable de/ser for versioned message Oct 16, 2025
@jstarry
Copy link
Contributor Author

jstarry commented Oct 16, 2025 •
edited
Loading

Thanks for the review @apfitzge! Sorry I was in the middle of updating the description but got side tracked while looking into another human readable serialization issue. I was thinking of marking this as breaking because any v0 messages serialized in the original compact format will not be deserializable. But since legacy messages were not deserializable I tend to think of this as a bug fix rather than a breaking change. Thoughts?

EDIT: Just conservatively marked this as breaking because my other change will definitely breaking

@jstarry jstarry changed the title fix: human readable de/ser for versioned message BREAKING: human readable de/ser for versioned message Oct 16, 2025
@jstarry jstarry mentioned this pull request Oct 16, 2025
Closed
@joncinque joncinque added the breaking PR contains breaking changes label Oct 16, 2025
@joncinque
Copy link
Collaborator

joncinque commented Feb 4, 2026

Do we want to land this? We're about to publish a breaking change to solana-message for wincode and txv1, so now's a great time!

@febo febo mentioned this pull request Feb 5, 2026
Merged
@jstarry jstarry force-pushed the fix/versioned-message-hr-deser branch from eeae20d to dbe6781 Compare February 20, 2026 05:12
@jstarry
Copy link
Contributor Author

jstarry commented Feb 20, 2026

@joncinque I think it's still a desirable change, I've rebased and fixed the conflicts

apfitzge
apfitzge reviewed Feb 20, 2026
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@apfitzge apfitzge apfitzge left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

breaking PR contains breaking changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jstarry @apfitzge @joncinque