@pcd/pod-pcd

A PCD representating an object in the POD (Provable Object Data) format, allowing it to be manipulated by generic apps like Zupass. For a full introduction, see the Developer Site.

POD libraries enable any app to create zero-knowledge proofs of cryptographic data. A POD could represent your ticket to an event, a secure message, a collectible badge, or an item in a role-playing game. Using PODs, developers can create ZK-enabled apps without the effort and risk of developing custom cryptography.

ZK proofs about PODs use General Purpose Circuits (GPC) which can prove many different things about PODs without revealing all details. GPCs use human-readable configuration and pre-compiled circuits so no knowledge of circuit programming is required.

See the PODPCD class for more details on the data of a POD PCD.

Related Packages

• For information about making POD objects, see the @pcd/pod package.

• For information about making proofs about PODs in Zupass, see the @pcd/gpc-pcd package.

Package Installation

This package will work either in browser or in a Node.js server. Packaging for a browser requires polyfill for some Node modules, including buffer.

Stability and Security

POD and GPC libraries are in beta and subject to change. We encourage devs to try them out and use them for apps, but be aware that updates will come in future.

The PODs themselves are persistent data, and we expect to maintain backward-compatibility when we make changes to the format. Library interfaces may also change. Any breaking changes will be reflected in the NPM versions using standard semantic versioning.