From 07e0218fed86fc18f63fbea74dd05643b8bd4700 Mon Sep 17 00:00:00 2001
From: Maddiaa0 <47148561+Maddiaa0@users.noreply.github.com>
Date: Wed, 23 Oct 2024 07:34:08 +0000
Subject: [PATCH] fix: add doc comment

---
 yarn-project/aztec.js/src/utils/cheat_codes.ts | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/yarn-project/aztec.js/src/utils/cheat_codes.ts b/yarn-project/aztec.js/src/utils/cheat_codes.ts
index bbf6e7922b7..8a89c790aa6 100644
--- a/yarn-project/aztec.js/src/utils/cheat_codes.ts
+++ b/yarn-project/aztec.js/src/utils/cheat_codes.ts
@@ -319,7 +319,16 @@ export class RollupCheatCodes {
     return await this.rollup.read.getEpochAtSlot([slotNumber]);
   }
 
-  public async getTips(): Promise<{ pending: bigint; proven: bigint }> {
+  /**
+   * Returns the pending and proven chain tips
+   * @returns The pending and proven chain tips
+   */
+  public async getTips(): Promise<{
+    /** The pending chain tip */
+    pending: bigint;
+    /** The proven chain tip */
+    proven: bigint;
+  }> {
     const [pending, proven] = await this.rollup.read.tips();
     return { pending, proven };
   }