OpenZeppelin · ericglau · Jan 13, 2025 · Jan 13, 2025 · Jan 13, 2025 · Jan 13, 2025
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.0.1-alpha.10 (2025-01-13)
+
+- Update Defender SDK to v2.1.0, enable internal `origin` option for Defender deployments.
+- **Breaking changes:**
+  - Requires Node 18 or higher.
+
 ## 0.0.1-alpha.9 (2024-09-16)
 
 - Fix packaging. ([#15](https://github.com/OpenZeppelin/defender-deploy-client-cli/pull/15))

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 zOS Global Limited
+Copyright (c) 2023-2025 Zeppelin Group Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ Run 'npx @openzeppelin/defender-deploy-client-cli <COMMAND> --help' for more inf
 
 ### Deploying a contract
 ```
-npx @openzeppelin/defender-deploy-client-cli deploy --contractName <CONTRACT_NAME> --contractPath <CONTRACT_PATH> --chainId <CHAIN_ID> --buildInfoFile <BUILD_INFO_FILE_PATH> [--constructorBytecode <CONSTRUCTOR_ARGS>] [--licenseType '<LICENSE>'] [--verifySourceCode <true|false>] [--relayerId <RELAYER_ID>] [--salt <SALT>] [--createFactoryAddress <CREATE_FACTORY_ADDRESS>] [--gasLimit <GAS_LIMIT>] [--gasPrice <GAS_PRICE>] [--maxFeePerGas <MAX_FEE_PER_GAS>] [--maxPriorityFeePerGas <MAX_PRIORITY_FEE_PER_GAS>] [--metadata '<METADATA>']
+npx @openzeppelin/defender-deploy-client-cli deploy --contractName <CONTRACT_NAME> --contractPath <CONTRACT_PATH> --chainId <CHAIN_ID> --buildInfoFile <BUILD_INFO_FILE_PATH> [--constructorBytecode <CONSTRUCTOR_ARGS>] [--licenseType '<LICENSE>'] [--verifySourceCode <true|false>] [--relayerId <RELAYER_ID>] [--salt <SALT>] [--createFactoryAddress <CREATE_FACTORY_ADDRESS>] [--gasLimit <GAS_LIMIT>] [--gasPrice <GAS_PRICE>] [--maxFeePerGas <MAX_FEE_PER_GAS>] [--maxPriorityFeePerGas <MAX_PRIORITY_FEE_PER_GAS>] [--metadata '<METADATA>'] [--origin '<ORIGIN>']
 
 Deploys a contract using OpenZeppelin Defender.
 
@@ -69,7 +69,7 @@ Additional options:
   --maxFeePerGas <MAX_FEE_PER_GAS>  Maximum total fee per gas, in wei.
   --maxPriorityFeePerGas <MAX_PRIORITY_FEE_PER_GAS>  Maximum priority fee per gas, in wei.
   --metadata '<METADATA>'         Use this to identify, tag, or classify deployments. See https://docs.openzeppelin.com/defender/module/deploy#metadata. Must be a JSON string, for example: --metadata '{ "commitHash": "4ae3e0d", "tag": "v1.0.0", "anyOtherField": "anyValue" }'
-
+  --origin <ORIGIN>               The client that made the deployment. For internal use only. Only 'Foundry' or 'SDK' are supported. Defaults to 'SDK'.
 ```
 
 ### Proposing an upgrade

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-deploy-client-cli",
-  "version": "0.0.1-alpha.9",
+  "version": "0.0.1-alpha.10",
   "description": "CLI for deployments using OpenZeppelin Defender SDK",
   "repository": "https://github.com/OpenZeppelin/defender-deploy-client-cli",
   "license": "MIT",
@@ -19,7 +19,7 @@
     "defender-deploy-client-cli": "./dist/cli.js"
   },
   "devDependencies": {
-    "@types/node": "^16.11.7",
+    "@types/node": "^18.0.0",
     "@types/minimist": "^1.2.5",
     "ava": "^6.0.0",
     "rimraf": "^5.0.0",
@@ -28,9 +28,9 @@
   },
   "dependencies": {
     "minimist": "^1.2.8",
-    "@openzeppelin/defender-sdk-deploy-client": "^1.14.4",
-    "@openzeppelin/defender-sdk-base-client": "^1.14.4",
-    "@openzeppelin/defender-sdk-network-client": "^1.14.4",
+    "@openzeppelin/defender-sdk-deploy-client": "^2.1.0",
+    "@openzeppelin/defender-sdk-base-client": "^2.1.0",
+    "@openzeppelin/defender-sdk-network-client": "^2.1.0",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/src/commands/deploy.ts b/src/commands/deploy.ts
@@ -2,10 +2,10 @@ import minimist from 'minimist';
 import { FunctionArgs, deployContract } from '../internal/deploy-contract';
 import { getDeployClient } from '../internal/client';
 import { USAGE_COMMAND_PREFIX, getAndValidateString, getNetwork } from '../internal/utils';
-import { DeployClient, DeployMetadata, TxOverrides } from '@openzeppelin/defender-sdk-deploy-client';
+import { DeployClient, DeploymentResponse, DeployMetadata, TxOverrides } from '@openzeppelin/defender-sdk-deploy-client';
 import { NetworkClient } from '@openzeppelin/defender-sdk-network-client';
 
-const USAGE = `${USAGE_COMMAND_PREFIX} deploy --contractName <CONTRACT_NAME> --contractPath <CONTRACT_PATH> --chainId <CHAIN_ID> --buildInfoFile <BUILD_INFO_FILE_PATH> [--constructorBytecode <CONSTRUCTOR_ARGS>] [--licenseType <LICENSE>] [--verifySourceCode <true|false>] [--relayerId <RELAYER_ID>] [--salt <SALT>] [--createFactoryAddress <CREATE_FACTORY_ADDRESS>] [--gasLimit <GAS_LIMIT>] [--gasPrice <GAS_PRICE>] [--maxFeePerGas <MAX_FEE_PER_GAS>] [--maxPriorityFeePerGas <MAX_PRIORITY_FEE_PER_GAS>] [--metadata <METADATA>]`;
+const USAGE = `${USAGE_COMMAND_PREFIX} deploy --contractName <CONTRACT_NAME> --contractPath <CONTRACT_PATH> --chainId <CHAIN_ID> --buildInfoFile <BUILD_INFO_FILE_PATH> [--constructorBytecode <CONSTRUCTOR_ARGS>] [--licenseType <LICENSE>] [--verifySourceCode <true|false>] [--relayerId <RELAYER_ID>] [--salt <SALT>] [--createFactoryAddress <CREATE_FACTORY_ADDRESS>] [--gasLimit <GAS_LIMIT>] [--gasPrice <GAS_PRICE>] [--maxFeePerGas <MAX_FEE_PER_GAS>] [--maxPriorityFeePerGas <MAX_PRIORITY_FEE_PER_GAS>] [--metadata <METADATA>] [--origin <ORIGIN>]`;
 const DETAILS = `
 Deploys a contract using OpenZeppelin Defender.
 
@@ -27,6 +27,7 @@ Additional options:
   --maxFeePerGas <MAX_FEE_PER_GAS>  Maximum total fee per gas, in wei.
   --maxPriorityFeePerGas <MAX_PRIORITY_FEE_PER_GAS>  Maximum priority fee per gas, in wei.
   --metadata '<METADATA>'         Use this to identify, tag, or classify deployments. See https://docs.openzeppelin.com/defender/module/deploy#metadata. Must be a JSON string, for example: --metadata '{ "commitHash": "4ae3e0d", "tag": "v1.0.0", "anyOtherField": "anyValue" }'
+  --origin <ORIGIN>               The client that made the deployment. For internal use only. Only 'Foundry' or 'SDK' are supported. Defaults to 'SDK'.
 `;
 
 export async function deploy(args: string[], deployClient?: DeployClient, networkClient?: NetworkClient): Promise<void> {
@@ -47,7 +48,7 @@ function parseArgs(args: string[]) {
       'help',
       'verifySourceCode',
     ],
-    string: ['contractName', 'contractPath', 'chainId', 'buildInfoFile', 'licenseType', 'constructorBytecode', 'relayerId', 'salt', 'createFactoryAddress', 'gasLimit', 'gasPrice', 'maxFeePerGas', 'maxPriorityFeePerGas', 'metadata'],
+    string: ['contractName', 'contractPath', 'chainId', 'buildInfoFile', 'licenseType', 'constructorBytecode', 'relayerId', 'salt', 'createFactoryAddress', 'gasLimit', 'gasPrice', 'maxFeePerGas', 'maxPriorityFeePerGas', 'metadata', 'origin'],
 
     alias: { h: 'help' },
     default: { verifySourceCode: true },
@@ -100,10 +101,11 @@ async function getFunctionArgs(parsedArgs: minimist.ParsedArgs, extraArgs: strin
     };
 
     const metadata = getAndValidateJsonString(parsedArgs, 'metadata');
+    const origin = getAndValidateOrigin(parsedArgs, 'origin');
 
     checkInvalidArgs(parsedArgs);
 
-    return { contractName, contractPath, network, buildInfoFile, licenseType, constructorBytecode, verifySourceCode, relayerId, salt, createFactoryAddress, txOverrides, metadata };
+    return { contractName, contractPath, network, buildInfoFile, licenseType, constructorBytecode, verifySourceCode, relayerId, salt, createFactoryAddress, txOverrides, metadata, origin };
   }
 }
 
@@ -129,6 +131,7 @@ function checkInvalidArgs(parsedArgs: minimist.ParsedArgs) {
         'maxFeePerGas',
         'maxPriorityFeePerGas',
         'metadata',
+        'origin',
       ].includes(key),
   );
   if (invalidArgs.length > 0) {
@@ -168,4 +171,17 @@ function getAndValidateJsonString(parsedArgs: minimist.ParsedArgs, option: strin
   } else {
     return undefined;
   }
+}
+
+function getAndValidateOrigin(parsedArgs: minimist.ParsedArgs, option: string): DeploymentResponse['origin'] | undefined {
+  const value = getAndValidateString(parsedArgs, option);
+  const supportedOrigins: DeploymentResponse['origin'][] = ['Foundry', 'SDK'];
+  if (value !== undefined) {
+    if (!supportedOrigins.includes(value as DeploymentResponse['origin'])) {
+      throw new Error(`Option --${option} only supports 'Foundry' or 'SDK'`);
+    }
+    return value as DeploymentResponse['origin'];
+  } else {
+    return undefined;
+  }
 }
