feat: add should keep polling method (#685)

Author: lucaslovato

source/scripts/Background/controllers/MigrationController.ts

@@ -1,6 +1,7 @@
 /* eslint-disable camelcase */
 import paliData from '../../../../package.json';
 import v3_0_1 from '../migration/v3_0_1';
+import v3_3_2 from '../migration/v3_3_2';
 import { getIsMigratedVersion, loadState } from 'state/paliStorage';
 
 const MigrationController = async () => {
@@ -21,6 +22,14 @@ const MigrationController = async () => {
   if (currentPaliVersion === '3.0.1' && !isMigratedVersion) {
     await v3_0_1(state);
   }
+
+  /**
+   * version < 3.3.2
+   * Description: add faucet feature
+   */
+  if (currentPaliVersion === '3.3.2' && !isMigratedVersion) {
+    await v3_3_2(state);
+  }
 };
 
 export default MigrationController;

source/scripts/Background/handlers/handlePaliUpdates.ts

@@ -1,14 +1,64 @@
+import { INetworkType } from '@pollum-io/sysweb3-network';
+
 import { controllerEmitter } from 'scripts/Background/controllers/controllerEmitter';
 import { isPollingRunNotValid } from 'scripts/Background/utils/isPollingRunNotValid';
 import store from 'state/store';
+import { setPrevBalances } from 'state/vault';
 
-export async function checkForUpdates() {
-  const { activeAccount, isBitcoinBased, activeNetwork } =
-    store.getState().vault;
+function shouldUpdate() {
+  const {
+    accounts,
+    activeAccount,
+    isBitcoinBased,
+    activeNetwork,
+    prevBalances,
+  } = store.getState().vault;
+
+  const chain = isBitcoinBased ? INetworkType.Syscoin : INetworkType.Ethereum;
+  const chainId = activeNetwork.chainId;
+
+  const currentBalance = isBitcoinBased
+    ? accounts[activeAccount.type][activeAccount.id].balances.syscoin
+    : accounts[activeAccount.type][activeAccount.id].balances.syscoin;
 
+  const previousBalance = prevBalances[activeAccount.id]?.[chain]?.[chainId];
+  const currentAccount = accounts[activeAccount.type][activeAccount.id];
+  const currentAccountTransactions = currentAccount.transactions[chain][
+    chainId
+  ] as any[];
+
+  const hasPendingTx = (currentAccountTransactions ?? []).every(
+    (tx) => tx.confirmations > 0
+  );
+
+  if (currentBalance === previousBalance && hasPendingTx) {
+    return false;
+  }
+
+  store.dispatch(
+    setPrevBalances({
+      activeAccountId: activeAccount.id,
+      balance: currentBalance,
+      chain: isBitcoinBased ? INetworkType.Syscoin : INetworkType.Ethereum,
+      chainId: activeNetwork.chainId,
+    })
+  );
+
+  return true;
+}
+
+export async function checkForUpdates() {
   if (isPollingRunNotValid()) {
     return;
   }
+
+  if (!shouldUpdate()) {
+    return;
+  }
+
+  const { activeAccount, isBitcoinBased, activeNetwork } =
+    store.getState().vault;
+
   controllerEmitter(
     ['wallet', 'updateUserNativeBalance'],
     [

source/scripts/Background/migration/v3_3_2.ts

@@ -0,0 +1,30 @@
+/* eslint-disable camelcase */
+
+import { saveState, setMigratedVersions } from 'state/paliStorage';
+import { initialState as initialVaultState } from 'state/vault';
+import { IVaultState } from 'state/vault/types';
+
+type V3_3_2 = {
+  vault: IVaultState;
+};
+
+const MigrateRunner = async (oldState: any) => {
+  try {
+    const newState: V3_3_2 = {
+      ...oldState,
+      vault: {
+        ...oldState.vault,
+        prevBalances: initialVaultState.prevBalances,
+      },
+    };
+
+    await Promise.all([saveState(newState), setMigratedVersions('3.3.2')]);
+
+    console.log('Migrate to <v3.3.2> successfully!');
+  } catch (error) {
+    console.log('<v3.3.2> Migration Error');
+    console.log(error);
+  }
+};
+
+export default MigrateRunner;

source/state/vault/index.ts

@@ -4,13 +4,13 @@ import cloneDeep from 'lodash/cloneDeep';
 import take from 'lodash/take';
 
 import {
-  initialNetworksState,
+  IKeyringBalances,
   initialActiveHdAccountState,
   initialActiveImportedAccountState,
-  KeyringAccountType,
-  IWalletState,
-  IKeyringBalances,
   initialActiveTrezorAccountState,
+  initialNetworksState,
+  IWalletState,
+  KeyringAccountType,
 } from '@pollum-io/sysweb3-keyring';
 import { INetwork, INetworkType } from '@pollum-io/sysweb3-network';
 import { INftsStructure } from '@pollum-io/sysweb3-utils';
@@ -89,6 +89,12 @@ export const initialState: IVaultState = {
     5700: true,
     57000: true,
   },
+  prevBalances: {
+    [0]: {
+      [INetworkType.Ethereum]: {},
+      [INetworkType.Syscoin]: {},
+    },
+  },
 };
 
 export const getHasEncryptedVault = createAsyncThunk(
@@ -795,13 +801,35 @@ const VaultState = createSlice({
         TransactionsType.Ethereum
       ][chainID] as IEvmTransaction[];
 
-      const removedTx = userTransactions.filter(
+      state.accounts[type][id].transactions[TransactionsType.Ethereum][
+        chainID
+      ] = userTransactions.filter(
         (tx) => tx.hash !== oldTxHash
       ) as IEvmTransaction[];
+    },
+    setPrevBalances(
+      state: IVaultState,
+      action: PayloadAction<{
+        activeAccountId: number;
+        balance: number;
+        chain: INetworkType;
+        chainId: number;
+      }>
+    ) {
+      const { activeAccountId, chain, chainId, balance } = action.payload;
 
-      state.accounts[type][id].transactions[TransactionsType.Ethereum][
-        chainID
-      ] = removedTx;
+      if (!state.prevBalances[activeAccountId]) {
+        state.prevBalances[activeAccountId] = {
+          [INetworkType.Ethereum]: {},
+          [INetworkType.Syscoin]: {},
+        };
+      }
+
+      if (!state.prevBalances[activeAccountId][chain]) {
+        state.prevBalances[activeAccountId][chain] = {};
+      }
+
+      state.prevBalances[activeAccountId][chain][chainId] = balance;
     },
   },
 
@@ -858,6 +886,7 @@ export const {
   setTransactionStatusToAccelerated,
   setCoinsList,
   setIsLastTxConfirmed,
+  setPrevBalances,
 } = VaultState.actions;
 
 export default VaultState.reducer;

source/state/vault/types.ts

@@ -14,7 +14,7 @@ import {
 import { ITokenEthProps, ITokenSysProps } from 'types/tokens';
 
 export interface IVaultState {
-  accounts: { [key in KeyringAccountType]: PaliAccount }; //todo adjust and guarantee type is correct
+  accounts: { [key in KeyringAccountType]: PaliAccount };
   activeAccount: {
     id: number;
     type: KeyringAccountType;
@@ -43,6 +43,7 @@ export interface IVaultState {
   isTimerEnabled: boolean;
   lastLogin: number;
   networks: INetworksVault;
+  prevBalances: IPrevBalances;
   shouldShowFaucetModal: { [k: number]: boolean };
   timer: number;
 }
@@ -56,6 +57,17 @@ export interface INetworksVault {
   };
 }
 
+export interface IPrevBalances {
+  [accountId: number]: {
+    [INetworkType.Ethereum]: {
+      [chainId: number]: number;
+    };
+    [INetworkType.Syscoin]: {
+      [chainId: number]: number;
+    };
+  };
+}
+
 export interface IChangingConnectedAccount {
   connectedAccountType: KeyringAccountType | undefined;
   host: string | undefined;