feat(wallet): the wallet now only fetches UTXOs on tx history change

Author: AngelCastilloB

packages/wallet/src/Wallets/BaseWallet.ts

@@ -51,7 +51,6 @@ import {
   createUtxoTracker,
   createWalletUtil,
   currentEpochTracker,
-  distinctBlock,
   distinctEraSummaries
 } from '../services';
 import { AddressType, Bip32Account, GroupedAddress, WitnessedTx, Witnesser, util } from '@cardano-sdk/key-management';
@@ -397,7 +396,6 @@ export class BaseWallet implements ObservableWallet {
       store: stores.tip,
       syncStatus: this.syncStatus
     });
-    const tipBlockHeight$ = distinctBlock(this.tip$);
 
     this.txSubmitProvider = new SmartTxSubmitProvider(
       { retryBackoffConfig },
@@ -499,11 +497,11 @@ export class BaseWallet implements ObservableWallet {
 
     this.utxo = createUtxoTracker({
       addresses$,
+      history$: this.transactions.history$,
       logger: contextLogger(this.#logger, 'utxo'),
       onFatalError,
       retryBackoffConfig,
       stores,
-      tipBlockHeight$,
       transactionsInFlight$: this.transactions.outgoing.inFlight$,
       utxoProvider: this.utxoProvider
     });

packages/wallet/src/services/UtxoTracker.ts

@@ -6,6 +6,7 @@ import { RetryBackoffConfig } from 'backoff-rxjs';
 import { TxInFlight, UtxoTracker } from './types';
 import { WalletStores } from '../persistence';
 import { coldObservableProvider } from '@cardano-sdk/util-rxjs';
+import { sortUtxoByTxIn } from '@cardano-sdk/input-selection';
 import chunk from 'lodash/chunk.js';
 import uniqWith from 'lodash/uniqWith.js';
 
@@ -17,7 +18,7 @@ export interface UtxoTrackerProps {
   addresses$: Observable<Cardano.PaymentAddress[]>;
   stores: Pick<WalletStores, 'utxo' | 'unspendableUtxo'>;
   transactionsInFlight$: Observable<TxInFlight[]>;
-  tipBlockHeight$: Observable<Cardano.BlockNo>;
+  history$: Observable<Cardano.HydratedTx[]>;
   retryBackoffConfig: RetryBackoffConfig;
   logger: Logger;
   onFatalError?: (value: unknown) => void;
@@ -31,7 +32,7 @@ export interface UtxoTrackerInternals {
 export const createUtxoProvider = (
   utxoProvider: UtxoProvider,
   addresses$: Observable<Cardano.PaymentAddress[]>,
-  tipBlockHeight$: Observable<Cardano.BlockNo>,
+  history$: Observable<Cardano.HydratedTx[]>,
   retryBackoffConfig: RetryBackoffConfig,
   onFatalError?: (value: unknown) => void
 ) =>
@@ -49,10 +50,10 @@ export const createUtxoProvider = (
             utxos = [...utxos, ...(await utxoProvider.utxoByAddresses({ addresses }))];
           }
 
-          return utxos;
+          return utxos.sort(sortUtxoByTxIn);
         },
         retryBackoffConfig,
-        trigger$: tipBlockHeight$
+        trigger$: history$
       })
     )
   );
