Skip to content

docs(wallet): Improve docs on ChangeSet persistence requirements#1844

Closed
ValuedMammal wants to merge 5 commits intobitcoindevkit:masterfrom
ValuedMammal:doc/wallet-changeset
Closed

docs(wallet): Improve docs on ChangeSet persistence requirements#1844
ValuedMammal wants to merge 5 commits intobitcoindevkit:masterfrom
ValuedMammal:doc/wallet-changeset

Conversation

@ValuedMammal
Copy link
Copy Markdown
Collaborator

This work in progress PR is meant to expand on and clarify the documentation for bdk_wallet::ChangeSet.

fixes bitcoindevkit/bdk_wallet#9

Notes to the reviewers

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

@ValuedMammal
Copy link
Copy Markdown
Collaborator Author

@tnull Is there any additional info or insight that you think should be included in the docs regarding the wallet ChangeSet, WalletPersister, etc?

@ValuedMammal ValuedMammal self-assigned this Feb 19, 2025
@ValuedMammal ValuedMammal added the documentation Improvements or additions to documentation label Feb 19, 2025
@ValuedMammal ValuedMammal added this to the 1.2.0 milestone Feb 19, 2025
@tnull
Copy link
Copy Markdown
Contributor

tnull commented Feb 21, 2025

@tnull Is there any additional info or insight that you think should be included in the docs regarding the wallet ChangeSet, WalletPersister, etc?

Ah, thank you for this PR! I think it would be great if the compatibility guarantees of ChangeSet could be spelled out as explicitly as possible (probably in its own sub-section of the ChangeSet docs?). Is the type ever going to change? If so, what types of changes to the data type do users implementing their own persistence need to prepare for? How do they need to detect and handle them? Can users persist the sub-changesets individually? Will forward compatibility (i.e., downgrades) also be supported? etc.

@ValuedMammal ValuedMammal force-pushed the doc/wallet-changeset branch from f40f8b9 to 0f14fef Compare March 9, 2025 19:04
@ValuedMammal ValuedMammal moved this from Needs Review to In Progress in BDK Wallet Mar 10, 2025
@ValuedMammal ValuedMammal modified the milestones: 1.2.0, 1.3.0 Apr 3, 2025
@ValuedMammal ValuedMammal deleted the doc/wallet-changeset branch April 7, 2025 21:13
@github-project-automation github-project-automation bot moved this from In Progress to Done in BDK Wallet Apr 7, 2025
@ValuedMammal
Copy link
Copy Markdown
Collaborator Author

Reopened bitcoindevkit/bdk_wallet#198

@notmandatory notmandatory removed this from the Wallet 2.0.0 milestone Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve docs on ChangeSet persistence requirements

3 participants