Class AggregateMessageClient

constructor

• new AggregateMessageClient(apiServer?: string): AggregateMessageClient

  Parameters

  • apiServer: string = DEFAULT_API_V2

  Returns AggregateMessageClient

apiServer

get

• get<T = any>(
      configuration: AggregateGetConfiguration,
  ): Promise<Record<string, T>>

  Retrieves an aggregate message on from the Aleph network. It uses the address & key(s) provided in the configuration given as a parameter to retrieve the wanted message.

  Type Parameters

  • T = any

  Parameters

  • configuration: AggregateGetConfiguration

    The configuration used to get the message, including the API endpoint.

  Returns Promise<Record<string, T>>

getAggregates

• getAggregates(config?: GetAggregatesConfiguration): Promise<PaginatedAggregates>

  Retrieves a paginated list of aggregates across addresses.

  Parameters

  • config: GetAggregatesConfiguration = {}

    Optional key/address filters, sorting and pagination.

  Returns Promise<PaginatedAggregates>

send

• send<T>(
      __namedParameters: AggregatePublishConfiguration<T>,
  ): Promise<AggregateMessage<T>>

  Publishes an aggregate message to the Aleph network.

  The message's content must respect the following format : { k_1: v_1, k_2: v_2, }

  Type Parameters

  • T

  Parameters

  • __namedParameters: AggregatePublishConfiguration<T>

  Returns Promise<AggregateMessage<T>>