From 9f1213f1f04e0983f78f95c0f235f95f4c1fb29e Mon Sep 17 00:00:00 2001 From: Neal Date: Wed, 6 Dec 2023 19:03:33 -0600 Subject: [PATCH 1/5] add readme --- packages/credentials/README.md | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/packages/credentials/README.md b/packages/credentials/README.md index 54580c164..6cb374f86 100644 --- a/packages/credentials/README.md +++ b/packages/credentials/README.md @@ -41,27 +41,17 @@ const vc = new VerifiableCredential({ ### Signing a Verifiable Credential Sign a `VerifiableCredential` with a DID: -- `signOptions`: The sign options used to sign the credential. +- `did`: The did that is signing the VC -First create a SignOptions object as follows: +First create a Did object as follows: ```javascript -import { Ed25519, Jose } from '@web5/crypto'; import { DidKeyMethod } from '@web5/dids'; - const issuer = await DidKeyMethod.create(); -const privateKey = (await Jose.jwkToKey({ key: issuer.keySet.verificationMethodKeys![0].privateKeyJwk! })).keyMaterial; - -const signOptions = { - issuerDid: issuer.did, - subjectDid: "did:example:subject", - kid: `${issuer.did}#${issuer.did.split(':')[2]}`, - signer: async (data) => await Ed25519.sign({ data, key: privateKey }) -}; ``` -Then sign the VC using the signoptions object +Then sign the VC using the did object ```javascript -const vcJwt = vc.sign(signOptions) +const vcJwt = vc.sign({did:issuer}) ``` ### Verifying a Verifiable Credential From 8bf35a1b0b5988d627a313ce430b2bbf6291cf09 Mon Sep 17 00:00:00 2001 From: Frank Hinek Date: Thu, 7 Dec 2023 14:21:19 -0500 Subject: [PATCH 2/5] Update packages/credentials/README.md --- packages/credentials/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/credentials/README.md b/packages/credentials/README.md index 6cb374f86..af721612f 100644 --- a/packages/credentials/README.md +++ b/packages/credentials/README.md @@ -51,7 +51,7 @@ const issuer = await DidKeyMethod.create(); Then sign the VC using the did object ```javascript -const vcJwt = vc.sign({did:issuer}) +const vcJwt = vc.sign({ did:issuer }); ``` ### Verifying a Verifiable Credential From 7f389f8fffca0d9d9a1cfe1918cdc62ea0012d10 Mon Sep 17 00:00:00 2001 From: Frank Hinek Date: Thu, 7 Dec 2023 14:21:49 -0500 Subject: [PATCH 3/5] Update packages/credentials/README.md --- packages/credentials/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/credentials/README.md b/packages/credentials/README.md index af721612f..e2a125d58 100644 --- a/packages/credentials/README.md +++ b/packages/credentials/README.md @@ -43,7 +43,7 @@ Sign a `VerifiableCredential` with a DID: - `did`: The did that is signing the VC -First create a Did object as follows: +First create a `Did` object as follows: ```javascript import { DidKeyMethod } from '@web5/dids'; const issuer = await DidKeyMethod.create(); From 109f67845f8209beffc11cca2fb2f487d7476c78 Mon Sep 17 00:00:00 2001 From: Frank Hinek Date: Thu, 7 Dec 2023 14:22:21 -0500 Subject: [PATCH 4/5] Update packages/credentials/README.md --- packages/credentials/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/credentials/README.md b/packages/credentials/README.md index e2a125d58..e9de22c85 100644 --- a/packages/credentials/README.md +++ b/packages/credentials/README.md @@ -49,7 +49,7 @@ import { DidKeyMethod } from '@web5/dids'; const issuer = await DidKeyMethod.create(); ``` -Then sign the VC using the did object +Then sign the VC using the `did` object ```javascript const vcJwt = vc.sign({ did:issuer }); ``` From 461bac9ee47c015c2fbb5b19cee7256cbda2a10b Mon Sep 17 00:00:00 2001 From: Frank Hinek Date: Thu, 7 Dec 2023 14:22:35 -0500 Subject: [PATCH 5/5] Update packages/credentials/README.md --- packages/credentials/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/credentials/README.md b/packages/credentials/README.md index e9de22c85..e597abc3a 100644 --- a/packages/credentials/README.md +++ b/packages/credentials/README.md @@ -51,7 +51,7 @@ const issuer = await DidKeyMethod.create(); Then sign the VC using the `did` object ```javascript -const vcJwt = vc.sign({ did:issuer }); +const vcJwt = vc.sign({ did: issuer }); ``` ### Verifying a Verifiable Credential