Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Announce that this repo has moved and link it's new location #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
132 changes: 0 additions & 132 deletions .gitignore

This file was deleted.

45 changes: 2 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,3 @@
# kcc-proto-exemplar
# This repository has moved

This is a simple implementation to illustrate the [known-customer-credential](https://github.com/TBD54566975/known-customer-credential) specification in code form.

# Guide

## 0. Setup & create `did:dht`'s for `issuer/` and `wallet/`

```shell
(cd idv-vendor; npm i);
(cd issuer; npm i; node 0-create-did-dht.js);
(cd wallet; npm i; node 0-create-did-dht.js);
```

## 1. Start servers for `issuer/` & `idv-vendor/`

```shell
cd idv-vendor; node server.js
```

And then in a different shell (or feel free to manage background processes)

```shell
cd issuer; node server.js
```

## 2. Execute `wallet/` scripts to orchestrate KCC flow

The scripts in this stage are provided to illustrate the sequential ordering of the KCC flow, and in practice roughly follow a GUI UX.

```shell
(cd wallet; ./full-flow.sh)
```

You can also step through each call in the sequence one-by-one (view `wallet/full-flow.sh` for more info).

# Notes

- The `KnownCustomerCredential` format is dummy, not the actual VC
- The IDV Vendor's form may be an iframe within an HTML resource hosted by the issuer
- We don't support `vp_token` here
- We aren't currently performing any nonce verfication within the issuer
- We use `@web5/credentials` for our JWT signing & verification, but any JWT solution will suffice
- Known issue (non-conformant with the kcc spec) with respect to JWS `typ` header in the `access_token` and the `proof.jwt`
The code that used to live here now lives in our [TBD Examples repo](https://github.com/TBD54566975/tbd-examples/tree/main/javascript/kcc-prototype-exemplar).
Loading