-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmod.ts
23 lines (20 loc) · 1.45 KB
/
mod.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/**
* A capability system for use with the Willow General Purpose Sync Protocol, conformant with the [Meadowcap specification](https://willowprotocol.org/specs/meadowcap).
*
* In Willow, a **namespace** is a self-contained data space with three dimensions: time, path, and subspace. Data entries correspond to points within this three dimensional space.
*
* This capability system enforces boundaries on who gets to read and write what data in a Willow namespace. Read or write access can be bestowed, delegated to others, or further restricted within a given three dimensional product.
*
* Willow namespaces can be communal or owned, and the subspace or namespace signature scheme will be used for signing and verifying, respectively.
*
* This system is meant to be used in tandem with Willow, and **must** be configured to use many of the same parameters (e.g. namespace signature scheme, payload digest encoder) as its parent Willow instance.
* These parameters can be provided via a `MeadowcapParams` object to construct a `Meadowcap` instance, which will then give you access to lots of useful methods and hopefully not have to think about those parameters anymore.
*
* @module
*/
export * from "./src/meadowcap/types.ts";
export * from "./src/meadowcap/meadowcap.ts";
export * from "./src/capabilities/types.ts";
export * from "./src/capabilities/encoding.ts";
export * from "./src/capabilities/semantics.ts";
export * from "./src/capabilities/validity.ts";