feat: replaced HbarLimit module with the new HbarLimitService class (#…

…3110) * feat: replaced HbarLimit module with the new HbarLimitService class (#3024) * fix: converted constant HBAR_RATE_LIMIT_DURATION from var into function Signed-off-by: Logan Nguyen <[email protected]> * chore: added jsdoc to private vars in hapiService module Signed-off-by: Logan Nguyen <[email protected]> * feat: initialized an instance of HbarLimitService in relay.ts Signed-off-by: Logan Nguyen <[email protected]> * feat: integrated HbarLimitService instance into HapiService class Signed-off-by: Logan Nguyen <[email protected]> * feat: integrated HbarLimitService instance into SDKClient class Signed-off-by: Logan Nguyen <[email protected]> * feat: integrated HbarLimitService instance into MetricService class Signed-off-by: Logan Nguyen <[email protected]> * fix: modified addExpense to turn ethAddress to be optional Some queries like getAccountInfo, getBalanceInfo, FileContentsQuery, etc. also add expense to remainingBalance but don't necessarily need to have an originalCaller (ethAddress). Therefore, addExpense can accept nullable ethAddress value. Only when ethAddress or ipAddress is valid, utilize spendingPlan logic. Otherwise, skip completely. Signed-off-by: Logan Nguyen <[email protected]> * feat: added getRemainingBudget() getter Signed-off-by: Logan Nguyen <[email protected]> * feat: added originalCallerAddress to IExecuteTransactionEventPayload and IExecuteQueryEventPayload Signed-off-by: Logan Nguyen <[email protected]> * feat: removed metricService instance in relay Signed-off-by: Logan Nguyen <[email protected]> * feat: replaced hbarLimitter with hbarLimitService in MetricService class Signed-off-by: Logan Nguyen <[email protected]> * fix: added estimateFileTransactionsFee to Utils Signed-off-by: Logan Nguyen <[email protected]> * feat: added txConstructorName and updated log messages for shouldLimit Signed-off-by: Logan Nguyen <[email protected]> * fix: rework logic for estimateFileTransactionsFee Signed-off-by: Logan Nguyen <[email protected]> * feat: removed hbarLimiter instance in SDKClient classes Signed-off-by: Logan Nguyen <[email protected]> * feat: deleted HbarLimit module from codease Signed-off-by: Logan Nguyen <[email protected]> * feat: reverted logic reworked on estimateFileTransactionsFee Signed-off-by: Logan Nguyen <[email protected]> * feat: added preemptive rate limit logic to createFile() method Signed-off-by: Logan Nguyen <[email protected]> * test: updated hbarLimiter.spec.ts Signed-off-by: Logan Nguyen <[email protected]> * fix: added names for child loggers for spending plan repo Signed-off-by: Logan Nguyen <[email protected]> * chore: reverted "feat: added getRemainingBudget() getter" This reverts commit fd9e119 and updated related tests Signed-off-by: Logan Nguyen <[email protected]> * fix: updated log message Signed-off-by: Logan Nguyen <[email protected]> * test: added HBAR_DAILY_LIMIT_BASIC to localTestEnv Signed-off-by: Logan Nguyen <[email protected]> * fix: converted function HBAR_RATE_LIMIT_DURATION from function into var Signed-off-by: Logan Nguyen <[email protected]> * fix: reverted "feat: removed metricService instance in relay" This reverts commit e45c321. Signed-off-by: Logan Nguyen <[email protected]> * chore: updated log message Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed failing test in hapiService Signed-off-by: Logan Nguyen <[email protected]> * fix: reverted ethAddress back to be a required param for addExpense Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed failing test in hapiService.spec.ts Signed-off-by: Logan Nguyen <[email protected]> * fix: loaded env into prcess.env for constant module Signed-off-by: Logan Nguyen <[email protected]> * chore: removed duplicating doc for estimateFileTransactionsFee Signed-off-by: Logan Nguyen <[email protected]> * chore: sort imports Signed-off-by: Victor Yanev <[email protected]> * fix: removed ipAddresses from log in hbarLimitService Signed-off-by: Logan Nguyen <[email protected]> * fix: renamed isDailyBudgetExceeded -> isTotalBudgetExceeded Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed conflicts after rebased Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed acceptance test for exhausting HBAR case Signed-off-by: Logan Nguyen <[email protected]> * fix: renamed HBAR_DAILY_LIMIT_BASIC to HBAR_RATE_LIMIT_BASIC Signed-off-by: Logan Nguyen <[email protected]> * fix: overrode env vars for npm acceptancetest:hbarlimiter script Signed-off-by: Logan Nguyen <[email protected]> * fix: moved logic of adding expenses to totalBudget above hbarSpendingPlan Signed-off-by: Logan Nguyen <[email protected]> --------- Signed-off-by: Logan Nguyen <[email protected]> Signed-off-by: Victor Yanev <[email protected]> Co-authored-by: Victor Yanev <[email protected]> Signed-off-by: Logan Nguyen <[email protected]> * test: create e2e tests for basic spending plan limit (#3104) * Adds acceptance test for BASIC user spending plans Signed-off-by: Konstantina Blazhukova <[email protected]> Fixes failing acceptance test Signed-off-by: Konstantina Blazhukova <[email protected]> Revert accidental deletion of method Signed-off-by: Konstantina Blazhukova <[email protected]> * Fixes CI Signed-off-by: Konstantina Blazhukova <[email protected]> * Fixes failiing acceptance tests and improves setup Signed-off-by: Konstantina Blazhukova <[email protected]> Update hbarLimiter.spec.ts Signed-off-by: Logan Nguyen <[email protected]> * fix: switched back HBAR_RATE_LIMIT_DURATION Signed-off-by: Logan Nguyen <[email protected]> * fix: renamed HBAR_DAILY_LIMIT_BASIC to HBAR_RATE_LIMIT_BASIC Signed-off-by: Logan Nguyen <[email protected]> Update localAcceptance.env Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed hbar limiter test Signed-off-by: Logan Nguyen <[email protected]> * fix: re-ordered test cases Signed-off-by: Logan Nguyen <[email protected]> * Improves test case and skips unecessary one Signed-off-by: Konstantina Blazhukova <[email protected]> * Improves unlinking of ip addresses Signed-off-by: Konstantina Blazhukova <[email protected]> * Revert "chore: remove unnecessary timeouts in tests" This reverts commit f688a4e. Signed-off-by: Konstantina Blazhukova <[email protected]> * Adds new deleteAll method in ipAddressRepository Signed-off-by: Konstantina Blazhukova <[email protected]> * Removes timeouts and adds logic to wait for limiter reset Signed-off-by: Konstantina Blazhukova <[email protected]> * Adds appropriate limits for acceptance tests Signed-off-by: Konstantina Blazhukova <[email protected]> * Adds new variables to .env Signed-off-by: Konstantina Blazhukova <[email protected]> * Improves test setup, removes unneeded limiter reset Signed-off-by: Konstantina Blazhukova <[email protected]> * Removes setting of env from terminal command, adds it to test setup instead Signed-off-by: Konstantina Blazhukova <[email protected]> * Adds necessary timeouts in tests relying on queries to mirror node Signed-off-by: Konstantina Blazhukova <[email protected]> * Fixes import in hbarLimiter spec Signed-off-by: Konstantina Blazhukova <[email protected]> * Removes unused imports, adds const where needed Signed-off-by: Konstantina Blazhukova <[email protected]> * Removes unused method Signed-off-by: Konstantina Blazhukova <[email protected]> * Makes improvements in ipAddressHbarRepo Signed-off-by: Konstantina Blazhukova <[email protected]> * Adds reset timestamp method to test Signed-off-by: Konstantina Blazhukova <[email protected]> * fix: added deleteAll() to EthAddressHbarSpendingPlanRepository class Signed-off-by: Logan Nguyen <[email protected]> * fix: reverted and cleaned up Signed-off-by: Logan Nguyen <[email protected]> * fix: removed duplicated test Signed-off-by: Logan Nguyen <[email protected]> --------- Signed-off-by: Konstantina Blazhukova <[email protected]> Signed-off-by: Logan Nguyen <[email protected]> Signed-off-by: Logan Nguyen <[email protected]> Update hbarLimiter.spec.ts Signed-off-by: Logan Nguyen <[email protected]> Update hbarLimiter.spec.ts Signed-off-by: Logan Nguyen <[email protected]> Co-Authored-By: Logan Nguyen <[email protected]> * chore: added info log after HbarLimiter is successfully configured Signed-off-by: Logan Nguyen <[email protected]> * chore: removed overriden variables in `acceptancetest:hbarlimiter` npm script Signed-off-by: Logan Nguyen <[email protected]> * fix: bumped HBAR_RATE_LIMIT_BASIC to 40 HBARs Signed-off-by: Logan Nguyen <[email protected]> * Shortens and improves logger name for new hbar plan repositories Signed-off-by: Konstantina Blazhukova <[email protected]> --------- Signed-off-by: Logan Nguyen <[email protected]> Signed-off-by: Victor Yanev <[email protected]> Signed-off-by: Konstantina Blazhukova <[email protected]> Co-authored-by: Victor Yanev <[email protected]> Co-authored-by: konstantinabl <[email protected]>
hashgraph · Oct 21, 2024 · 34ec5a2 · 34ec5a2
1 parent a1ae911
commit 34ec5a2
Show file tree

Hide file tree

Showing 29 changed files with 958 additions and 1,005 deletions.
diff --git a/package.json b/package.json
@@ -47,7 +47,7 @@
     "acceptancetest:api_batch3": "nyc ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@api-batch-3' --exit",
     "acceptancetest:erc20": "nyc ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@erc20' --exit",
     "acceptancetest:ratelimiter": "nyc ts-mocha packages/ws-server/tests/acceptance/index.spec.ts -g '@web-socket-ratelimiter' --exit && ts-mocha packages/server/tests/acceptance/index.spec.ts -g '@ratelimiter' --exit",
-    "acceptancetest:hbarlimiter": "HBAR_RATE_LIMIT_TINYBAR=3000000000 nyc ts-mocha packages/server/tests/acceptance/index.spec.ts -g '@hbarlimiter' --exit",
+    "acceptancetest:hbarlimiter": "nyc ts-mocha packages/server/tests/acceptance/index.spec.ts -g '@hbarlimiter' --exit",
     "acceptancetest:tokencreate": "nyc ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@tokencreate' --exit",
     "acceptancetest:tokenmanagement": "nyc ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@tokenmanagement' --exit",
     "acceptancetest:htsprecompilev1": "nyc ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@htsprecompilev1' --exit",

diff --git a/packages/relay/src/lib/clients/sdkClient.ts b/packages/relay/src/lib/clients/sdkClient.ts
@@ -53,14 +53,15 @@ import {
   TransactionResponse,
 } from '@hashgraph/sdk';
 import { Logger } from 'pino';
+import { Utils } from '../../utils';
 import { EventEmitter } from 'events';
-import HbarLimit from '../hbarlimiter';
 import constants from './../constants';
 import { BigNumber } from '@hashgraph/sdk/lib/Transfer';
-import { SDKClientError } from '../errors/SDKClientError';
-import { JsonRpcError, predefined } from '../errors/JsonRpcError';
-import { CacheService } from '../services/cacheService/cacheService';
 import { weibarHexToTinyBarInt } from '../../formatters';
+import { SDKClientError } from './../errors/SDKClientError';
+import { HbarLimitService } from '../services/hbarLimitService';
+import { JsonRpcError, predefined } from './../errors/JsonRpcError';
+import { CacheService } from '../services/cacheService/cacheService';
 import {
   IExecuteQueryEventPayload,
   IExecuteTransactionEventPayload,
@@ -85,12 +86,6 @@ export class SDKClient {
    */
   private readonly logger: Logger;
 
-  /**
-   * This limiter tracks hbar expenses and limits.
-   * @private
-   */
-  private readonly hbarLimiter: HbarLimit;
-
   /**
    * LRU cache container.
    * @private
@@ -118,21 +113,28 @@ export class SDKClient {
    */
   private readonly eventEmitter: EventEmitter;
 
+  /**
+   * An instance of the HbarLimitService that tracks hbar expenses and limits.
+   * @private
+   * @readonly
+   * @type {HbarLimitService}
+   */
+  private readonly hbarLimitService: HbarLimitService;
+
   /**
    * Constructs an instance of the SDKClient and initializes various services and settings.
    *
    * @param {Client} clientMain - The primary Hedera client instance used for executing transactions and queries.
    * @param {Logger} logger - The logger instance for logging information, warnings, and errors.
-   * @param {HbarLimit} hbarLimiter - The Hbar rate limiter instance for managing Hbar transaction budgets.
    * @param {CacheService} cacheService - The cache service instance used for caching and retrieving data.
    * @param {EventEmitter} eventEmitter - The eventEmitter used for emitting and handling events within the class.
    */
   constructor(
     clientMain: Client,
     logger: Logger,
-    hbarLimiter: HbarLimit,
     cacheService: CacheService,
     eventEmitter: EventEmitter,
+    hbarLimitService: HbarLimitService,
   ) {
     this.clientMain = clientMain;
 
@@ -143,9 +145,9 @@ export class SDKClient {
     }
 
     this.logger = logger;
-    this.hbarLimiter = hbarLimiter;
     this.cacheService = cacheService;
     this.eventEmitter = eventEmitter;
+    this.hbarLimitService = hbarLimitService;
     this.maxChunks = Number(process.env.FILE_APPEND_MAX_CHUNKS) || 20;
     this.fileAppendChunkSize = Number(process.env.FILE_APPEND_CHUNK_SIZE) || 5120;
   }
@@ -417,30 +419,14 @@ export class SDKClient {
     if (ethereumTransactionData.callData.length <= this.fileAppendChunkSize) {
       ethereumTransaction.setEthereumData(ethereumTransactionData.toBytes());
     } else {
-      const isPreemptiveCheckOn = process.env.HBAR_RATE_LIMIT_PREEMPTIVE_CHECK === 'true';
-
-      if (isPreemptiveCheckOn) {
-        const hexCallDataLength = Buffer.from(ethereumTransactionData.callData).toString('hex').length;
-        const shouldPreemptivelyLimit = this.hbarLimiter.shouldPreemptivelyLimitFileTransactions(
-          originalCallerAddress,
-          hexCallDataLength,
-          this.fileAppendChunkSize,
-          currentNetworkExchangeRateInCents,
-          requestDetails,
-        );
-
-        if (shouldPreemptivelyLimit) {
-          throw predefined.HBAR_RATE_LIMIT_PREEMPTIVE_EXCEEDED;
-        }
-      }
-
       fileId = await this.createFile(
         ethereumTransactionData.callData,
         this.clientMain,
         requestDetails,
         callerName,
         interactingEntity,
         originalCallerAddress,
+        currentNetworkExchangeRateInCents,
       );
       if (!fileId) {
         throw new SDKClientError({}, `${requestDetails.formattedRequestId} No fileId created for transaction. `);
@@ -506,7 +492,7 @@ export class SDKClient {
       contractCallQuery.setPaymentTransactionId(TransactionId.generate(this.clientMain.operatorAccountId));
     }
 
-    return this.executeQuery(contractCallQuery, this.clientMain, callerName, to, requestDetails);
+    return this.executeQuery(contractCallQuery, this.clientMain, callerName, to, requestDetails, from);
   }
 
   /**
@@ -603,6 +589,7 @@ export class SDKClient {
    * @param {string} callerName - The name of the caller executing the query.
    * @param {string} interactingEntity - The entity interacting with the query.
    * @param {RequestDetails} requestDetails - The request details for logging and tracking.
+   * @param {string} [originalCallerAddress] - The optional address of the original caller making the request.
    * @returns {Promise<T>} A promise resolving to the query response.
    * @throws {Error} Throws an error if the query fails or if rate limits are exceeded.
    * @template T - The type of the query response.
@@ -613,6 +600,7 @@ export class SDKClient {
     callerName: string,
     interactingEntity: string,
     requestDetails: RequestDetails,
+    originalCallerAddress?: string,
   ): Promise<T> {
     const queryConstructorName = query.constructor.name;
     const requestIdPrefix = requestDetails.formattedRequestId;
@@ -669,6 +657,7 @@ export class SDKClient {
           interactingEntity,
           status,
           requestDetails,
+          originalCallerAddress,
         } as IExecuteQueryEventPayload);
       }
     }
@@ -683,6 +672,7 @@ export class SDKClient {
    * @param {RequestDetails} requestDetails - The request details for logging and tracking.
    * @param {boolean} shouldThrowHbarLimit - Flag to indicate whether to check HBAR limits.
    * @param {string} originalCallerAddress - The address of the original caller making the request.
+   * @param {number} [estimatedTxFee] - The optioanl total estimated transaction fee.
    * @returns {Promise<TransactionResponse>} - A promise that resolves to the transaction response.
    * @throws {SDKClientError} - Throws if an error occurs during transaction execution.
    */
@@ -693,19 +683,22 @@ export class SDKClient {
     requestDetails: RequestDetails,
     shouldThrowHbarLimit: boolean,
     originalCallerAddress: string,
+    estimatedTxFee?: number,
   ): Promise<TransactionResponse> {
     const txConstructorName = transaction.constructor.name;
     let transactionId: string = '';
     let transactionResponse: TransactionResponse | null = null;
 
     if (shouldThrowHbarLimit) {
-      const shouldLimit = this.hbarLimiter.shouldLimit(
-        Date.now(),
+      const shouldLimit = await this.hbarLimitService.shouldLimit(
         constants.EXECUTION_MODE.TRANSACTION,
         callerName,
+        txConstructorName,
         originalCallerAddress,
         requestDetails,
+        estimatedTxFee,
       );
+
       if (shouldLimit) {
         throw predefined.HBAR_RATE_LIMIT_EXCEEDED;
       }
@@ -756,6 +749,7 @@ export class SDKClient {
           txConstructorName,
           operatorAccountId: this.clientMain.operatorAccountId!.toString(),
           interactingEntity,
+          originalCallerAddress,
         } as IExecuteTransactionEventPayload);
       }
     }
@@ -770,6 +764,7 @@ export class SDKClient {
    * @param {RequestDetails} requestDetails - The request details for logging and tracking.
    * @param {boolean} shouldThrowHbarLimit - Flag to indicate whether to check HBAR limits.
    * @param {string} originalCallerAddress - The address of the original caller making the request.
+   * @param {number} [estimatedTxFee] - The optioanl total estimated transaction fee.
    * @returns {Promise<void>} - A promise that resolves when the batch execution is complete.
    * @throws {SDKClientError} - Throws if an error occurs during batch transaction execution.
    */
@@ -780,18 +775,21 @@ export class SDKClient {
     requestDetails: RequestDetails,
     shouldThrowHbarLimit: boolean,
     originalCallerAddress: string,
+    estimatedTxFee?: number,
   ): Promise<void> {
     const txConstructorName = transaction.constructor.name;
     let transactionResponses: TransactionResponse[] | null = null;
 
     if (shouldThrowHbarLimit) {
-      const shouldLimit = this.hbarLimiter.shouldLimit(
-        Date.now(),
+      const shouldLimit = await this.hbarLimitService.shouldLimit(
         constants.EXECUTION_MODE.TRANSACTION,
         callerName,
+        txConstructorName,
         originalCallerAddress,
         requestDetails,
+        estimatedTxFee,
       );
+
       if (shouldLimit) {
         throw predefined.HBAR_RATE_LIMIT_EXCEEDED;
       }
@@ -822,6 +820,7 @@ export class SDKClient {
               txConstructorName,
               operatorAccountId: this.clientMain.operatorAccountId!.toString(),
               interactingEntity,
+              originalCallerAddress,
             } as IExecuteTransactionEventPayload);
           }
         }
@@ -837,6 +836,7 @@ export class SDKClient {
    * @param {string} callerName - The name of the caller creating the file.
    * @param {string} interactingEntity - The entity interacting with the transaction.
    * @param {string} originalCallerAddress - The address of the original caller making the request.
+   * @param {number} currentNetworkExchangeRateInCents - The current network exchange rate in cents per HBAR.
    * @returns {Promise<FileId | null>} A promise that resolves to the created file ID or null if the creation failed.
    * @throws Will throw an error if the created file is empty or if any transaction fails during execution.
    */
@@ -847,9 +847,29 @@ export class SDKClient {
     callerName: string,
     interactingEntity: string,
     originalCallerAddress: string,
+    currentNetworkExchangeRateInCents: number,
   ): Promise<FileId | null> {
     const hexedCallData = Buffer.from(callData).toString('hex');
 
+    const estimatedTxFee = Utils.estimateFileTransactionsFee(
+      hexedCallData.length,
+      this.fileAppendChunkSize,
+      currentNetworkExchangeRateInCents,
+    );
+
+    const shouldPreemptivelyLimit = await this.hbarLimitService.shouldLimit(
+      constants.EXECUTION_MODE.TRANSACTION,
+      callerName,
+      this.createFile.name,
+      originalCallerAddress,
+      requestDetails,
+      estimatedTxFee,
+    );
+
+    if (shouldPreemptivelyLimit) {
+      throw predefined.HBAR_RATE_LIMIT_EXCEEDED;
+    }
+
     const fileCreateTx = new FileCreateTransaction()
       .setContents(hexedCallData.substring(0, this.fileAppendChunkSize))
       .setKeys(client.operatorPublicKey ? [client.operatorPublicKey] : []);
@@ -859,7 +879,7 @@ export class SDKClient {
       callerName,
       interactingEntity,
       requestDetails,
-      true,
+      false,
       originalCallerAddress,
     );
 
@@ -877,7 +897,7 @@ export class SDKClient {
         callerName,
         interactingEntity,
         requestDetails,
-        true,
+        false,
         originalCallerAddress,
       );
     }
@@ -889,6 +909,7 @@ export class SDKClient {
         callerName,
         interactingEntity,
         requestDetails,
+        originalCallerAddress,
       );
 
       if (fileInfo.size.isZero()) {
@@ -942,6 +963,7 @@ export class SDKClient {
         callerName,
         interactingEntity,
         requestDetails,
+        originalCallerAddress,
       );
 
       if (fileInfo.isDeleted) {

diff --git a/packages/relay/src/lib/constants.ts b/packages/relay/src/lib/constants.ts
@@ -18,8 +18,12 @@
  *
  */
 
+import dotenv from 'dotenv';
+import findConfig from 'find-config';
 import { BigNumber } from 'bignumber.js';
 
+dotenv.config({ path: findConfig('.env') || '' });
+
 enum CACHE_KEY {
   ACCOUNT = 'account',
   ETH_BLOCK_NUMBER = 'eth_block_number',

diff --git a/packages/relay/src/lib/db/repositories/hbarLimiter/ethAddressHbarSpendingPlanRepository.ts b/packages/relay/src/lib/db/repositories/hbarLimiter/ethAddressHbarSpendingPlanRepository.ts
@@ -102,6 +102,21 @@ export class EthAddressHbarSpendingPlanRepository {
     }
   }
 
+  /**
+   * Deletes all spending plans associted with EVM addresses from cache.
+   *
+   * @param {RequestDetails} requestDetails - The request details for logging and tracking.
+   * @returns {Promise<void>} - A promise that resolves when all IP address spending plans are deleted.
+   */
+  async deleteAll(requestDetails: RequestDetails): Promise<void> {
+    const key = this.getKey('*');
+    const keys = await this.cache.keys(key, this.deleteAll.name, requestDetails);
+    for (const key of keys) {
+      await this.cache.delete(key, this.deleteAll.name, requestDetails);
+    }
+    this.logger.trace(`${requestDetails.formattedRequestId} Deleted all EVM address spending plans`);
+  }
+
   /**
    * Finds an {@link EthAddressHbarSpendingPlan} for an ETH address.
    *

diff --git a/packages/relay/src/lib/db/repositories/hbarLimiter/ipAddressHbarSpendingPlanRepository.ts b/packages/relay/src/lib/db/repositories/hbarLimiter/ipAddressHbarSpendingPlanRepository.ts
@@ -102,6 +102,21 @@ export class IPAddressHbarSpendingPlanRepository {
     }
   }
 
+  /**
+   * Deletes all spending plans associated with IP address from cache.
+   *
+   * @param {RequestDetails} requestDetails - The request details for logging and tracking.
+   * @returns {Promise<void>} - A promise that resolves when all IP address spending plans are deleted.
+   */
+  async deleteAll(requestDetails: RequestDetails): Promise<void> {
+    const key = this.getKey('*');
+    const keys = await this.cache.keys(key, this.deleteAll.name, requestDetails);
+    for (const key of keys) {
+      await this.cache.delete(key, this.deleteAll.name, requestDetails);
+    }
+    this.logger.trace(`${requestDetails.formattedRequestId} Deleted all IP address spending plans`);
+  }
+
   /**
    * Finds an {@link IPAddressHbarSpendingPlan} for an IP address.
    *