Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dcx-protocol/root) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Decentralized Credential Exchange (DCX)

DCX is a new Decentralized Web Nodes (DWN) protocol that facilitates the decentralized exchange of borrower data for lender money seurely and privately and a npm package that implements the protocol as a one-click server solution.

As an open, permissionless, "credentials in, credentials out" asynchronous web server, DCX leverages the strongest Web5 primitives: DWNs, Verifiable Credentials (VCs), Credential Manifests, Verifiable Presentations and Presentation Exchange amongst other important Web5 primitives. DCX facilitates decentralized credential exchange by performing CRUD operations on both applicant and issuer DWNs. Different DWN record schemas represent various messages sent between actors, detailing the VCs required as inputs and outputs for the DCX server.

Applicant

/packages/applicant/src/protocol.ts credential applicant protocol definition
/packages/applicant/src/handlers.ts pre-defined credential applicant protocol handlers
/packages/applicant/src/server.ts pre-built server to run credential issuer side (TODO: applicant server code)

Common code shared between the issuer and applicant

/packages/common/src/schemas/manifest.ts DWN manifest record schema definition
/packages/common/src/schemas/application.ts DWN application record schema definition
/packages/common/src/schemas/response.ts DWN response record schema definition
/packages/common/src/schemas/invoice.ts DWN invoice record schema definition

Issuer

/packages/issuer/src/protocol.ts credential issuer protocol definition
/packages/issuer/src/handlers.ts pre-defined credential issuer protocol handlers
/packages/issuer/src/server.ts pre-built server to run credential issuer side

To learn more about the components of DCX, check out /docs/learn/README.md.

To learn more about the architecture and sequences of DCX, check out /docs/diagrams/README.md.

To learn how to use DCX, check out /docs/usage/README.md.

Package Versions

package	npm	issues
@dcx-protocol/root
@dcx-protocol/applicant
@dcx-protocol/common
@dcx-protocol/issuer

Project Resources

Resource	Description
CODEOWNERS	Outlines the project lead(s)
CODE_OF_CONDUCT.md	Expected behavior for project contributors, promoting a welcoming environment
CONTRIBUTING.md	Developer guide to build, test, run, access CI, chat, discuss, file issues
GOVERNANCE.md	Project governance
LICENSE