Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(file_store): Document that it's a dev database #1661

Merged
merged 1 commit into from
Oct 31, 2024
Merged

chore(file_store): Document that it's a dev database #1661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions crates/file_store/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd personally make it even clearer by using bold and uppercase.

Suggested change
> ⚠ `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.
> ⚠ `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.
Expand Down
3 changes: 3 additions & 0 deletions crates/file_store/src/store.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<C>
where
Expand Down
Loading