Skip to content

Commit

Permalink
Add some schema information and development status
Browse files Browse the repository at this point in the history
  • Loading branch information
sondreb committed Apr 6, 2021
1 parent 6f75bf5 commit 9243b27
Show file tree
Hide file tree
Showing 2 changed files with 97 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

Library that helps working with DIDs (decentralized identities) on Blockcore and resolve DID Document from the "did:is" DID Method.

## Development and Status

The current implementation supports JWT VCs and can decode the JWT VSs into an JSON structure that is similar to JSON-LD, but is not compliant with the standard ("proof" element of it).

The next goal is to implement Linked Data Signature / JSON-LD, making the VCs more easily indexed / searchable and human readable.

https://github.com/w3c-ccg/lds-jws2020

Support for JWT VCs will likely be removed from this library in the future and should not be used.

## Building and Testing

The library can be built using TypeScript Compiler, either directly or through npm:
Expand Down
87 changes: 87 additions & 0 deletions schemas/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Schemas

https://github.com/w3c-ccg/vc-json-schemas

Some known schemas from specifications:

- "DomainLinkageCredential"

```json
"credentialSubject": {
"id": "did:key:z6MkoTHsgNNrby8JzCNQ1iRLyW5QQ6R8Xuu6AA8igGrMVPUM",
"origin": "https://identity.foundation"
}
```

- "NameCredential"
- "UniversityDegreeCredential"

```json
"credentialSubject": {
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"degree": {
"type": "BachelorDegree",
"name": "Bachelor of Science and Arts"
}
```

- "RelationshipCredential"

```json
"credentialSubject": [{
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"name": "Jayden Doe",
"spouse": "did:example:c276e12ec21ebfeb1f712ebc6f1"
}, {
"id": "did:example:c276e12ec21ebfeb1f712ebc6f1",
"name": "Morgan Doe",
"spouse": "did:example:ebfeb1f712ebc6f1c276e12ec21"
}]
```

```json
"credentialSubject": {
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"parent": {
"id": "did:example:ebfeb1c276e12ec211f712ebc6f",
"type": "Mother"
}
```

```json
"credentialSubject": {
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"ageUnder": 16,
"parent": {
"id": "did:example:ebfeb1c276e12ec211f712ebc6f",
"type": "Mother"
}
```

- "PrescriptionCredential"

```json
"credentialSubject": {
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"prescription": {....}
}
```

- "NameAndAddress"

```json
"credentialSubject": {
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"name": "Mr John Doe",
"address": "10 Some Street, Anytown, ThisLocal, Country X"
}
```



# DID Method / Controller / Vault API

CRUD

"revokeKey"

0 comments on commit 9243b27

Please sign in to comment.