fix: structure

Author: Jeday

features/overview/components/balance/balance.tsx

@@ -1,8 +1,8 @@
 import { OverviewItem, OverviewSection } from 'features/overview/shared';
-import { SectionPayload, useVaultOverview } from 'features/overview/contexts';
+import { SectionData, useVaultOverview } from 'features/overview/contexts';
 import { appPaths } from 'consts/routing';
 
-const sectionPayloadList: SectionPayload[] = [
+const sectionPayloadList: SectionData[] = [
   {
     key: 'withdrawableEth',
     actionRole: 'withdrawer',

features/overview/components/capacity/capacity.tsx

@@ -1,8 +1,8 @@
 import { OverviewItem, OverviewSection } from 'features/overview/shared';
-import { SectionPayload, useVaultOverview } from 'features/overview/contexts';
+import { SectionData, useVaultOverview } from 'features/overview/contexts';
 import { getUtilizationRatioColor } from 'utils';
 
-const sectionPayloadList: SectionPayload[] = [
+const sectionPayloadList: SectionData[] = [
   {
     key: 'utilizationRatio',
   },

features/overview/components/health/heath.tsx

@@ -1,8 +1,8 @@
 import { OverviewItem, OverviewSection } from 'features/overview/shared';
-import { SectionPayload, useVaultOverview } from 'features/overview/contexts';
+import { SectionData, useVaultOverview } from 'features/overview/contexts';
 import { formatPercent, getHealthFactorColor } from 'utils';
 
-const sectionPayloadList: SectionPayload[] = [
+const sectionPayloadList: SectionData[] = [
   {
     key: 'healthFactorNumber',
   },

features/overview/components/node-operator/node-operator.tsx

@@ -1,8 +1,8 @@
 import { OverviewItem, OverviewSection } from 'features/overview/shared';
-import { SectionPayload, useVaultOverview } from 'features/overview/contexts';
+import { SectionData, useVaultOverview } from 'features/overview/contexts';
 import { appPaths } from 'consts/routing';
 
-const sectionPayloadList: SectionPayload[] = [
+const sectionPayloadList: SectionData[] = [
   {
     key: 'nodeOperatorFee',
   },

features/overview/contexts/index.tsx

@@ -3,5 +3,6 @@ export {
   useVaultOverview,
   type VaultOverviewContextType,
   type VaultOverviewContextKeys,
-  type SectionData as SectionPayload,
+  type SectionData,
+  type SectionPayload,
 } from './vault-overview';

features/overview/shared/overview-item/overview-item.tsx

@@ -8,8 +8,8 @@ import { useVaultInfo, useVaultPermission } from 'modules/vaults';
 import { OverviewItemValue } from './overview-item-value';
 import { ItemWrapper, Title } from './styles';
 
-import type { SectionPayload } from 'features/overview/contexts/vault-overview';
 import { Hint } from 'shared/components';
+import type { SectionPayload } from 'features/overview/contexts';
 
 export type ItemProps = {
   payload: string | Address | number;

features/settings/main/hooks/use-edit-main-settings.ts

@@ -147,6 +147,7 @@ export const useEditMainSettings = () => {
           }),
         );
 
+        // refetch anyway because some transactions may be successful
         await refetchVaultInfo();
 
         return result;

modules/vaults/components/permissioned-submit-button.tsx

@@ -35,7 +35,7 @@ export const PermissionedSubmitButton = forwardRef<
     <ConnectWalletButton>
       <Button disabled={shouldDisable} ref={ref} {...rest}>
         {shouldShowPermissionError
-          ? `You don't have ${roleTitle} role`
+          ? vaultTexts.common.errors.noRoles([roleTitle])
           : children}
       </Button>
     </ConnectWalletButton>
@@ -60,15 +60,14 @@ export const MultiplePermissionedSubmitButton = forwardRef<
   const shouldShowPermissionError =
     !isLoading && data && !data.hasPermissions && isAccountActive;
 
-  const missingRoles = data?.missingRoles
-    .map((role) => vaultTexts.roles[role].title)
-    .join(', ');
+  const missingRoles =
+    data?.missingRoles.map((role) => vaultTexts.roles[role].title) ?? [];
 
   return (
     <ConnectWalletButton>
       <Button disabled={shouldDisable} ref={ref} {...rest}>
         {shouldShowPermissionError
-          ? `You don't have ${missingRoles} role${data && data.missingRoles.length > 1 ? 's' : ''}`
+          ? vaultTexts.common.errors.noRoles(missingRoles)
           : children}
       </Button>
     </ConnectWalletButton>

modules/vaults/consts/texts.ts

@@ -2,7 +2,10 @@ type Token = 'stETH' | 'wstETH';
 
 type ConfirmAction = 'Setting' | 'Proposing';
 
+// This structure contains texts related to vault functionality
+// such texts for actions, metrics, roles and etc
 export const vaultTexts = {
+  // configuration for transactions and forms
   actions: {
     approve: {
       loading: (token: Token) => `Approving ${token}` as const,
@@ -112,6 +115,8 @@ export const vaultTexts = {
       },
     },
   },
+  // configuration for vault metrics as seen in overview page
+  // but can be used in other places as well where vault status is displayed
   metrics: {
     totalValue: {
       title: 'Total value',
@@ -175,6 +180,7 @@ export const vaultTexts = {
       action: 'Claim',
     },
   },
+  // configuration for vault roles
   roles: {
     defaultAdmin: {
       title: 'Vault Owner',
@@ -283,4 +289,11 @@ export const vaultTexts = {
       hint: 'Allows to increase locked ETH amount on stVault to allow stETH minting',
     },
   },
+  // common texts like errors, warnings, etc.
+  common: {
+    errors: {
+      noRoles: (roleNames: string[]) =>
+        `You don't have ${roleNames.join(',')} role${roleNames.length > 1 ? 's' : ''}` as const,
+    },
+  },
 } as const;