Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update list of implementations #92

Merged
merged 2 commits into from
Aug 13, 2024
Merged

docs: update list of implementations #92

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50d54ed
docs: update list of implementations
kentbull Jul 23, 2024
76143f6
refactor: use reference links and add licensing info
kentbull Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 49 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ We have a community Discord server and we'd love to see you there!
[https://discord.gg/YEyTH5TfuB](https://discord.gg/YEyTH5TfuB)

### Associated Specifications
The table below lists all deliverables of the KERI Community:
The table below lists all current deliverables of the KERI Community in the Trust over IP (ToIP) organization:

| Acronym | Full Name of Deliverable | Link to Deliverable | Lead Authors | Status / Notes |
|---|---|---|---|---|
Expand All @@ -19,15 +19,16 @@ The table below lists all deliverables of the KERI Community:
The work at DIF has been archived and any perceived IPR issues resolved.
https://github.com/decentralized-identity/keri

###### IETF drafts
###### IETF draft specifications
For a time the KERI specifications were IETF draft specifications subsequent to the DIF work. The following links reference the IETF draft specifications.

https://weboftrust.github.io/ietf-keri/draft-ssmith-keri.html
https://weboftrust.github.io/ietf-acdc/draft-ssmith-acdc.html
https://weboftrust.github.io/ietf-cesr/draft-ssmith-cesr.html


### Policy
The specfications are governed by the Technical Stack Working Group charter at ToIP
The specifications are governed by the Technical Stack Working Group charter at ToIP.

## Meetings

Expand All @@ -52,17 +53,55 @@ Passcode: 379242

### Education

Community members have an education/documentation effort in progress here [edu](https://keriworld.slack.com/archives/C03RB6ASVUM)'. The repo for the Web of Trust terminology and glossaries is [here](https://github.com/WebOfTrust/WOT-terms).
Community members have an education/documentation effort in progress here [edu][KERISSE_URL]'. The repo for the Web of Trust terminology and glossaries is [here][WOT_TERMS_REPO].

Technical meetings on [KERISSE](kerisse.org) take place twice a week. Drop us a line if you're considering participation by creating an issue [here](https://github.com/WebOfTrust/WOT-terms/issues).
The repo for the Web of Trust terminology and glossaries is [here](https://github.com/WebOfTrust/WOT-terms).
Technical meetings on [KERISSE][KERISSE_URL] take place twice a week. Drop us a line if you're considering participation by creating an issue [here](https://github.com/WebOfTrust/WOT-terms/issues).
The repo for the Web of Trust terminology and glossaries is [here][WOT_TERMS_REPO].

## Existing Implementations
The reference implementation for KERI is the keripy implementation. This is hosted here by the WebOfTrust project. The repository may be found here:
* [keripy](https://github.com/WebOfTrust/keripy) – under development

The keripy implementation is Apache-2.0 licensed as are all repositories in the WebOfTrust project.
The reference implementation for KERI is the [KERIpy][KERIPY_REPO] (Python) implementation. This is hosted here by the WebOfTrust project. The [KERIpy][KERIPY_REPO] implementation is Apache-2.0 licensed as are all repositories in the WebOfTrust project.

See the below table for where the reference implementation, and others, are located.

| Component | Name | Language | License | Creators / Maintainers | Status | Recent Version | Spec Compliance |
| ----------------------- | -----------------------------| ---------- | ----------------------- |------------------------------- | ----------------------------- | ---------------------| ------------------------------ |
| KERI core & CESR | [keripy][KERIPY_REPO] | Python | [Apache 2.0][APACHE2.0] | WebOfTrust community | Stable Release, Maintained | [1.1.17][KERIPY_VS] | KERI, ACDC, CESR 1.0, 2.0 100% |
| Agent Infrastructure | [keria][KERIA_REPO] | Python | [Apache 2.0][APACHE2.0] | WebOfTrust community | Early Release, Maintained | [0.1.3][KERIA_VS] | N/A - no KERIA spec |
| Edge Agent Library | [signify-ts][SIG_TS_REPO] | Typescript | [Apache 2.0][APACHE2.0] | WebOfTrust community | Early Release, Maintained | [0.1.0][SIG_TS_VS] | N/A - no Signify spec |
| Edge Agent Library | [signify-py][SIG_PY_REPO] | Python | [Apache 2.0][APACHE2.0] | WebOfTrust community | Early Release, Maintained | [0.2.1][SIG_PY_VS] | N/A - no Signify spec |
| CESR Library | [cesride][CESRIDE_REPO] | Rust | [Apache 2.0][APACHE2.0] | WebOfTrust community | Release; inactive | [0.6.4][CESRIDE_VS] | CESR 1.0 90% |
| Trust Spanning Protocol | [tsp][TSP_REPO] | Rust | [Apache 2.0][APACHE2.0] | Wenjing Chu (ToIP), OpenWallet | Prototype | N/A | ? |
| KERI core | [keriox][KERIOX_REPO] | Rust | [EUPL 1.2][EUPL1.2] | Human Colossus Foundation | Release + Active development | [0.11.0][KERIOX_VS] | KERI, ACDC 1.0 95%+ |
| CESR Library | [cesrox][CESROX_REPO] | Rust | [EUPL 1.2][EUPL1.2] | Human Colossus Foundation | Some development | [0.1.4][CESROX_VS] | CESR 1.0 100%, CESR 2.0 ? |
| CESR | [simple-cesr][SIM_CESR_REPO] | Typescript | [Apache 2.0][APACHE2.0] | Future Forge | Release + Active development | [0.2.3][SIM_CESR_VS] | CESR 1.0 ? |
| KERI core | [kerigo][KERIGO_REPO] | Go | [Apache 2.0][APACHE2.0] | DIF community members | Little development | N/A | KERI, ACDC, CESR ? |

We also encourage the implementation of KERI in other languages. We are happy to host other implementations here
in the WebOfTrust project as long as they are Apache-2.0 licensed.

<!-- Reference links -->

[KERISSE_URL]: https://weboftrust.github.io/kerisse/
[WOT_TERMS_REPO]: https://github.com/WebOfTrust/WOT-terms
[APACHE2.0]: https://www.apache.org/licenses/LICENSE-2.0
[EUPL1.2]: https://github.com/THCLab/licensing?tab=readme-ov-file

[KERIPY_REPO]: https://github.com/WebOfTrust/keripy
[KERIA_REPO]: https://github.com/WebOfTrust/keria
[SIG_TS_REPO]: https://github.com/WebOfTrust/signify-ts
[SIG_PY_REPO]: https://github.com/WebOfTrust/signifypy
[CESRIDE_REPO]: https://github.com/WebOfTrust/cesride
[TSP_REPO]: https://github.com/openwallet-foundation-labs/tsp
[KERIOX_REPO]: https://github.com/THCLab/keriox
[CESROX_REPO]: https://github.com/THCLab/cesrox
[SIM_CESR_REPO]: https://github.com/simple-ssi/simple-cesr
[KERIGO_REPO]: https://github.com/decentralized-identity/kerigo

[KERIPY_VS]: https://pypi.org/project/keri/1.1.17/
[KERIA_VS]: https://pypi.org/project/keria/0.1.3/
[SIG_TS_VS]: https://pypi.org/project/signifypy/0.1.0/
[SIG_PY_VS]: https://www.npmjs.com/package/signify-ts/v/0.2.1
[CESRIDE_VS]: https://crates.io/crates/cesride/0.6.4
[KERIOX_VS]: https://crates.io/crates/keri-core/0.11.0
[CESROX_VS]: https://crates.io/crates/cesrox/0.1.4
[SIM_CESR_VS]: https://www.npmjs.com/package/@simple-ssi/simple-cesr/v/0.2.3