@openzeppelin/upgrades-core 1.30.0 → 1.31.0

package/src/cli/validate.ts

@@ -1,9 +1,9 @@
 import minimist from 'minimist';
 
 import { ValidateUpgradeSafetyOptions, validateUpgradeSafety } from '.';
-import { withValidationDefaults } from '..';
 import { ValidationError, errorKinds } from '../validate/run';
 import debug from '../utils/debug';
+import { withCliDefaults } from './validate/validate-upgrade-safety';
 
 const USAGE = 'Usage: npx @openzeppelin/upgrades-core validate [<BUILD_INFO_DIR>] [<OPTIONS>]';
 const DETAILS = `
@@ -14,7 +14,8 @@ Arguments:
 
 Options:
   --contract <CONTRACT>  The name or fully qualified name of the contract to validate. If not specified, all upgradeable contracts in the build info directory will be validated.
-  --reference <REFERENCE_CONTRACT>  The name or fully qualified name of the reference contract to use for storage layout comparisons. Can only be used along with the --contract option. If not specified, uses the @custom:oz-upgrades-from annotation in the contract that is being validated.
+  --reference <REFERENCE_CONTRACT>  Can only be used when the --contract option is also provided. The name or fully qualified name of the reference contract to use for storage layout comparisons. If not specified, uses the @custom:oz-upgrades-from annotation if it is defined in the contract that is being validated.
+  --requireReference  Can only be used when the --contract option is also provided. If specified, requires either the --reference option to be provided or the contract to have a @custom:oz-upgrades-from annotation.
   --unsafeAllow "<VALIDATION_ERRORS>"  Selectively disable one or more validation errors. Comma-separated list with one or more of the following: ${errorKinds.join(
     ', ',
   )}
@@ -45,6 +46,7 @@ function parseArgs(args: string[]) {
       'unsafeSkipStorageCheck',
       'unsafeAllowCustomTypes',
       'unsafeAllowLinkedLibraries',
+      'requireReference',
     ],
     string: ['unsafeAllow', 'contract', 'reference'],
     alias: { h: 'help' },
@@ -87,10 +89,15 @@ export function getFunctionArgs(parsedArgs: minimist.ParsedArgs, extraArgs: stri
     const buildInfoDir = extraArgs.length === 1 ? undefined : extraArgs[1];
     const contract = getAndValidateString(parsedArgs, 'contract');
     const reference = getAndValidateString(parsedArgs, 'reference');
-    if (reference !== undefined && contract === undefined) {
-      throw new Error('The --reference option can only be used along with the --contract option.');
-    }
     const opts = withDefaults(parsedArgs);
+
+    if (contract === undefined) {
+      if (reference !== undefined) {
+        throw new Error('The --reference option can only be used along with the --contract option.');
+      } else if (opts.requireReference) {
+        throw new Error('The --requireReference option can only be used along with the --contract option.');
+      }
+    }
     return { buildInfoDir, contract, reference, opts };
   }
 }
@@ -117,6 +124,7 @@ function validateOptions(parsedArgs: minimist.ParsedArgs) {
         'unsafeAllow',
         'contract',
         'reference',
+        'requireReference',
       ].includes(key),
   );
   if (invalidArgs.length > 0) {
@@ -152,7 +160,8 @@ export function withDefaults(parsedArgs: minimist.ParsedArgs): Required<Validate
     unsafeAllowCustomTypes: parsedArgs['unsafeAllowCustomTypes'],
     unsafeAllowLinkedLibraries: parsedArgs['unsafeAllowLinkedLibraries'],
     unsafeAllow: getUnsafeAllowKinds(parsedArgs['unsafeAllow']),
+    requireReference: parsedArgs['requireReference'],
   };
 
-  return withValidationDefaults(allOpts);
+  return withCliDefaults(allOpts);
 }

package/src/index.ts

@@ -60,3 +60,4 @@ export { ValidateUpgradeSafetyOptions, validateUpgradeSafety, ProjectReport, Ref
 
 export { getUpgradeInterfaceVersion } from './upgrade-interface-version';
 export { makeNamespacedInput } from './utils/make-namespaced';
+export { isNamespaceSupported } from './storage/namespace';

package/src/storage/namespace.ts

@@ -7,6 +7,7 @@ import { getAnnotationArgs, getDocumentation, hasAnnotationTag } from '../utils/
 import { Node } from 'solidity-ast/node';
 import { CompilationContext, getTypeMembers, loadLayoutType } from './extract';
 import { UpgradesError } from '../error';
+import * as versions from 'compare-versions';
 
 /**
  * Loads a contract's namespaces and namespaced type information into the storage layout.
@@ -260,3 +261,7 @@ function findLayoutStructMember(
 function findTypeWithLabel(types: Record<string, TypeItem>, label: string) {
   return Object.values(types).find(type => type.label === label);
 }
+
+export function isNamespaceSupported(solcVersion: string) {
+  return versions.compare(solcVersion, '0.8.20', '>=');
+}

package/src/validate/run.ts

@@ -2,7 +2,6 @@ import { Node } from 'solidity-ast/node';
 import { isNodeType, findAll, ASTDereferencer, astDereferencer } from 'solidity-ast/utils';
 import type { ContractDefinition, FunctionDefinition } from 'solidity-ast';
 import debug from '../utils/debug';
-import * as versions from 'compare-versions';
 
 import { SolcOutput, SolcBytecode, SolcInput } from '../solc-api';
 import { SrcDecoder } from '../src-decoder';
@@ -14,7 +13,7 @@ import { extractStorageLayout } from '../storage/extract';
 import { StorageLayout } from '../storage/layout';
 import { getFullyQualifiedName } from '../utils/contract-name';
 import { getAnnotationArgs as getSupportedAnnotationArgs, getDocumentation } from '../utils/annotations';
-import { getStorageLocationAnnotation } from '../storage/namespace';
+import { getStorageLocationAnnotation, isNamespaceSupported } from '../storage/namespace';
 import { UpgradesError } from '../error';
 
 export type ValidationRunData = Record<string, ContractValidation>;
@@ -243,7 +242,7 @@ function checkNamespaceSolidityVersion(source: string, solcVersion?: string, sol
           () =>
             `Structs with the @custom:storage-location annotation can only be used with Solidity version 0.8.20 or higher. Pass the solcVersion parameter to the validate function, or remove the annotation if the struct is not used for namespaced storage.`,
         );
-      } else if (versions.compare(solcVersion, '0.8.20', '<')) {
+      } else if (!isNamespaceSupported(solcVersion)) {
         throw new UpgradesError(
           `${source}: Namespace annotations require Solidity version >= 0.8.20, but ${solcVersion} was used`,
           () =>