Add tests for erc20-token-stream, update existing token context to use decimals, and not just assume ether

Author: jeffsmale90

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

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "Ft70Omb1nOK49mRy2oPSAEBuwiDJsl0Ooig/6O85dCc=",
+    "shasum": "0TP5ydRCXNvDxWxjTs7Rp1v5C85Ld3tPabxulFWKWHo=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/gator-permissions-snap/src/core/permissionHandlerFactory.ts

@@ -2,9 +2,9 @@ import type { PermissionRequest } from '@metamask/7715-permissions-shared/types'
 import { extractPermissionName } from '@metamask/7715-permissions-shared/utils';
 
 import type { AccountController } from '../accountController';
+import { erc20TokenStreamPermissionDefinition } from '../permissions/erc20TokenStream';
 import { nativeTokenPeriodicPermissionDefinition } from '../permissions/nativeTokenPeriodic';
 import { nativeTokenStreamPermissionDefinition } from '../permissions/nativeTokenStream';
-import { erc20TokenStreamPermissionDefinition } from '../permissions/erc20TokenStream';
 import type { TokenMetadataService } from '../services/tokenMetadataService';
 import type { TokenPricesService } from '../services/tokenPricesService';
 import type { UserEventDispatcher } from '../userEventDispatcher';

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

@@ -1,7 +1,8 @@
-import { formatEther, maxUint256, parseEther, toHex } from 'viem';
+import { formatUnits, maxUint256, parseUnits, toHex } from 'viem';
 
 import type { AccountController } from '../../accountController';
 import { TimePeriod } from '../../core/types';
