aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contracts/src/utils/increase_time.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/contracts/src/utils/increase_time.ts')
-rw-r--r--packages/contracts/src/utils/increase_time.ts9
1 files changed, 7 insertions, 2 deletions
diff --git a/packages/contracts/src/utils/increase_time.ts b/packages/contracts/src/utils/increase_time.ts
index 726a759f3..5336a180d 100644
--- a/packages/contracts/src/utils/increase_time.ts
+++ b/packages/contracts/src/utils/increase_time.ts
@@ -5,8 +5,13 @@ import { web3Wrapper } from './web3_wrapper';
let firstAccount: string | undefined;
-// increases time by the given number of seconds and then mines a block so that
-// the current block timestamp has the offset applied.
+/**
+ * Increases time by the given number of seconds and then mines a block so that
+ * the current block timestamp has the offset applied.
+ * @param seconds the Promise which is expected to reject
+ * @returns a new Promise which will resolve with the new total time offset or
+ * reject if the time could not be increased.
+ */
export async function increaseTimeAndMineBlockAsync(seconds: number): Promise<number> {
if (_.isUndefined(firstAccount)) {
const accounts = await web3Wrapper.getAvailableAddressesAsync();