diff --git a/src/internal/deploy-contract.ts b/src/internal/deploy-contract.ts
@@ -16,6 +16,7 @@ export interface FunctionArgs {
   createFactoryAddress?: string;
   txOverrides?: TxOverrides;
   metadata?: DeployMetadata;
+  origin?: DeployContractRequest['origin'];
 }
 
 export async function deployContract(args: FunctionArgs, client: DeployClient) {
@@ -34,6 +35,7 @@ export async function deployContract(args: FunctionArgs, client: DeployClient) {
     createFactoryAddress: args.createFactoryAddress,
     txOverrides: args.txOverrides,
     metadata: args.metadata,
+    origin: args.origin,
   };
 
   let deployment: DeploymentResponse;

diff --git a/test/cli.js.snap b/test/cli.js.snap
diff --git a/test/deploy.js b/test/deploy.js
@@ -82,6 +82,7 @@ test('deploy required args', async t => {
       maxPriorityFeePerGas: undefined
     },
     metadata: undefined,
+    origin: undefined,
   });
 });
 
@@ -102,6 +103,7 @@ test('deploy all args', async t => {
       '--maxFeePerGas', '2000000000', // 2 gwei
       '--maxPriorityFeePerGas', '500000000', // 0.5 gwei
       '--metadata', '{ "commitHash": "4ae3e0d", "tag": "v1.0.0", "anyOtherField": "anyValue" }',
+      '--origin', 'Foundry',
     ];
 
   await deploy(args, t.context.fakeDeployClient, t.context.fakeNetworkClient);
@@ -129,7 +131,8 @@ test('deploy all args', async t => {
       commitHash: '4ae3e0d',
       tag: 'v1.0.0',
       anyOtherField: 'anyValue',
-    }
+    },
+    origin: 'Foundry',
   });
 });
 

