@ledgerhq/live-common 25.1.0 → 25.2.0-next.0

package/src/bridge/react/BridgeSync.tsx

@@ -11,12 +11,14 @@ import React, {
   useMemo,
 } from "react";
 import { getVotesCount, isUpToDateAccount } from "../../account";
-import type { SubAccount, Account, CryptoCurrency } from "../../types";
 import { getAccountBridge } from "..";
 import { getAccountCurrency } from "../../account";
 import { getEnv } from "../../env";
 import type { SyncAction, SyncState, BridgeSyncState } from "./types";
 import { BridgeSyncContext, BridgeSyncStateContext } from "./context";
+import type { Account, SubAccount } from "@ledgerhq/types-live";
+import type { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
+
 export type Props = {
   // this is a wrapping component that you need to put in your tree
   children: React.ReactNode;
@@ -42,6 +44,12 @@ export type Props = {
   // an array of token ids to blacklist from the account sync
   blacklistedTokenIds?: string[];
 };
+
+type SyncJob = {
+  accountId: string;
+  reason: string;
+};
+
 export const BridgeSync = ({
   children,
   accounts,
@@ -124,7 +132,7 @@ function useSyncQueue({
     setBridgeSyncState((state) => ({ ...state, [accountId]: s }));
   }, []);
   const synchronize = useCallback(
-    (accountId: string, next: () => void) => {
+    ({ accountId, reason }: SyncJob, next: () => void) => {
       const state = bridgeSyncState[accountId] || nothingState;
 
       if (state.pending) {
@@ -181,6 +189,7 @@ function useSyncQueue({
             ).length,
             tokensLength: subAccounts.length,
             votesCount: getVotesCount(account),
+            reason,
           });
 
           if (event === "SyncSuccess") {
@@ -196,6 +205,7 @@ function useSyncQueue({
                 parentCurrencyName: account.currency.name,
                 parentDerivationMode: account.derivationMode,
                 votesCount: getVotesCount(a, account),
+                reason,
               });
             });
           }
@@ -269,8 +279,7 @@ function useSyncQueue({
   }, [synchronize]);
   const [syncQueue] = useState(() =>
     priorityQueue(
-      (accountId: string, next: () => void) =>
-        synchronizeRef.current(accountId, next),
+      (job: SyncJob, next: () => void) => synchronizeRef.current(job, next),
       getEnv("SYNC_MAX_CONCURRENT")
     )
   );
@@ -281,22 +290,28 @@ function useSyncQueue({
 function useSync({ syncQueue, accounts }) {
   const skipUnderPriority = useRef(-1);
   const sync = useMemo(() => {
-    const schedule = (ids: string[], priority: number) => {
+    const schedule = (ids: string[], priority: number, reason: string) => {
       if (priority < skipUnderPriority.current) return;
       // by convention we remove concurrent tasks with same priority
       // FIXME this is somehow a hack. ideally we should just dedup the account ids in the pending queue...
       syncQueue.remove((o) => priority === o.priority);
       log("bridge", "schedule " + ids.join(", "));
-      syncQueue.push(ids, -priority);
+      syncQueue.push(
+        ids.map((accountId) => ({
+          accountId,
+          reason,
+        })),
+        -priority
+      );
     };
 
     // don't always sync in the same order to avoid potential "account never reached"
     const shuffledAccountIds = () => shuffle(accounts.map((a) => a.id));
 
     const handlers = {
-      BACKGROUND_TICK: () => {
+      BACKGROUND_TICK: ({ reason }: { reason: string }) => {
         if (syncQueue.idle()) {
-          schedule(shuffledAccountIds(), -1);
+          schedule(shuffledAccountIds(), -1, reason);
         }
       },
       SET_SKIP_UNDER_PRIORITY: ({ priority }: { priority: number }) => {
@@ -306,29 +321,39 @@ function useSync({ syncQueue, accounts }) {
 
         if (priority === -1 && !accounts.every(isUpToDateAccount)) {
           // going back to -1 priority => retriggering a background sync if it is "Paused"
-          schedule(shuffledAccountIds(), -1);
+          schedule(shuffledAccountIds(), -1, "outdated");
         }
       },
-      SYNC_ALL_ACCOUNTS: ({ priority }: { priority: number }) => {
-        schedule(shuffledAccountIds(), priority);
+      SYNC_ALL_ACCOUNTS: ({
+        priority,
+        reason,
+      }: {
+        priority: number;
+        reason: string;
+      }) => {
+        schedule(shuffledAccountIds(), priority, reason);
       },
       SYNC_ONE_ACCOUNT: ({
         accountId,
         priority,
+        reason,
       }: {
         accountId: string;
         priority: number;
+        reason: string;
       }) => {
-        schedule([accountId], priority);
+        schedule([accountId], priority, reason);
       },
       SYNC_SOME_ACCOUNTS: ({
         accountIds,
         priority,
+        reason,
       }: {
         accountIds: string[];
         priority: number;
+        reason: string;
       }) => {
-        schedule(accountIds, priority);
+        schedule(accountIds, priority, reason);
       },
     };
     return (action: SyncAction) => {
@@ -361,14 +386,19 @@ function useSyncBackground({ sync }) {
   useEffect(() => {
     let syncTimeout;
 
-    const syncLoop = async () => {
+    const syncLoop = async (reason: string) => {
       sync({
         type: "BACKGROUND_TICK",
+        reason,
       });
-      syncTimeout = setTimeout(syncLoop, getEnv("SYNC_ALL_INTERVAL"));
+      syncTimeout = setTimeout(
+        syncLoop,
+        getEnv("SYNC_ALL_INTERVAL"),
+        "background"
+      );
     };
 
-    syncTimeout = setTimeout(syncLoop, getEnv("SYNC_BOOT_DELAY"));
+    syncTimeout = setTimeout(syncLoop, getEnv("SYNC_BOOT_DELAY"), "initial");
     return () => clearTimeout(syncTimeout);
   }, [sync]);
 }
@@ -392,6 +422,7 @@ function useSyncContinouslyPendingOperations({ sync, accounts }) {
         type: "SYNC_SOME_ACCOUNTS",
         accountIds: refIds.current,
         priority: 20,
+        reason: "pending-operations",
       });
       timeout = setTimeout(update, getEnv("SYNC_PENDING_INTERVAL"));
     };

package/src/bridge/react/SyncOneAccountOnMount.ts

@@ -3,9 +3,11 @@ import { useBridgeSync } from "./context";
 export const SyncOneAccountOnMount = ({
   priority,
   accountId,
+  reason = "one-account",
 }: {
   accountId: string;
   priority: number;
+  reason: string;
 }): null => {
   const sync = useBridgeSync();
   useEffect(() => {
@@ -13,7 +15,8 @@ export const SyncOneAccountOnMount = ({
       type: "SYNC_ONE_ACCOUNT",
       priority,
       accountId,
+      reason,
     });
-  }, [sync, priority, accountId]);
+  }, [sync, priority, accountId, reason]);
   return null;
 };

package/src/bridge/react/index.ts

@@ -1,6 +1,5 @@
 export * from "./context";
 export * from "./BridgeSync";
-export * from "./SyncAllAccountsOnMount";
 export * from "./SyncOneAccountOnMount";
 export * from "./SyncSkipUnderPriority";
 export * from "./useAccountSyncState";

package/src/bridge/react/types.ts

@@ -1,6 +1,7 @@
 export type SyncAction =
   | {
       type: "BACKGROUND_TICK";
+      reason: string;
     }
   | {
       type: "SET_SKIP_UNDER_PRIORITY";
@@ -10,15 +11,18 @@ export type SyncAction =
       type: "SYNC_ONE_ACCOUNT";
       accountId: string;
       priority: number;
+      reason: string;
     }
   | {
       type: "SYNC_SOME_ACCOUNTS";
       accountIds: string[];
       priority: number;
+      reason: string;
     }
   | {
       type: "SYNC_ALL_ACCOUNTS";
       priority: number;
+      reason: string;
     };
 export type SyncState = {
   pending: boolean;

package/src/bridge/useBridgeTransaction.ts

@@ -1,15 +1,11 @@
 import { BigNumber } from "bignumber.js";
 import { useEffect, useReducer, useCallback, useRef } from "react";
 import { log } from "@ledgerhq/logs";
-import type {
-  Transaction,
-  TransactionStatus,
-  Account,
-  AccountLike,
-} from "../types";
 import { getAccountBridge } from ".";
 import { getMainAccount } from "../account";
 import { delay } from "../promise";
+import type { Account, AccountLike } from "@ledgerhq/types-live";
+import type { Transaction, TransactionStatus } from "../generated/types";
 export type State = {
   account: AccountLike | null | undefined;
   parentAccount: Account | null | undefined;

package/src/compound/logic.ts

@@ -1,6 +1,5 @@
 import { BigNumber } from "bignumber.js";
 import { findCompoundToken } from "../currencies";
-import type { TokenAccount, Account, Operation } from "../types";
 import type {
   CompoundAccountSummary,
   ClosedLoansHistory,
@@ -13,6 +12,7 @@ import {
   findCurrentRate,
   getEnabledAmount,
 } from "../families/ethereum/modules/compound";
+import { Account, Operation, TokenAccount } from "@ledgerhq/types-live";
 // to confirm in practice if this threshold is high enough / too high
 const unlimitedThreshold = new BigNumber(2).pow(250);
 export function getAccountCapabilities(account: TokenAccount):

package/src/compound/react.ts

@@ -1,6 +1,5 @@
 import { useMemo } from "react";
 import { BigNumber } from "bignumber.js";
-import type { AccountLikeArray, TokenAccount } from "../types";
 import {
   getSupplyMax,
   isCompoundTokenSupported,
@@ -8,6 +7,7 @@ import {
 import type { CompoundAccountSummary } from "./types";
 import { makeCompoundSummaryForAccount } from "./logic";
 import { findCompoundToken } from "../currencies";
+import { AccountLikeArray, TokenAccount } from "@ledgerhq/types-live";
 export function useSupplyMax(account: TokenAccount): BigNumber {
   return useMemo(() => getSupplyMax(account), [account]);
 }

package/src/compound/types.ts

@@ -1,5 +1,5 @@
+import { Account, TokenAccount } from "@ledgerhq/types-live";
 import { BigNumber } from "bignumber.js";
-import type { TokenAccount, Account } from "../types";
 // ? LOGO Token
 export type CompoundAssetMetric = {
   grossSupply: number;

package/src/countervalues/api/index.ts

@@ -5,13 +5,15 @@ import mockAPI from "./api.mock";
 
 const api: CounterValuesAPI = {
   fetchHistorical: (granularity, pair) =>
-    getEnv("MOCK")
+    getEnv("MOCK_COUNTERVALUES")
       ? mockAPI.fetchHistorical(granularity, pair)
       : prodAPI.fetchHistorical(granularity, pair),
   fetchLatest: (pairs) =>
-    getEnv("MOCK") ? mockAPI.fetchLatest(pairs) : prodAPI.fetchLatest(pairs),
+    getEnv("MOCK_COUNTERVALUES")
+      ? mockAPI.fetchLatest(pairs)
+      : prodAPI.fetchLatest(pairs),
   fetchMarketcapTickers: () =>
-    getEnv("MOCK")
+    getEnv("MOCK_COUNTERVALUES")
       ? mockAPI.fetchMarketcapTickers()
       : prodAPI.fetchMarketcapTickers(),
 };

package/src/countervalues/helpers.ts

@@ -1,4 +1,4 @@
-import type { Currency } from "../types";
+import { Currency } from "@ledgerhq/types-cryptoassets";
 import type { RateGranularity } from "./types";
 
 const HOUR = 60 * 60 * 1000;

package/src/countervalues/logic.integration.test.ts

@@ -6,7 +6,7 @@ import {
   findCurrencyByTicker,
 } from "../currencies";
 import { getBTCValues } from "../countervalues/mock";
-import { Currency } from "@ledgerhq/cryptoassets";
+import { Currency } from "@ledgerhq/types-cryptoassets";
 
 const bitcoin = getCryptoCurrencyById("bitcoin");
 const usd = getFiatCurrencyByTicker("USD");

package/src/countervalues/logic.ts

@@ -1,5 +1,4 @@
 import { log } from "@ledgerhq/logs";
-import type { Currency, Account } from "../types";
 import { flattenAccounts, getAccountCurrency } from "../account/helpers";
 import { promiseAllBatched } from "../promise";
 import type {
@@ -29,6 +28,8 @@ import {
   mapRate,
   resolveTrackingPair,
 } from "./modules";
+import type { Account } from "@ledgerhq/types-live";
+import type { Currency } from "@ledgerhq/types-cryptoassets";
 
 // yield raw version of the countervalues state to be saved in a db
 export function exportCountervalues({

package/src/countervalues/mock.test.ts

@@ -13,6 +13,7 @@ import {
   parseFormattedDate,
 } from "./helpers";
 setEnv("MOCK", "1");
+setEnv("MOCK_COUNTERVALUES", "1");
 test("helpers", () => {
   expect(formatCounterValueDay(new Date())).toBe("2018-03-14");
   expect(formatCounterValueHour(new Date())).toBe("2018-03-14T17");

package/src/countervalues/modules/index.ts

@@ -1,10 +1,10 @@
 import { log } from "@ledgerhq/logs";
-import type { Currency } from "../../types";
 import type { RateGranularity, TrackingPair } from "../types";
 import type { Module } from "./types";
 import api from "../api";
 import weth from "./weth";
 import ethbtc from "./ethbtc";
+import type { Currency } from "@ledgerhq/types-cryptoassets";
 
 const modules: Module[] = [weth, ethbtc];
 

package/src/countervalues/modules/types.ts

@@ -1,4 +1,4 @@
-import type { Currency } from "../../types";
+import type { Currency } from "@ledgerhq/types-cryptoassets";
 import type { RateGranularity, TrackingPair, RateMapRaw } from "../types";
 
 export type Pair = {

package/src/countervalues/react.tsx

@@ -10,7 +10,6 @@ import React, {
   useCallback,
   ReactElement,
 } from "react";
-import type { Account, AccountLike, Currency, Unit } from "../types";
 import { getAccountCurrency, getAccountUnit } from "../account/helpers";
 import {
   initialState,
@@ -28,6 +27,8 @@ import type {
   TrackingPair,
 } from "./types";
 import { useDebounce } from "../hooks/useDebounce";
+import type { Account, AccountLike } from "@ledgerhq/types-live";
+import type { Currency, Unit } from "@ledgerhq/types-cryptoassets";
 // Polling is the control object you get from the high level <PollingConsumer>{ polling => ...
 export type Polling = {
   // completely wipe all countervalues

package/src/countervalues/types.ts

@@ -1,5 +1,7 @@
-import type { Currency } from "../types";
 // CountervaluesSettings is user config that drives the countervalues logic.
+
+import type { Currency } from "@ledgerhq/types-cryptoassets";
+
 // we generally will just infer it from Accounts
 export type CountervaluesSettings = {
   trackingPairs: TrackingPair[];

package/src/cross.ts

@@ -1,7 +1,6 @@
 // cross helps dealing with cross-project feature like export/import & cross project conversions
 import { BigNumber } from "bignumber.js";
 import compressjs from "@ledgerhq/compressjs";
-import type { Account, CryptoCurrencyIds } from "./types";
 import {
   runDerivationScheme,
   getDerivationScheme,
@@ -9,6 +8,7 @@ import {
 } from "./derivation";
 import { decodeAccountId, emptyHistoryCache } from "./account";
 import { getCryptoCurrencyById } from "./currencies";
+import type { Account, CryptoCurrencyIds } from "@ledgerhq/types-live";
 
 export type AccountData = {
   id: string;

package/src/csvExport.ts

@@ -1,10 +1,11 @@
 import { BigNumber } from "bignumber.js";
-import type { Currency, Account, AccountLike, Operation } from "./types";
+import type { Account, AccountLike, Operation } from "@ledgerhq/types-live";
 import { formatCurrencyUnit } from "./currencies";
 import { getAccountCurrency, getMainAccount, flattenAccounts } from "./account";
 import { flattenOperationWithInternalsAndNfts } from "./operation";
 import { calculate } from "./countervalues/logic";
 import type { CounterValuesState } from "./countervalues/types";
+import type { Currency } from "@ledgerhq/types-cryptoassets";
 
 type Field = {
   title: string;

package/src/currencies/CurrencyURIScheme.ts

@@ -1,7 +1,7 @@
 import querystring from "querystring";
 import { BigNumber } from "bignumber.js";
-import type { CryptoCurrency } from "../types";
 import { findCryptoCurrencyByScheme } from "@ledgerhq/cryptoassets";
+import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 // see https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki
 type Data = {
   address: string;