Update native-token-periodic permission

Author: jeffsmale90

packages/gator-permissions-snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "lDkiV/mNq1vl4SG72M9dcOe2EuQQGhrmR+8QEsDeD9E=",
+    "shasum": "k3y7TRsPdHuDrL9r1SbxdLYSK2tdbbWT0C4xdUa2EhU=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/context.ts

@@ -3,7 +3,7 @@ import { parseEther, toHex } from 'viem';
 import type { AccountController } from '../../accountController';
 import { TimePeriod } from '../../core/types';
 import type { TokenPricesService } from '../../services/tokenPricesService';
-import { formatEtherFromString } from '../../utils/balance';
+import { formatUnitsFromString } from '../../utils/balance';
 import {
   convertReadableDateToTimestamp,
   convertTimestampToReadableDate,
@@ -17,6 +17,7 @@ import type {
   PopulatedNativeTokenPeriodicPermission,
   NativeTokenPeriodicPermission,
 } from './types';
+import { IconUrls } from '../../ui/iconConstant';
 
 /**
  * Construct an amended NativeTokenPeriodicPermissionRequest, based on the specified request,
@@ -91,32 +92,33 @@ export async function buildContext({
 }): Promise<NativeTokenPeriodicContext> {
   const chainId = Number(permissionRequest.chainId);
 
-  const balancePromise = accountController
-    .getAccountBalance({
-      chainId,
-    })
-    .then(async (balance) => {
-      const balanceFormattedAsCurrency =
-        await tokenPricesService.getCryptoToFiatConversion(
-          `eip155:1/slip44:60`,
-          balance,
-        );
-      return { balance, balanceFormattedAsCurrency };
-    });
-
-  const [address, { balance, balanceFormattedAsCurrency }] = await Promise.all([
-    accountController.getAccountAddress({
-      chainId,
-    }),
-    balancePromise,
-  ]);
+  const address = await accountController.getAccountAddress({
+    chainId,
+  });
+
+  const {
+    balance: rawBalance,
+    decimals,
+    symbol,
+  } = await accountController.getTokenBalanceAndMetadata({
+    chainId,
+  });
+
+  const balanceFormatted = await tokenPricesService.getCryptoToFiatConversion(
+    `eip155:1/slip44:60`,
+    toHex(rawBalance),
+  );
+
+  // todo: this should just be BigInt
+  const balance = toHex(rawBalance);
 
   const expiry = convertTimestampToReadableDate(permissionRequest.expiry);
 
-  const periodAmount = formatEtherFromString(
-    permissionRequest.permission.data.periodAmount,
-    false,
-  );
+  const periodAmount = formatUnitsFromString({
+    value: permissionRequest.permission.data.periodAmount,
+    allowUndefined: false,
+    decimals,
+  });
 
   const periodDuration =
     permissionRequest.permission.data.periodDuration.toString();
@@ -144,7 +146,9 @@ export async function buildContext({
     accountDetails: {
       address,
       balance,
-      balanceFormattedAsCurrency,
+      balanceFormattedAsCurrency: balanceFormatted,
+      symbol,
+      iconUrl: IconUrls.ethereum.token,
     },
     permissionDetails: {
       periodAmount,

packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/types.ts

@@ -28,6 +28,8 @@ export type NativeTokenPeriodicContext = BaseContext & {
     address: Hex;
     balanceFormattedAsCurrency: string;
     balance: string;
+    symbol: string;
+    iconUrl: string;
   };
   permissionDetails: {
     periodAmount: string;

packages/gator-permissions-snap/test/permissions/nativeTokenPeriodic/content.test.ts

@@ -8,6 +8,7 @@ import type {
   NativeTokenPeriodicMetadata,
 } from '../../../src/permissions/nativeTokenPeriodic/types';
 import { TIME_PERIOD_TO_SECONDS } from '../../../src/utils/time';
+import { IconUrls } from '../../../src/ui/iconConstant';
 
 const mockContext: NativeTokenPeriodicContext = {
   expiry: '05/01/2024',
@@ -17,6 +18,8 @@ const mockContext: NativeTokenPeriodicContext = {
     address: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
     balance: toHex(parseUnits('10', 18)),
     balanceFormattedAsCurrency: '$🐊10.00',
+    symbol: 'ETH',
+    iconUrl: IconUrls.ethereum.token,
   },
   permissionDetails: {
     periodAmount: '1',

packages/gator-permissions-snap/test/permissions/nativeTokenPeriodic/context.test.ts

@@ -20,6 +20,7 @@ import {
   convertReadableDateToTimestamp,
   TIME_PERIOD_TO_SECONDS,
 } from '../../../src/utils/time';
+import { IconUrls } from '../../../src/ui/iconConstant';
 
 const permissionWithoutOptionals: NativeTokenPeriodicPermission = {
   type: 'native-token-periodic',
@@ -60,6 +61,8 @@ const alreadyPopulatedContext: NativeTokenPeriodicContext = {
     address: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
     balance: toHex(parseUnits('10', 18)),
     balanceFormattedAsCurrency: '$🐊10.00',
+    symbol: 'ETH',
+    iconUrl: IconUrls.ethereum.token,
   },
   permissionDetails: {
     periodAmount: '1',
@@ -115,9 +118,11 @@ describe('nativeTokenPeriodic:context', () => {
         getAccountAddress: jest
           .fn()
           .mockResolvedValue(alreadyPopulatedContext.accountDetails.address),
-        getAccountBalance: jest
-          .fn()
-          .mockResolvedValue(alreadyPopulatedContext.accountDetails.balance),
+        getTokenBalanceAndMetadata: jest.fn(() => ({
+          balance: BigInt(alreadyPopulatedContext.accountDetails.balance),
+          symbol: alreadyPopulatedContext.accountDetails.symbol,
+          decimals: 18,
+        })),
       } as unknown as jest.Mocked<AccountController>;
     });
 
@@ -134,7 +139,9 @@ describe('nativeTokenPeriodic:context', () => {
         chainId: Number(alreadyPopulatedPermissionRequest.chainId),
       });
 
-      expect(mockAccountController.getAccountBalance).toHaveBeenCalledWith({
+      expect(
+        mockAccountController.getTokenBalanceAndMetadata,
+      ).toHaveBeenCalledWith({
         chainId: Number(alreadyPopulatedPermissionRequest.chainId),
       });
 

packages/gator-permissions-snap/test/permissions/nativeTokenStream/context.test.ts

@@ -139,8 +139,8 @@ describe('nativeTokenStream:context', () => {
           () => alreadyPopulatedContext.accountDetails.address,
         ),
         getTokenBalanceAndMetadata: jest.fn(() => ({
-          balance: parseUnits('10', 18),
-          symbol: 'ETH',
+          balance: BigInt(alreadyPopulatedContext.accountDetails.balance),
+          symbol: alreadyPopulatedContext.accountDetails.symbol,
           decimals: 18,
         })),
       } as unknown as jest.Mocked<AccountController>;