@twin.org/identity-cli 0.0.1-next.12 → 0.0.1-next.14

package/dist/cjs/index.cjs

@@ -14,8 +14,8 @@ var commander = require('commander');
 var entityStorageConnectorMemory = require('@twin.org/entity-storage-connector-memory');
 var entityStorageModels = require('@twin.org/entity-storage-models');
 var vaultConnectorEntityStorage = require('@twin.org/vault-connector-entity-storage');
-var identityModels = require('@twin.org/identity-models');
 var standardsW3cDid = require('@twin.org/standards-w3c-did');
+var identityModels = require('@twin.org/identity-models');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 // Copyright 2024 IOTA Stiftung.
@@ -264,18 +264,16 @@ async function actionCommandProofCreate(opts) {
     cliCore.CLIDisplay.break();
     cliCore.CLIDisplay.spinnerStart();
     const proof = await iotaIdentityConnector.createProof(localIdentity, id, data);
-    const proofValue = core.Converter.bytesToBase64(proof.value);
     cliCore.CLIDisplay.spinnerStop();
     if (opts.console) {
-        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.proof-create.labels.type"), proof.type);
-        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.proof-create.labels.value"), proofValue);
+        cliCore.CLIDisplay.json(proof);
         cliCore.CLIDisplay.break();
     }
     if (core.Is.stringValue(opts?.json)) {
-        await cliCore.CLIUtils.writeJsonFile(opts.json, { type: proof.type, value: proofValue }, opts.mergeJson);
+        await cliCore.CLIUtils.writeJsonFile(opts.json, { cryptosuite: proof.cryptosuite, value: proof.proofValue }, opts.mergeJson);
     }
     if (core.Is.stringValue(opts?.env)) {
-        await cliCore.CLIUtils.writeEnvFile(opts.env, [`DID_PROOF_TYPE="${proof.type}"`, `DID_PROOF_VALUE="${proofValue}"`], opts.mergeEnv);
+        await cliCore.CLIUtils.writeEnvFile(opts.env, [`DID_CRYPTOSUITE="${proof.cryptosuite}"`, `DID_PROOF_VALUE="${proof.proofValue}"`], opts.mergeEnv);
     }
     cliCore.CLIDisplay.done();
 }
