Add recurring allowance permissions support on smart-session (#3075)

reown-com · Oct 15, 2024 · 7f99593 · 7f99593
1 parent 9d8ce0a
commit 7f99593
Show file tree

Hide file tree

Showing 10 changed files with 962 additions and 522 deletions.
diff --git a/.changeset/beige-lemons-clean.md b/.changeset/beige-lemons-clean.md
@@ -0,0 +1,23 @@
+---
+'@reown/appkit-experimental': patch
+'@apps/demo': patch
+'@apps/gallery': patch
+'@apps/laboratory': patch
+'@reown/appkit-adapter-ethers': patch
+'@reown/appkit-adapter-ethers5': patch
+'@reown/appkit-adapter-polkadot': patch
+'@reown/appkit-adapter-solana': patch
+'@reown/appkit-adapter-wagmi': patch
+'@reown/appkit': patch
+'@reown/appkit-utils': patch
+'@reown/appkit-cdn': patch
+'@reown/appkit-common': patch
+'@reown/appkit-core': patch
+'@reown/appkit-polyfills': patch
+'@reown/appkit-scaffold-ui': patch
+'@reown/appkit-siwe': patch
+'@reown/appkit-ui': patch
+'@reown/appkit-wallet': patch
+---
+
+Added NativeTokenRecurringAllowancePermission and ERC20RecurringAllowancePermission support on appkit-experimental/smart-session sdk
diff --git a/packages/experimental/exports/smart-session/index.ts b/packages/experimental/exports/smart-session/index.ts
@@ -3,8 +3,4 @@ export {
   isSmartSessionSupported
 } from '../../src/smart-session/grantPermissions.js'
 
-export type {
-  KeyType,
-  SmartSessionGrantPermissionsRequest,
-  SmartSessionGrantPermissionsResponse
-} from '../../src/smart-session/utils/TypeUtils.js'
+export * from '../../src/smart-session/utils/TypeUtils.js'
diff --git a/packages/experimental/src/smart-session/schema/index.ts b/packages/experimental/src/smart-session/schema/index.ts
@@ -22,7 +22,10 @@ export const ERROR_MESSAGES = {
   //PermissionSchema
   INVALID_PERMISSIONS: 'Invalid permissions: must be a non-empty array',
   INVALID_PERMISSIONS_TYPE: 'Invalid permissions: Expected array, received object',
-  INVALID_PERMISSIONS_TYPE_LITERALS: 'Invalid literal value, expected "contract-call"',
+
+  INVALID_ALLOWANCE_FORMAT: 'Invalid allowance: must be a hexadecimal string starting with "0x"',
+  INVALID_START: 'Invalid start time: must be a positive integer and in the future',
+  INVALID_PERIOD: 'Invalid period: must be a positive integer',
   //PolicySchema
   INVALID_POLICIES: 'Invalid policies: must be a non-empty array',
   INVALID_POLICIES_TYPE: 'Invalid policies: Expected array, received object',
@@ -90,16 +93,51 @@ const FunctionPermissionSchema = z.object({
 
 // Contract Call Permission Schema
 const ContractCallPermissionSchema = z.object({
-  type: z.literal('contract-call').refine(val => val === 'contract-call', {
-    message: ERROR_MESSAGES.INVALID_PERMISSIONS_TYPE_LITERALS
-  }),
+  type: z.literal('contract-call'),
   data: z.object({
     address: z.string().startsWith('0x', { message: ERROR_MESSAGES.INVALID_ADDRESS }),
     abi: z.array(z.record(z.unknown())),
     functions: z.array(FunctionPermissionSchema)
   })
 })
 
+// Native Token Recurring Allowance Permission Schema
+const NativeTokenRecurringAllowancePermissionSchema = z.object({
+  type: z.literal('native-token-recurring-allowance'),
+  data: z.object({
+    allowance: z.string().startsWith('0x', { message: ERROR_MESSAGES.INVALID_ALLOWANCE_FORMAT }),
+    start: z
+      .number()
+      .positive({ message: ERROR_MESSAGES.INVALID_START })
+      .refine(value => value > Math.floor(Date.now() / 1000), {
+        message: ERROR_MESSAGES.INVALID_START
+      }),
+    period: z.number().positive({ message: ERROR_MESSAGES.INVALID_PERIOD })
+  })
+})
+
+// ERC20 Recurring Allowance Permission Schema
+const ERC20RecurringAllowancePermissionSchema = z.object({
+  type: z.literal('erc20-recurring-allowance'),
+  data: z.object({
+    token: z.string().startsWith('0x', { message: ERROR_MESSAGES.INVALID_ADDRESS }),
+    allowance: z.string().startsWith('0x', { message: ERROR_MESSAGES.INVALID_ALLOWANCE_FORMAT }),
+    start: z
+      .number()
+      .positive({ message: ERROR_MESSAGES.INVALID_START })
+      .refine(value => value > Math.floor(Date.now() / 1000), {
+        message: ERROR_MESSAGES.INVALID_START
+      }),
+    period: z.number().positive({ message: ERROR_MESSAGES.INVALID_PERIOD })
+  })
+})
+
+// Update Permission Schema to support new types
+const PermissionSchema = z.union([
+  ContractCallPermissionSchema,
+  NativeTokenRecurringAllowancePermissionSchema,
+  ERC20RecurringAllowancePermissionSchema
+])
 // Policies Schema
 const PolicySchema = z.object({
   type: z.string(),
@@ -114,7 +152,7 @@ export const SmartSessionGrantPermissionsRequestSchema = z
     expiry: ExpirySchema,
     signer: SignerSchema,
     permissions: z
-      .array(ContractCallPermissionSchema)
+      .array(PermissionSchema)
       .nonempty({ message: ERROR_MESSAGES.INVALID_PERMISSIONS }),
     policies: z.array(PolicySchema)
   })

diff --git a/packages/experimental/src/smart-session/utils/TypeUtils.ts b/packages/experimental/src/smart-session/utils/TypeUtils.ts
@@ -93,8 +93,29 @@ export type ContractCallPermission = {
   }
 }
 
+export type NativeTokenRecurringAllowancePermission = {
+  type: 'native-token-recurring-allowance'
+  data: {
+    allowance: `0x${string}`
+    start: number
+    period: number
+  }
+}
+
+export type ERC20RecurringAllowancePermission = {
+  type: 'erc20-recurring-allowance'
+  data: {
+    token: `0x${string}`
+    allowance: `0x${string}`
+    start: number
+    period: number
+  }
+}
 // Union type for all possible permissions
-export type Permission = ContractCallPermission
+export type Permission =
+  | ContractCallPermission
+  | NativeTokenRecurringAllowancePermission
+  | ERC20RecurringAllowancePermission
 
 //--Cosigner Types----------------------------------------------------------------------- //
 export type AddPermissionRequest = SmartSessionGrantPermissionsRequest