feat: added getRemainingBudget() getter

Signed-off-by: Logan Nguyen <logan.nguyen@swirldslabs.com>

packages/relay/src/lib/services/hbarLimitService/index.ts

@@ -251,6 +251,16 @@ export class HbarLimitService implements IHbarLimitService {
     );
   }
 
+  /**
+   * Retrieves the remaining budget.
+   *
+   * @public
+   * @returns {number} The remaining budget value.
+   */
+  public getRemainingBudget(): number {
+    return this.remainingBudget;
+  }
+
   /**
    * Checks if the total daily budget has been exceeded.
    * @param {string} mode - The mode of the transaction or request.

packages/relay/tests/lib/services/hbarLimitService/hbarLimitService.spec.ts

@@ -46,6 +46,7 @@ describe('HbarLimitService', function () {
   const register = new Registry();
   const totalBudget = 100_000;
   const mode = constants.EXECUTION_MODE.TRANSACTION;
+  const mockTxCost = 100;
   const methodName = 'testMethod';
   const mockEthAddress = '0x123';
   const mockIpAddress = 'x.x.x';
@@ -668,6 +669,17 @@ describe('HbarLimitService', function () {
     });
   });
 
+  describe('getRemainingBudget', () => {
+    it('Should correctly get the remaining budget', async () => {
+      const originalRemainingBudget = hbarLimitService.getRemainingBudget();
+      expect(originalRemainingBudget).to.eq(totalBudget);
+
+      await hbarLimitService.addExpense(mockTxCost);
+      const updatedRemainingBudget = hbarLimitService.getRemainingBudget();
+      expect(updatedRemainingBudget).to.eq(totalBudget - mockTxCost);
+    });
+  });
+
   describe('isDailyBudgetExceeded', function () {
     const testIsDailyBudgetExceeded = async (remainingBudget: number, expected: boolean) => {
       // @ts-ignore