vc-engine
v0.1.7
Published
VC SDK - Verifiable Credential SDK with embedded SSI service lifecycle management
Maintainers
Readme
@beclab/vc-engine
vc-engine is a minimal SDK for VC (Verifiable Credential) workflows.
It embeds ssi-service inside a Node.js application, so developers do not need to deploy a separate SSI service to:
- register VC schemas
- apply for VCs
- issue VCs
- create VPs
- verify VPs
Background
VC / DID are basic building blocks for decentralized identity:
- W3C DID Core: defines what a DID is
- W3C Verifiable Credentials: defines the VC / VP data model
- DIF: provides interaction specifications such as Credential Manifest and Presentation Exchange
In short:
- DID is an identity identifier
- VC is a trusted claim issued to a holder
- VP is a package of one or more VCs presented to a verifier
Roles and Scenarios
Issuer
Defines credential types and issues VCs to users.
Examples: a school issues a degree credential, a company issues an employee credential, Olares issues a domain ownership credential.
Holder
Applies for, stores, and presents VCs.
Example: a user receives a domain VC and later creates a VP to prove domain ownership.
Verifier
Defines verification requirements and checks whether the VP submitted by a Holder is trustworthy.
Example: an application asks the user to prove ownership of an Olares ID or domain.
Installation
npm install @beclab/vc-engineThe install script downloads the ssi-service binary automatically.
Minimal Example
import { VcEngine } from '@beclab/vc-engine';
const engine = await VcEngine.create();
const schemas = await engine.core.registry.listSchemas();
console.log(schemas);
await engine.stop();For more SDK usage, see docs/sdk-api.md.
