Skip to content

Commit 3b7f909

Browse files
authored
docs: clarify protocol version vs API version
The "Merlin v1.0" label domain-separates incompatible _protocols_, while the crate semver applies also to the API. So it is conceivable that Merlin-the-crate may decide to implement an incompatible API (v2.0 crate) while being compatible with the same Merlin-the-protocol (v1.0 protocol and label).
1 parent 7f1f4af commit 3b7f909

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/constants.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
/// Domain separation label to initialize the STROBE context.
22
///
3-
/// This should be consistent with the crate's semver string.
3+
/// This is not to be confused with the crate's semver string:
4+
/// the latter applies to the API, while this label defines the protocol.
5+
/// E.g. it is possible that crate 2.0 will have an incompatible API,
6+
/// but implement the same 1.0 protocol.
47
pub const MERLIN_PROTOCOL_LABEL: &[u8] = b"Merlin v1.0";

0 commit comments

Comments
 (0)