Feature/rate limit

README.md

@@ -104,43 +104,74 @@ You can control the from and to of a transaction.
 
 ```typescript
 // elements contained in the array are allowed to be transacted.
-export const getTxAllowList = (): Array<TransactionAllow> => {
-  return [
-    {
-      fromList: ['0xaf395754eB6F542742784cE7702940C60465A46a'],
-      toList: ['0xaf395754eB6F542742784cE7702940C60465A46a'],
-    },
-    {
-      fromList: ['0xaf395754eB6F542742784cE7702940C60465A46c'],
-      toList: ['0xaf395754eB6F542742784cE7702940C60465A46c'],
-    },
-  ];
-};
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['0xaf395754eB6F542742784cE7702940C60465A46a'],
+    toList: ['0xaf395754eB6F542742784cE7702940C60465A46a'],
+  },
+  {
+    fromList: ['0xaf395754eB6F542742784cE7702940C60465A46c'],
+    toList: ['0xaf395754eB6F542742784cE7702940C60465A46c'],
+  },
+];
 ```
 
 ```typescript
 // '*' is wildcard.
-export const getTxAllowList = (): Array<TransactionAllow> => {
-  return [
-    {
-      fromList: ['*'],
-      toList: ['*'],
-    },
-  ];
-}
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: ['*'],
+  },
+];
 ```
 
 ```typescript
 // ! is denial.
+
 // 0xaf395754eB6F542742784cE7702940C60465A46a are not allowed to be transacted.
-export const getTxAllowList = (): Array<TransactionAllow> => {
-  return [
-    {
-      fromList: ['!0xaf395754eB6F542742784cE7702940C60465A46a'],
-      toList: ['!0xaf395754eB6F542742784cE7702940C60465A46a'],
-    },
-  ];
-};
+// But any address other than 0xaf395754eB6F542742784cE7702940C60465A46a are allowed to be transacted.
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['!0xaf395754eB6F542742784cE7702940C60465A46a'],
+    toList: ['*'],
+  },
+];
+
+// Everyone are not allowed to transact to 0xaf395754eB6F542742784cE7702940C60465A46a.
+// everyone are allowed to transact to any address other than 0xaf395754eB6F542742784cE7702940C60465A46a.
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: ['!0xaf395754eB6F542742784cE7702940C60465A46a'],
+  },
+];
+
+// Multiple Setting is enabled.
+// Everyone are not allowed to transact to 0xaf395754eB6F542742784cE7702940C60465A46a and 0xaf395754eB6F542742784cE7702940C60465A46c.
+// everyone are allowed to transact to any address other than 0xaf395754eB6F542742784cE7702940C60465A46a and 0xaf395754eB6F542742784cE7702940C60465A46c.
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: [
+      '!0xaf395754eB6F542742784cE7702940C60465A46a',
+      '!0xaf395754eB6F542742784cE7702940C60465A46c'
+    ],
+  },
+];
+```
+
+```typescript
+// You can not set setting with address and address_denial.
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: [
+      '0xaf395754eB6F542742784cE7702940C60465A46a',
+      '!0xaf395754eB6F542742784cE7702940C60465A46c'
+    ],
+  },
+];
 ```
 
 If you want to allow transacting factory and bridge contracts, please set those contract addresses to `to`.
@@ -153,35 +184,31 @@ L2ERC721Bridge: '0x6200000000000000000000000000000000000001',
 ```
 
 ```typescript
-export const getTxAllowList = (): Array<TransactionAllow> => {
-  return [
-    {
-      fromList: [<FROM_YOU_WANT_TO_SET>],
-      toList: [
-        '0x4200000000000000000000000000000000000010',
-        '0x4200000000000000000000000000000000000012',
-        '0x6200000000000000000000000000000000000001',
-      ],
-    },
-    ...
-  ];
-};
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: [<FROM_YOU_WANT_TO_SET>],
+    toList: [
+      '0x4200000000000000000000000000000000000010',
+      '0x4200000000000000000000000000000000000012',
+      '0x6200000000000000000000000000000000000001',
+    ],
+  },
+  ...
+];
 ```
 
 #### Value
 You can control the token value of a transaction.
 
 ```typescript
 // Only transactions with more than 1000000000000000000unit values are allowed.
-export const getTxAllowList = (): Array<TransactionAllow> => {
-  return [
-    {
-      fromList: ['*'],
-      toList: ['*'],
-      value: { gt: '1000000000000000000' },
-    }
-  ];
-};
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: ['*'],
+    value: { gt: '1000000000000000000' },
+  }
+];
 ```
 
 | value's key  |  Comparison Operation  |
@@ -198,25 +225,15 @@ You can control deployer of a verse.
 
 ```typescript
 // Only 0xaf395754eB6F542742784cE7702940C60465A46a can deploy
-export const getDeployAllowList = (): Array<string> => {
-  return ['0xaf395754eB6F542742784cE7702940C60465A46a'];
-};
+const deployAllowList: Array<string> = ['0xaf395754eB6F542742784cE7702940C60465A46a'];
 
 // Everyone can deploy
