-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
reformat readme and index, update links
- Loading branch information
Bnonni
committed
Jul 22, 2024
1 parent
a5eb433
commit fd0c83b
Showing
10 changed files
with
152 additions
and
45 deletions.
There are no files selected for viewing
10 changes: 5 additions & 5 deletions
10
.../protocols/dvcx/credential-applicant.json → ...n/protocols/dcx/credential-applicant.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 5 additions & 5 deletions
10
...n/protocols/dvcx/credential-exchange.json → ...wn/protocols/dcx/credential-exchange.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 5 additions & 5 deletions
10
...own/protocols/dvcx/credential-issuer.json → ...nown/protocols/dcx/credential-issuer.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,49 @@ | ||
| # formfree.github.io | ||
|
|
||
| Contains .well-known files for FormFree identity | ||
| - <a href="./.well-known/protocols/">protocols</a> | ||
| - <a href="./.well-known/protocols/dvcx/">dvcx protocols</a> | ||
| - <a href="./.well-known/protocols/dvcx/credential-issuer.json">dvcx credential-issuer protocol</a> | ||
| - <a href="./.well-known/protocols/dvcx/credential-applicant.json">dvcx credential-applicant protocol</a> | ||
| - <a href="./.well-known/protocols/dvcx/credential-exchange.json">dvcx credential-exchange protocol</a> | ||
| - <a href="./.well-known/schemas/">schemas</a> | ||
| - <a href="./.well-known/schemas/dvcx/">dvcx schemas</a> | ||
| - <a href="./.well-known/schemas/dvcx/application.json">dvcx application schema</a> | ||
| - <a href="./.well-known/schemas/dvcx/invoice.json">dvcx invoice schema</a> | ||
| - <a href="./.well-known/schemas/dvcx/manifest.json">dvcx manifest schema</a> | ||
| - <a href="./.well-known/schemas/dvcx/response.json">dvcx response schema</a> | ||
| # FormFree Protocols & Schemas | ||
|
|
||
| This repo contains .well-known files for FormFree Holdings Corporation | ||
|
|
||
| - [Protocols](/.well-known/protocols/) | ||
| - [Schemas](/.well-known/schemas/) | ||
| - [DCX](/.well-known/schemas/dcx/) | ||
|
|
||
| ## DCX | ||
|
|
||
| For more information about DCX, check out the following links | ||
|
|
||
| - [TBD54566975/incubation-dcx](https://github.com/TBD54566975/incubation-dcx) TBD incubation repo | ||
| - [@dcx-protocol/root](https://www.npmjs.com/package/@dcx-protocol/root) NPMJS Package | ||
|
|
||
| ### Protocols | ||
|
|
||
| These are DWN protocols for the issuer and applicant side of DCX, as well as the full exchange (both sides). | ||
| Protocols define the CRUD operations permitted by on the different DWN records defined in the [Schemas](#schemas) section below. | ||
| Credential Exchange Protocol is not implemented directly. It is implemented separately but is provided here for reference. | ||
|
|
||
| - [Credential Issuer Protocol](/.well-known/protocols/dcx/credential-issuer.json) | ||
| - [Credential Applicant Protocol](/.well-known/protocols/dcx/credential-applicant.json) | ||
| - [Credential Exchange Protocol](/.well-known/protocols/dcx/credential-exchange.json) | ||
|
|
||
| ### Schemas | ||
|
|
||
| - [Application Schema](/.well-known/schemas/dcx/application.json) | ||
| - Schema definition for application DWN records | ||
| - Submitted by DCX applicants to DCX issuer DWNs | ||
| - Includes the actual input credential proofs of credentials currently held by DCX applicants | ||
| - Used to request a new output credential from a DCX issuer | ||
|
|
||
| - [Manifest Schema](/.well-known/schemas/dcx/manifest.json) | ||
| - Schema definition for manifest DWN records | ||
| - Created by issuers in their own DWNs | ||
| - Conforms to the DIF spec for [credential manifests](https://github.com/TBD54566975/incubation-dcx?tab=readme-ov-file#credential-manifest) | ||
| - Defines the input credentials required to obtain an output credential and the type of output credential | ||
| - Read by applicants and used to know what credentials they need to acquire before requesting an output credential from a DCX issuer | ||
|
|
||
| - [Response Schema](/.well-known/schemas/dcx/response.json) | ||
| - Schema definition for response DWN records; | ||
| - Created by DCX issuers in response to an application record | ||
| - Contains either an approval + output VC or a denial + reasoning | ||
|
|
||
| - [Invoice Schema](/.well-known/schemas/dcx/invoice.json) | ||
| - Optional Schema definition for invoice DWN records | ||
| - Created by DCX issuers and sent to DCX applicant DWNs | ||
| - Currently unimplemented in the DCX npm package |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters