Update licenseType doc and error message (#9)

OpenZeppelin · Apr 16, 2024 · fafbbaa · fafbbaa
1 parent d4c7cef
commit fafbbaa
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.0.1-alpha.6 (2024-04-16)
+
+- Update documentation and error message about supported values for `--licenseType` option. ([#9](https://github.com/OpenZeppelin/defender-deploy-client-cli/pull/9))
+
 ## 0.0.1-alpha.5 (2024-03-11)
 
 - Support private networks and forked networks. ([#7](https://github.com/OpenZeppelin/defender-deploy-client-cli/pull/7))

diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ Required options:
 
 Additional options:
   --constructorBytecode <CONSTRUCTOR_BYTECODE>  0x-prefixed ABI encoded byte string representing the constructor arguments. Required if the constructor has arguments.
-  --licenseType <LICENSE>         License type for the contract. Recommended if verifying source code. Defaults to "None".
+  --licenseType "<LICENSE>"         License type to display on block explorers for verified source code. See https://etherscan.io/contract-license-types for supported values and use the string found in brackets, e.g. "MIT"
   --verifySourceCode <true|false>  Whether to verify source code on block explorers. Defaults to true.
   --relayerId <RELAYER_ID>        Relayer ID to use for deployment. Defaults to the relayer configured for your deployment environment on Defender.
   --salt <SALT>                   Salt to use for CREATE2 deployment. Defaults to a random salt.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-deploy-client-cli",
-  "version": "0.0.1-alpha.5",
+  "version": "0.0.1-alpha.6",
   "description": "CLI for deployments using OpenZeppelin Defender SDK",
   "repository": "https://github.com/OpenZeppelin/defender-deploy-client-cli",
   "license": "MIT",

diff --git a/src/commands/deploy.ts b/src/commands/deploy.ts
@@ -17,7 +17,7 @@ Required options:
 
 Additional options:
   --constructorBytecode <CONSTRUCTOR_BYTECODE>  0x-prefixed ABI encoded byte string representing the constructor arguments. Required if the constructor has arguments.
-  --licenseType <LICENSE>         License type for the contract. Recommended if verifying source code. Defaults to "None".
+  --licenseType "<LICENSE>"         License type to display on block explorers for verified source code. See https://etherscan.io/contract-license-types for supported values and use the string found in brackets, e.g. "MIT"
   --verifySourceCode <true|false>  Whether to verify source code on block explorers. Defaults to true.
   --relayerId <RELAYER_ID>        Relayer ID to use for deployment. Defaults to the relayer configured for your deployment environment on Defender.
   --salt <SALT>                   Salt to use for CREATE2 deployment. Defaults to a random salt.

diff --git a/src/internal/deploy-contract.ts b/src/internal/deploy-contract.ts
@@ -38,7 +38,7 @@ export async function deployContract(args: FunctionArgs, client: DeployClient) {
   } catch (e: any) {
     if (e.response?.data?.message?.includes('licenseType should be equal to one of the allowed values')) {
       throw new Error(
-        `License type ${args.licenseType} is not a valid SPDX license identifier for block explorer verification. Specify a valid license type.`,
+        `The licenseType option "${args.licenseType}" is not valid for block explorer verification. See https://etherscan.io/contract-license-types for supported values and use the string found in brackets, e.g. "MIT"`,
       );
     } else {
       throw e;

diff --git a/test/deploy.js.md b/test/deploy.js.md
@@ -20,7 +20,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
     Additional options:␊
       --constructorBytecode <CONSTRUCTOR_BYTECODE>  0x-prefixed ABI encoded byte string representing the constructor arguments. Required if the constructor has arguments.␊
-      --licenseType <LICENSE>         License type for the contract. Recommended if verifying source code. Defaults to "None".␊
+      --licenseType "<LICENSE>"         License type to display on block explorers for verified source code. See https://etherscan.io/contract-license-types for supported values and use the string found in brackets, e.g. "MIT"␊
       --verifySourceCode <true|false>  Whether to verify source code on block explorers. Defaults to true.␊
       --relayerId <RELAYER_ID>        Relayer ID to use for deployment. Defaults to the relayer configured for your deployment environment on Defender.␊
       --salt <SALT>                   Salt to use for CREATE2 deployment. Defaults to a random salt.␊

diff --git a/test/deploy.js.snap b/test/deploy.js.snap