@divviup/common
v0.2.2
Published
[![Coverage Status](https://coveralls.io/repos/github/divviup/divviup-ts/badge.svg?branch=main)](https://coveralls.io/github/divviup/divviup-ts?branch=main) [![CI](https://github.com/divviup/divviup-ts/actions/workflows/ci.yaml/badge.svg)](https://github.
Downloads
78
Readme
DivviUp Typescript Client
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.
DAP
| Package version | Git branch | Protocol version | Conforms to specification? | Status |
| ----------------------------------- | ----------------------------------- | --------------------------------- | -------------------------- | ------------------------------- |
| N/A | release-dap-draft-02
| draft-ietf-ppm-dap-02
| Yes | Unmaintained |
| N/A | release-dap-draft-03
| draft-ietf-ppm-dap-03
| Yes | Unmaintained as of May 22, 2023 |
| @divviup/[email protected]
| release-dap-draft-04
| draft-ietf-ppm-dap-04
| Yes | Supported |
| @divviup/[email protected]
| release-dap-draft-07
| draft-ietf-ppm-dap-07
| Yes | Supported |
| @divviup/[email protected]
| main
| draft-ietf-ppm-dap-09
| Yes | Supported |
VDAF and Prio3
| VDAF Package | Prio3 Package | Git branch | Protocol version | Conforms to specification? | Status |
| ------------------------------------- | --------------------------------------- | ----------------------------------- | ------------------------------------ | -------------------------- | ------------------------------- |
| N/A | N/A | release/dap-draft-03
| draft-irtf-cfrg-vdaf-03
| Yes | Unmaintained as of May 22, 2023 |
| @divviup/[email protected]
| @divviup/[email protected]
| release/dap-draft-04
| draft-irtf-cfrg-vdaf-05
| Yes | Supported |
| @divviup/[email protected]
| @divviup/[email protected]
| release/dap-draft-07
| draft-irtf-cfrg-vdaf-07
| Yes | Supported |
| @divviup/[email protected]
| @divviup/[email protected]
| main
| draft-irtf-cfrg-vdaf-08
| Yes | Supported |
Bundling into an npm application
$ npm add @divviup/dap
import Task from "@divviup/dap";
const task = new Task({
type: "sum",
bits: 8,
id: "3XTBHxTtUAtI516GeXZsVIKjBPYVNIYmF94vEBb4jcY",
leader: "https://dap.api.divviup.org",
helper: "https://dap.example.com",
timePrecisionSeconds: 3600,
});
await task.sendMeasurement(42);
CDN URLs
DivviUp publishes bundled and minified builds suitable for use from a script tag. Task
will be available on globalThis as divviup.dap.Task
.
JsDelivr
<script
src="https://cdn.jsdelivr.net/npm/@divviup/[email protected]/dist/browser.js"
crossorigin="anonymous"
integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>
UNPKG
<script
src="https://unpkg.com/@divviup/[email protected]/dist/browser.js"
crossorigin="anonymous"
integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>