Implement persistence with the new structures #965

evanlinjin · 2023-05-04T02:55:37Z

Description

This is part of #895 and #971

Introduce a more generic version of the keychain::persist::* structures that only needs a single generic for the changeset type.

Additional changes:

The Append trait has a new method is_empty.
Introduce Store structure for bdk_file_store (which implements PersistBackend).

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

New Features:

I've added tests for the new feature
I've added docs for the new feature

crates/file_store/src/store.rs

crates/chain/src/persist.rs

This is a more generic version of `keychain::persist::*` structures. Additional changes: * The `Append` trait has a new method `is_empty`. * Introduce `Store` structure for `bdk_file_store`.

LLFourn

I left a few nits. Otherwise LGTM.

crates/file_store/src/store.rs

crates/file_store/src/entry_iter.rs

crates/file_store/src/store.rs

LLFourn · 2023-05-10T03:47:47Z

crates/chain/src/tx_data_traits.rs

@@ -64,20 +64,35 @@ impl<A: Anchor> Anchor for &'static A {
 pub trait Append {
    /// Append another object of the same type onto `self`.
    fn append(&mut self, other: Self);
+
+    /// Returns whether the structure is considered empty.
+    fn is_empty(&self) -> bool;


Let's say I wanted to implement Append for a u32 to represent a monotonically increasing value -- I guess u32::MIN would return true for is_empty.

I think implementing Append for u32 is a rather confusing combination. Option<u32> or using a wrapped type makes more sense for me.

danielabrozzoni · 2023-05-10T10:30:39Z

crates/chain/src/persist.rs

+#[derive(Debug)]
+pub struct Persist<B, C> {
+    backend: B,
+    stage: C,


nit: maybe it should be S for stage, instead of C?

C for changeset though 😮

Then do changeset: C :P

I support changeset: C 🙂

danielabrozzoni · 2023-05-10T10:44:09Z

crates/chain/src/persist.rs

+        let mut temp = C::default();
+        core::mem::swap(&mut temp, &mut self.stage);
+        self.backend.write_changes(&temp)


Mhhhh maybe put a small comment here, it took me a second to figure out what you were trying to do (commit changes and clean self.stage at the same time)

Also, a shorter way of writing this, but not necessarily a cleaner one, might be:

self.backend.write_changes(core::mem::take(&mut self.stage))

actually shouldn't we only clear it in the case that it succeeds.

That's a good point

/// Commit the staged changes to the underlying persistance backend. /// /// Changes that are committed (if any) are returned. /// /// # Error /// /// Returns a backend-defined error if this fails. pub fn commit(&mut self) -> Result<Option<C>, B::WriteError> { if self.stage.is_empty() { return Ok(None); } self.backend .write_changes(&self.stage) // if written successfully, take and return `self.stage` .map(|_| Some(core::mem::take(&mut self.stage))) }

danielabrozzoni · 2023-05-10T21:14:13Z

crates/file_store/src/entry_iter.rs

+    db_file: Option<&'t mut File>,
+
+    /// The file position for the first read of `db_file`.
+    start_pos: Option<u64>,


nit: maybe expand in the docs why it's an Option and what happens when this is None

notmandatory added this to the 1.0.0-alpha.1 milestone May 4, 2023

notmandatory added the BDK 1.0.0 label May 4, 2023

evanlinjin force-pushed the persist_redesign branch from da5054a to 6752b69 Compare May 4, 2023 05:38

LLFourn reviewed May 4, 2023

View reviewed changes

crates/file_store/src/store.rs Outdated Show resolved Hide resolved

evanlinjin force-pushed the persist_redesign branch from b23bcaa to 6ac7d25 Compare May 4, 2023 08:33

This was referenced May 5, 2023

Various tweaks to redesigned structures #963

Merged

Furthur changes to redesign structures. #971

Closed

notmandatory removed the BDK 1.0.0 label May 6, 2023

notmandatory assigned evanlinjin May 6, 2023

bodymindarts reviewed May 7, 2023

View reviewed changes

crates/chain/src/persist.rs Outdated Show resolved Hide resolved

evanlinjin force-pushed the persist_redesign branch from d2e7b48 to a427a6d Compare May 9, 2023 02:07

notmandatory mentioned this pull request May 9, 2023

W19 BDK Lib Call bitcoindevkit/.github#57

Closed

21 tasks

evanlinjin force-pushed the persist_redesign branch 3 times, most recently from 46259f5 to f8dd5e2 Compare May 9, 2023 04:38

evanlinjin marked this pull request as ready for review May 9, 2023 04:48

[persist_redesign] Introduce redesigned persist types

2aa08a5

This is a more generic version of `keychain::persist::*` structures. Additional changes: * The `Append` trait has a new method `is_empty`. * Introduce `Store` structure for `bdk_file_store`.

evanlinjin force-pushed the persist_redesign branch from f8dd5e2 to 2aa08a5 Compare May 9, 2023 04:55

evanlinjin requested a review from LLFourn May 9, 2023 05:01

LLFourn approved these changes May 10, 2023

View reviewed changes

Add more impls for Append and docs for file store magic

4963240

evanlinjin force-pushed the persist_redesign branch from 935dc16 to 4963240 Compare May 10, 2023 07:07

evanlinjin merged commit 05d353c into bitcoindevkit:master May 10, 2023

danielabrozzoni reviewed May 10, 2023

View reviewed changes

notmandatory mentioned this pull request May 15, 2023

W21 BDK Lib Team Call bitcoindevkit/.github#59

Closed

19 tasks

notmandatory mentioned this pull request Jul 4, 2023

Release 1.0.0-alpha.1 #1025

Closed

24 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement persistence with the new structures #965

Implement persistence with the new structures #965

evanlinjin commented May 4, 2023 •

edited

Loading

LLFourn left a comment

LLFourn May 10, 2023

evanlinjin May 10, 2023

danielabrozzoni May 10, 2023

evanlinjin May 23, 2023

danielabrozzoni May 23, 2023

notmandatory May 23, 2023 •

edited

Loading

danielabrozzoni May 10, 2023

LLFourn May 11, 2023

evanlinjin May 11, 2023

evanlinjin May 11, 2023

evanlinjin May 11, 2023

danielabrozzoni May 10, 2023

Implement persistence with the new structures #965

Implement persistence with the new structures #965

Conversation

evanlinjin commented May 4, 2023 • edited Loading

Description

Changelog notice

Checklists

All Submissions:

New Features:

LLFourn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

notmandatory May 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evanlinjin commented May 4, 2023 •

edited

Loading

notmandatory May 23, 2023 •

edited

Loading