sdk: Upgrade to borsh 1.2.1 #34355
Merged
sdk: Upgrade to borsh 1.2.1 #34355
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
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #34355 +/- ##
=========================================
- Coverage 81.9% 81.8% -0.1%
=========================================
Files 819 819
Lines 220569 220823 +254
=========================================
+ Hits 180788 180805 +17
- Misses 39781 40018 +237 |
| @@ -46,6 +46,7 @@ const MAX_BASE58_LEN: usize = 44; | |||
| Pod, | |||
| Zeroable, | |||
| )] | |||
| #[borsh(crate = "borsh")] | |||
There was a problem hiding this comment.
Incidentally, is there a good place to read documentation of borsh tags? I looked on their repo and rust docs, but must have missed it.
There was a problem hiding this comment.
The docs.rs was the best source at https://docs.rs/borsh/latest/borsh/derive.BorshDeserialize.html but I did also have to read the source directly too. This one tripped me up for awhile
CriesofCarrots
approved these changes
Dec 8, 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.
Problem
Borsh has released major version 1, and we're still on 0.10 everywhere.
Summary of Changes
Add default support borsh v1 on all structs, with backward compatibility on
Pubkeyand theStakestructs. There were some changes in the schema interface with v1, which required updatingget_packed_len.The concept is to also maintain backwards compatibility with v0.9, and we can drop support for older versions whenever we decide to move to sdk v2.
There's also a bit of copy-pasta for the stake structs, which was copied from
cargo expandon version 0.10.3. We could eventually go with #32668 to derive everything by macro, but I went the lazy route. Let me know if you prefer the proxy-crate approach!I've tested a few downstream programs, including SPL, Anchor, and the Metaplex token-auth rules. Metaplex token-metadata and some of its upstream dependencies reject anything greater than 1.16, and I didn't want to bother patching many repos for the test, so I just tried the most upstream one.
I'll also check around with some ecosystem teams to see what else I can check.
Fixes #