diff --git a/test/deploy.js.md b/test/deploy.js.md
@@ -8,7 +8,7 @@ Generated by [AVA](https://avajs.dev).
 
 > Snapshot 1
 
-    `Usage: npx @openzeppelin/defender-deploy-client-cli deploy --contractName <CONTRACT_NAME> --contractPath <CONTRACT_PATH> --chainId <CHAIN_ID> --buildInfoFile <BUILD_INFO_FILE_PATH> [--constructorBytecode <CONSTRUCTOR_ARGS>] [--licenseType <LICENSE>] [--verifySourceCode <true|false>] [--relayerId <RELAYER_ID>] [--salt <SALT>] [--createFactoryAddress <CREATE_FACTORY_ADDRESS>] [--gasLimit <GAS_LIMIT>] [--gasPrice <GAS_PRICE>] [--maxFeePerGas <MAX_FEE_PER_GAS>] [--maxPriorityFeePerGas <MAX_PRIORITY_FEE_PER_GAS>] [--metadata <METADATA>]␊
+    `Usage: npx @openzeppelin/defender-deploy-client-cli deploy --contractName <CONTRACT_NAME> --contractPath <CONTRACT_PATH> --chainId <CHAIN_ID> --buildInfoFile <BUILD_INFO_FILE_PATH> [--constructorBytecode <CONSTRUCTOR_ARGS>] [--licenseType <LICENSE>] [--verifySourceCode <true|false>] [--relayerId <RELAYER_ID>] [--salt <SALT>] [--createFactoryAddress <CREATE_FACTORY_ADDRESS>] [--gasLimit <GAS_LIMIT>] [--gasPrice <GAS_PRICE>] [--maxFeePerGas <MAX_FEE_PER_GAS>] [--maxPriorityFeePerGas <MAX_PRIORITY_FEE_PER_GAS>] [--metadata <METADATA>] [--origin <ORIGIN>]␊
     ␊
     Deploys a contract using OpenZeppelin Defender.␊
     ␊
@@ -30,5 +30,6 @@ Generated by [AVA](https://avajs.dev).
       --maxFeePerGas <MAX_FEE_PER_GAS>  Maximum total fee per gas, in wei.␊
       --maxPriorityFeePerGas <MAX_PRIORITY_FEE_PER_GAS>  Maximum priority fee per gas, in wei.␊
       --metadata '<METADATA>'         Use this to identify, tag, or classify deployments. See https://docs.openzeppelin.com/defender/module/deploy#metadata. Must be a JSON string, for example: --metadata '{ "commitHash": "4ae3e0d", "tag": "v1.0.0", "anyOtherField": "anyValue" }'␊
+      --origin <ORIGIN>               The client that made the deployment. For internal use only. Only 'Foundry' or 'SDK' are supported. Defaults to 'SDK'.␊
     ␊
     `
diff --git a/test/deploy.js.snap b/test/deploy.js.snap
diff --git a/test/get-approval-process.js.snap b/test/get-approval-process.js.snap
diff --git a/test/propose-upgrade.js.snap b/test/propose-upgrade.js.snap