From 3f478a1a9181dc49d82674b1ab58184d8faa1b21 Mon Sep 17 00:00:00 2001 From: Alex Gherghisan Date: Fri, 1 Dec 2023 16:12:15 +0000 Subject: [PATCH] chore: update param docs --- .../src/synchronizer/server_world_state_synchronizer.ts | 2 +- .../world-state/src/synchronizer/world_state_synchronizer.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/yarn-project/world-state/src/synchronizer/server_world_state_synchronizer.ts b/yarn-project/world-state/src/synchronizer/server_world_state_synchronizer.ts index 07e641fcb18..8c07bed87c4 100644 --- a/yarn-project/world-state/src/synchronizer/server_world_state_synchronizer.ts +++ b/yarn-project/world-state/src/synchronizer/server_world_state_synchronizer.ts @@ -135,7 +135,7 @@ export class ServerWorldStateSynchronizer implements WorldStateSynchronizer { /** * Forces an immediate sync * @param minBlockNumber - The minimum block number that we must sync to - * @returns A promise that resolves to the blockNumber the world state has synced to + * @returns A promise that resolves with the block number the world state was synced to */ public async syncImmediate(minBlockNumber?: number): Promise { if (this.currentState !== WorldStateRunningState.RUNNING) { diff --git a/yarn-project/world-state/src/synchronizer/world_state_synchronizer.ts b/yarn-project/world-state/src/synchronizer/world_state_synchronizer.ts index fde191b4621..96e6885101a 100644 --- a/yarn-project/world-state/src/synchronizer/world_state_synchronizer.ts +++ b/yarn-project/world-state/src/synchronizer/world_state_synchronizer.ts @@ -48,7 +48,7 @@ export interface WorldStateSynchronizer { /** * Forces an immediate sync to an optionally provided minimum block number * @param minBlockNumber - The minimum block number that we must sync to - * @returns A promise that resolves once the sync has completed. + * @returns A promise that resolves with the block number the world state was synced to */ syncImmediate(minBlockNumber?: number): Promise;