Skip to content

Commit 493638e

Browse files
committed
Merge #1661: chore(file_store): Document that it's a dev database
4b5bd0b chore(file_store): Document that it's a dev database (LLFourn) Pull request description: Document `bdk_file_store` is a development/testing database ACKs for top commit: LagginTimes: ACK 4b5bd0b ValuedMammal: ACK 4b5bd0b oleonardolima: ACK 4b5bd0b Tree-SHA512: a374753fe3d367870afc7b4cb301ef7fd09da1babefb0601191b266123358c2ffd247e4c6c5fb84eaa0e3b2821f8c0b1337cde6d63bbc2dce3fb7d5ff0286cef
2 parents b220d61 + 4b5bd0b commit 493638e

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

crates/file_store/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# BDK File Store
22

3+
> `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.
4+
35
This is a simple append-only flat file database for persisting [`bdk_chain`] changesets.
46

57
The main structure is [`Store`] which works with any [`bdk_chain`] based changesets to persist data into a flat file.

crates/file_store/src/store.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ use std::{
1010
};
1111

1212
/// Persists an append-only list of changesets (`C`) to a single file.
13+
///
14+
/// > ⚠ This is a development/testing database. It does not natively support backwards compatible
15+
/// > BDK version upgrades so should not be used in production.
1316
#[derive(Debug)]
1417
pub struct Store<C>
1518
where

0 commit comments

Comments
 (0)