feat(ckbtc): Add get_utxos_cache to reduce latency of update_balance calls#4788
Merged
feat(ckbtc): Add get_utxos_cache to reduce latency of update_balance calls#4788
Conversation
Contributor
There was a problem hiding this comment.
If this pull request affects the behavior of any canister owned by
the Governance team, remember to update the corresponding
unreleased_changes.md file(s).
To acknowldge this reminder (and unblock the PR), dismiss this
code review by going to the bottom of the pull request page, and
supply one of the following reasons:
-
Done.
-
No canister behavior changes.
c5fde3e to
f5079ba
Compare
No NNS governance canister behavior changes.
Contributor
gregorydemay
left a comment
There was a problem hiding this comment.
Thanks a lot @ninegua for this PR! Mostly some minor comments and understanding questions, otherwise code looks very good!
Co-authored-by: gregorydemay <112856886+gregorydemay@users.noreply.github.com>
gregorydemay
approved these changes
Apr 23, 2025
Contributor
gregorydemay
left a comment
There was a problem hiding this comment.
Thanks @ninegua for this PR!
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
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.
XC-314: ckBTC: Cache update_balance results
The call to the bitcoin canister's get_utxos method takes up the majority time of a update_balance call.
Sometimes a client may call update_balance repeatedly, which adds to the workload of the ckBTC minter canister.
The result of get_utxos would remain unchanged until the bitcoin canister receives a new block, which makes it a good candidate for caching.
This PR implements an internal get_utxos_cache that will reuse previous call results (if available and not expired) without making new get_utxos calls. Entries are expired based on a pre-configured get_utxos_cache_expiration setting.
Caching get_utxos results is safe for update_balance because: