Interface BlockAndPrivateDataEventsRequest

Delivers block and private data events.

interface BlockAndPrivateDataEventsRequest {
    getBytes(): Uint8Array<ArrayBufferLike>;
    getDigest(): Uint8Array<ArrayBufferLike>;
    getEvents(
        options?: CallOptions,
    ): Promise<CloseableAsyncIterable<BlockAndPrivateData>>;
}

Hierarchy (View Summary)

  • Signable
    • BlockAndPrivateDataEventsRequest

Methods

getBytes getDigest getEvents

Methods

getBytes

  • getBytes(): Uint8Array<ArrayBufferLike>

  • Get the serialized bytes of the signable object. Serialized bytes can be used to recreate the object using methods on Gateway.

    Returns Uint8Array<ArrayBufferLike>

getDigest

  • getDigest(): Uint8Array<ArrayBufferLike>

  • Get the digest of the signable object. This is used to generate a digital signature.

    Returns Uint8Array<ArrayBufferLike>

getEvents

  • getEvents(
        options?: CallOptions,
    ): Promise<CloseableAsyncIterable<BlockAndPrivateData>>

  • Get block and private data events.

    Parameters

    Returns Promise<CloseableAsyncIterable<BlockAndPrivateData>>

    Block and private data protocol buffer messages. The iterator should be closed after use to complete the eventing session.

    Throws

    GatewayError Thrown by the iterator if the gRPC service invocation fails.

    Example

    const events = await network.getBlockAndPrivateEventsData();
    try {
        for await (const event of events) {
            // Process block and private data event
        }
    } finally {
        events.close();
    }

Settings

Member Visibility

On This Page

Methods