W3C VCDM CR 1

README.md

@@ -15,96 +15,30 @@
 
 🚧 Experimental implementation of Verifiable Credentials Data Model v2.0 🔥
 
-## Usage
-
-```sh
-npm i @transmute/verifiable-credentials@latest --save
-```
+- [CR-vc-data-model-2.0-20240201](https://www.w3.org/TR/2024/CR-vc-data-model-2.0-20240201/)
+- [WD-vc-jose-cose-20240126](https://www.w3.org/TR/2024/WD-vc-jose-cose-20240126/)
+- [WD-vc-bitstring-status-list-20240107](https://www.w3.org/TR/2024/WD-vc-bitstring-status-list-20240107/)
 
-```ts
-import transmute from '@transmute/verifiable-credentials'
-```
+- [CG-ED-traceability-vocab](https://w3c-ccg.github.io/traceability-vocab/)
 
-This library relies on [transmute-industries/vc-jwt-sd](https://github.com/transmute-industries/vc-jwt-sd) 
-to support the [Verifiable Credentials Data Model v2.0](https://www.w3.org/TR/vc-data-model-2.0/)
+## Usage
 
-### Issuance
+Requires node 18 or higher.
 
-```ts
-const alg = 'ES384'
-const nonce = 'nonce-123'
-const audience = 'audience-456'
-const issuerRole = await transmute.vc.sd.key.generate(alg)
-const holderRole = await transmute.vc.sd.key.generate(alg)
-const vc = await transmute.vc.sd.issuer({
-  kid: issuerRole.publicKeyJwk.kid,
-  secretKeyJwk: issuerRole.secretKeyJwk
-})
-.issue({
-  holder: holderRole.publicKeyJwk.kid, // jkt and jwk confirmation are both supported.
-  claimset: fs.readFileSync('test/vc-data-model-2.0/example1/issuance-claims.yaml').toString()
-})
+```sh
+nvm use 18
 ```
 
-### Presentation
-
-```ts
-const vp = await transmute.vc.sd.holder({
-  kid: holderRole.publicKeyJwk.kid,
-  secretKeyJwk: holderRole.secretKeyJwk
-})
-.issue({
-  token: vc,
-  nonce: nonce,
-  audience: audience,
-  disclosure: fs.readFileSync('test/vc-data-model-2.0/example1/disclosure-claims.yaml').toString()
-})
+```sh
+npm i @transmute/verifiable-credentials@latest --save
 ```
 
-### Verification
-
 ```ts
-const verification = await transmute.vc.sd.verifier({
-  resolver: {
-    resolve: async (kid: string) => {
-      if (kid === issuerRole.publicKeyJwk.kid) {
-        return issuerRole.publicKeyJwk
-      }
-      if (kid === holderRole.publicKeyJwk.kid) {
-        return holderRole.publicKeyJwk
-      }
-      throw new Error('Unsupported kid: ' + kid)
-    }
-  }
-})
-.verify({
-  token: vp,
-  audience,
-  nonce
-})
+import * as transmute from "@transmute/verifiable-credentials";
 ```
 
-
-
-### Validator
-
 ```ts
-const validator = await w3c.vc.validator({
-  issuer: async () => {
-    // this resolver must return parsed application/jwk+json
-    return publicKey
-  },
-  credentialSchema: async () => {
-    // this resolver MUST return parsed application/schema+json
-    return credentialSchema
-  },
-  credentialStatus: async () => {
-    // this resolver MUST return application/vc+ld+sd-jwt
-    return statusList
-  }
-})
-// validate after verify... 
-const validation = await validator.validate(verified)
+// todo...
 ```
 
 ## Develop
@@ -114,4 +48,4 @@ npm i
 npm t
 npm run lint
 npm run build
-```
+```