@@ -64,13 +65,13 @@ export const createUtxoTracker = (
     stores,
     transactionsInFlight$,
     retryBackoffConfig,
-    tipBlockHeight$,
+    history$,
     logger,
     onFatalError
   }: UtxoTrackerProps,
   {
     utxoSource$ = new PersistentCollectionTrackerSubject<Cardano.Utxo>(
-      () => createUtxoProvider(utxoProvider, addresses$, tipBlockHeight$, retryBackoffConfig, onFatalError),
+      () => createUtxoProvider(utxoProvider, addresses$, history$, retryBackoffConfig, onFatalError),
       stores.utxo
     ),
     unspendableUtxoSource$ = new PersistentCollectionTrackerSubject(

packages/wallet/src/services/util/equals.ts

@@ -7,12 +7,27 @@ export const tipEquals = (a: Cardano.Tip, b: Cardano.Tip) => a.hash === b.hash;
 
 export const txEquals = (a: Cardano.HydratedTx, b: Cardano.HydratedTx) => a.id === b.id;
 
+export const sameSortedArrayItems = <T>(arrayA: T[], arrayB: T[], itemEquals: (a: T, b: T) => boolean): boolean => {
+  if (arrayA.length !== arrayB.length) return false;
+
+  for (const [i, element] of arrayA.entries()) {
+    if (!itemEquals(element, arrayB[i])) {
+      return false;
+    }
+  }
+
+  return true;
+};
+
 export const transactionsEquals = (a: Cardano.HydratedTx[], b: Cardano.HydratedTx[]) => sameArrayItems(a, b, txEquals);
 
 export const txInEquals = (a: Cardano.TxIn, b: Cardano.TxIn) => a.txId === b.txId && a.index === b.index;
 
-export const utxoEquals = (a: Cardano.Utxo[], b: Cardano.Utxo[]) =>
-  sameArrayItems(a, b, ([aTxIn], [bTxIn]) => txInEquals(aTxIn, bTxIn));
+export const utxoEquals = (a: Cardano.Utxo[], b: Cardano.Utxo[]) => {
+  if (a === b) return true;
+
+  return sameSortedArrayItems(a, b, ([aTxIn], [bTxIn]) => txInEquals(aTxIn, bTxIn));
+};
 
 export const eraSummariesEquals = (a: EraSummary[], b: EraSummary[]) =>
   sameArrayItems(a, b, (es1, es2) => es1.start.slot === es2.start.slot);

packages/wallet/test/services/UtxoTracker.test.ts

@@ -20,7 +20,7 @@ const createStubOutputs = (numOutputs: number) =>
 describe('createUtxoTracker', () => {
   // these variables are not relevant for this test, overwriting utxoSource$
   let retryBackoffConfig: RetryBackoffConfig;
-  let tipBlockHeight$: Observable<Cardano.BlockNo>;
+  let history$: Observable<Cardano.HydratedTx[]>;
   let utxoProvider: UtxoProvider;
   const logger = dummyLogger;
 
@@ -88,13 +88,13 @@ describe('createUtxoTracker', () => {
       const utxoTracker = createUtxoTracker(
         {
           addresses$: cold('a|', { a: [ownAddress!] }),
+          history$,
           logger,
           retryBackoffConfig,
           stores: {
             unspendableUtxo: store,
             utxo: store
           },
-          tipBlockHeight$,
           transactionsInFlight$,
           utxoProvider
         },
@@ -142,13 +142,13 @@ describe('createUtxoTracker', () => {
       const utxoTracker = createUtxoTracker(
         {
           addresses$: cold('a', { a: [address!] }),
+          history$,
           logger,
           retryBackoffConfig,
           stores: {
             unspendableUtxo: store,
             utxo: store
           },
-          tipBlockHeight$,
           transactionsInFlight$,
           utxoProvider
         },
@@ -172,13 +172,13 @@ describe('createUtxoTracker', () => {
       const utxoTracker = createUtxoTracker(
         {
           addresses$: cold('a|', { a: [address!] }),
+          history$,
           logger,
           retryBackoffConfig,
           stores: {
             unspendableUtxo: store,
             utxo: store
           },
-          tipBlockHeight$,
           transactionsInFlight$,
           utxoProvider
         },
@@ -211,13 +211,13 @@ describe('createUtxoTracker', () => {
       const utxoTracker = createUtxoTracker(
         {
           addresses$: cold('a|', { a: [address!] }),
+          history$,
           logger,
           retryBackoffConfig,
           stores: {
             unspendableUtxo: store,
             utxo: store
           },
-          tipBlockHeight$,
           transactionsInFlight$,
           utxoProvider
         },
@@ -241,13 +241,13 @@ describe('createUtxoTracker', () => {
       const utxoTracker = createUtxoTracker(
         {
           addresses$: cold('a|', { a: [address!] }),
+          history$,
           logger,
           retryBackoffConfig,
           stores: {
             unspendableUtxo: store,
             utxo: store
           },
-          tipBlockHeight$,
           transactionsInFlight$,
           utxoProvider
         },