docs: add bincode-to-wincode migration plan (#837) #885

Closed
Ghost wants to merge 0 commits from plan/837-wincode-migration into main

Summary

Adds the migration plan for #837 (replace bincode with wincode).

This PR contains only the planning document; no code or dependency changes are included yet.

What the plan covers

  • Current bincode usage: iced_beacon is the only direct consumer, but it lives in the orbital-iced submodule, so the work needs paired PRs in orbital-iced and Orbital.
  • Wire compatibility: current bincode::config::legacy() matches wincode's default config, so the beacon protocol should remain byte-for-byte compatible.
  • Recommended approach: serde_wincode::SerdeCompat<T> at the encode/decode boundary, because beacon field types (web_time, semver::Version, palette::Seed) are serde-only.
  • Phased rollout: baseline golden bytes, dependency swap, compatibility tests, submodule bump, and Renovate cleanup.
  • Risks: preallocation/size limits, young crate versions, and remaining transitive bincode copies from syntect and cargo-hot-protocol.

Follow-ups tracked by the plan

  • Supersede the Renovate branch PR/832 (bump to tombstone bincode 3.0.0).
  • Remove the bincode < 3.0.0 Renovate rule once the direct dependency is gone.

Refs #837

## Summary Adds the migration plan for #837 (replace `bincode` with `wincode`). This PR contains **only the planning document**; no code or dependency changes are included yet. ### What the plan covers - Current `bincode` usage: `iced_beacon` is the only direct consumer, but it lives in the `orbital-iced` submodule, so the work needs paired PRs in `orbital-iced` and `Orbital`. - Wire compatibility: current `bincode::config::legacy()` matches `wincode`'s default config, so the beacon protocol should remain byte-for-byte compatible. - Recommended approach: `serde_wincode::SerdeCompat<T>` at the encode/decode boundary, because beacon field types (`web_time`, `semver::Version`, `palette::Seed`) are serde-only. - Phased rollout: baseline golden bytes, dependency swap, compatibility tests, submodule bump, and Renovate cleanup. - Risks: preallocation/size limits, young crate versions, and remaining transitive `bincode` copies from `syntect` and `cargo-hot-protocol`. ### Follow-ups tracked by the plan - Supersede the Renovate branch `PR/832` (bump to tombstone `bincode` 3.0.0). - Remove the `bincode < 3.0.0` Renovate rule once the direct dependency is gone. Refs #837
docs: add bincode-to-wincode migration plan (#837)
All checks were successful
Lint / lint (pull_request) Successful in 2m30s
bfbd3084e5
Ghost closed this pull request 2026-10-21 23:55:40 +00:00
All checks were successful
Lint / lint (pull_request) Successful in 2m30s

Pull request closed

Sign in to join this conversation.
No description provided.