Skip to content

Add new time periods for ERC20 and native token permissions #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Oct 22, 2025
Merged

Add new time periods for ERC20 and native token permissions #190

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7cd1465
Add new time periods and refactor related logic for ERC20 and native …
mj-kiwi Oct 8, 2025
254eeb1
Update tests
mj-kiwi Oct 9, 2025
78ec2fa
Add tests for getClosestTimePeriod function and related time periods
mj-kiwi Oct 9, 2025
8673a95
Remove debug logs and add comments for time period constants in conte…
mj-kiwi Oct 14, 2025
15f94a3
Enhance time period validation and error handling in ERC20 and native…
mj-kiwi Oct 15, 2025
a51061f
Refactor periodDuration type to use zPeriodDuration in ERC20 and nati…
mj-kiwi Oct 17, 2025
a85fcfc
Refactor time period handling to simplify duration conversion; update…
mj-kiwi Oct 21, 2025
1234de0
Refactor time period handling in ERC20 and native token contexts to r…
mj-kiwi Oct 21, 2025
390adaf
Refactor period handling to replace periodType with periodDuration in…
mj-kiwi Oct 22, 2025
b9704d5
Refactor periodDuration handling to change type from string to number…
mj-kiwi Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/gator-permissions-snap/src/permissions/contextValidation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,12 +157,12 @@ export function calculateAmountPerSecond(
* @param periodDuration - The period duration string to validate.
* @returns Object containing parsed duration and any validation error.
*/
export function validatePeriodDuration(periodDuration: string): {
export function validatePeriodDuration(periodDuration: number): {
duration: number | undefined;
error: string | undefined;
} {
try {
const duration = parseInt(periodDuration, 10);
const duration = periodDuration;
if (isNaN(duration) || duration <= 0) {
return {
duration: undefined,
Expand Down
4 changes: 2 additions & 2 deletions packages/gator-permissions-snap/src/permissions/erc20TokenPeriodic/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export async function applyContext({
periodAmount: bigIntToHex(
parseUnits({ formatted: permissionDetails.periodAmount, decimals }),
),
periodDuration: parseInt(permissionDetails.periodDuration, 10),
periodDuration: permissionDetails.periodDuration,
startTime: permissionDetails.startTime,
justification: originalRequest.permission.data.justification,
tokenAddress: originalRequest.permission.data.tokenAddress,
Expand Down Expand Up @@ -176,7 +176,7 @@ export async function buildContext({
decimals,
});

const periodDuration = data.periodDuration.toString();
const { periodDuration } = data;

const startTime = data.startTime ?? Math.floor(Date.now() / 1000);

Expand Down
6 changes: 2 additions & 4 deletions packages/gator-permissions-snap/src/permissions/erc20TokenPeriodic/rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,7 @@ export const periodDurationRule: RuleDefinition<
type: 'dropdown',
getRuleData: ({ context, metadata }) => ({
isAdjustmentAllowed: context.isAdjustmentAllowed,
value: getClosestTimePeriod(
parseInt(context.permissionDetails.periodDuration, 10),
),
value: getClosestTimePeriod(context.permissionDetails.periodDuration),
isVisible: true,
tooltip: 'The duration of the period',
options: Object.values(TimePeriod),
Expand All @@ -73,7 +71,7 @@ export const periodDurationRule: RuleDefinition<
);
}

const periodDuration = Number(periodSeconds).toString();
const periodDuration = Number(periodSeconds);

return {
...context,
Expand Down
2 changes: 1 addition & 1 deletion packages/gator-permissions-snap/src/permissions/erc20TokenPeriodic/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export type Erc20TokenPeriodicMetadata = BaseMetadata & {
export type Erc20TokenPeriodicContext = BaseContext & {
permissionDetails: {
periodAmount: string;
periodDuration: string;
periodDuration: number;
startTime: number;
};
};
Expand Down
4 changes: 2 additions & 2 deletions packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export async function applyContext({
periodAmount: bigIntToHex(
parseUnits({ formatted: permissionDetails.periodAmount, decimals }),
),
periodDuration: parseInt(permissionDetails.periodDuration, 10),
periodDuration: permissionDetails.periodDuration,
startTime: permissionDetails.startTime,
justification: originalRequest.permission.data.justification,
};
Expand Down Expand Up @@ -176,7 +176,7 @@ export async function buildContext({
decimals,
});

const periodDuration = data.periodDuration.toString();
const { periodDuration } = data;

const startTime = data.startTime ?? Math.floor(Date.now() / 1000);

Expand Down
6 changes: 2 additions & 4 deletions packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,7 @@ export const periodDurationRule: RuleDefinition<
type: 'dropdown',
getRuleData: ({ context, metadata }) => ({
isAdjustmentAllowed: context.isAdjustmentAllowed,
value: getClosestTimePeriod(
parseInt(context.permissionDetails.periodDuration, 10),
),
value: getClosestTimePeriod(context.permissionDetails.periodDuration),
isVisible: true,
tooltip: 'The duration of the period',
options: Object.values(TimePeriod),
Expand All @@ -73,7 +71,7 @@ export const periodDurationRule: RuleDefinition<
);
}

const periodDuration = Number(periodSeconds).toString();
const periodDuration = Number(periodSeconds);

return {
...context,
Expand Down
2 changes: 1 addition & 1 deletion packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export type NativeTokenPeriodicMetadata = BaseMetadata & {
export type NativeTokenPeriodicContext = BaseContext & {
permissionDetails: {
periodAmount: string;
periodDuration: string;
periodDuration: number;
startTime: number;
};
};
Expand Down
8 changes: 4 additions & 4 deletions packages/gator-permissions-snap/test/permissions/erc20TokenPeriodic/context.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ const alreadyPopulatedContext: Erc20TokenPeriodicContext = {
},
permissionDetails: {
periodAmount: '100',
periodDuration: Number(TIME_PERIOD_TO_SECONDS[TimePeriod.DAILY]).toString(),
periodDuration: Number(TIME_PERIOD_TO_SECONDS[TimePeriod.DAILY]),
startTime: 1729900800,
},
} as const;
Expand Down Expand Up @@ -306,7 +306,7 @@ describe('erc20TokenPeriodic:context', () => {
...context,
permissionDetails: {
...context.permissionDetails,
periodDuration: 'invalid',
periodDuration: 'invalid' as unknown as number,
},
};

Expand All @@ -324,7 +324,7 @@ describe('erc20TokenPeriodic:context', () => {
...context,
permissionDetails: {
...context.permissionDetails,
periodDuration: '-1',
periodDuration: '-1' as unknown as number,
},
};

Expand Down Expand Up @@ -452,7 +452,7 @@ describe('erc20TokenPeriodic:context', () => {
permissionDetails: {
...alreadyPopulatedContext.permissionDetails,
periodAmount: '200',
periodDuration: '604800', // 1 week
periodDuration: 604800, // 1 week
startTime: Math.floor(Date.now() / 1000),
},
expiry: {
Expand Down
6 changes: 3 additions & 3 deletions packages/gator-permissions-snap/test/permissions/nativeTokenPeriodic/context.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ const alreadyPopulatedContext: NativeTokenPeriodicContext = {
},
permissionDetails: {
periodAmount: '1',
periodDuration: Number(TIME_PERIOD_TO_SECONDS[TimePeriod.DAILY]).toString(),
periodDuration: Number(TIME_PERIOD_TO_SECONDS[TimePeriod.DAILY]),
startTime: 1729900800,
},
} as const;
Expand Down Expand Up @@ -296,7 +296,7 @@ describe('nativeTokenPeriodic:context', () => {
...context,
permissionDetails: {
...context.permissionDetails,
periodDuration: 'invalid',
periodDuration: 'invalid' as unknown as number,
},
};

Expand All @@ -314,7 +314,7 @@ describe('nativeTokenPeriodic:context', () => {
...context,
permissionDetails: {
...context.permissionDetails,
periodDuration: '-1',
periodDuration: '-1' as unknown as number,
},
};

Expand Down
5 changes: 4 additions & 1 deletion packages/site/src/components/permissions/ERC20TokenPeriodicForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { useCallback, useEffect, useState } from 'react';
import { parseUnits, toHex, type Hex } from 'viem';

import type { ERC20TokenPeriodicPermissionRequest } from './types';

type ERC20TokenPeriodicFormProps = {
Expand All @@ -15,7 +16,9 @@ export const ERC20TokenPeriodicForm = ({
BigInt(toHex(parseUnits('1', decimals))),
);
const [periodDuration, setPeriodDuration] = useState(2592000); // 30 days in seconds
const [startTime, setStartTime] = useState<number | null>(Math.floor(Date.now() / 1000));
const [startTime, setStartTime] = useState<number | null>(
Math.floor(Date.now() / 1000),
);
const [expiry, setExpiry] = useState(
Math.floor(Date.now() / 1000) + 60 * 60 * 24 * 30, // 30 days from now
);
Expand Down
7 changes: 5 additions & 2 deletions packages/site/src/components/permissions/NativeTokenPeriodicForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { bigIntToHex } from '@metamask/utils';
import { useCallback, useEffect, useState } from 'react';
import { parseUnits } from 'viem';

import type { NativeTokenPeriodicPermissionRequest } from './types';
import { bigIntToHex } from '@metamask/utils';

type NativeTokenPeriodicFormProps = {
onChange: (request: NativeTokenPeriodicPermissionRequest) => void;
Expand All @@ -14,7 +15,9 @@ export const NativeTokenPeriodicForm = ({
BigInt(bigIntToHex(parseUnits('1', 18))),
);
const [periodDuration, setPeriodDuration] = useState(2592000); // 30 days in seconds
const [startTime, setStartTime] = useState<number | null>(Math.floor(Date.now() / 1000));
const [startTime, setStartTime] = useState<number | null>(
Math.floor(Date.now() / 1000),
);
const [expiry, setExpiry] = useState(
Math.floor(Date.now() / 1000) + 60 * 60 * 24 * 30, // 30 days from now
);
Expand Down
Loading