Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions protocol/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# v0.8.0

Major breaking changes!

* **Handshake API** Introduced compile-time type safety using the typestate pattern. The handshake now uses typed states (`Initialized`, `SentKey`, `ReceivedKey`, `SentVersion`) that prevent out-of-order method calls at compile time.
* **Crate Feature Flags** Removed the `alloc` feature flag, simplifying to `no_std` (core) and `std` (I/O) features. Removed the `futures` feature flag in favor of a single `tokio` feature for async support, reflecting real-world usage patterns.
* **I/O Interfaces** Added new synchronous I/O interface (`io::Protocol`) alongside the existing async interface (moved to `futures::Protocol`). Both interfaces take ownership of underlying I/O readers and writers.
* **Infallible Serialization** The `serialize()` function now returns `Vec<u8>` directly instead of `Result<Vec<u8>, Error>`, eliminating unnecessary error handling for in-memory operations.

## Migration Guide

* Remove error handling from `serialize()` calls.
* Adapt `AsyncProtocol` code to the new `futures::Protocol` interface which owns the underlying reader and writer.
* If using the lower level `handshake` interface, update code to use the new typed state machine.
* If using the lower level `PacketHandler` interface, update to the new `CipherSession` interface.

# v0.7.0

* Loosen tokio version restrictions allowing the consumer to dictate the tokio version best for them. The version could effect the MSRV of the library.
Expand Down
2 changes: 1 addition & 1 deletion protocol/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bip324"
version = "0.7.0"
version = "0.8.0"
authors = ["Nick Johnson <nick@yonson.dev>", "Robert Netzke <rustaceanrob@protonmail.com>"]
edition = "2021"
license = "CC0-1.0"
Expand Down