+import type { TokenMetadataService } from '../../services/tokenMetadataService';
 import type { TokenPricesService } from '../../services/tokenPricesService';
 import { formatUnitsFromString } from '../../utils/balance';
 import {
@@ -36,18 +37,21 @@ export async function applyContext({
   context: Erc20TokenStreamContext;
   originalRequest: Erc20TokenStreamPermissionRequest;
 }): Promise<Erc20TokenStreamPermissionRequest> {
-  const { permissionDetails } = context;
+  const {
+    permissionDetails,
+    accountDetails: { decimals },
+  } = context;
   const expiry = convertReadableDateToTimestamp(context.expiry);
 
   const permissionData = {
     maxAmount: permissionDetails.maxAmount
-      ? toHex(parseEther(permissionDetails.maxAmount))
+      ? toHex(parseUnits(permissionDetails.maxAmount, decimals))
       : undefined,
     initialAmount: permissionDetails.initialAmount
-      ? toHex(parseEther(permissionDetails.initialAmount))
+      ? toHex(parseUnits(permissionDetails.initialAmount, decimals))
       : undefined,
     amountPerSecond: toHex(
-      parseEther(permissionDetails.amountPerPeriod) /
+      parseUnits(permissionDetails.amountPerPeriod, decimals) /
         TIME_PERIOD_TO_SECONDS[permissionDetails.timePeriod],
     ),
     startTime: convertReadableDateToTimestamp(permissionDetails.startTime),
@@ -95,16 +99,19 @@ export async function populatePermission({
  * @param options0.permissionRequest - The Erc20 token stream permission request to convert.
  * @param options0.tokenPricesService - Service for fetching token price information.
  * @param options0.accountController - Controller for managing account operations.
+ * @param options0.tokenMetadataService - Service for fetching token metadata.
  * @returns A context object containing the formatted permission details and account information.
  */
 export async function buildContext({
   permissionRequest,
   tokenPricesService,
   accountController,
+  tokenMetadataService,
 }: {
   permissionRequest: Erc20TokenStreamPermissionRequest;
   tokenPricesService: TokenPricesService;
   accountController: AccountController;
+  tokenMetadataService: TokenMetadataService;
 }): Promise<Erc20TokenStreamContext> {
   const chainId = Number(permissionRequest.chainId);
   const { tokenAddress } = permissionRequest.permission.data;
@@ -117,8 +124,9 @@ export async function buildContext({
     balance: rawBalance,
     decimals,
     symbol,
-  } = await accountController.getTokenBalanceAndMetadata({
+  } = await tokenMetadataService.getTokenBalanceAndMetadata({
     chainId,
+    account: address,
     assetAddress: tokenAddress,
   });
 
@@ -153,8 +161,9 @@ export async function buildContext({
 
   // It may seem strange to convert the amount per second to amount per period, format, and then convert back to amount per second.
   // The user is inputting amount per period, and we derive amount per second, so it makes sense for the context to contain the amount per period.
-  const amountPerPeriod = formatEther(
+  const amountPerPeriod = formatUnits(
     amountPerSecond * TIME_PERIOD_TO_SECONDS[timePeriod],
+    decimals,
   );
 
   const startTime = convertTimestampToReadableDate(
@@ -194,7 +203,11 @@ export async function deriveMetadata({
 }: {
   context: Erc20TokenStreamContext;
 }): Promise<Erc20TokenStreamMetadata> {
-  const { permissionDetails, expiry } = context;
+  const {
+    permissionDetails,
+    expiry,
+    accountDetails: { decimals },
+  } = context;
 
   const validationErrors: Erc20TokenStreamMetadata['validationErrors'] = {};
 
@@ -204,7 +217,7 @@ export async function deriveMetadata({
   let amountPerSecond = 'Unknown';
   if (permissionDetails.maxAmount) {
     try {
-      maxAmountBigInt = parseEther(permissionDetails.maxAmount);
+      maxAmountBigInt = parseUnits(permissionDetails.maxAmount, decimals);
       if (maxAmountBigInt < 0n) {
         validationErrors.maxAmountError = 'Max amount must be greater than 0';
         maxAmountBigInt = undefined;
@@ -216,7 +229,10 @@ export async function deriveMetadata({
 
   if (permissionDetails.initialAmount) {
     try {
-      initialAmountBigInt = parseEther(permissionDetails.initialAmount);
+      initialAmountBigInt = parseUnits(
+        permissionDetails.initialAmount,
+        decimals,
+      );
       if (initialAmountBigInt < 0n) {
         validationErrors.initialAmountError =
           'Initial amount must be greater than 0';
@@ -228,15 +244,19 @@ export async function deriveMetadata({
   }
 
   try {
-    amountPerSecondBigInt = parseEther(permissionDetails.amountPerPeriod);
+    amountPerSecondBigInt = parseUnits(
+      permissionDetails.amountPerPeriod,
+      decimals,
+    );
     if (amountPerSecondBigInt <= 0n) {
       validationErrors.amountPerPeriodError =
         'Amount per period must be greater than 0';
       amountPerSecondBigInt = undefined;
     } else {
-      amountPerSecond = formatEther(
+      amountPerSecond = formatUnits(
         amountPerSecondBigInt /
           TIME_PERIOD_TO_SECONDS[permissionDetails.timePeriod],
+        decimals,
       );
     }
   } catch (error) {

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

@@ -1,4 +1,4 @@
-import { parseEther, toHex } from 'viem';
+import { parseUnits, toHex } from 'viem';
 
 import type { AccountController } from '../../accountController';
 import { TimePeriod } from '../../core/types';
@@ -34,11 +34,14 @@ export async function applyContext({
   context: NativeTokenPeriodicContext;
   originalRequest: NativeTokenPeriodicPermissionRequest;
 }): Promise<NativeTokenPeriodicPermissionRequest> {
-  const { permissionDetails } = context;
+  const {
+    permissionDetails,
+    accountDetails: { decimals },
+  } = context;
   const expiry = convertReadableDateToTimestamp(context.expiry);
 
   const permissionData = {
-    periodAmount: toHex(parseEther(permissionDetails.periodAmount)),
+    periodAmount: toHex(parseUnits(permissionDetails.periodAmount, decimals)),
     periodDuration: parseInt(permissionDetails.periodDuration, 10),
     startTime: convertReadableDateToTimestamp(permissionDetails.startTime),
     justification: originalRequest.permission.data.justification,
@@ -175,12 +178,19 @@ export async function deriveMetadata({
 }: {
   context: NativeTokenPeriodicContext;
 }): Promise<NativeTokenPeriodicMetadata> {
-  const { permissionDetails, expiry } = context;
+  const {
+    permissionDetails,
+    expiry,
+    accountDetails: { decimals },
+  } = context;
 
   const validationErrors: NativeTokenPeriodicMetadata['validationErrors'] = {};
 
   try {
-    const periodAmountBigInt = parseEther(permissionDetails.periodAmount);
+    const periodAmountBigInt = parseUnits(
+      permissionDetails.periodAmount,
+      decimals,
+    );
     if (periodAmountBigInt <= 0n) {
       validationErrors.periodAmountError =
         'Period amount must be greater than 0';

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

@@ -1,4 +1,4 @@
-import { formatEther, maxUint256, parseEther, toHex } from 'viem';
+import { formatUnits, maxUint256, parseUnits, toHex } from 'viem';
 
 import type { AccountController } from '../../accountController';
 import { TimePeriod } from '../../core/types';
@@ -37,18 +37,21 @@ export async function applyContext({
   context: NativeTokenStreamContext;
   originalRequest: NativeTokenStreamPermissionRequest;
 }): Promise<NativeTokenStreamPermissionRequest> {
-  const { permissionDetails } = context;
+  const {
+    permissionDetails,
+    accountDetails: { decimals },
+  } = context;
   const expiry = convertReadableDateToTimestamp(context.expiry);
 
   const permissionData = {
     maxAmount: permissionDetails.maxAmount
-      ? toHex(parseEther(permissionDetails.maxAmount))
+      ? toHex(parseUnits(permissionDetails.maxAmount, decimals))
       : undefined,
     initialAmount: permissionDetails.initialAmount
-      ? toHex(parseEther(permissionDetails.initialAmount))
+      ? toHex(parseUnits(permissionDetails.initialAmount, decimals))
       : undefined,
     amountPerSecond: toHex(
-      parseEther(permissionDetails.amountPerPeriod) /
+      parseUnits(permissionDetails.amountPerPeriod, decimals) /
         TIME_PERIOD_TO_SECONDS[permissionDetails.timePeriod],
     ),
     startTime: convertReadableDateToTimestamp(permissionDetails.startTime),
@@ -155,8 +158,9 @@ export async function buildContext({
 
   // It may seem strange to convert the amount per second to amount per period, format, and then convert back to amount per second.
   // The user is inputting amount per period, and we derive amount per second, so it makes sense for the context to contain the amount per period.
-  const amountPerPeriod = formatEther(
+  const amountPerPeriod = formatUnits(
     amountPerSecond * TIME_PERIOD_TO_SECONDS[timePeriod],
+    decimals,
   );
 
   const startTime = convertTimestampToReadableDate(
@@ -196,7 +200,11 @@ export async function deriveMetadata({
 }: {
   context: NativeTokenStreamContext;
 }): Promise<NativeTokenStreamMetadata> {
-  const { permissionDetails, expiry } = context;
+  const {
+    permissionDetails,
+    expiry,
+    accountDetails: { decimals },
+  } = context;
 
   const validationErrors: NativeTokenStreamMetadata['validationErrors'] = {};
 
@@ -206,7 +214,7 @@ export async function deriveMetadata({
   let amountPerSecond = 'Unknown';
   if (permissionDetails.maxAmount) {
     try {
-      maxAmountBigInt = parseEther(permissionDetails.maxAmount);
+      maxAmountBigInt = parseUnits(permissionDetails.maxAmount, decimals);
       if (maxAmountBigInt < 0n) {
         validationErrors.maxAmountError = 'Max amount must be greater than 0';
         maxAmountBigInt = undefined;
@@ -218,7 +226,10 @@ export async function deriveMetadata({
 
   if (permissionDetails.initialAmount) {
     try {
-      initialAmountBigInt = parseEther(permissionDetails.initialAmount);
+      initialAmountBigInt = parseUnits(
+        permissionDetails.initialAmount,
+        decimals,
+      );
       if (initialAmountBigInt < 0n) {
         validationErrors.initialAmountError =
           'Initial amount must be greater than 0';
@@ -230,15 +241,19 @@ export async function deriveMetadata({
   }
 
   try {
-    amountPerSecondBigInt = parseEther(permissionDetails.amountPerPeriod);
+    amountPerSecondBigInt = parseUnits(
+      permissionDetails.amountPerPeriod,
+      decimals,
+    );
     if (amountPerSecondBigInt <= 0n) {
       validationErrors.amountPerPeriodError =
         'Amount per period must be greater than 0';
       amountPerSecondBigInt = undefined;
     } else {
-      amountPerSecond = formatEther(
+      amountPerSecond = formatUnits(
         amountPerSecondBigInt /
           TIME_PERIOD_TO_SECONDS[permissionDetails.timePeriod],
+        decimals,
       );
     }
   } catch (error) {