Skip to content

Commit 07e0218

Browse files
committed
fix: add doc comment
1 parent dca5b35 commit 07e0218

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

yarn-project/aztec.js/src/utils/cheat_codes.ts

+10-1
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,16 @@ export class RollupCheatCodes {
319319
return await this.rollup.read.getEpochAtSlot([slotNumber]);
320320
}
321321

322-
public async getTips(): Promise<{ pending: bigint; proven: bigint }> {
322+
/**
323+
* Returns the pending and proven chain tips
324+
* @returns The pending and proven chain tips
325+
*/
326+
public async getTips(): Promise<{
327+
/** The pending chain tip */
328+
pending: bigint;
329+
/** The proven chain tip */
330+
proven: bigint;
331+
}> {
323332
const [pending, proven] = await this.rollup.read.tips();
324333
return { pending, proven };
325334
}

0 commit comments

Comments
 (0)