-export const getDeployAllowList = (): Array<string> => {
-  return ['*'];
-};
-
-// 0xaf395754eB6F542742784cE7702940C60465A46c cannot deploy,
-// 0xaf395754eB6F542742784cE7702940C60465A46a can deploy
-export const getDeployAllowList = (): Array<string> => {
-  return [
-    '!0xaf395754eB6F542742784cE7702940C60465A46c',
-    '0xaf395754eB6F542742784cE7702940C60465A46a',
-  ];
-};
+const deployAllowList: Array<string> = ['*'];
 ```
 
+### Transaction access rate limit(Option)
+If you set transaction access rate limit, follow [Transaction access rate limit](/docs/RateLimit.md)
+
 ### Set allowed header
 You can set whether you inherit proxy request's host header on verse request at `src/config/configuration.ts`.
 ```typescript

docs/RateLimit.md

@@ -0,0 +1,169 @@
+# Transaction access rate limit
+
+## Datastore setting
+For setting datastore to store transaction history, you have to set datastore environment variables.
+
+```bash
+# In case of redis
+RATE_LIMIT_PLUGIN=redis
+REDIS_URI=<REDIS_URI> # e.g. redis://localhost:6379/0
+```
+
+And please set expire as the period of time to store the transaction.
+
+## Rate limit setting
+Using `txAllowList` at `src/config/transactionAllowList.ts`, you can set transaction rate limit.
+Please define rateLimit variable and set `txAllowList`.
+
+```typescript
+const rateLimitA = {
+  name: 'wildcard',
+  interval: 86400,
+  limit: 1000,
+};
+
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: ['*'],
+    rateLimit: rateLimitA,
+  },
+];
+```
+
+| RateLimit key  |  Description | Required |
+| ---- | ---- | ---- |
+|  name  |  RateLimit setting name. Must be unique.  | O |
+|  perFrom  |  Whether the setting is restricted for each from set in fromList or not  | |
+|  perTo  |  Whether the setting is restricted for each to set in the toList or not  | |
+|  perMethod  |  Whether the setting is restricted for each contract method or not  | |
+|  interval  |  Rate limit interval(seconds)  | O |
+|  limit  |  Number of tx's allowed in the interval  | O |
+
+rateLimit can be shared by another txAllowList setting.
+
+```typescript
+const rateLimitA = {
+  name: 'wildcard',
+  perFrom: true,
+  perTo: true,
+  interval: 86400,
+  limit: 1,
+};
+
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
+    rateLimit: rateLimitA,
+  },
+  {
+    fromList: ['*'],
+    toList: ['0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4'],
+    rateLimit: rateLimitA,
+  },
+];
+```
+
+### Example(limit settings per user)
+Each user can perform a transaction to `0x9809d9d94b0b3380db38b1e1a06047a2964e0041` once every 60 seconds.
+
+```typescript
+const rateLimitA = {
+  name: 'wildcard',
+  perFrom: true,
+  interval: 60,
+  limit: 1,
+};
+
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
+    rateLimit: rateLimitA,
+  },
+]
+```
+
+### Example(limit settings per all users)
+Transaction to `0x9809d9d94b0b3380db38b1e1a06047a2964e0041` can only be executed once every 60 seconds
+
+```typescript
+const rateLimitA = {
+  name: 'wildcard',
+  interval: 60,
+  limit: 1,
+};
+
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
+    rateLimit: rateLimitA,
+  },
+];
+```
+
+### Example(limit settings per contract)
+Transaction to `0x9809d9d94b0b3380db38b1e1a06047a2964e0041` or `0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4` can only be executed once every 60 seconds respectively.
+```typescript
+const rateLimitA = {
+  name: 'wildcard',
+  perTo: true,
+  interval: 60,
+  limit: 1,
+};
+
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
+    rateLimit: rateLimitA,
+  },
+  {
+    fromList: ['*'],
+    toList: ['0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4'],
+    rateLimit: rateLimitA,
+  },
+];
+```
+
+### Example(limit settings per all contracts)
+Both together, Transaction to `0x9809d9d94b0b3380db38b1e1a06047a2964e0041` or `0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4` can only be executed once every 60 seconds.
+
+```typescript
+const rateLimitA = {
+  name: 'wildcard',
+  interval: 60,
+  limit: 1,
+};
+
+const txAllowList: Array<TransactionAllow> = [
+  {
+    fromList: ['*'],
+    toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
+    rateLimit: rateLimitA,
+  },
+  {
+    fromList: ['*'],
+    toList: ['0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4'],
+    rateLimit: rateLimitA,
+  },
+];
+```
+
+## Set Addresses unlimited tx rate
+Addresses set in `getDeployAllowList` and `getUnlimitedTxRateAddresses` are not rate-limited for transactions.
+
+```typescript
+const deployAllowList: Array<string> = ['0xaf395754eB6F542742784cE7702940C60465A46c'];
+
+const unlimitedTxRateAddresses: Array<string> = ['0xaf395754eB6F542742784cE7702940C60465A46a'];
+```
+
+You can set wildcard
+```typescript
+const deployAllowList: Array<string> = ['*'];
+
+const unlimitedTxRateAddresses: Array<string> = ['*'];
+```