Grammatical fixes to files and readme

README.md

@@ -41,7 +41,7 @@ To run the examples in this repository, you need:
 - Node.js v16 or higher installed on your system.
 - A basic understanding of TypeScript.
 - A configured `.env` file. You'll find a `.env.example` in the root of this project, which outlines the necessary environment variables.
-- Optional but highly encourged to get fimilar with [Onyx SSI SDK](https://github.com/jpmorganchase/onyx-ssi-sdk) and the broader SSI Ecosystem.
+- Optional but highly encouraged to get familiar with [Onyx SSI SDK](https://github.com/jpmorganchase/onyx-ssi-sdk) and the broader SSI Ecosystem.
 
 ## Getting Started
 
@@ -58,7 +58,7 @@ To run the examples in this repository, you need:
    Enter the root directory of the cloned repository with:
 
    ```
-   cd onyx-ssi-examples
+   cd onyx-ssi-sdk-examples
    ```
 
 3. **Configure Environment Variables**

config.ts

@@ -40,7 +40,7 @@ export const VC_DIR_PATH =
 export const VC = getParam("VC");
 export const VC_ES256K_PRIVATE_KEY = getParam("VC_ES256K_PRIVATE_KEY");
 
-//VP congifs
+//VP configs
 export const VP_DIR_PATH =
   getParam("VP_DIR_PATH") || "./src/verifiable_presentation";
 export const VP = getParam("VP");

src/holder/create-and-sign-vp.ts

@@ -25,7 +25,7 @@ const createAndSignVp = async () => {
 
   if (VC) {
     try {
-      console.log("\nReading a existing signed VC JWT\n");
+      console.log("\nReading an existing signed VC JWT\n");
       const signedVcJwt = fs.readFileSync(
         path.resolve(VC_DIR_PATH, `${camelCase(VC)}.jwt`),
         "utf8"
@@ -57,7 +57,7 @@ const createAndSignVp = async () => {
           );
         } else {
           console.log(
-            "HOLDER_ES256K_PRIVATE_KEY cannot sign this verifiable credentail\n"
+            "HOLDER_ES256K_PRIVATE_KEY cannot sign this verifiable credential\n"
           );
         }
       } else if (includes(signedVc.sub, "key")) {
@@ -80,14 +80,14 @@ const createAndSignVp = async () => {
           );
         } else {
           console.log(
-            "\nHOLDER_EDDSA_PRIVATE_KEY cannot sign this verifiable credentail\n"
+            "\nHOLDER_EDDSA_PRIVATE_KEY cannot sign this verifiable credential\n"
           );
         }
       }
     } catch (err) {
       console.log("\nFailed to fetch file\n");
       console.log(
-        "\nTo run this script you must have a valid VC and a vaild signed VC JWT\n"
+        "\nTo run this script you must have a valid VC and a valid signed VC JWT\n"
       );
       console.log(
         "\nPlease refer to issuer scripts to generate and sign a VC\n"
@@ -96,7 +96,7 @@ const createAndSignVp = async () => {
   } else {
     console.log("\nVC not found!\n");
     console.log(
-      "\nTo run this script you must have a valid VC and a vaild signed VC JWT\n"
+      "\nTo run this script you must have a valid VC and a valid signed VC JWT\n"
     );
     console.log("\nPlease refer to issuer scripts to generate and sign a VC\n");
   }

src/holder/create-vp-from-vc.ts

@@ -10,7 +10,7 @@ const createVp = () => {
 
   if (VC) {
     try {
-      console.log("\nReading a existing signed VC JWT\n");
+      console.log("\nReading an existing signed VC JWT\n");
       const signedVcJwt = fs.readFileSync(
         path.resolve(VC_DIR_PATH, `${camelCase(VC)}.jwt`),
         "utf8"
@@ -32,7 +32,7 @@ const createVp = () => {
     } catch (err) {
       console.log("\nFailed to fetch file\n");
       console.log(
-        "\nTo run this script you must have a valid VC and a vaild signed VC JWT\n"
+        "\nTo run this script you must have a valid VC and a valid signed VC JWT\n"
       );
       console.log(
         "\nPlease refer to issuer scripts to generate and sign a VC\n"
@@ -41,7 +41,7 @@ const createVp = () => {
   } else {
     console.log("\nVC not found!\n");
     console.log(
-      "\nTo run this script you must have a valid VC and a vaild signed VC JWT\n"
+      "\nTo run this script you must have a valid VC and a valid signed VC JWT\n"
     );
     console.log("\nPlease refer to issuer scripts to generate and sign a VC\n");
   }

src/holder/create-vp-with-additional-params.ts

@@ -40,7 +40,7 @@ const createVp = () => {
     } catch (err) {
       console.log("\nFailed to fetch file\n");
       console.log(
-        "\nTo run this script you must have a valid VC and a vaild signed VC JWT\n"
+        "\nTo run this script you must have a valid VC and a valid signed VC JWT\n"
       );
       console.log(
         "\nPlease refer to issuer scripts to generate and sign a VC\n"
@@ -49,7 +49,7 @@ const createVp = () => {
   } else {
     console.log("\nVC not found!\n");
     console.log(
-      "\nTo run this script you must have a valid VC and a vaild signed VC JWT\n"
+      "\nTo run this script you must have a valid VC and a valid signed VC JWT\n"
     );
     console.log("\nPlease refer to issuer scripts to generate and sign a VC\n");
   }

src/holder/sign-vp.ts

@@ -72,7 +72,7 @@ const signVp = async () => {
         );
       } else {
         console.log(
-          "\nHOLDER_EDDSA_PRIVATE_KEY cannot sign this verifiable credentail\n"
+          "\nHOLDER_EDDSA_PRIVATE_KEY cannot sign this verifiable credential\n"
         );
       }
     }

src/issuer/create-and-sign-vc.ts

@@ -34,7 +34,7 @@ const createVc = async () => {
   };
 
   console.log(
-    `\nGenerating a signed verifiable Cridential of type ${credentialType}\n`
+    `\nGenerating a signed verifiable Credential of type ${credentialType}\n`
   );
 
   const signedVc = await createAndSignCredentialJWT(

src/issuer/create-vc-did-ethr.ts

@@ -44,7 +44,7 @@ const createVc = async () => {
     id: vcDidKey,
   };
 
-  console.log(`\nGenerating Verifiable Cridential of type ${credentialType}\n`);
+  console.log(`\nGenerating Verifiable Credential of type ${credentialType}\n`);
 
   const vc = createCredential(
     issuerDidWithKeys.did,

src/issuer/create-vc-with-additional-params.ts

@@ -62,7 +62,7 @@ const createVcWithAdditonalParams = async (VC_SCHEMA_URL: string) => {
 
   if (validation) {
     console.log(
-      `\nGenerating Verifiable Cridential of type ${credentialType}\n`
+      `\nGenerating Verifiable Credential of type ${credentialType}\n`
     );
 
     const vc = await createCredentialFromSchema(

src/issuer/deactivate-vc.ts

@@ -35,7 +35,7 @@ const createVc = async () => {
     id: vcDidKey,
   };
 
-  console.log(`\nGenerating Verifiable Cridential of type ${credentialType}\n`);
+  console.log(`\nGenerating Verifiable Credential of type ${credentialType}\n`);
 
   const vc = createCredential(
     issuerDidWithKeys.did,

src/issuer/sign-vc.ts

@@ -44,7 +44,7 @@ const createVc = async () => {
     id: vcDidKey,
   };
 
-  console.log(`\nGenerating ${credentialType} Verifiable Cridential\n`);
+  console.log(`\nGenerating ${credentialType} Verifiable Credentials\n`);
 
   return createCredential(
     (await issuerDidWithKeys()).did,

src/verifier/verify-dates.ts

@@ -23,7 +23,7 @@ const verificationWithDates = async () => {
 
   if (VP) {
     try {
-      console.log("\nReading a existing signed VP JWT\n");
+      console.log("\nReading an existing signed VP JWT\n");
       const signedVpJwt = fs.readFileSync(
         path.resolve(VP_DIR_PATH, `${camelCase(VP)}.jwt`),
         "utf8"
@@ -83,7 +83,7 @@ const verificationWithDates = async () => {
     } catch (err) {
       console.log("\nFailed to fetch file\n");
       console.log(
-        "\nTo run this script you must have a valid VP and a vaild signed VP JWT\n"
+        "\nTo run this script you must have a valid VP and a valid signed VP JWT\n"
       );
       console.log(
         "\nPlease refer to issuer scripts to generate and sign a VP\n"
@@ -92,7 +92,7 @@ const verificationWithDates = async () => {
   } else {
     console.log("\nVP not found!\n");
     console.log(
-      "\nTo run this script you must have a valid VP and a vaild signed VP JWT\n"
+      "\nTo run this script you must have a valid VP and a valid signed VP JWT\n"
     );
     console.log("\nPlease refer to issuer scripts to generate and sign a VP\n");
   }

src/verifier/verify-revocation-status.ts

@@ -21,7 +21,7 @@ const verificationWithRevocationStatus = async () => {
 
   if (VP) {
     try {
-      console.log("\nReading a existing signed VP JWT\n");
+      console.log("\nReading an existing signed VP JWT\n");
       const signedVpJwt = fs.readFileSync(
         path.resolve(VP_DIR_PATH, `${camelCase(VP)}.jwt`),
         "utf8"
@@ -63,7 +63,7 @@ const verificationWithRevocationStatus = async () => {
     } catch (err) {
       console.log("\nFailed to fetch file\n");
       console.log(
-        "\nTo run this script you must have a valid VP and a vaild signed VP JWT\n"
+        "\nTo run this script you must have a valid VP and a valid signed VP JWT\n"
       );
       console.log(
         "\nPlease refer to issuer scripts to generate and sign a VP\n"
@@ -72,7 +72,7 @@ const verificationWithRevocationStatus = async () => {
   } else {
     console.log("\nVP not found!\n");
     console.log(
-      "\nTo run this script you must have a valid VP and a vaild signed VP JWT\n"
+      "\nTo run this script you must have a valid VP and a valid signed VP JWT\n"
     );
     console.log("\nPlease refer to issuer scripts to generate and sign a VP\n");
   }

src/verifier/verify-schema-validation.ts

@@ -23,7 +23,7 @@ const verificationWithSchemaValidation = async () => {
 
   if (VP) {
     try {
-      console.log("\nReading a existing signed VP JWT\n");
+      console.log("\nReading an existing signed VP JWT\n");
       const signedVpJwt = fs.readFileSync(
         path.resolve(VP_DIR_PATH, `${camelCase(VP)}.jwt`),
         "utf8"
@@ -67,7 +67,7 @@ const verificationWithSchemaValidation = async () => {
     } catch (err) {
       console.log("\nFailed to fetch file\n");
       console.log(
-        "\nTo run this script you must have a valid VP and a vaild signed VP JWT\n"
+        "\nTo run this script you must have a valid VP and a valid signed VP JWT\n"
       );
       console.log(
         "\nPlease refer to issuer scripts to generate and sign a VP\n"
@@ -76,7 +76,7 @@ const verificationWithSchemaValidation = async () => {
   } else {
     console.log("\nVP not found!\n");
     console.log(
-      "\nTo run this script you must have a valid VP and a vaild signed VP JWT\n"
+      "\nTo run this script you must have a valid VP and a valid signed VP JWT\n"
     );
     console.log("\nPlease refer to issuer scripts to generate and sign a VP\n");
   }

src/verifier/verify.ts

@@ -22,7 +22,7 @@ const verification = async () => {
 
   if (VP) {
     try {
-      console.log("\nReading a existing signed VP JWT\n");
+      console.log("\nReading an existing signed VP JWT\n");
       const signedVpJwt = fs.readFileSync(
         path.resolve(VP_DIR_PATH, `${camelCase(VP)}.jwt`),
         "utf8"
@@ -58,7 +58,7 @@ const verification = async () => {
     } catch (err) {
       console.log("\nFailed to fetch file\n");
       console.log(
-        "\nTo run this script you must have a valid VP and a vaild signed VP JWT\n"
+        "\nTo run this script you must have a valid VP and a valid signed VP JWT\n"
       );
       console.log(
         "\nPlease refer to issuer scripts to generate and sign a VP\n"
@@ -67,7 +67,7 @@ const verification = async () => {
   } else {
     console.log("\nVP not found!\n");
     console.log(
-      "\nTo run this script you must have a valid VP and a vaild signed VP JWT\n"
+      "\nTo run this script you must have a valid VP and a valid signed VP JWT\n"
     );
     console.log("\nPlease refer to issuer scripts to generate and sign a VP\n");
   }