Class Task<Spec, Measurement>

constructor

• new Task<
      Spec extends KnownVdafSpec,
      Measurement extends number | bigint | boolean | number[],
  >(
      parameters: ClientParameters & Spec,
  ): Task<Spec, Measurement>

• Builds a new Task from the ClientParameters provided.

  Type Parameters

  • Spec extends KnownVdafSpec
  • Measurement extends number | bigint | boolean | number[]

  Parameters

  • parameters: ClientParameters & Spec

  Returns Task<Spec, Measurement>

Static ReadonlyprotocolVersion

fetchKeyConfiguration

• fetchKeyConfiguration(): Promise<void>

• Fetches hpke configuration from the configured aggregators over the network. This will make one http/https request for each aggregator (leader and helper).

  Returns Promise<void>

  Throws

  DAPError if any response is not Ok.

generateReport

• generateReport(
      measurement: Measurement,
      options?: ReportOptions,
  ): Promise<Report>

• Produce a Report from the supplied Measurement

  This may make network requests to fetch key configuration from the leader and helper, if needed.

  Parameters

  • measurement: Measurement

    The type of this argument will be determined by the Vdaf that this task is constructed for.
  • Optionaloptions: ReportOptions

  Returns Promise<Report>

  Throws

  Error if there is any issue in generating the report

invalidateHpkeConfig

• invalidateHpkeConfig(): void

• Returns void

sendMeasurement

• sendMeasurement(
      measurement: Measurement,
      options?: ReportOptions,
  ): Promise<void>

• A convenience function to fetch the key configuration (if needed), generate a report from the provided measurement and send that report to the leader aggregator.

  This will call Task.generateReport and Task.sendReport, while automatically handling any errors due to server key rotation with re-encryption and a retry.

  Parameters

  • measurement: Measurement
  • Optionaloptions: ReportOptions

  Returns Promise<void>

  Throws

  DAPError if any http response is not Ok or Error if there is an issue generating the report

sendReport

• sendReport(report: Report): Promise<void>

• Sends a pregenerated Report to the leader aggregator.

  Parameters

  • report: Report

    The Report to send.

  Returns Promise<void>

  Throws

  DAPError if the response is not Ok.