diff --git a/README.md b/README.md index 54c0df3..65dfc37 100644 --- a/README.md +++ b/README.md @@ -9,30 +9,7 @@ [![CI](https://github.com/energywebfoundation/ssi/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/energywebfoundation/ssi/actions/workflows/main.yml) ## Introduction -This repository provides *sample* Self-Sovereign-Identity (SSI) wallet components and libraries. -These are currently provided for demonstration and proof-of-concept purposes. -The functionality is mostly generic functionality based on cryptography and SSI standards, -however the intention is that it can be used to enable more specific energy industry use cases. - -These SSI wallet components are a part of the [Energy Web Decentralized Operating System](#ew-dos). -For more information about SSI at EWF, see the [EWF Gitbook page on SSI](https://energy-web-foundation.gitbook.io/energy-web/foundational-concepts/self-sovereign-identity). - -## 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) +This repository provides a VC API implementation. ### Apps #### VC-API @@ -54,29 +31,6 @@ const did = generateDID(key); // Code from ssi-did lib. Returns initial DID Docu #### KMS Interface -### Other apps/components - -### Switchboard - -[Switchboard](https://github.com/energywebfoundation/switchboard-dapp) can be used as a UI to initiate and continue a VC-API exchange. -It uses [iam-client-lib](#iam-client-lib) to accomplish this. - -### iam-client-lib -[iam-client-lib](https://github.com/energywebfoundation/iam-client-lib/) provides SSI related functions such as interaction with EWF's Switchboard role credential definitions, credential request and issuance and connection to the ssi-hub. -It can be used as a client library to this vc-api (for example, to start an exchange). - -### ssi-hub -[ssi-hub](https://github.com/energywebfoundation/ssi-hub)'s persistence of issued credentials, requested credentials and DID relationships could be integrated with the code in this repository. - -### ew-did-registry -[ew-did-registry](https://github.com/energywebfoundation/ew-did-registry) provides ssi related libraries written by Energy Web. -As such, there is currently some overlap between ew-did-registry libraries and the code in this repository. -For example: -- The DID creation code in the DID library could provided by ew-did-registry -- [ew-did-registry credential-interface](https://github.com/energywebfoundation/ew-did-registry/tree/development/packages/credentials-interface) provides interfaces with could be used within this repository - -The overlap was created due to the prototyping nature of this repository and will be reduced in the future. - ## Technology Decisions ### Rationale for Spruce DIDKit Spruce's DIDKit is used for DID generation and credential issuance & verification. @@ -128,28 +82,6 @@ See [contributing.md](./contributing.md) ## Questions and Support For questions and support please use the Github issues. -## EW-DOS -The Energy Web Decentralized Operating System is a blockchain-based, multi-layer digital infrastructure. - -The purpose of EW-DOS is to develop and deploy an open and decentralized digital operating system for the energy sector in support of a low-carbon, customer-centric energy future. - -We develop blockchain technology, full-stack applications and middleware packages that facilitate participation of Distributed Energy Resources on the grid and create open market places for transparent and efficient renewable energy trading. - -- To learn about more about the EW-DOS tech stack, see our [documentation](https://app.gitbook.com/@energy-web-foundation/s/energy-web/). - -- For an overview of the energy-sector challenges our use cases address, go [here](https://app.gitbook.com/@energy-web-foundation/s/energy-web/our-mission). - -For a deep-dive into the motivation and methodology behind our technical solutions, we encourage you to read our White Papers: - -- [Energy Web White Paper on Vision and Purpose](https://www.energyweb.org/reports/EWDOS-Vision-Purpose/) -- [Energy Web White Paper on Technology Detail](https://www.energyweb.org/wp-content/uploads/2020/06/EnergyWeb-EWDOS-PART2-TechnologyDetail-202006-vFinal.pdf) - - -## Connect with Energy Web -- [Twitter](https://twitter.com/energywebx) -- [Discord](https://discord.com/channels/706103009205288990/843970822254362664) -- [Telegram](https://t.me/energyweb) - ## License This project is licensed under the GNU General Public License v3.0 or later - see the [LICENSE](LICENSE) file for details diff --git a/architecture.md b/architecture.md deleted file mode 100644 index a0ea090..0000000 --- a/architecture.md +++ /dev/null @@ -1,2 +0,0 @@ -//This should mention EW-DOS dependents and dependencies -//Overview of modules/packages and how they interact (i.e. organization/application/role OR Traceability/Trade/Device Registry/Organizations) \ No newline at end of file diff --git a/ssi.c4container.png b/ssi.c4container.png deleted file mode 100644 index 9e28cac..0000000 Binary files a/ssi.c4container.png and /dev/null differ