Feat/sync specific vtxo #66
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
the original `settle` function has been replaced by 2 new functions - `settle_all`: will attempt to settle all boarding inputs and pending vtxos - `settle`: which accepts inputs of which boarding and pending vtxos to settle with this clients can decide to settle all VTXOs at once or decide to settle only specific VTXOs
luckysori
approved these changes
May 19, 2025
| @@ -127,7 +127,6 @@ pub use error::Error; | |||
| /// # &self, | |||
| /// # server_pk: XOnlyPublicKey, | |||
| /// # exit_delay: bitcoin::Sequence, | |||
| /// # descriptor_template: &str, | |||
There was a problem hiding this comment.
Should we be running doc tests in CI?
Comment on lines
+59
to
+60
| /// Lift all pending VTXOs and boarding outputs into the Ark, converting them into new, | ||
| /// confirmed VTXOs. We do this by "joining the next round". |
There was a problem hiding this comment.
I guess we should document this function differently.
|
What if we avoided the breaking change and added a settle_only? I have yet to find a use case for granular settlements, so I would keep settle for consistency with other SDK (which settle all) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
the original
settlefunction has been replaced by 2 new functionssettle_all: will attempt to settle all boarding inputs and pending vtxossettle: which accepts inputs of which boarding and pending vtxos to settlewith this clients can decide to settle all VTXOs at once or decide to settle only specific VTXOs
Note: I've cherry-picked a single e2e test to use the new functions. The other e2e tests are still using the
settle_allfunction.Note: This is a breaking change due to renaming the existing
settlefunction tosettle_all.