feat(frontend): use always Ledger canister for ICRC balances #5016
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
| @@ -87,7 +99,7 @@ const initIcrcWalletTransactionsScheduler = (): IcWalletTransactionsScheduler< | |||
| PostMessageDataRequestIcrcStrict | |||
| > => | |||
| new IcWalletTransactionsScheduler( | |||
| getTransactions, | |||
| getTransactionsWithLedgerBalance, | |||
There was a problem hiding this comment.
Either before, ideally, or after, the code of the application should be refactored, as the schedulers and workers currently reflect the fact that we only fetch transactions—which, to some extent, is already not ideal.
So, IcWalletTransactionsScheduler, getTransactions, etc., should all be renamed to be more generic.
| const getTransactionsWithLedgerBalance = async ( | ||
| params: SchedulerJobParams<PostMessageDataRequestIcrcStrict> | ||
| ): Promise<IcrcIndexNgGetTransactions> => { | ||
| const balance = await getBalance(params); |
There was a problem hiding this comment.
- no
await Promise.something([])? - what happens if the balance succeed and transactions fails, does that become acceptable since we are already here?
| ): Promise<IcrcIndexNgGetTransactions> => { | ||
| const balance = await getBalance(params); | ||
|
|
||
| // Ignoring the balance from the transactions' response. |
There was a problem hiding this comment.
We should be more expressive than just a comment in my opinion. This should be expressed by the code.
| @@ -79,6 +79,18 @@ const getBalance = ({ | |||
| }); | |||
| }; | |||
|
|
|||
| const getTransactionsWithLedgerBalance = async ( | |||
| params: SchedulerJobParams<PostMessageDataRequestIcrcStrict> | |||
| ): Promise<IcrcIndexNgGetTransactions> => { | |||
There was a problem hiding this comment.
The return type isn't IcrcIndexNgGetTransactions. It's Omit<IcrcIndexNgGetTransactions, "balance"> & SomethingElse.
| import { arrayOfNumberToUint8Array, jsonReplacer } from '@dfinity/utils'; | ||
| import type { MockInstance } from 'vitest'; | ||
| import { mock } from 'vitest-mock-extended'; | ||
|
|
||
| describe('ic-wallet-transactions.worker', () => { | ||
| let spyGetBalance: MockInstance; |
There was a problem hiding this comment.
- There is no new tests that asserts that the balance comes indeed from the ledger and not from the index?
- No tests about one or the other failing?
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
To guarantee that the balance is always loaded and correct, we force the ICRC Wallet scheduler to always use the Ledger canister for the balance instead of the Index canister. This change could cause smaller lagged inconsistencies between data: the total of transactions may not match the balance for a few seconds.
However, it was deemed acceptable since it would at least guarantee the correct amount if the Index canister of an ICRC is not correctly working (it happened in a few cases and support tickets were raised).
Changes
getBalanceAndTransactionsthat merges thegetBalancemethod with the transactions one. It will override thebalanceprop.getBalanceAndTransactionsin theIcWalletTransactionsScheduler.Tests
Adjusted the tests to the new structure.