Skip to content

Commit

Permalink
Merge pull request #195 from energywebfoundation/owf-migration-notice
Browse files Browse the repository at this point in the history
Update the README to reflect the VC API migration to OWF
  • Loading branch information
jrhender authored Sep 18, 2024
2 parents b0ac375 + f641de5 commit cb2fac5
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 17 deletions.
29 changes: 12 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Notice: OWF VC API Implementation Adoption

The VC API implementation initially developed in this repository has been adopted by the Open Wallet Foundation.
The implementation can now be found at the following repository: https://github.com/openwallet-foundation-labs/vc-api.

___

<p align="center">
<a href="https://www.energyweb.org" target="blank"><img src="./EW.png" width="120" alt="Energy Web Foundation Logo" /></a>
<a href="https://www.eliagroup.com/" target="blank"><img src="./EG.jpg" height="100" alt="Elia Group Logo" /></a>
Expand All @@ -19,24 +26,12 @@ For more information about SSI at EWF, see the [EWF Gitbook page on SSI](https:/

## Architecture

### Container Diagram

The following is a C4 Container diagram of the apps within this repository as well as related apps such as [Switchboard](#switchboard).
The diagram was generated used [EnergyWeb's IcePanel](https://s.icepanel.io/gODPIqAQio/-/-/q8qxi31rvqe/g5rxwbzt0c7/342.1/288.7/0.438).

Note that several of these apps (e.g. Switchboard, Web3 Wallet, SSI Wallet Client) are not in this repository.
They are shown on the diagram for context on how the apps in this repository can be used.
See the [other apps/components](#other-appscomponents) section for more details on some of these other apps.

The diagram shows that multiple apps (Switchboard, an Elia developed apps or other apps) could act as clients to [VC-API](#vc-api).
In addition, these same client app could work with other VC-API implementions.
This interoperability is made possible through conformance to the [VC-API specification](https://w3c-ccg.github.io/vc-api).

![c4 container diagram](./ssi.c4container.png)

### Apps
#### VC-API
The [vc-api app](./apps/vc-api) is a NestJs implementation of the [W3C Credentials Community Group](https://w3c-ccg.github.io/) [VC API Specification](https://w3c-ccg.github.io/vc-api).

#### Input-Descriptor-To-Credential App
This [input-descriptor-to-credential app](./) is a NestJs implementation of a complementary service to
the [vc-api app](https://github.com/openwallet-foundation-labs/vc-api).
It allows converting an input descriptor to a credential to be signed.

### Libraries
#### DID Library
Expand Down
Binary file removed ssi.c4container.png
Binary file not shown.

0 comments on commit cb2fac5

Please sign in to comment.