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.

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

Add new crate bdk-persist #1412

Merged
merged 1 commit into from
Apr 29, 2024
Merged

Conversation

rustaceanrob
Copy link
Contributor

Description

#1387 introduced anyhow as a dependency to remove generics from Wallet. Introducing a new crate for persistence types removes the dependency on anyhow for bdk_chain. Resolves #1409, as well as removing the old documentation for "tracker".

Notes to the reviewers

Open for any comments.

Changelog notice

  • Introduce bdk-persist crate

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

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

Copy link
Contributor

@ValuedMammal ValuedMammal left a comment

Choose a reason for hiding this comment

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

Additional note that the wallet README has links to PersistBackend that should be updated to point to the new bdk_persist crate. So far, that's the only other thing that stood out to me.

@rustaceanrob
Copy link
Contributor Author

Thanks for those suggestions, updated

@ValuedMammal
Copy link
Contributor

LGTM. I built and ran the example crates to check that persistence still works, also built the docs locally and found no issues (assuming the new crate will be published to docs.rs).

@rustaceanrob
Copy link
Contributor Author

Thanks for those checks, appreciate it. I also clicked around the docs locally and it linked properly. Think I caught them all with a grep. Might do one final pass for any bdk-chain references to one of the bdk-persist traits but hopefully its all good.

@rustaceanrob rustaceanrob force-pushed the bdk-persist branch 2 times, most recently from 6940643 to b89dc4f Compare April 27, 2024 02:19
@rustaceanrob rustaceanrob marked this pull request as ready for review April 27, 2024 02:22
@storopoli
Copy link
Contributor

Just a minor check: are we adding the new bdk_persist to CI? Or is it already covered by default?

Copy link
Member

@evanlinjin evanlinjin left a comment

Choose a reason for hiding this comment

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

ACK 81de8f6

version = "0.1.0"
repository = "https://github.com/bitcoindevkit/bdk"
documentation = "https://docs.rs/bdk_persist"
description = "Types that define data persistence of a BDK wallet"
Copy link
Member

Choose a reason for hiding this comment

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

Nit: *Types used for persisting bdk_chain data.

@evanlinjin evanlinjin merged commit ed3ccc1 into bitcoindevkit:master Apr 29, 2024
12 checks passed
@rustaceanrob rustaceanrob deleted the bdk-persist branch April 30, 2024 23:10
@danielabrozzoni danielabrozzoni mentioned this pull request May 2, 2024
28 tasks
@ValuedMammal ValuedMammal mentioned this pull request May 8, 2024
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Introduce bdk_persist crate
4 participants