Merge pull request #210 from zerodevapp/feat/ratelimit_off_standard

Feat/ratelimit off standard

Author: leekt

bun.lockb

@@ -33,6 +33,7 @@ import {
     ECDSA_SIGNER_CONTRACT,
     GAS_POLICY_CONTRACT,
     type Policy,
+    RATE_LIMIT_POLICY_WITH_RESET_CONTRACT,
     SUDO_POLICY_CONTRACT,
     deserializePermissionAccount,
     serializePermissionAccount
@@ -728,6 +729,54 @@ describe("Permission kernel Account", () => {
         TEST_TIMEOUT
     )
 
+    test(
+        "Smart account client send transaction with RateLimitPolicy with reset",
+        async () => {
+            const startAt = Math.floor(Date.now() / 1000)
+
+            const rateLimitPolicy = await toRateLimitPolicy({
+                policyAddress: RATE_LIMIT_POLICY_WITH_RESET_CONTRACT,
+                interval: 100,
+                count: 2
+            })
+
+            const permissionSmartAccountClient = await getKernelAccountClient({
+                account: await getSignerToPermissionKernelAccount([
+                    rateLimitPolicy
+                ]),
+                paymaster: zeroDevPaymaster
+            })
+
+            await sleep(2 * 5000)
+
+            const response = await permissionSmartAccountClient.sendTransaction(
+                {
+                    to: zeroAddress,
+                    value: 0n,
+                    data: "0x"
+                }
+            )
+
+            expect(response).toBeString()
+            expect(response).toHaveLength(TX_HASH_LENGTH)
+            expect(response).toMatch(TX_HASH_REGEX)
+            console.log("Transaction hash:", response)
+
+            const response2 =
+                await permissionSmartAccountClient.sendTransaction({
+                    to: zeroAddress,
+                    value: 0n,
+                    data: "0x"
+                })
+
+            expect(response2).toBeString()
+            expect(response2).toHaveLength(TX_HASH_LENGTH)
+            expect(response2).toMatch(TX_HASH_REGEX)
+            console.log("Transaction hash:", response2)
+        },
+        TEST_TIMEOUT
+    )
+
     test(
         "Smart account client send transaction with CallPolicy V0.0.1",
         async () => {

packages/test/v0.7/permissionValidator.test.ts

@@ -1,5 +1,11 @@
 # @zerodev/permissions
 
+## 5.5.3
+
+### Patch Changes
+
+- add optional rate limit policy for non-4337 opcode rule compliant way
+
 ## 5.5.2
 
 ### Patch Changes

plugins/permission/CHANGELOG.md

@@ -37,6 +37,14 @@ export const CALL_POLICY_CONTRACT_V0_0_4 =
 export const GAS_POLICY_CONTRACT = "0xaeFC5AbC67FfD258abD0A3E54f65E70326F84b23"
 export const RATE_LIMIT_POLICY_CONTRACT =
     "0xf63d4139B25c836334edD76641356c6b74C86873"
+
+/**
+ * @dev RATE_LIMIT_POLICY_WITH_RESET_CONTRACT
+ * - use non-standard way to deal with reset
+ */
+export const RATE_LIMIT_POLICY_WITH_RESET_CONTRACT =
+    "0x6a06358e6b283921deceabe7e8a3741d506cca9b"
+
 export const SIGNATURE_POLICY_CONTRACT =
     "0xF6A936c88D97E6fad13b98d2FD731Ff17eeD591d"
 export const SUDO_POLICY_CONTRACT = "0x67b436caD8a6D025DF6C82C5BB43fbF11fC5B9B7"

plugins/permission/constants.ts

@@ -1,6 +1,6 @@
 {
     "name": "@zerodev/permissions",
-    "version": "5.5.2",
+    "version": "5.5.3",
     "author": "ZeroDev",
     "main": "./_cjs/index.js",
     "module": "./_esm/index.js",

plugins/permission/package.json

@@ -1,6 +1,9 @@
 import { concatHex } from "viem"
 import { PolicyFlags } from "../constants.js"
-import { RATE_LIMIT_POLICY_CONTRACT } from "../constants.js"
+import {
+    RATE_LIMIT_POLICY_CONTRACT,
+    RATE_LIMIT_POLICY_WITH_RESET_CONTRACT
+} from "../constants.js"
 import type { Policy, PolicyParams } from "../types.js"
 
 export type RateLimitPolicyParams = PolicyParams & {
@@ -18,13 +21,31 @@ export function toRateLimitPolicy({
 }: RateLimitPolicyParams): Policy {
     return {
         getPolicyData: () => {
-            const intervalHex = interval.toString(16).padStart(12, "0")
-            const countHex = count.toString(16).padStart(12, "0")
-            const startAtHex = startAt.toString(16).padStart(12, "0")
+            if (policyAddress === RATE_LIMIT_POLICY_CONTRACT) {
+                const intervalHex = interval.toString(16).padStart(12, "0")
+                const countHex = count.toString(16).padStart(12, "0")
+                const startAtHex = startAt.toString(16).padStart(12, "0")
 
-            const data = intervalHex + countHex + startAtHex
+                const data = intervalHex + countHex + startAtHex
 
-            return `0x${data}`
+                return `0x${data}`
+            } else if (
+                policyAddress === RATE_LIMIT_POLICY_WITH_RESET_CONTRACT
+            ) {
+                if (startAt !== 0 && startAt !== undefined) {
+                    throw new Error(
+                        "RATE_LIMIT_POLICY_WITH_RESET_CONTRACT does not support startAt"
+                    )
+                }
+                const intervalHex = interval.toString(16).padStart(12, "0")
+                const countHex = count.toString(16).padStart(12, "0")
+
+                const data = intervalHex + countHex
+
+                return `0x${data}`
+            } else {
+                throw new Error("Invalid policy address")
+            }
         },
         getPolicyInfoInBytes: () => {
             return concatHex([policyFlag, policyAddress])