From: LLFourn Date: Sun, 27 Oct 2024 23:57:29 +0000 (+1100) Subject: chore(file_store): Document that it's a dev database X-Git-Tag: v1.0.0-beta.6~28^2 X-Git-Url: http://internal-gitweb-vhost/script/%22https:/struct.EncoderStringWriter.html?a=commitdiff_plain;h=4b5bd0b14bfba95f0ca4e2c612d6e24832ba5b73;p=bdk chore(file_store): Document that it's a dev database --- diff --git a/crates/file_store/README.md b/crates/file_store/README.md index 7b00aa0e..5c4100b9 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 49ddc773..ec86d4e5 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