@@ -294,7 +292,7 @@ function buildCommandProofVerify() {
         .description(core.I18n.formatMessage("commands.proof-verify.description"))
         .requiredOption(core.I18n.formatMessage("commands.proof-verify.options.id.param"), core.I18n.formatMessage("commands.proof-verify.options.id.description"))
         .requiredOption(core.I18n.formatMessage("commands.proof-verify.options.data.param"), core.I18n.formatMessage("commands.proof-verify.options.data.description"))
-        .requiredOption(core.I18n.formatMessage("commands.proof-verify.options.type.param"), core.I18n.formatMessage("commands.proof-verify.options.type.description"))
+        .requiredOption(core.I18n.formatMessage("commands.proof-verify.options.cryptosuite.param"), core.I18n.formatMessage("commands.proof-verify.options.cryptosuite.description"))
         .requiredOption(core.I18n.formatMessage("commands.proof-verify.options.value.param"), core.I18n.formatMessage("commands.proof-verify.options.value.description"));
     cliCore.CLIOptions.output(command, {
         noConsole: true,
@@ -313,19 +311,19 @@ function buildCommandProofVerify() {
  * @param opts The options for the command.
  * @param opts.id The id of the verification method to use for the credential.
  * @param opts.data The data to verify the proof for.
- * @param opts.type The type of the proof.
+ * @param opts.cryptosuite The cryptosuite of the proof.
  * @param opts.value The proof value.
  * @param opts.node The node URL.
  */
 async function actionCommandProofVerify(opts) {
     const id = cliCore.CLIParam.stringValue("id", opts.id);
     const data = cliCore.CLIParam.hexBase64("data", opts.data);
-    const type = cliCore.CLIParam.stringValue("type", opts.type);
-    const value = cliCore.CLIParam.hexBase64("value", opts.value);
+    const cryptosuite = cliCore.CLIParam.stringValue("cryptosuite", opts.cryptosuite);
+    const value = cliCore.CLIParam.stringValue("value", opts.value);
     const nodeEndpoint = cliCore.CLIParam.url("node", opts.node);
     cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.proof-verify.labels.verificationMethodId"), id);
-    cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.proof-verify.labels.type"), type);
-    cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.proof-verify.labels.value"), core.Converter.bytesToBase64(value));
+    cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.proof-verify.labels.cryptosuite"), cryptosuite);
+    cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.proof-verify.labels.value"), value);
     cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
     cliCore.CLIDisplay.break();
     setupVault();
@@ -349,7 +347,15 @@ async function actionCommandProofVerify(opts) {
     cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.proof-verify.progress.verifyingProof"));
     cliCore.CLIDisplay.break();
     cliCore.CLIDisplay.spinnerStart();
-    const isVerified = await iotaIdentityConnector.verifyProof(id, data, type, value);
+    const proof = {
+        "@context": standardsW3cDid.DidContexts.ContextVCDataIntegrity,
+        type: standardsW3cDid.DidTypes.DataIntegrityProof,
+        verificationMethod: id,
+        cryptosuite,
+        proofPurpose: "assertionMethod",
+        proofValue: value
+    };
+    const isVerified = await iotaIdentityConnector.verifyProof(data, proof);
     cliCore.CLIDisplay.spinnerStop();
     if (opts.console) {
         cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.proof-verify.labels.isVerified"), isVerified);

package/dist/esm/index.mjs

@@ -12,8 +12,8 @@ import { Command, Option } from 'commander';
 import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
 import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 import { initSchema, EntityStorageVaultConnector } from '@twin.org/vault-connector-entity-storage';
+import { DidContexts, DidTypes, DidVerificationMethodType } from '@twin.org/standards-w3c-did';
 import { DocumentHelper } from '@twin.org/identity-models';
-import { DidVerificationMethodType } from '@twin.org/standards-w3c-did';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -261,18 +261,16 @@ async function actionCommandProofCreate(opts) {
     CLIDisplay.break();
     CLIDisplay.spinnerStart();
     const proof = await iotaIdentityConnector.createProof(localIdentity, id, data);
-    const proofValue = Converter.bytesToBase64(proof.value);
     CLIDisplay.spinnerStop();
     if (opts.console) {
-        CLIDisplay.value(I18n.formatMessage("commands.proof-create.labels.type"), proof.type);
-        CLIDisplay.value(I18n.formatMessage("commands.proof-create.labels.value"), proofValue);
+        CLIDisplay.json(proof);
         CLIDisplay.break();
     }
     if (Is.stringValue(opts?.json)) {
-        await CLIUtils.writeJsonFile(opts.json, { type: proof.type, value: proofValue }, opts.mergeJson);
+        await CLIUtils.writeJsonFile(opts.json, { cryptosuite: proof.cryptosuite, value: proof.proofValue }, opts.mergeJson);
     }
     if (Is.stringValue(opts?.env)) {
-        await CLIUtils.writeEnvFile(opts.env, [`DID_PROOF_TYPE="${proof.type}"`, `DID_PROOF_VALUE="${proofValue}"`], opts.mergeEnv);
+        await CLIUtils.writeEnvFile(opts.env, [`DID_CRYPTOSUITE="${proof.cryptosuite}"`, `DID_PROOF_VALUE="${proof.proofValue}"`], opts.mergeEnv);
     }
     CLIDisplay.done();
 }
@@ -291,7 +289,7 @@ function buildCommandProofVerify() {
         .description(I18n.formatMessage("commands.proof-verify.description"))
         .requiredOption(I18n.formatMessage("commands.proof-verify.options.id.param"), I18n.formatMessage("commands.proof-verify.options.id.description"))
         .requiredOption(I18n.formatMessage("commands.proof-verify.options.data.param"), I18n.formatMessage("commands.proof-verify.options.data.description"))
-        .requiredOption(I18n.formatMessage("commands.proof-verify.options.type.param"), I18n.formatMessage("commands.proof-verify.options.type.description"))
+        .requiredOption(I18n.formatMessage("commands.proof-verify.options.cryptosuite.param"), I18n.formatMessage("commands.proof-verify.options.cryptosuite.description"))
         .requiredOption(I18n.formatMessage("commands.proof-verify.options.value.param"), I18n.formatMessage("commands.proof-verify.options.value.description"));
     CLIOptions.output(command, {
         noConsole: true,
@@ -310,19 +308,19 @@ function buildCommandProofVerify() {
  * @param opts The options for the command.
  * @param opts.id The id of the verification method to use for the credential.
  * @param opts.data The data to verify the proof for.
- * @param opts.type The type of the proof.
+ * @param opts.cryptosuite The cryptosuite of the proof.
  * @param opts.value The proof value.
  * @param opts.node The node URL.
  */
 async function actionCommandProofVerify(opts) {
     const id = CLIParam.stringValue("id", opts.id);
     const data = CLIParam.hexBase64("data", opts.data);
-    const type = CLIParam.stringValue("type", opts.type);
-    const value = CLIParam.hexBase64("value", opts.value);
+    const cryptosuite = CLIParam.stringValue("cryptosuite", opts.cryptosuite);
+    const value = CLIParam.stringValue("value", opts.value);
     const nodeEndpoint = CLIParam.url("node", opts.node);
     CLIDisplay.value(I18n.formatMessage("commands.proof-verify.labels.verificationMethodId"), id);
-    CLIDisplay.value(I18n.formatMessage("commands.proof-verify.labels.type"), type);
-    CLIDisplay.value(I18n.formatMessage("commands.proof-verify.labels.value"), Converter.bytesToBase64(value));
+    CLIDisplay.value(I18n.formatMessage("commands.proof-verify.labels.cryptosuite"), cryptosuite);
+    CLIDisplay.value(I18n.formatMessage("commands.proof-verify.labels.value"), value);
     CLIDisplay.value(I18n.formatMessage("commands.common.labels.node"), nodeEndpoint);
     CLIDisplay.break();
     setupVault();
@@ -346,7 +344,15 @@ async function actionCommandProofVerify(opts) {
     CLIDisplay.task(I18n.formatMessage("commands.proof-verify.progress.verifyingProof"));
     CLIDisplay.break();
     CLIDisplay.spinnerStart();
-    const isVerified = await iotaIdentityConnector.verifyProof(id, data, type, value);
+    const proof = {
+        "@context": DidContexts.ContextVCDataIntegrity,
+        type: DidTypes.DataIntegrityProof,
+        verificationMethod: id,
+        cryptosuite,
+        proofPurpose: "assertionMethod",
+        proofValue: value
+    };
+    const isVerified = await iotaIdentityConnector.verifyProof(data, proof);
     CLIDisplay.spinnerStop();
     if (opts.console) {
         CLIDisplay.value(I18n.formatMessage("commands.proof-verify.labels.isVerified"), isVerified);

package/dist/locales/en.json

@@ -1,24 +1,5 @@
 {
   "error": {
-    "commands": {
-      "verifiable-credential-create": {
-        "subjectJsonFileNotFound": "The subject JSON file was not found."
-      },
-      "common": {
-        "missingEnv": "The \"{option}\" option is configured as an environment variable, but there is no environment variable with the name \"{value}\" set.",
-        "optionInvalidHex": "The \"{option}\" does not appear to be hex. \"{value}\"",
-        "optionInvalidBase64": "The \"{option}\" does not appear to be base64. \"{value}\"",
-        "optionInvalidHexBase64": "The \"{option}\" does not appear to be hex or base64. \"{value}\"",
-        "optionInvalidBech32": "The \"{option}\" does not appear to be bech32. \"{value}\"",
-        "optionMinValue": "The \"{option}\" option must be greater than or equal to {minValue}, it is {value}.",
-        "optionMaxValue": "The \"{option}\" option must be less than or equal to {maxValue}, it is {value}."
-      },
-      "address": {
-        "seedMissingEnv": "The seed does not appear to be hex or base64, assuming it is an environment variable, but there is no environment variable with the name \"{env}\" set.",
-        "seedInvalidEnv": "The seed does not appear to be hex or base64, assuming it is an environment variable, but there the environment variable is neither hex or base64. \"{envValue}\"",
-        "seedInvalidFormat": "The seed does not appear to be hex, base64 or an environment variable. \"{seed}\""
-      }
-    },
     "validation": {
       "beEmpty": "{fieldName} must be empty",
       "beNotEmpty": "{fieldName} must not be empty",
@@ -27,6 +8,10 @@
       "beTextMinMax": "{fieldName} must be longer than {minLength} and shorter than {maxLength} characters",
       "beTextMin": "{fieldName} must be longer than {minLength} characters",
       "beTextMax": "{fieldName} must be shorter than {maxLength} characters",
+      "beTextBase58": "{fieldName} must be text formatted using Base58 characters",
+      "beTextBase64": "{fieldName} must be text formatted using Base64 characters",
+      "beTextHex": "{fieldName} must be text formatted using Hex characters",
+      "beTextRegExp": "{fieldName} must be text formatted using the matching pattern {format}",
       "beNumber": "{fieldName} must be a number",
       "beNumberMinMax": "{fieldName} must be >= {minValue} and <= {maxValue}",
       "beNumberMin": "{fieldName} must be >= {minValue}",
@@ -69,6 +54,7 @@
       "stringEmpty": "Property \"{property}\" must have a value, it is empty",
       "stringBase64": "Property \"{property}\" must be a base64 encoded string, it is \"{value}\"",
       "stringBase64Url": "Property \"{property}\" must be a base64 url encoded string, it is \"{value}\"",
+      "stringBase58": "Property \"{property}\" must be a base58 encoded string, it is \"{value}\"",
       "stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
       "stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
       "number": "Property \"{property}\" must be a number, it is \"{value}\"",
@@ -108,6 +94,15 @@
     "bitString": {
       "outOfRange": "The index should be >= 0 and less than the length of the bit string"
     },
+    "base32": {
+      "invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+    },
+    "base64": {
+      "length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
+    },
+    "base58": {
+      "invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+    },
     "bip39": {
       "missingMnemonicWord": "The mnemonic contains a word not in the wordlist, \"{value}\"",
       "checksumMismatch": "The checksum does not match \"{newChecksum}\" != \"{checksumBits}\""
@@ -133,18 +128,15 @@
     "sha256": {
       "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
     },
+    "sha3": {
+      "bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+    },
     "hmacSha256": {
       "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
     },
     "hmacSha512": {
       "bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
     },
-    "base32": {
-      "invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
-    },
-    "base64": {
-      "length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
-    },
     "bech32": {
       "decodeFailed": "The address contains decoding failed for address \"{bech32}\"",
       "invalidChecksum": "The address contains an invalid checksum in address, \"{bech32}\"",
@@ -169,6 +161,25 @@
     "slip0010": {
       "invalidSeed": "The seed is invalid \"{seed}\""
     },
+    "commands": {
+      "common": {
+        "missingEnv": "The \"{option}\" option is configured as an environment variable, but there is no environment variable with the name \"{value}\" set.",
+        "optionInvalidHex": "The \"{option}\" does not appear to be hex. \"{value}\"",
+        "optionInvalidBase64": "The \"{option}\" does not appear to be base64. \"{value}\"",
+        "optionInvalidHexBase64": "The \"{option}\" does not appear to be hex or base64. \"{value}\"",
+        "optionInvalidBech32": "The \"{option}\" does not appear to be bech32. \"{value}\"",
+        "optionMinValue": "The \"{option}\" option must be greater than or equal to {minValue}, it is {value}.",
+        "optionMaxValue": "The \"{option}\" option must be less than or equal to {maxValue}, it is {value}."
+      },
+      "address": {
+        "seedMissingEnv": "The seed does not appear to be hex or base64, assuming it is an environment variable, but there is no environment variable with the name \"{env}\" set.",
+        "seedInvalidEnv": "The seed does not appear to be hex or base64, assuming it is an environment variable, but there the environment variable is neither hex or base64. \"{envValue}\"",
+        "seedInvalidFormat": "The seed does not appear to be hex, base64 or an environment variable. \"{seed}\""
+      },
+      "verifiable-credential-create": {
+        "subjectJsonFileNotFound": "The subject JSON file was not found."
+      }
+    },
     "entitySchemaHelper": {
       "noIsPrimary": "Property \"entitySchema.properties\" must contain a value with isPrimary set",
       "multipleIsPrimary": "Property \"entitySchema.properties\" contains more than one property with isPrimary set"
@@ -210,7 +221,9 @@
       "unrevokeVerifiableCredentialsFailed": "Unrevoking verifiable credentials failed",
       "inclusionFailed": "The transaction generated for the identity was not included in a reasonable amount of time",
       "insufficientFunds": "There were insufficient funds to complete the operation",
-      "walletConnectorMissing": "The wallet connector must be available to perform this operation"
+      "walletConnectorMissing": "The wallet connector must be available to perform this operation",
+      "proofType": "The proof type must be DataIntegrityProof, it is currently {proofType}",
+      "cryptosuite": "The proof cryptosuite must be eddsa-jcs-2022, it is currently {cryptosuite}"
     },
     "iota": {
       "inclusionFailed": "The transaction generated was not included in a reasonable amount of time",
@@ -231,7 +244,231 @@
       "insufficientFunds": "There were insufficient funds to complete the operation"
     }
   },
+  "errorNames": {
+    "error": "Error",
+    "generalError": "General",
+    "guardError": "Guard",
+    "conflictError": "Conflict",
+    "notFoundError": "Not Found",
+    "notSupportedError": "Not Supported",
+    "alreadyExistsError": "Already Exists",
+    "notImplementedError": "Not Implemented",
+    "validationError": "Validation",
+    "unprocessableError": "Unprocessable"
+  },
+  "validation": {
+    "defaultFieldName": "The field"
+  },
+  "cli": {
+    "progress": {
+      "done": "Done.",
+      "error": "Error",
+      "loadingEnvFiles": "Loading env files",
+      "pleaseWait": "Please wait...",
+      "writingJsonFile": "Writing JSON file",
+      "writingEnvFile": "Writing env file",
+      "readingJsonFile": "Reading JSON file",
+      "readingEnvFile": "Reading env file"
+    },
+    "options": {
+      "lang": {
+        "param": "--lang '<'lang'>'",
+        "description": "The language to display the output in."
+      },
+      "load-env": {
+        "param": "--load-env [env...]",
+        "description": "Load the env files to initialise any environment variables."
+      },
+      "no-console": {
+        "param": "--no-console",
+        "description": "Hides the output in the console."
+      },
+      "json": {
+        "param": "--json '<'filename'>'",
+        "description": "Creates a JSON file containing the output."
+      },
+      "env": {
+        "param": "--env '<'filename'>'",
+        "description": "Creates an env file containing the output."
+      },
+      "merge-json": {
+        "param": "--merge-json",
+        "description": "If the JSON file already exists merge the data instead of overwriting."
+      },
+      "merge-env": {
+        "param": "--merge-env",
+        "description": "If the env file already exists merge the data instead of overwriting."
+      }
+    }
+  },
   "commands": {
+    "mnemonic": {
+      "summary": "Create a mnemonic.",
+      "description": "Create a mnemonic, will also generate the equivalent seed in hex and base64 format.",
+      "options": {
+        "strength": {
+          "param": "--strength '<'number'>'",
+          "description": "The number of words in the mnemonic, defaults to 256 which produces 24 words."
+        },
+        "seed-format": {
+          "param": "--seed-format '<'format'>'",
+          "description": "The format to output the seed."
+        },
+        "no-console": {
+          "param": "--no-console",
+          "description": "Hides the mnemonic and seed in the console."
+        },
+        "json": {
+          "param": "--json '<'filename'>'",
+          "description": "Creates a JSON file containing the mnemonic and seed."
+        },
+        "env": {
+          "param": "--env '<'filename'>'",
+          "description": "Creates an env file containing the mnemonic and seed."
+        },
+        "env-prefix": {
+          "param": "--env-prefix '<'prefix'>'",
+          "description": "Prefixes the env variables with the value."
+        }
+      },
+      "progress": {
+        "writingJsonFile": "Writing JSON file",
+        "writingEnvFile": "Writing env file"
+      },
+      "labels": {
+        "mnemonic": "Mnemonic",
+        "seed": "Seed",
+        "envPrefix": "Env Prefix"
+      }
+    },
+    "address": {
+      "summary": "Create bech32 addresses and keys from the seed.",
+      "description": "Create a number of bech32 addresses and their associated key pairs from the seed.",
+      "options": {
+        "seed": {
+          "param": "--seed '<'seed'>'",
+          "description": "The seed to use for generating the addresses, this can be either hex, base64 or an environment variable name. For an environment variable start the value with a !"
+        },
+        "start": {
+          "param": "--start '<'number'>'",
+          "description": "The index of the first address to create."
+        },
+        "count": {
+          "param": "--count '<'number'>'",
+          "description": "The number of addresses to create, max 100."
+        },
+        "account": {
+          "param": "--account '<'number'>'",
+          "description": "The account used to generate the bech32 addresses."
+        },
+        "hrp": {
+          "param": "--hrp '<'hrp'>'",
+          "description": "The human readable part of the bech32 addresses."
+        },
+        "coin": {
+          "param": "--coin '<'coin'>'",
+          "description": "The coin type used to generate the bech32 addresses."
+        },
+        "key-type": {
+          "param": "--key-type '<'type'>'",
+          "description": "The type of key to generate."
+        },
+        "key-format": {
+          "param": "--key-format '<'format'>'",
+          "description": "The format to output the keys."
+        }
+      },
+      "progress": {
+        "generatingAddresses": "Generating addresses"
+      },
+      "labels": {
+        "seed": "Seed",
+        "start": "Start",
+        "count": "Count",
+        "account": "Account",
+        "hrp": "HRP",
+        "coin": "Coin",
+        "key-type": "Key Type",
+        "key-format": "Key Format",
+        "index": "Index",
+        "address": "Address",
+        "public-key": "Public Key",
+        "private-key": "Private Key"
+      }
+    },
+    "faucet": {
+      "summary": "Request funds from the faucet.",
+      "description": "Request funds from the faucet for the supplied address.",
+      "options": {
+        "address": {
+          "param": "--address '<'address'>'",
+          "description": "The address to fill from the faucet either in bech32 format, or start with ! to read environment variable."
+        },
+        "faucet": {
+          "param": "--faucet '<'url'>'",
+          "description": "The url for the faucet endpoint, or an environment variable name containing the url."
+        }
+      },
+      "progress": {
+        "requestingFunds": "Requesting Funds",
+        "requestingBalance": "Requesting Balance"
+      },
+      "labels": {
+        "faucet": "Faucet",
+        "fundsAdded": "Funds Added"
+      },
+      "messages": {
+        "noFundsAdded": "No funds were added to the address."
+      }
+    },
+    "transfer": {
+      "summary": "Transfer funds from one address to another.",
+      "description": "Transfer funds from one address to another.",
+      "options": {
+        "address": {
+          "param": "--address '<'address'>'",
+          "description": "The address to send the funds from either in bech32 format, or start with ! to read environment variable."
+        },
+        "dest-address": {
+          "param": "--dest-address '<'address'>'",
+          "description": "The address to send the funds to either in bech32 format, or start with ! to read environment variable."
+        },
+        "amount": {
+          "param": "--amount '<'amount'>'",
+          "description": "The amount of funds to send."
+        },
+        "seed": {
+          "param": "--seed '<'seed'>'",
+          "description": "The seed for the source address in hex or base64 used to sign the transfer, or start with ! to read environment variable."
+        }
+      },
+      "progress": {
+        "transferringFunds": "Transferring"
+      },
+      "labels": {
+        "destAddress": "Destination Address"
+      }
+    },
+    "common": {
+      "options": {
+        "node": {
+          "param": "--node '<'url'>'",
+          "description": "The url for the node endpoint, or an environment variable name containing the url."
+        },
+        "explorer": {
+          "param": "--explorer '<'url'>'",
+          "description": "The url for the explorer endpoint, or an environment variable name containing the url."
+        }
+      },
+      "labels": {
+        "address": "Address",
+        "balance": "Balance",
+        "node": "Node",
+        "explorer": "Explorer",
+        "explore": "Explore",
+        "did": "DID"
+      }
+    },
     "identity-create": {
       "summary": "Create a Decentralized Identifier (DID).",
       "description": "Creates a Decentralized Identifier (DID).",
@@ -497,9 +734,7 @@
         "creatingProof": "Creating Proof"
       },
       "labels": {
-        "verificationMethodId": "Verification Method Id",
-        "type": "Proof Type",
-        "value": "Proof Value"
+        "verificationMethodId": "Verification Method Id"
       }
     },
     "proof-verify": {
@@ -514,9 +749,9 @@
           "param": "--data '<'data'>'",
           "description": "The base64 or hex encoded data to verify the proof for, or start with ! to read environment variable."
         },
-        "type": {
-          "param": "--type '<'type'>'",
-          "description": "The type of the proof, or start with ! to read environment variable."
+        "cryptosuite": {
+          "param": "--cryptosuite '<'cryptosuite'>'",
+          "description": "The cryptosuite of the proof, or start with ! to read environment variable."
         },
         "value": {
           "param": "--value '<'value'>'",
@@ -528,234 +763,10 @@
       },
       "labels": {
         "verificationMethodId": "Verification Method Id",
-        "type": "Proof Type",
+        "cryptosuite": "Proof Cryptosuite",
         "value": "Proof Value",
         "isVerified": "Is Verified"
       }
-    },
-    "common": {
-      "options": {
-        "node": {
-          "param": "--node '<'url'>'",
-          "description": "The url for the node endpoint, or an environment variable name containing the url."
-        },
-        "explorer": {
-          "param": "--explorer '<'url'>'",
-          "description": "The url for the explorer endpoint, or an environment variable name containing the url."
-        }
-      },
-      "labels": {
-        "did": "DID",
-        "node": "Node",
-        "explorer": "Explorer",
-        "explore": "Explore",
-        "address": "Address",
-        "balance": "Balance"
-      }
-    },
-    "mnemonic": {
-      "summary": "Create a mnemonic.",
-      "description": "Create a mnemonic, will also generate the equivalent seed in hex and base64 format.",
-      "options": {
-        "strength": {
-          "param": "--strength '<'number'>'",
-          "description": "The number of words in the mnemonic, defaults to 256 which produces 24 words."
-        },
-        "seed-format": {
-          "param": "--seed-format '<'format'>'",
-          "description": "The format to output the seed."
-        },
-        "no-console": {
-          "param": "--no-console",
-          "description": "Hides the mnemonic and seed in the console."
-        },
-        "json": {
-          "param": "--json '<'filename'>'",
-          "description": "Creates a JSON file containing the mnemonic and seed."
-        },
-        "env": {
-          "param": "--env '<'filename'>'",
-          "description": "Creates an env file containing the mnemonic and seed."
-        },
-        "env-prefix": {
-          "param": "--env-prefix '<'prefix'>'",
-          "description": "Prefixes the env variables with the value."
-        }
-      },
-      "progress": {
-        "writingJsonFile": "Writing JSON file",
-        "writingEnvFile": "Writing env file"
-      },
-      "labels": {
-        "mnemonic": "Mnemonic",
-        "seed": "Seed",
-        "envPrefix": "Env Prefix"
-      }
-    },
-    "address": {
-      "summary": "Create bech32 addresses and keys from the seed.",
-      "description": "Create a number of bech32 addresses and their associated key pairs from the seed.",
-      "options": {
-        "seed": {
-          "param": "--seed '<'seed'>'",
-          "description": "The seed to use for generating the addresses, this can be either hex, base64 or an environment variable name. For an environment variable start the value with a !"
-        },
-        "start": {
-          "param": "--start '<'number'>'",
-          "description": "The index of the first address to create."
-        },
-        "count": {
-          "param": "--count '<'number'>'",
-          "description": "The number of addresses to create, max 100."
-        },
-        "account": {
-          "param": "--account '<'number'>'",
-          "description": "The account used to generate the bech32 addresses."
-        },
-        "hrp": {
-          "param": "--hrp '<'hrp'>'",
-          "description": "The human readable part of the bech32 addresses."
-        },
-        "coin": {
-          "param": "--coin '<'coin'>'",
-          "description": "The coin type used to generate the bech32 addresses."
-        },
-        "key-type": {
-          "param": "--key-type '<'type'>'",
-          "description": "The type of key to generate."
-        },
-        "key-format": {
-          "param": "--key-format '<'format'>'",
-          "description": "The format to output the keys."
-        }
-      },
-      "progress": {
-        "generatingAddresses": "Generating addresses"
-      },
-      "labels": {
-        "seed": "Seed",
-        "start": "Start",
-        "count": "Count",
-        "account": "Account",
-        "hrp": "HRP",
-        "coin": "Coin",
-        "key-type": "Key Type",
-        "key-format": "Key Format",
-        "index": "Index",
-        "address": "Address",
-        "public-key": "Public Key",
-        "private-key": "Private Key"
-      }
-    },
-    "faucet": {
-      "summary": "Request funds from the faucet.",
-      "description": "Request funds from the faucet for the supplied address.",
-      "options": {
-        "address": {
-          "param": "--address '<'address'>'",
-          "description": "The address to fill from the faucet either in bech32 format, or start with ! to read environment variable."
-        },
-        "faucet": {
-          "param": "--faucet '<'url'>'",
-          "description": "The url for the faucet endpoint, or an environment variable name containing the url."
-        }
-      },
-      "progress": {
-        "requestingFunds": "Requesting Funds",
-        "requestingBalance": "Requesting Balance"
-      },
-      "labels": {
-        "faucet": "Faucet",
-        "fundsAdded": "Funds Added"
-      },
-      "messages": {
-        "noFundsAdded": "No funds were added to the address."
-      }
-    },
-    "transfer": {
-      "summary": "Transfer funds from one address to another.",
-      "description": "Transfer funds from one address to another.",
-      "options": {
-        "address": {
-          "param": "--address '<'address'>'",
-          "description": "The address to send the funds from either in bech32 format, or start with ! to read environment variable."
-        },
-        "dest-address": {
-          "param": "--dest-address '<'address'>'",
-          "description": "The address to send the funds to either in bech32 format, or start with ! to read environment variable."
-        },
-        "amount": {
-          "param": "--amount '<'amount'>'",
-          "description": "The amount of funds to send."
-        },
-        "seed": {
-          "param": "--seed '<'seed'>'",
-          "description": "The seed for the source address in hex or base64 used to sign the transfer, or start with ! to read environment variable."
-        }
-      },
-      "progress": {
-        "transferringFunds": "Transferring"
-      },
-      "labels": {
-        "destAddress": "Destination Address"
-      }
-    }
-  },
-  "errorNames": {
-    "error": "Error",
-    "generalError": "General",
-    "guardError": "Guard",
-    "conflictError": "Conflict",
-    "notFoundError": "Not Found",
-    "notSupportedError": "Not Supported",
-    "alreadyExistsError": "Already Exists",
-    "notImplementedError": "Not Implemented",
-    "validationError": "Validation",
-    "unprocessableError": "Unprocessable"
-  },
-  "validation": {
-    "defaultFieldName": "The field"
-  },
-  "cli": {
-    "progress": {
-      "done": "Done.",
-      "error": "Error",
-      "loadingEnvFiles": "Loading env files",
-      "pleaseWait": "Please wait...",
-      "writingJsonFile": "Writing JSON file",
-      "writingEnvFile": "Writing env file",
-      "readingJsonFile": "Reading JSON file",
-      "readingEnvFile": "Reading env file"
-    },
-    "options": {
-      "lang": {
-        "param": "--lang '<'lang'>'",
-        "description": "The language to display the output in."
-      },
-      "load-env": {
-        "param": "--load-env [env...]",
-        "description": "Load the env files to initialise any environment variables."
-      },
-      "no-console": {
-        "param": "--no-console",
-        "description": "Hides the output in the console."
-      },
-      "json": {
-        "param": "--json '<'filename'>'",
-        "description": "Creates a JSON file containing the output."
-      },
-      "env": {
-        "param": "--env '<'filename'>'",
-        "description": "Creates an env file containing the output."
-      },
-      "merge-json": {
-        "param": "--merge-json",
-        "description": "If the JSON file already exists merge the data instead of overwriting."
-      },
-      "merge-env": {
-        "param": "--merge-env",
-        "description": "If the env file already exists merge the data instead of overwriting."
-      }
     }
   },
   "jsonLdProcessor": {

package/dist/types/commands/proofVerify.d.ts

@@ -10,14 +10,14 @@ export declare function buildCommandProofVerify(): Command;
  * @param opts The options for the command.
  * @param opts.id The id of the verification method to use for the credential.
  * @param opts.data The data to verify the proof for.
- * @param opts.type The type of the proof.
+ * @param opts.cryptosuite The cryptosuite of the proof.
  * @param opts.value The proof value.
  * @param opts.node The node URL.
  */
 export declare function actionCommandProofVerify(opts: {
     id: string;
     data: string;
-    type: string;
+    cryptosuite: string;
     value: string;
     node: string;
 } & CliOutputOptions): Promise<void>;

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/identity-cli - Changelog
 
-## v0.0.1-next.12
+## v0.0.1-next.14
 
 - Initial Release

package/docs/examples.md

@@ -207,5 +207,5 @@ This will output the proof as a set of data containing the type and a value in b
 This command will verify a proof using the specified verification method.
 
 ```shell
-twin-identity proof-verify --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --data aGVsbG8gd29ybGQ= --type Ed25519 --value lrPdZ+Gfgc8w/ha2YU7hil8s+gykFHAdmIEdJdraWeRkkb8nHHF1PLKs4gGPXCT1mqBIwiwOgz5V0JKIg00UDg==
+twin-identity proof-verify --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --data aGVsbG8gd29ybGQ= --cryptosuite eddsa-jcs-2022 --value 5LVrNuqQzQxnLMxwwpkE1smcD9Zpygg3gvJ6xvwdcLGrhk4yXFW8jewGY5Z3kRMKL1dasqw6ABBCcNgUv1pngnzA
 ```

package/locales/en.json

@@ -272,9 +272,7 @@
 				"creatingProof": "Creating Proof"
 			},
 			"labels": {
-				"verificationMethodId": "Verification Method Id",
-				"type": "Proof Type",
-				"value": "Proof Value"
+				"verificationMethodId": "Verification Method Id"
 			}
 		},
 		"proof-verify": {
@@ -289,9 +287,9 @@
 					"param": "--data '<'data'>'",
 					"description": "The base64 or hex encoded data to verify the proof for, or start with ! to read environment variable."
 				},
-				"type": {
-					"param": "--type '<'type'>'",
-					"description": "The type of the proof, or start with ! to read environment variable."
+				"cryptosuite": {
+					"param": "--cryptosuite '<'cryptosuite'>'",
+					"description": "The cryptosuite of the proof, or start with ! to read environment variable."
 				},
 				"value": {
 					"param": "--value '<'value'>'",
@@ -303,7 +301,7 @@
 			},
 			"labels": {
 				"verificationMethodId": "Verification Method Id",
-				"type": "Proof Type",
+				"cryptosuite": "Proof Cryptosuite",
 				"value": "Proof Value",
 				"isVerified": "Is Verified"
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-cli",
-	"version": "0.0.1-next.12",
+	"version": "0.0.1-next.14",
 	"description": "A command line interface for interacting with the identity connectors",
 	"repository": {
 		"type": "git",
@@ -22,8 +22,8 @@
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-memory": "next",
-		"@twin.org/identity-connector-iota": "0.0.1-next.12",
-		"@twin.org/identity-models": "0.0.1-next.12",
+		"@twin.org/identity-connector-iota": "0.0.1-next.14",
+		"@twin.org/identity-models": "0.0.1-next.14",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-connector-entity-storage": "next",