feat: makes ip address of request available in application layer

docs/design/distributed-cache.md

@@ -19,9 +19,9 @@ Important details is that, if an operator does not want to use Redis or it went
 
 ```javascript
 interface ICacheClient {
-  get(key: string, callingMethod: string, requestIdPrefix?: string): any;
-  set(key: string, value: any, callingMethod: string, ttl?: number, requestIdPrefix?: string): void;
-  delete(key: string, callingMethod: string, requestIdPrefix?: string): void;
+  get(key: string, callingMethod: string): any;
+  set(key: string, value: any, callingMethod: string, ttl?: number): void;
+  delete(key: string, callingMethod: string): void;
   clear(): void;
 }
 ```
@@ -40,15 +40,15 @@ class LocalLRUCache implements ICacheClient{
     public constructor() {
         this.cache = new LRU(this.options);
     }
-    get(key: string, callingMethod: string, requestIdPrefix?: string) {
+    get(key: string, callingMethod: string) {
         // Get item from internal cache implementation
     }
 
-    set(key: string, value: any, callingMethod: string, ttl?: number, requestIdPrefix?: string) {
+    set(key: string, value: any, callingMethod: string, ttl?: number) {
         // Set item to internal cache implementation
     }
 
-    delete(key: string, callingMethod: string, requestIdPrefix?: string) {
+    delete(key: string, callingMethod: string) {
         // Delete item from internal cache implementation
     }
 
@@ -81,15 +81,15 @@ class RedisCache implements ICacheClient{
 
         this.cache = client;
     }
-    get(key: string, callingMethod: string, requestIdPrefix?: string) {
+    get(key: string, callingMethod: string) {
         // Get item from shared cache implementation
     }
 
-    set(key: string, value: any, callingMethod: string, ttl?: number, requestIdPrefix?: string) {
+    set(key: string, value: any, callingMethod: string, ttl?: number) {
         // Set item to shared cache implementation
     }
 
-    delete(key: string, callingMethod: string, requestIdPrefix?: string) {
+    delete(key: string, callingMethod: string) {
         // Delete item from shared cache implementation
     }
 
@@ -120,19 +120,19 @@ class CacheClientService{
         const sharedCache = new RedisCache();
     }
 
-    get(key: string, callingMethod: string, requestIdPrefix?: string, shared: boolean = false) {
+    get(key: string, callingMethod: string, shared: boolean = false) {
         // Depending on the shared boolean, this method decide from where it should request the data.
         // Fallbacks to internalCache in case of error from the shared cache.
         // Getting from shared cache depends on REDIS_ENABLED env. variable
     }
 
-    set(key: string, value: any, callingMethod: string, ttl?: number, requestIdPrefix?: string, shared: boolean = false) {
+    set(key: string, value: any, callingMethod: string, ttl?: number, shared: boolean = false) {
         // Depending on the shared boolean, this method decide where it should save the data.
         // Fallbacks to internalCache in case of error from the shared cache.
         // Setting to shared cache depends on REDIS_ENABLED env. variable
     }
 
-    delete(key: string, callingMethod: string, requestIdPrefix?: string, shared: boolean = false) {
+    delete(key: string, callingMethod: string, shared: boolean = false) {
         // Depending on the shared boolean, this method decide from where it should delete the data.
         // Fallbacks to internalCache in case of error from the shared cache.
         // Deleting from shared cache depends on REDIS_ENABLED env. variable

package.json

@@ -4,6 +4,7 @@
     "@types/chai-as-promised": "^7.1.5",
     "@types/co-body": "6.1.0",
     "@types/koa-cors": "^0.0.6",
+    "@types/lodash": "^4.17.7",
     "@typescript-eslint/eslint-plugin": "^6.5.0",
     "@typescript-eslint/parser": "^6.5.0",
     "axios-mock-adapter": "^1.20.0",

packages/relay/src/formatters.ts

@@ -21,9 +21,7 @@
 import crypto from 'crypto';
 import constants from './lib/constants';
 import { BigNumber as BN } from 'bignumber.js';
-import { TransactionRecord } from '@hashgraph/sdk';
 import { BigNumber } from '@hashgraph/sdk/lib/Transfer';
-import { MirrorNodeTransactionRecord } from './lib/types/mirrorNode';
 import { Transaction, Transaction1559, Transaction2930 } from './lib/model';
 
 const EMPTY_HEX = '0x';

packages/relay/src/index.ts

@@ -19,7 +19,7 @@
  */
 
 import { Block, Log, Receipt, Transaction } from './lib/model';
-import { IContractCallRequest } from './lib/types';
+import { IContractCallRequest, RequestDetails } from './lib/types';
 import { JsonRpcError, predefined } from './lib/errors/JsonRpcError';
 import WebSocketError from './lib/errors/WebSocketError';
 import { MirrorNodeClientError } from './lib/errors/MirrorNodeClientError';
@@ -62,95 +62,112 @@ export interface Net {
 }
 
 export interface Eth {
-  blockNumber(requestId?: string): Promise<string>;
+  blockNumber(requestDetails: RequestDetails): Promise<string>;
 
-  call(call: any, blockParam: string | object | null, requestId?: string): Promise<string | JsonRpcError>;
+  call(call: any, blockParam: string | object | null, requestDetails: RequestDetails): Promise<string | JsonRpcError>;
 
-  coinbase(requestId?: string): JsonRpcError;
+  coinbase(requestDetails: RequestDetails): JsonRpcError;
 
   estimateGas(
     transaction: IContractCallRequest,
     blockParam: string | null,
-    requestId?: string,
+    requestDetails: RequestDetails,
   ): Promise<string | JsonRpcError>;
 
-  gasPrice(requestId?: string): Promise<string>;
+  gasPrice(requestDetails: RequestDetails): Promise<string>;
 
-  getBalance(account: string, blockNumber: string | null, requestId?: string): Promise<string>;
+  getBalance(account: string, blockNumber: string | null, requestDetails: RequestDetails): Promise<string>;
 
-  getBlockByHash(hash: string, showDetails: boolean, requestId?: string): Promise<Block | null>;
+  getBlockByHash(hash: string, showDetails: boolean, requestDetails: RequestDetails): Promise<Block | null>;
 
-  getBlockByNumber(blockNum: string, showDetails: boolean, requestId?: string): Promise<Block | null>;
+  getBlockByNumber(blockNum: string, showDetails: boolean, requestDetails: RequestDetails): Promise<Block | null>;
 
-  getBlockTransactionCountByHash(hash: string, requestId?: string): Promise<string | null>;
+  getBlockTransactionCountByHash(hash: string, requestDetails: RequestDetails): Promise<string | null>;
 
-  getBlockTransactionCountByNumber(blockNum: string, requestId?: string): Promise<string | null>;
+  getBlockTransactionCountByNumber(blockNum: string, requestDetails: RequestDetails): Promise<string | null>;
 
-  getCode(address: string, blockNumber: string | null, requestId?: string): Promise<string>;
+  getCode(address: string, blockNumber: string | null, requestDetails: RequestDetails): Promise<string>;
 
-  chainId(requestId?: string): string;
+  chainId(requestDetails: RequestDetails): string;
 
   getLogs(
     blockHash: string | null,
     fromBlock: string | null,
     toBlock: string | null,
     address: string | string[] | null,
     topics: any[] | null,
-    requestId?: string,
+    requestDetails: RequestDetails,
   ): Promise<Log[]>;
 
-  getStorageAt(address: string, slot: string, blockNumber: string | null, requestId?: string): Promise<string>;
-
-  getTransactionByBlockHashAndIndex(hash: string, index: string, requestId?: string): Promise<Transaction | null>;
-
-  getTransactionByBlockNumberAndIndex(blockNum: string, index: string, requestId?: string): Promise<Transaction | null>;
-
-  getTransactionByHash(hash: string, requestId?: string): Promise<Transaction | null>;
-
-  getTransactionCount(address: string, blockNum: string, requestId?: string): Promise<string | JsonRpcError>;
+  getStorageAt(
+    address: string,
+    slot: string,
+    requestDetails: RequestDetails,
+    blockNumber: string | null,
+  ): Promise<string>;
+
+  getTransactionByBlockHashAndIndex(
+    hash: string,
+    index: string,
+    requestDetails: RequestDetails,
+  ): Promise<Transaction | null>;
+
+  getTransactionByBlockNumberAndIndex(
+    blockNum: string,
+    index: string,
+    requestDetails: RequestDetails,
+  ): Promise<Transaction | null>;
+
+  getTransactionByHash(hash: string, requestDetails: RequestDetails): Promise<Transaction | null>;
+
+  getTransactionCount(
+    address: string,
+    blockNum: string,
+    requestDetails: RequestDetails,
+  ): Promise<string | JsonRpcError>;
 
-  getTransactionReceipt(hash: string, requestId?: string): Promise<Receipt | null>;
+  getTransactionReceipt(hash: string, requestDetails: RequestDetails): Promise<Receipt | null>;
 
-  getUncleByBlockHashAndIndex(requestId?: string): Promise<any>;
+  getUncleByBlockHashAndIndex(requestDetails: RequestDetails): Promise<any>;
 
-  getUncleByBlockNumberAndIndex(requestId?: string): Promise<any>;
+  getUncleByBlockNumberAndIndex(requestDetails: RequestDetails): Promise<any>;
 
-  getUncleCountByBlockHash(requestId?: string): Promise<string>;
+  getUncleCountByBlockHash(requestDetails: RequestDetails): Promise<string>;
 
-  getUncleCountByBlockNumber(requestId?: string): Promise<string>;
+  getUncleCountByBlockNumber(requestDetails: RequestDetails): Promise<string>;
 
-  getWork(requestId?: string): JsonRpcError;
+  getWork(requestDetails: RequestDetails): JsonRpcError;
 
   feeHistory(
     blockCount: number,
     newestBlock: string,
     rewardPercentiles: Array<number> | null,
-    requestId?: string,
+    requestDetails: RequestDetails,
   ): Promise<any>;
 
-  hashrate(requestId?: string): Promise<string>;
+  hashrate(requestDetails: RequestDetails): Promise<string>;
 
-  maxPriorityFeePerGas(requestId?: string): Promise<string>;
+  maxPriorityFeePerGas(requestDetails: RequestDetails): Promise<string>;
 
-  mining(requestId?: string): Promise<boolean>;
+  mining(requestDetails: RequestDetails): Promise<boolean>;
 
-  protocolVersion(requestId?: string): JsonRpcError;
+  protocolVersion(requestDetails: RequestDetails): JsonRpcError;
 
-  sendRawTransaction(transaction: string, requestId: string): Promise<string | JsonRpcError>;
+  sendRawTransaction(transaction: string, requestDetails: RequestDetails): Promise<string | JsonRpcError>;
 
-  sendTransaction(requestId?: string): JsonRpcError;
+  sendTransaction(requestDetails: RequestDetails): JsonRpcError;
 
-  sign(requestId?: string): JsonRpcError;
+  sign(requestDetails: RequestDetails): JsonRpcError;
 
-  signTransaction(requestId?: string): JsonRpcError;
+  signTransaction(requestDetails: RequestDetails): JsonRpcError;
 
-  submitHashrate(requestId?: string): JsonRpcError;
+  submitHashrate(requestDetails: RequestDetails): JsonRpcError;
 
-  submitWork(requestId?: string): Promise<boolean>;
+  submitWork(requestDetails: RequestDetails): Promise<boolean>;
 
-  syncing(requestId?: string): Promise<boolean>;
+  syncing(requestDetails: RequestDetails): Promise<boolean>;
 
-  accounts(requestId?: string): Array<any>;
+  accounts(requestDetails: RequestDetails): Array<any>;
 
   filterService(): IFilterService;
 

packages/relay/src/lib/clients/cache/ICacheClient.ts

@@ -18,17 +18,19 @@
  *
  */
 
+import { RequestDetails } from '../../types';
+
 export interface ICacheClient {
-  keys(pattern: string, callingMethod: string, requestIdPrefix?: string): Promise<string[]>;
-  get(key: string, callingMethod: string, requestIdPrefix?: string): Promise<any>;
-  set(key: string, value: any, callingMethod: string, ttl?: number, requestIdPrefix?: string): Promise<void>;
-  multiSet(keyValuePairs: Record<string, any>, callingMethod: string, requestIdPrefix?: string): Promise<void>;
+  keys(pattern: string, callingMethod: string, requestDetails: RequestDetails): Promise<string[]>;
+  get(key: string, callingMethod: string, requestDetails: RequestDetails): Promise<any>;
+  set(key: string, value: any, callingMethod: string, requestDetails: RequestDetails, ttl?: number): Promise<void>;
+  multiSet(keyValuePairs: Record<string, any>, callingMethod: string, requestDetails: RequestDetails): Promise<void>;
   pipelineSet(
     keyValuePairs: Record<string, any>,
     callingMethod: string,
+    requestDetails: RequestDetails,
     ttl?: number | undefined,
-    requestIdPrefix?: string,
   ): Promise<void>;
-  delete(key: string, callingMethod: string, requestIdPrefix?: string): Promise<void>;
+  delete(key: string, callingMethod: string, requestDetails: RequestDetails): Promise<void>;
   clear(): Promise<void>;
 }

packages/relay/src/lib/clients/cache/IRedisCacheClient.ts

@@ -19,10 +19,17 @@
  */
 
 import type { ICacheClient } from './ICacheClient';
+import { RequestDetails } from '../../types';
 
 export interface IRedisCacheClient extends ICacheClient {
   disconnect: () => Promise<void>;
-  incrBy(key: string, amount: number, callingMethod: string, requestIdPrefix?: string): Promise<number>;
-  rPush(key: string, value: any, callingMethod: string, requestIdPrefix?: string): Promise<number>;
-  lRange(key: string, start: number, end: number, callingMethod: string, requestIdPrefix?: string): Promise<any[]>;
+  incrBy(key: string, amount: number, callingMethod: string, requestDetails: RequestDetails): Promise<number>;
+  rPush(key: string, value: any, callingMethod: string, requestDetails: RequestDetails): Promise<number>;
+  lRange(
+    key: string,
+    start: number,
+    end: number,
+    callingMethod: string,
+    requestDetails: RequestDetails,
+  ): Promise<any[]>;
 }