fix!: Fix serialization of CustomAddr so that the data serializes the same as a Vec<u8> - #4465
Merged
Conversation
… same as a Vec<u8> This is needed so the inline size remains an implementation detail. It breaks CustomAddr deser, but that is fine since custom addresses, while being stable, are only used in conjunction with a feature cleary marked as experimental.
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/4465/docs/iroh/ Last updated: 2026-08-06T08:28:14Z |
Member
|
LGTM. The breakage is unfortunate, but I think your reasoning can hold and I don't see a good alternative. So I'd be in favor of doing that. Should be iroh 1.1 though not 1.0.4 I'd say, and get a special note in the release notes. |
Frando
approved these changes
Aug 10, 2026
rklaehn
changed the title
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
2 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.
Description
Fix serialization of CustomAddr so that the data serializes the same as a Vec
This is needed so the inline size remains an implementation detail. It breaks CustomAddr deser, but that is fine since custom addresses, while being stable, are only used in conjunction with a feature cleary marked as experimental.
Breaking Changes
Does not change the public API, but does change the serialization of CustomAddrs. I think we don't need a iroh-base 2.0 regardless because you only create or use CustomAddrs when working with the experimental custom transports that are explicitly excluded from stability guarantees. YMMV.
Notes & open questions
Note for next release: we technically break serialization format for CustomAddr, so we should add the rationale for not going to 2.0 to the release notes.
Change checklist
proposed change and wrote an as clear and concise description as
they could.
intented effect.