All permission decoders are now permission-type specific typed, ensuring returned data is appropriately typed.

Author: jeffsmale90

packages/7715-permission-types/src/permissions/caveats/erc20TokenAllowance.ts

@@ -1,3 +1,4 @@
+import type { Erc20TokenAllowancePermission } from '../../types';
 import { expiryRule } from '../rules/expiry';
 import { erc20PayeeRuleDecoder } from '../rules/payee';
 import { redeemerRuleDecoder } from '../rules/redeemer';
@@ -61,7 +62,7 @@ export function makeErc20TokenAllowanceDecoderConfig(
 function validateAndDecodeData(
   caveats: ChecksumCaveat[],
   contractAddresses: ChecksumEnforcersByChainId,
-): DecodedPermissionData {
+): DecodedPermissionData<Erc20TokenAllowancePermission> {
   const { erc20PeriodicEnforcer, valueLteEnforcer } = contractAddresses;
 
   const valueLteTerms = getTermsByEnforcer({

packages/7715-permission-types/src/permissions/caveats/erc20TokenPeriodic.ts

@@ -1,5 +1,7 @@
 import { decodeERC20TokenPeriodTransferTerms } from '@metamask/delegation-core';
+import { bigIntToHex } from '@metamask/utils';
 
+import type { Erc20TokenPeriodicPermission } from '../../types';
 import { expiryRule } from '../rules/expiry';
 import { erc20PayeeRuleDecoder } from '../rules/payee';
 import { redeemerRuleDecoder } from '../rules/redeemer';
@@ -61,7 +63,7 @@ export function makeErc20TokenPeriodicDecoderConfig(
 function validateAndDecodeData(
   caveats: ChecksumCaveat[],
   contractAddresses: ChecksumEnforcersByChainId,
-): DecodedPermissionData {
+): DecodedPermissionData<Erc20TokenPeriodicPermission> {
   const { erc20PeriodicEnforcer, valueLteEnforcer } = contractAddresses;
 
   const valueLteTerms = getTermsByEnforcer({
@@ -108,5 +110,10 @@ function validateAndDecodeData(
     );
   }
 
-  return { tokenAddress, periodAmount, periodDuration, startTime };
+  return {
+    tokenAddress,
+    periodAmount: bigIntToHex(periodAmount),
+    periodDuration,
+    startTime,
+  };
 }

packages/7715-permission-types/src/permissions/caveats/erc20TokenStream.ts

@@ -1,5 +1,7 @@
 import { decodeERC20StreamingTerms } from '@metamask/delegation-core';
+import { bigIntToHex } from '@metamask/utils';
 
+import type { Erc20TokenStreamPermission } from '../../types';
 import { expiryRule } from '../rules/expiry';
 import { erc20PayeeRuleDecoder } from '../rules/payee';
 import { redeemerRuleDecoder } from '../rules/redeemer';
@@ -57,7 +59,7 @@ export function makeErc20TokenStreamDecoderConfig(
 function validateAndDecodeData(
   caveats: ChecksumCaveat[],
   contractAddresses: ChecksumEnforcersByChainId,
-): DecodedPermissionData {
+): DecodedPermissionData<Erc20TokenStreamPermission> {
   const { erc20StreamingEnforcer, valueLteEnforcer } = contractAddresses;
 
   const valueLteTerms = getTermsByEnforcer({
@@ -96,9 +98,9 @@ function validateAndDecodeData(
 
   return {
     tokenAddress,
-    initialAmount,
-    maxAmount,
-    amountPerSecond,
+    initialAmount: bigIntToHex(initialAmount),
+    maxAmount: bigIntToHex(maxAmount),
+    amountPerSecond: bigIntToHex(amountPerSecond),
     startTime,
   };
 }

packages/7715-permission-types/src/permissions/caveats/nativeTokenAllowance.ts

@@ -1,5 +1,6 @@
 import { hexToNumber } from '@metamask/utils';
 
+import type { NativeTokenAllowancePermission } from '../../types';
 import { expiryRule } from '../rules/expiry';
 import { nativePayeeRuleDecoder } from '../rules/payee';
 import { redeemerRuleDecoder } from '../rules/redeemer';
@@ -63,7 +64,7 @@ export function makeNativeTokenAllowanceDecoderConfig(
 function validateAndDecodeData(
   caveats: ChecksumCaveat[],
   contractAddresses: ChecksumEnforcersByChainId,
-): DecodedPermissionData {
+): DecodedPermissionData<NativeTokenAllowancePermission> {
   const { nativeTokenPeriodicEnforcer, exactCalldataEnforcer } =
     contractAddresses;
 

packages/7715-permission-types/src/permissions/caveats/nativeTokenPeriodic.ts

@@ -1,5 +1,7 @@
 import { decodeNativeTokenPeriodTransferTerms } from '@metamask/delegation-core';
+import { bigIntToHex } from '@metamask/utils';
 
+import type { NativeTokenPeriodicPermission } from '../../types';
 import { expiryRule } from '../rules/expiry';
 import { nativePayeeRuleDecoder } from '../rules/payee';
 import { redeemerRuleDecoder } from '../rules/redeemer';
@@ -57,7 +59,7 @@ export function makeNativeTokenPeriodicDecoderConfig(
 function validateAndDecodeData(
   caveats: ChecksumCaveat[],
   contractAddresses: ChecksumEnforcersByChainId,
-): DecodedPermissionData {
+): DecodedPermissionData<NativeTokenPeriodicPermission> {
   const { nativeTokenPeriodicEnforcer, exactCalldataEnforcer } =
     contractAddresses;
 
@@ -104,5 +106,9 @@ function validateAndDecodeData(
     );
   }
 
-  return { periodAmount, periodDuration, startTime };
+  return {
+    periodAmount: bigIntToHex(periodAmount),
+    periodDuration,
+    startTime,
+  };
 }

packages/7715-permission-types/src/permissions/caveats/nativeTokenStream.ts

@@ -1,5 +1,7 @@
 import { decodeNativeTokenStreamingTerms } from '@metamask/delegation-core';
+import { bigIntToHex } from '@metamask/utils';
 
+import type { NativeTokenStreamPermission } from '../../types';
 import { expiryRule } from '../rules/expiry';
 import { nativePayeeRuleDecoder } from '../rules/payee';
 import { redeemerRuleDecoder } from '../rules/redeemer';
@@ -57,7 +59,7 @@ export function makeNativeTokenStreamDecoderConfig(
 function validateAndDecodeData(
   caveats: ChecksumCaveat[],
   contractAddresses: ChecksumEnforcersByChainId,
-): DecodedPermissionData {
+): DecodedPermissionData<NativeTokenStreamPermission> {
   const { nativeTokenStreamingEnforcer, exactCalldataEnforcer } =
     contractAddresses;
 
@@ -95,5 +97,10 @@ function validateAndDecodeData(
     );
   }
 
-  return { initialAmount, maxAmount, amountPerSecond, startTime };
+  return {
+    initialAmount: bigIntToHex(initialAmount),
+    maxAmount: bigIntToHex(maxAmount),
+    amountPerSecond: bigIntToHex(amountPerSecond),
+    startTime,
+  };
 }

packages/7715-permission-types/src/permissions/caveats/tokenApprovalRevocation.ts

@@ -1,5 +1,6 @@
 import { decodeApprovalRevocationTerms } from '@metamask/delegation-core';
 
+import type { TokenApprovalRevocationPermission } from '../../types';
 import { expiryRule } from '../rules/expiry';
 import type {
   ChecksumCaveat,
@@ -46,7 +47,7 @@ export function makeTokenApprovalRevocationDecoderConfig(
 function validateAndDecodeData(
   caveats: ChecksumCaveat[],
   contractAddresses: ChecksumEnforcersByChainId,
-): DecodedPermissionData {
+): DecodedPermissionData<TokenApprovalRevocationPermission> {
   const { approvalRevocationEnforcer } = contractAddresses;
 
   const terms = getTermsByEnforcer({

packages/7715-permission-types/src/permissions/types.ts

@@ -26,7 +26,9 @@ export type ChecksumCaveat = Caveat<Hex>;
 /**
  * Type of the `data` parameter of a decoded permission.
  */
-export type DecodedPermissionData = PermissionTypes['data'];
+export type DecodedPermissionData<
+  TPermissionType extends PermissionTypes = PermissionTypes,
+> = TPermissionType['data'];
 
 /**
  * Supported permission type identifiers that can be decoded from a permission context.

packages/7715-permission-types/test/permissions/caveats/erc20TokenPeriodic.test.ts

@@ -3,7 +3,7 @@ import {
   CHAIN_ID,
   DELEGATOR_CONTRACTS,
 } from '@metamask/delegation-deployments';
-import type { Hex } from '@metamask/utils';
+import { bigIntToHex, type Hex } from '@metamask/utils';
 import { describe, it, expect } from 'vitest';
 
 import { makePermissionDecoderConfigs } from '../../../src/permissions';
@@ -113,7 +113,7 @@ describe('erc20-token-periodic decoder config', () => {
         ),
       ).toStrictEqual({
         tokenAddress: TOKEN_ADDRESS,
-        periodAmount: 100n,
+        periodAmount: bigIntToHex(100n),
         periodDuration: 86400,
         startTime: START_TIME,
       });
@@ -165,7 +165,7 @@ describe('erc20-token-periodic decoder config', () => {
         ),
       ).toStrictEqual({
         tokenAddress: TOKEN_ADDRESS,
-        periodAmount: 100n,
+        periodAmount: bigIntToHex(100n),
         periodDuration: MAX_PERIOD_DURATION,
         startTime: START_TIME,
       });

packages/7715-permission-types/test/permissions/caveats/erc20TokenStream.test.ts

@@ -3,7 +3,7 @@ import {
   CHAIN_ID,
   DELEGATOR_CONTRACTS,
 } from '@metamask/delegation-deployments';
-import type { Hex } from '@metamask/utils';
+import { bigIntToHex, type Hex } from '@metamask/utils';
 import { describe, it, expect } from 'vitest';
 
 import { makePermissionDecoderConfigs } from '../../../src/permissions';
@@ -122,9 +122,9 @@ describe('erc20-token-stream decoder config', () => {
         ),
       ).toStrictEqual({
         tokenAddress: TOKEN_ADDRESS,
-        initialAmount: 10n,
-        maxAmount: 100n,
-        amountPerSecond: 5n,
+        initialAmount: bigIntToHex(10n),
+        maxAmount: bigIntToHex(100n),
+        amountPerSecond: bigIntToHex(5n),
         startTime: START_TIME,
       });
     });