Add env variable to control rate limiting (#655)

* feat: add env var to control rate limiting

Signed-off-by: Ivo Yankov <[email protected]>

* chore: update helm chart values

Signed-off-by: Ivo Yankov <[email protected]>

* docs: add new env var to readme

Signed-off-by: Ivo Yankov <[email protected]>

Signed-off-by: Ivo Yankov <[email protected]>

Author: Ivo-Yankov

.env.example

@@ -15,4 +15,5 @@ TIER_3_RATE_LIMIT =
 LIMIT_DURATION =
 HBAR_RATE_LIMIT_TINYBAR =
 HBAR_RATE_LIMIT_DURATION =
+RATE_LIMIT_DISABLED =
 ETH_GET_LOGS_BLOCK_RANGE_LIMIT =

README.md

@@ -79,6 +79,7 @@ TIER_3_RATE_LIMIT = 400
 LIMIT_DURATION = 60000
 HBAR_RATE_LIMIT_TINYBAR = 6000000000
 HBAR_RATE_LIMIT_DURATION = 60000
+RATE_LIMIT_DISABLED = false
 ```
 
 The following table highlights some initial configuration values to consider

docs/rate-limiting.md

@@ -13,10 +13,12 @@ TIER_1_RATE_LIMIT = 100;
 TIER_2_RATE_LIMIT = 800;
 TIER_3_RATE_LIMIT = 1600;
 LIMIT_DURATION = 60000;
+RATE_LIMIT_DISABLED = false;
 ```
 
 - **DEFAULT_RATE_LIMIT**: - default fallback rate limit, if no other is configured. Default is to `200` (200 request per IP).
 - **TIER_1_RATE_LIMIT**: - restrictive limiting tier, for expensive endpoints. Default is to `100` (100 request per IP).
 - **TIER_2_RATE_LIMIT**: - moderate limiting tier, for non expensive endpoints. Default is to `800` (800 request per IP).
 - **TIER_3_RATE_LIMIT**: - relaxed limiting tier. Default is to `1600` (1600 request per IP).
 - **LIMIT_DURATION**: - reset limit duration. This creates a timestamp, which resets all limits, when it's reached. Default is to `60000` (1 minute).
+- **RATE_LIMIT_DISABLED**: - if set to `true` no rate limiting will be performed.

helm-chart/templates/configmap.yaml

@@ -26,3 +26,4 @@ data:
   HBAR_RATE_LIMIT_TINYBAR: {{ .Values.config.HBAR_RATE_LIMIT_TINYBAR }}
   HBAR_RATE_LIMIT_DURATION: {{ .Values.config.HBAR_RATE_LIMIT_DURATION }}
   ETH_GET_LOGS_BLOCK_RANGE_LIMIT: {{ .Values.config.ETH_GET_LOGS_BLOCK_RANGE_LIMIT }}
+  RATE_LIMIT_DISABLED: {{ .Values.config.RATE_LIMIT_DISABLED }}

helm-chart/templates/deployment.yaml

@@ -138,6 +138,12 @@ spec:
                 name: {{ include "json-rpc-relay.fullname" . }}
                 key: ETH_GET_LOGS_BLOCK_RANGE_LIMIT
                 optional: true
+          - name: RATE_LIMIT_DISABLED
+            valueFrom:
+              configMapKeyRef:
+                name: {{ include "json-rpc-relay.fullname" . }}
+                key: RATE_LIMIT_DISABLED
+                optional: true
         ports:
           - containerPort: {{ .Values.ports.containerPort }}
             name: {{ .Values.ports.name  }}

helm-chart/values.yaml

@@ -110,6 +110,7 @@ config:
   HBAR_RATE_LIMIT_TINYBAR: 5000000000
   HBAR_RATE_LIMIT_DURATION: 60000
   ETH_GET_LOGS_BLOCK_RANGE_LIMIT: 1000
+  RATE_LIMIT_DISABLED: false
 
 # Enable rolling_restarts if SDK calls fail this is usually due to stale connections that get cycled on restart
 rolling_restart:

packages/server/src/ratelimit/index.ts

@@ -43,6 +43,7 @@ export default class RateLimit {
   }
 
   shouldRateLimit(ip: string, methodName: string, total: number): boolean {
+    if (process.env.RATE_LIMIT_DISABLED && process.env.RATE_LIMIT_DISABLED === 'true') return false;
     this.precheck(ip, methodName, total);
     if (!this.shouldReset(ip)) {
       if (this.checkRemaining(ip, methodName)) {

packages/server/tests/localAcceptance.env

@@ -20,4 +20,5 @@ TIER_2_RATE_LIMIT = 800
 TIER_3_RATE_LIMIT = 1600
 LIMIT_DURATION = 60000
 HBAR_RATE_LIMIT_TINYBAR = 8000000000
-HBAR_RATE_LIMIT_DURATION = 60000
+HBAR_RATE_LIMIT_DURATION = 60000
+RATE_LIMIT_DISABLED=true