From ee98c424c8edcfe90265d6fb25855048ec3810ea Mon Sep 17 00:00:00 2001 From: pd Date: Fri, 8 May 2026 09:06:11 -0700 Subject: [PATCH] docs: link backup & recovery docs --- bedrock/src/backup/mod.rs | 12 +++++++++++- bedrock/src/lib.rs | 2 -- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/bedrock/src/backup/mod.rs b/bedrock/src/backup/mod.rs index 13c9fc2a..67f688c2 100644 --- a/bedrock/src/backup/mod.rs +++ b/bedrock/src/backup/mod.rs @@ -1,3 +1,11 @@ +//! World App's "Backup & Recovery" (client-side primitives). +//! +//! This module owns the backup file format, manifest computation, sealing/unsealing, +//! and the Turnkey stamping helpers shared across iOS and Android. +//! +//! For the architecture, factor model, flows, and threat model, see the central docs: +//! . + mod backup_format; mod client_events; mod manifest; @@ -252,7 +260,7 @@ impl BackupManager { } /// Adds new factor by re-encrypting the backup keypair (not the backup itself!) - /// with a new factor secret. + /// with a new factor secret. (See BF-3 Adding a Main Faactor) /// /// * `encrypted_backup_key_with_existing_factor_secret` - is the backup keypair that was /// encrypted with the existing factor secret. Hex encoded. @@ -637,6 +645,8 @@ impl<'de> Deserialize<'de> for BackupFileDesignator { } /// Errors that can occur when working with backups and manifests. +/// +/// Further error documentation: #[crate::bedrock_error] pub enum BackupError { #[error("Failed to decode factor secret as hex")] diff --git a/bedrock/src/lib.rs b/bedrock/src/lib.rs index feeb60e0..0e51af3e 100644 --- a/bedrock/src/lib.rs +++ b/bedrock/src/lib.rs @@ -30,8 +30,6 @@ pub mod transactions; /// Introduces low level primitives for the crypto wallet, including logging functionality. pub mod primitives; -/// Tools for storing, retrieving, encrypting and decrypting backup data and metadata. -/// See `backup::BackupManager` for the high-level API. pub mod backup; /// Introduces low level operations for interacting with a Nitro Enclave.