From b1284571376a17a799e2c69ad12d411d377b23fb Mon Sep 17 00:00:00 2001 From: Hammed Abass Date: Sun, 9 Aug 2026 18:07:03 +0200 Subject: [PATCH] docs(core): clarify experimental domain versions --- crates/vnidrop/src/api.rs | 7 +++++-- crates/vnidrop/tests/experimental_domain.rs | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/crates/vnidrop/src/api.rs b/crates/vnidrop/src/api.rs index b847338..aa9fcde 100644 --- a/crates/vnidrop/src/api.rs +++ b/crates/vnidrop/src/api.rs @@ -10,9 +10,10 @@ use crate::util::{non_empty, now_ms}; pub(crate) const MAX_CUSTOM_RELAYS: usize = 8; pub(crate) const MAX_RELAY_URL_BYTES: usize = 2_048; +/// Versions the additive public domain seam and its two experimental wire protocols. #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, uniffi::Record)] pub struct ExperimentalSavedDeviceCapabilities { - pub api_version: u16, + pub domain_contract_version: u16, pub relationship_protocol_version: u16, pub targeted_transfer_protocol_version: u16, } @@ -20,7 +21,7 @@ pub struct ExperimentalSavedDeviceCapabilities { #[uniffi::export] pub fn experimental_saved_device_capabilities() -> ExperimentalSavedDeviceCapabilities { ExperimentalSavedDeviceCapabilities { - api_version: 1, + domain_contract_version: 1, relationship_protocol_version: 1, targeted_transfer_protocol_version: 1, } @@ -36,6 +37,7 @@ pub struct SavedDevice { pub last_authenticated_at: Option, } +/// Durable consent lifecycle for one remote app-installation identity. #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, uniffi::Enum)] pub enum DeviceRelationshipState { PendingOutgoing, @@ -56,6 +58,7 @@ pub struct DeviceRelationship { pub updated_at: i64, } +/// Rust-owned lifecycle for an immutable one-sender, one-receiver transfer. #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, uniffi::Enum)] pub enum TargetedTransferState { Preparing, diff --git a/crates/vnidrop/tests/experimental_domain.rs b/crates/vnidrop/tests/experimental_domain.rs index 38a582c..fb79840 100644 --- a/crates/vnidrop/tests/experimental_domain.rs +++ b/crates/vnidrop/tests/experimental_domain.rs @@ -12,7 +12,7 @@ fn saved_device_protocols_are_explicitly_experimental_and_versioned() { assert_eq!( experimental_saved_device_capabilities(), ExperimentalSavedDeviceCapabilities { - api_version: 1, + domain_contract_version: 1, relationship_protocol_version: 1, targeted_transfer_protocol_version: 1, }