Interface ChaincodeEventsRequest

Delivers events emitted by transaction functions in a specific chaincode.

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

Hierarchy (View Summary)

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<ChaincodeEvent>>

  • Get chaincode events emitted by transaction functions of a specific chaincode.

    Parameters

    Returns Promise<CloseableAsyncIterable<ChaincodeEvent>>

    Chaincode events. 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 request.getEvents();
    try {
        for await (const event of events) {
            // Process event
        }
    } finally {
        events.close();
    }

Settings

Member Visibility

On This Page

Methods