Interface BlockRetrievalOptions<ProgressEvents>

interface BlockRetrievalOptions<ProgressEvents> {
    onProgress?: ((evt) => void);
    signal?: AbortSignal;
    validateFn?(block): Promise<void>;
}

Type Parameters

Hierarchy

Properties

onProgress? signal?

Methods

validateFn?

Properties

Optional onProgress

onProgress?: ((evt) => void)

Type declaration

Optional signal

signal?: AbortSignal

Methods

Optional validateFn

  • validateFn(block): Promise<void>

  • A function that blockBrokers should call prior to returning a block to ensure it can maintain control of the block request flow. e.g. TrustedGatewayBlockBroker will use this to ensure that the block is valid from one of the gateways before assuming it's work is done. If the block is not valid, it should try another gateway and WILL consider the gateway that returned the invalid blocks completely unreliable.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

onProgresssignalvalidateFn