FOLLOW-244: Add notifyTopUpIfNeeded to canisters service #5857
Conversation
This file contains 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
yhabib
reviewed
Nov 26, 2024
yhabib
approved these changes
Nov 26, 2024
1 task
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 26, 2024
…5859) # Motivation # Motivation Topping up a canister is a 2-step process: 1. Transfer ICP to a subaccount of the CMC 2. Notify the CMC of the transfer Because the process might be interrupted between the 2 steps, the nns-dapp canister listens for all transactions to see if any might be a canister top-up transaction by an NNS dapp user. We want the NNS dapp to stop listening for all transactions so we want to move this fallback mechanism to the frontend. # Changes 1. Call the service function that was added in #5857 from `CanisterDetails` to actually do the notifying if needed. # Tests 1. Unit tests added. 2. Tested manually by removing the top-up functionality from the backend canister and reloading the page in the middle of the top-up process. # Todos - [x] Add entry to changelog (if necessary).
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.
Motivation
Topping up a canister is a 2-step process:
Because the process might be interrupted between the 2 steps, the nns-dapp canister listens for all transactions to see if any might be a canister top-up transaction by an NNS dapp user.
We want the NNS dapp to stop listening for all transactions so we want to move this fallback mechanism to the frontend.
In this PR we add a service function that will be used to check if the CMC needs to be notified and to do so if needed.
It only checks the most recent transaction to see if it is a funding transaction. It's theoretically possible to have a funding transaction that is followed by another transaction that's not the corresponding burn transaction. This was discussed with the PM and decided that it's unlikely enough that it's not worth the extra complexity to take into account. If we decide later that we do want to take this into account we can still recover from those cases that were missed before.
Changes
notifyTopUpIfNeeded. It checks the latest transaction on the CMC subaccount for a specific canister and notifies the CMC if the latest transaction is a top-up transaction.Tests
Todos
not yet