Move token metadata into tokenMetadata key on context objects

jeffsmale90 · jeffsmale90 · commit f2a7c55bd530 · 2025-06-09T16:39:57.000+12:00
diff --git a/packages/gator-permissions-snap/snap.manifest.json b/packages/gator-permissions-snap/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "0TP5ydRCXNvDxWxjTs7Rp1v5C85Ld3tPabxulFWKWHo=",
+    "shasum": "/p0aPugcJzMS6wNekI/ZtyJUQ/5EsupvbPDiT4cPebg=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
diff --git a/packages/gator-permissions-snap/src/permissions/erc20TokenStream/content.tsx b/packages/gator-permissions-snap/src/permissions/erc20TokenStream/content.tsx
@@ -62,7 +62,7 @@ export async function createConfirmationContent({
     },
     {
       label: 'Token',
-      text: context.accountDetails.symbol,
+      text: context.tokenMetadata.symbol,
     },
   ];
 
@@ -76,6 +76,7 @@ export async function createConfirmationContent({
       />
       <AccountDetails
         account={context.accountDetails}
+        tokenMetadata={context.tokenMetadata}
         title="Stream from"
         tooltip="The account that the token stream comes from."
       />
@@ -97,7 +98,7 @@ export async function createConfirmationContent({
             <Input
               name="stream-rate"
               type="text"
-              value={`${amountPerSecond} ${context.accountDetails.symbol}/sec`}
+              value={`${amountPerSecond} ${context.tokenMetadata.symbol}/sec`}
               disabled={true}
             />
           </Field>
diff --git a/packages/gator-permissions-snap/src/permissions/erc20TokenStream/context.ts b/packages/gator-permissions-snap/src/permissions/erc20TokenStream/context.ts
@@ -39,7 +39,7 @@ export async function applyContext({
 }): Promise<Erc20TokenStreamPermissionRequest> {
   const {
     permissionDetails,
-    accountDetails: { decimals },
+    tokenMetadata: { decimals },
   } = context;
   const expiry = convertReadableDateToTimestamp(context.expiry);
 
@@ -136,7 +136,6 @@ export async function buildContext({
     decimals,
   );
 
-  // todo: this should just be BigInt
   const balance = toHex(rawBalance);
 
   const expiry = convertTimestampToReadableDate(permissionRequest.expiry);
@@ -179,6 +178,8 @@ export async function buildContext({
       address,
       balance,
       balanceFormattedAsCurrency: balanceFormatted,
+    },
+    tokenMetadata: {
       symbol,
       decimals,
     },
@@ -206,7 +207,7 @@ export async function deriveMetadata({
   const {
     permissionDetails,
     expiry,
-    accountDetails: { decimals },
+    tokenMetadata: { decimals },
   } = context;
 
   const validationErrors: Erc20TokenStreamMetadata['validationErrors'] = {};
diff --git a/packages/gator-permissions-snap/src/permissions/erc20TokenStream/types.ts b/packages/gator-permissions-snap/src/permissions/erc20TokenStream/types.ts
@@ -24,12 +24,13 @@ export type Erc20TokenStreamMetadata = {
   };
 };
 
-// todo: move accountDetails to the base context so that accountDetails formatting is shared between permissions
 export type Erc20TokenStreamContext = BaseContext & {
   accountDetails: {
     address: Hex;
     balanceFormattedAsCurrency: string;
     balance: Hex;
+  };
+  tokenMetadata: {
     decimals: number;
     symbol: string;
   };
diff --git a/packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/content.tsx b/packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/content.tsx
@@ -75,6 +75,7 @@ export async function createConfirmationContent({
         />
         <AccountDetails
           account={context.accountDetails}
+          tokenMetadata={context.tokenMetadata}
           title="Transfer from"
           tooltip="The account that the token transfers come from."
         />
diff --git a/packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/context.ts b/packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/context.ts
@@ -36,7 +36,7 @@ export async function applyContext({
 }): Promise<NativeTokenPeriodicPermissionRequest> {
   const {
     permissionDetails,
-    accountDetails: { decimals },
+    tokenMetadata: { decimals },
   } = context;
   const expiry = convertReadableDateToTimestamp(context.expiry);
 
@@ -155,6 +155,8 @@ export async function buildContext({
       address,
       balance,
       balanceFormattedAsCurrency: balanceFormatted,
+    },
+    tokenMetadata: {
       symbol,
       decimals,
     },
@@ -181,7 +183,7 @@ export async function deriveMetadata({
   const {
     permissionDetails,
     expiry,
-    accountDetails: { decimals },
+    tokenMetadata: { decimals },
   } = context;
 
   const validationErrors: NativeTokenPeriodicMetadata['validationErrors'] = {};
diff --git a/packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/types.ts b/packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/types.ts
@@ -28,6 +28,8 @@ export type NativeTokenPeriodicContext = BaseContext & {
     address: Hex;
     balanceFormattedAsCurrency: string;
     balance: Hex;
+  };
+  tokenMetadata: {
     decimals: number;
     symbol: string;
   };
diff --git a/packages/gator-permissions-snap/src/permissions/nativeTokenStream/content.tsx b/packages/gator-permissions-snap/src/permissions/nativeTokenStream/content.tsx
@@ -70,7 +70,7 @@ export async function createConfirmationContent({
     },
     {
       label: 'Token',
-      text: context.accountDetails.symbol,
+      text: context.tokenMetadata.symbol,
       iconUrl: IconUrls.ethereum.token,
     },
   ];
@@ -85,6 +85,7 @@ export async function createConfirmationContent({
       />
       <AccountDetails
         account={context.accountDetails}
+        tokenMetadata={context.tokenMetadata}
         title="Stream from"
         tooltip="The account that the token stream comes from."
       />
@@ -106,7 +107,7 @@ export async function createConfirmationContent({
             <Box>
               <Image
                 src={IconUrls.ethereum.token}
-                alt={`${context.accountDetails.symbol} token icon`}
+                alt={`${context.tokenMetadata.symbol} token icon`}
               />
             </Box>
             <Input
diff --git a/packages/gator-permissions-snap/src/permissions/nativeTokenStream/context.ts b/packages/gator-permissions-snap/src/permissions/nativeTokenStream/context.ts
@@ -39,7 +39,7 @@ export async function applyContext({
 }): Promise<NativeTokenStreamPermissionRequest> {
   const {
     permissionDetails,
-    accountDetails: { decimals },
+    tokenMetadata: { decimals },
   } = context;
   const expiry = convertReadableDateToTimestamp(context.expiry);
 
@@ -171,11 +171,12 @@ export async function buildContext({
     expiry,
     justification: permissionRequest.permission.data.justification,
     isAdjustmentAllowed: permissionRequest.isAdjustmentAllowed ?? true,
-    // todo: we should consider removing the accountDetails from the context object, and into it's own object
     accountDetails: {
       address,
       balance,
       balanceFormattedAsCurrency: balanceFormatted,
+    },
+    tokenMetadata: {
       symbol,
       decimals,
     },
@@ -203,7 +204,7 @@ export async function deriveMetadata({
   const {
     permissionDetails,
     expiry,
-    accountDetails: { decimals },
+    tokenMetadata: { decimals },
   } = context;
 
   const validationErrors: NativeTokenStreamMetadata['validationErrors'] = {};
diff --git a/packages/gator-permissions-snap/src/permissions/nativeTokenStream/types.ts b/packages/gator-permissions-snap/src/permissions/nativeTokenStream/types.ts
@@ -24,12 +24,13 @@ export type NativeTokenStreamMetadata = {
   };
 };
 
-// todo: move accountDetails to the base context so that accountDetails formatting is shared between permissions
 export type NativeTokenStreamContext = BaseContext & {
   accountDetails: {
     address: Hex;
     balanceFormattedAsCurrency: string;
     balance: Hex;
+  };
+  tokenMetadata: {
     decimals: number;
     symbol: string;
   };
diff --git a/packages/gator-permissions-snap/src/ui/components/AccountDetails.tsx b/packages/gator-permissions-snap/src/ui/components/AccountDetails.tsx
@@ -9,18 +9,23 @@ export type AccountDetailsProps = {
     address: Hex;
     balanceFormattedAsCurrency: string;
     balance: Hex;
+  };
+  tokenMetadata: {
     decimals: number;
+    symbol: string;
   };
   title: string;
   tooltip: string;
 };
 
 export const AccountDetails: SnapComponent<AccountDetailsProps> = ({
   account,
+  tokenMetadata,
   title,
   tooltip,
 }) => {
-  const { address, balance, balanceFormattedAsCurrency, decimals } = account;
+  const { address, balance, balanceFormattedAsCurrency } = account;
+  const { decimals } = tokenMetadata;
   return (
     <Section>
       <Box direction="vertical">
diff --git a/packages/gator-permissions-snap/test/permissions/erc20TokenStream/content.test.ts b/packages/gator-permissions-snap/test/permissions/erc20TokenStream/content.test.ts
@@ -18,6 +18,8 @@ const mockContext: Erc20TokenStreamContext = {
     address: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
     balance: toHex(parseUnits('10', tokenDecimals)),
     balanceFormattedAsCurrency: '$🐊10.00',
+  },
+  tokenMetadata: {
     decimals: tokenDecimals,
     symbol: 'USDC',
   },
diff --git a/packages/gator-permissions-snap/test/permissions/erc20TokenStream/context.test.ts b/packages/gator-permissions-snap/test/permissions/erc20TokenStream/context.test.ts
@@ -67,6 +67,8 @@ const alreadyPopulatedContext: Erc20TokenStreamContext = {
     address: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
     balance: toHex(100_000_000), // 100 USDC (6 decimals)
     balanceFormattedAsCurrency: '$🐊100.00',
+  },
+  tokenMetadata: {
     symbol: 'USDC',
     decimals: USDC_DECIMALS,
   },
@@ -149,7 +151,7 @@ describe('erc20TokenStream:context', () => {
       mockTokenMetadataService = {
         getTokenBalanceAndMetadata: jest.fn(() => ({
           balance: BigInt(alreadyPopulatedContext.accountDetails.balance),
-          symbol: alreadyPopulatedContext.accountDetails.symbol,
+          symbol: alreadyPopulatedContext.tokenMetadata.symbol,
           decimals: USDC_DECIMALS,
         })),
       } as unknown as jest.Mocked<TokenMetadataService>;
diff --git a/packages/gator-permissions-snap/test/permissions/nativeTokenPeriodic/content.test.ts b/packages/gator-permissions-snap/test/permissions/nativeTokenPeriodic/content.test.ts
@@ -17,6 +17,8 @@ const mockContext: NativeTokenPeriodicContext = {
     address: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
     balance: toHex(parseUnits('10', 18)),
     balanceFormattedAsCurrency: '$🐊10.00',
+  },
+  tokenMetadata: {
     symbol: 'ETH',
     decimals: 18,
   },
diff --git a/packages/gator-permissions-snap/test/permissions/nativeTokenPeriodic/context.test.ts b/packages/gator-permissions-snap/test/permissions/nativeTokenPeriodic/context.test.ts
@@ -61,6 +61,8 @@ const alreadyPopulatedContext: NativeTokenPeriodicContext = {
     address: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
     balance: toHex(parseUnits('10', 18)),
     balanceFormattedAsCurrency: '$🐊10.00',
+  },
+  tokenMetadata: {
     symbol: 'ETH',
     decimals: 18,
   },
@@ -124,7 +126,7 @@ describe('nativeTokenPeriodic:context', () => {
       mockTokenMetadataService = {
         getTokenBalanceAndMetadata: jest.fn(() => ({
           balance: BigInt(alreadyPopulatedContext.accountDetails.balance),
-          symbol: alreadyPopulatedContext.accountDetails.symbol,
+          symbol: alreadyPopulatedContext.tokenMetadata.symbol,
           decimals: 18,
         })),
       } as unknown as jest.Mocked<TokenMetadataService>;
diff --git a/packages/gator-permissions-snap/test/permissions/nativeTokenStream/content.test.ts b/packages/gator-permissions-snap/test/permissions/nativeTokenStream/content.test.ts
@@ -16,6 +16,8 @@ const mockContext: NativeTokenStreamContext = {
     address: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
     balance: toHex(parseUnits('10', 18)),
     balanceFormattedAsCurrency: '$🐊10.00',
+  },
+  tokenMetadata: {
     symbol: 'ETH',
     decimals: 18,
   },
diff --git a/packages/gator-permissions-snap/test/permissions/nativeTokenStream/context.test.ts b/packages/gator-permissions-snap/test/permissions/nativeTokenStream/context.test.ts
@@ -63,6 +63,8 @@ const alreadyPopulatedContext: NativeTokenStreamContext = {
     address: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
     balance: toHex(parseUnits('10', 18)),
     balanceFormattedAsCurrency: '$🐊10.00',
+  },
+  tokenMetadata: {
     symbol: 'ETH',
     decimals: 18,
   },
@@ -144,7 +146,7 @@ describe('nativeTokenStream:context', () => {
       mockTokenMetadataService = {
         getTokenBalanceAndMetadata: jest.fn(() => ({
           balance: BigInt(alreadyPopulatedContext.accountDetails.balance),
-          symbol: alreadyPopulatedContext.accountDetails.symbol,
+          symbol: alreadyPopulatedContext.tokenMetadata.symbol,
           decimals: 18,
         })),
       } as unknown as jest.Mocked<TokenMetadataService>;
diff --git a/packages/site/src/components/permissions/ERC20TokenStreamForm.tsx b/packages/site/src/components/permissions/ERC20TokenStreamForm.tsx
@@ -10,14 +10,16 @@ type ERC20TokenStreamFormProps = {
 export const ERC20TokenStreamForm = ({
   onChange,
 }: ERC20TokenStreamFormProps) => {
+  const decimals = 6;
+
   const [initialAmount, setInitialAmount] = useState<bigint | null>(
-    BigInt(toHex(parseUnits('.5', 18))),
+    BigInt(toHex(parseUnits('.5', decimals))),
   );
   const [amountPerSecond, setAmountPerSecond] = useState(
-    BigInt(toHex(parseUnits('.5', 18))),
+    BigInt(toHex(parseUnits('.5', decimals))),
   );
   const [maxAmount, setMaxAmount] = useState<bigint | null>(
-    BigInt(toHex(parseUnits('2.5', 18))),
+    BigInt(toHex(parseUnits('2.5', decimals))),
   );
   const [startTime, setStartTime] = useState(Math.floor(Date.now() / 1000));
   const [expiry, setExpiry] = useState(
