From 4b5bd0b14bfba95f0ca4e2c612d6e24832ba5b73 Mon Sep 17 00:00:00 2001 From: LLFourn Date: Mon, 28 Oct 2024 10:57:29 +1100 Subject: [PATCH] chore(file_store): Document that it's a dev database --- crates/file_store/README.md | 2 ++ crates/file_store/src/store.rs | 3 +++ 2 files changed, 5 insertions(+) diff --git a/crates/file_store/README.md b/crates/file_store/README.md index 7b00aa0e0..5c4100b93 100644 --- a/crates/file_store/README.md +++ b/crates/file_store/README.md @@ -1,5 +1,7 @@ # BDK File Store +> ⚠ `bdk_file_store` is a development/testing database. It does not natively support backwards compatible BDK version upgrades so should not be used in production. + This is a simple append-only flat file database for persisting [`bdk_chain`] changesets. The main structure is [`Store`] which works with any [`bdk_chain`] based changesets to persist data into a flat file. diff --git a/crates/file_store/src/store.rs b/crates/file_store/src/store.rs index 49ddc7731..ec86d4e5e 100644 --- a/crates/file_store/src/store.rs +++ b/crates/file_store/src/store.rs @@ -10,6 +10,9 @@ use std::{ }; /// Persists an append-only list of changesets (`C`) to a single file. +/// +/// > ⚠ This is a development/testing database. It does not natively support backwards compatible +/// > BDK version upgrades so should not be used in production. #[derive(Debug)] pub struct Store where