Skip to content

TypeScript client for the Distributed Aggregation Protocol

License

Notifications You must be signed in to change notification settings

divviup/divviup-ts

Repository files navigation

DivviUp Typescript Client

Coverage Status CI

docs for main

Protocol Versions and Release Branches

The main branch is under continuous development and will usually be partway between DAP and VDAF drafts. divviup-ts uses stable release branches to maintain implementations of different draft versions. Artifacts for some draft version are published from a corresponding release/dap-draft-xy branch. Only supported release branches receive dependency updates and backports.

Git branch Draft version Conforms to specification? Status
release/dap-draft-02 draft-ietf-ppm-dap-02 Yes Unmaintained
release/dap-draft-03 draft-ietf-ppm-dap-03 Yes Unmaintained as of May 22, 2023
release/dap-draft-04 draft-ietf-ppm-dap-04 Yes Supported
main draft-ietf-ppm-dap-07 Partially Supported

Usage

import Task from "@divviup/dap";

const task = new Task({
  type: "sum",
  bits: 8,
  id: "3XTBHxTtUAtI516GeXZsVIKjBPYVNIYmF94vEBb4jcY",
  leader: "http://localhost:8080",
  helper: "http://localhost:8081",
  timePrecisionSeconds: 3600,
});

await task.sendMeasurement(42);