chore(suite-common): rename formatter to more appropriate name

trezor · Jan 16, 2025 · 275b92f · 275b92f
1 parent 5cb1895
commit 275b92f
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 21 deletions.
diff --git a/suite-common/formatters/src/FormatterProvider.tsx b/suite-common/formatters/src/FormatterProvider.tsx
@@ -21,9 +21,9 @@ import {
 } from './formatters/prepareFiatAmountFormatter';
 import { MonthNameFormatter } from './formatters/prepareMonthNameFormatter';
 import {
-    NetworkSymbolFormatterDataContext,
-    prepareNetworkSymbolFormatter,
-} from './formatters/prepareNetworkSymbolFormatter';
+    DisplaySymbolFormatterDataContext,
+    prepareDisplaySymbolFormatter,
+} from './formatters/prepareDisplaySymbolFormatter';
 import { prepareTimeFormatter } from './formatters/prepareTimeFormatter';
 import { Formatter } from './makeFormatter';
 import { FormatterConfig, FormatterProviderConfig } from './types';
@@ -39,7 +39,7 @@ export type Formatters = {
         string,
         CryptoAmountFormatterDataContext
     >;
-    NetworkSymbolFormatter: Formatter<NetworkSymbol, string, NetworkSymbolFormatterDataContext>;
+    DisplaySymbolFormatter: Formatter<NetworkSymbol, string, DisplaySymbolFormatterDataContext>;
     NetworkNameFormatter: Formatter<NetworkSymbol, string>;
     SignValueFormatter: Formatter<SignValue | undefined, string>;
     FiatAmountFormatter: Formatter<
@@ -57,15 +57,15 @@ export const FormatterProviderContext = createContext<Formatters>({} as Formatte
 
 export const getFormatters = (config: FormatterConfig): Formatters => {
     const CryptoAmountFormatter = prepareCryptoAmountFormatter(config);
-    const NetworkSymbolFormatter = prepareNetworkSymbolFormatter(config);
+    const DisplaySymbolFormatter = prepareDisplaySymbolFormatter(config);
     const FiatAmountFormatter = prepareFiatAmountFormatter(config);
     const DateFormatter = prepareDateFormatter(config);
     const TimeFormatter = prepareTimeFormatter(config);
     const DateTimeFormatter = prepareDateTimeFormatter(config);
 
     return {
         CryptoAmountFormatter,
-        NetworkSymbolFormatter,
+        DisplaySymbolFormatter,
         NetworkNameFormatter,
         FiatAmountFormatter,
         DateFormatter,

diff --git a/suite-common/formatters/src/formatters/prepareCryptoAmountFormatter.ts b/suite-common/formatters/src/formatters/prepareCryptoAmountFormatter.ts
@@ -15,7 +15,7 @@ import { PROTO } from '@trezor/connect';
 
 import { makeFormatter } from '../makeFormatter';
 import { FormatterConfig } from '../types';
-import { prepareNetworkSymbolFormatter } from './prepareNetworkSymbolFormatter';
+import { prepareDisplaySymbolFormatter } from './prepareDisplaySymbolFormatter';
 
 export type CryptoAmountFormatterInputValue = string;
 
@@ -70,9 +70,9 @@ const convertToUnit = (
 };
 
 const appendSymbol = (value: string, config: FormatterConfig, symbol: NetworkSymbol) => {
-    const NetworkSymbolFormatter = prepareNetworkSymbolFormatter(config);
+    const DisplaySymbolFormatter = prepareDisplaySymbolFormatter(config);
 
-    return `${value} ${NetworkSymbolFormatter.format(symbol)}`;
+    return `${value} ${DisplaySymbolFormatter.format(symbol)}`;
 };
 
 export const prepareCryptoAmountFormatter = (config: FormatterConfig) =>

diff --git a/...rmatters/prepareNetworkSymbolFormatter.ts → ...rmatters/prepareDisplaySymbolFormatter.ts b/...rmatters/prepareNetworkSymbolFormatter.ts → ...rmatters/prepareDisplaySymbolFormatter.ts
@@ -4,10 +4,10 @@ import { getNetwork, getNetworkDisplaySymbol, NetworkSymbol } from '@suite-commo
 import { FormatterConfig } from '../types';
 import { makeFormatter } from '../makeFormatter';
 
-export type NetworkSymbolFormatterDataContext = { areAmountUnitsEnabled?: boolean };
+export type DisplaySymbolFormatterDataContext = { areAmountUnitsEnabled?: boolean };
 
-export const prepareNetworkSymbolFormatter = (config: FormatterConfig) =>
-    makeFormatter<NetworkSymbol, string, NetworkSymbolFormatterDataContext>(
+export const prepareDisplaySymbolFormatter = (config: FormatterConfig) =>
+    makeFormatter<NetworkSymbol, string, DisplaySymbolFormatterDataContext>(
         (symbol, dataContext) => {
             const { bitcoinAmountUnit } = config;
             const { areAmountUnitsEnabled = true } = dataContext;
@@ -26,5 +26,5 @@ export const prepareNetworkSymbolFormatter = (config: FormatterConfig) =>
 
             return formattedSymbol;
         },
-        'NetworkSymbolFormatter',
+        'DisplaySymbolFormatter',
     );
diff --git a/...sts/prepareNetworkSymbolFormatter.test.ts → ...sts/prepareDisplaySymbolFormatter.test.ts b/...sts/prepareNetworkSymbolFormatter.test.ts → ...sts/prepareDisplaySymbolFormatter.test.ts
@@ -1,13 +1,13 @@
 import { PROTO } from '@trezor/connect';
 import { NetworkSymbol } from '@suite-common/wallet-config';
 
-import { prepareNetworkSymbolFormatter } from '../prepareNetworkSymbolFormatter';
+import { prepareDisplaySymbolFormatter } from '../prepareDisplaySymbolFormatter';
 
-describe('prepareNetworkSymbolFormatter', () => {
-    let networkSymbolFormatter: ReturnType<typeof prepareNetworkSymbolFormatter>;
+describe('prepareDisplaySymbolFormatter', () => {
+    let displaySymbolFormatter: ReturnType<typeof prepareDisplaySymbolFormatter>;
 
     beforeEach(() => {
-        networkSymbolFormatter = prepareNetworkSymbolFormatter({
+        displaySymbolFormatter = prepareDisplaySymbolFormatter({
             coins: [],
             locale: 'en',
             bitcoinAmountUnit: PROTO.AmountUnit.BITCOIN,
@@ -24,7 +24,7 @@ describe('prepareNetworkSymbolFormatter', () => {
     ] as [NetworkSymbol, string][])(
         'should display symbolName (#16190) case %#',
         (symbol: NetworkSymbol, expectedValue: string) => {
-            expect(networkSymbolFormatter.format(symbol, {})).toBe(expectedValue);
+            expect(displaySymbolFormatter.format(symbol, {})).toBe(expectedValue);
         },
     );
 });
diff --git a/suite-native/accounts/src/components/SelectableNetworkItem.tsx b/suite-native/accounts/src/components/SelectableNetworkItem.tsx
@@ -28,7 +28,7 @@ const tokensBadgeStyle = prepareNativeStyle(utils => ({
 
 export const SelectableNetworkItem = ({ symbol, onPress, rightIcon }: SelectableAssetItemProps) => {
     const { applyStyle } = useNativeStyles();
-    const { NetworkSymbolFormatter } = useFormatters();
+    const { DisplaySymbolFormatter } = useFormatters();
 
     const handlePress = () => {
         if (!onPress) return;
@@ -52,7 +52,7 @@ export const SelectableNetworkItem = ({ symbol, onPress, rightIcon }: Selectable
                         <Text variant="body">{networkName}</Text>
                         <HStack alignItems="center" justifyContent="center">
                             <Text variant="hint" color="textSubdued">
-                                <NetworkSymbolFormatter
+                                <DisplaySymbolFormatter
                                     value={symbol}
                                     areAmountUnitsEnabled={false}
                                 />

diff --git a/suite-native/module-send/src/components/CryptoAmountInput.tsx b/suite-native/module-send/src/components/CryptoAmountInput.tsx
@@ -53,7 +53,7 @@ export const CryptoAmountInput = ({
     const { applyStyle } = useNativeStyles();
     const { setValue, trigger } = useFormContext<SendOutputsFormValues>();
     const { cryptoAmountTransformer } = useSendAmountTransformers(symbol);
-    const { NetworkSymbolFormatter: formatter } = useFormatters();
+    const { DisplaySymbolFormatter: formatter } = useFormatters();
     const debounce = useDebounce();
 
     const tokenSymbol = useSelector((state: TokensRootState) =>