fix: add doc comment

AztecProtocol · Oct 23, 2024 · 07e0218 · 07e0218
1 parent dca5b35
commit 07e0218
Showing 1 changed file with 10 additions and 1 deletion.
diff --git 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 };
   }