Improve docs on ChangeSet
persistence requirements
#1600
Labels
documentation
Improvements or additions to documentation
Milestone
Describe the enhancement
Currently, the docs for
bdk_wallet::ChangeSet
are not super clear on what requirements implementations ofWalletPersister
need to fulfill.In Discord, we established that:
ChangeSet
s (i.e., local_chain, tx_graph, indexer) may get persisted independently/non-atomically. I.e., in case of a persistence-failure-and-restart scenario subsequentpersist
calls would deliver sub-ChangeSet
s that are still mergable. This means that the persisted state wouldn't be corrupted by a persistence failure of one of the sub-ChangeSet
s.It would be good to add all of these specifics and details to the
ChangeSet
/WalletPersister
docs.Use case
Being able to implement
WalletPersister
without screwing up.The text was updated successfully, but these errors were encountered: