@openzeppelin/upgrades-core 1.35.1 → 1.37.0

package/src/cli/validate/validate-upgrade-safety.ts

@@ -1,3 +1,4 @@
+import path from 'path';
 import { ValidationOptions, withValidationDefaults } from '../..';
 
 import { getBuildInfoFiles } from './build-info-file';
@@ -22,10 +23,12 @@ export type SpecifiedContracts = {
  * Validates the upgrade safety of all contracts in the build info dir's build info files.
  * Only contracts that are detected as upgradeable will be validated.
  *
- * @param buildInfoDir Absolute path of build info directory, or undefined to use the default Hardhat or Foundry build-info dir.
+ * @param buildInfoDir Path of build info directory, or undefined to use the default Hardhat or Foundry build-info dir.
  * @param 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.
  * @param reference The name or fully qualified name of the reference contract to use for storage layout comparisons. Can only be used along with `contract`. If not specified, uses the `@custom:oz-upgrades-from` annotation in the contract that is being validated.
  * @param opts Validation options, or undefined to use the default validation options.
+ * @param referenceBuildInfoDirs Optional paths of additional build info directories from previous versions of the project to use for storage layout comparisons. When using this option, refer to one of these directories using prefix `<dirName>:` before the contract name or fully qualified name in the `reference` param or `@custom:oz-upgrades-from` annotation, where `<dirName>` is the directory short name. Each directory short name must be unique, including compared to the main build info directory.
+ * @param exclude Exclude validations for contracts in source file paths that match any of the given glob patterns.
  * @returns The project report.
  */
 export async function validateUpgradeSafety(
@@ -33,28 +36,57 @@ export async function validateUpgradeSafety(
   contract?: string,
   reference?: string,
   opts: ValidateUpgradeSafetyOptions = {},
+  referenceBuildInfoDirs?: string[],
+  exclude?: string[],
 ): Promise<ProjectReport> {
   const allOpts = withCliDefaults(opts);
 
   const buildInfoFiles = await getBuildInfoFiles(buildInfoDir);
   const sourceContracts = validateBuildInfoContracts(buildInfoFiles);
 
-  const specifiedContracts = findSpecifiedContracts(sourceContracts, allOpts, contract, reference);
+  const buildInfoDictionary: BuildInfoDictionary = {};
+  buildInfoDictionary[''] = sourceContracts;
+  if (buildInfoFiles.length > 0) {
+    buildInfoDictionary[buildInfoFiles[0].dirShortName] = sourceContracts;
+  }
+
+  if (referenceBuildInfoDirs !== undefined) {
+    for (const referenceBuildInfoDir of referenceBuildInfoDirs) {
+      const key = path.basename(referenceBuildInfoDir);
+
+      if (buildInfoDictionary[key] !== undefined) {
+        throw new Error(`Reference build info directory short name '${key}' is not unique.`);
+      }
+
+      const referenceBuildInfoFiles = await getBuildInfoFiles(referenceBuildInfoDir);
+      buildInfoDictionary[key] = validateBuildInfoContracts(referenceBuildInfoFiles);
+    }
+  }
 
-  const contractReports = getContractReports(sourceContracts, allOpts, specifiedContracts);
+  const specifiedContracts = findSpecifiedContracts(buildInfoDictionary, allOpts, contract, reference);
+
+  const contractReports = getContractReports(buildInfoDictionary, allOpts, specifiedContracts, exclude);
   return getProjectReport(contractReports, specifiedContracts !== undefined);
 }
 
+/**
+ * Dictionary of build info directories and the contracts they contain.
+ * Main build info directory can be found with the key '' and also with its short name.
+ */
+export interface BuildInfoDictionary {
+  [buildInfoDirName: string]: SourceContract[];
+}
+
 export function findSpecifiedContracts(
-  sourceContracts: SourceContract[],
+  buildInfoDictionary: BuildInfoDictionary,
   opts: Required<ValidateUpgradeSafetyOptions>,
   contractName?: string,
   referenceName?: string,
 ): SpecifiedContracts | undefined {
   if (contractName !== undefined) {
     return {
-      contract: findContract(contractName, undefined, sourceContracts),
-      reference: referenceName !== undefined ? findContract(referenceName, undefined, sourceContracts) : undefined,
+      contract: findContract(contractName, undefined, buildInfoDictionary, true), // only search main build info dir for the specified contract
+      reference: referenceName !== undefined ? findContract(referenceName, undefined, buildInfoDictionary) : undefined,
     };
   } else if (referenceName !== undefined) {
     throw new Error(`The reference option can only be specified when the contract option is also specified.`);

package/src/cli/validate/validations.test.ts

@@ -14,13 +14,17 @@ const test = _test as TestFn<Context>;
 const SOURCE_FILE = 'contracts/test/cli/Validate.sol';
 
 test.before(async t => {
-  const buildInfo = await artifacts.getBuildInfo(`${SOURCE_FILE}:Safe`);
+  const hardhatBuildInfo = await artifacts.getBuildInfo(`${SOURCE_FILE}:Safe`);
 
-  if (buildInfo === undefined) {
+  if (hardhatBuildInfo === undefined) {
     t.fail();
   } else {
-    const sourceContracts = validateBuildInfoContracts([buildInfo]);
-    t.context.reports = getContractReports(sourceContracts, withCliDefaults({}));
+    const buildInfoFile = {
+      ...hardhatBuildInfo,
+      dirShortName: 'build-info',
+    };
+    const sourceContracts = validateBuildInfoContracts([buildInfoFile]);
+    t.context.reports = getContractReports({ '': sourceContracts }, withCliDefaults({}));
   }
 });
 

package/src/cli/validate/validations.ts

@@ -13,6 +13,7 @@ export interface SourceContract {
   name: string;
   fullyQualifiedName: string;
   validationData: ValidationRunData;
+  buildInfoDirShortName: string;
 }
 
 export function validateBuildInfoContracts(buildInfoFiles: BuildInfoFile[]): SourceContract[] {
@@ -48,6 +49,7 @@ function addContractsFromBuildInfo(
         name: contractDef.name,
         fullyQualifiedName,
         validationData: validationData,
+        buildInfoDirShortName: buildInfoFile.dirShortName,
       });
     }
   }

package/src/cli/validate.test.ts

@@ -110,3 +110,25 @@ test('withDefaults - invalid unsafeAllow', t => {
     )}`,
   });
 });
+
+test('withDefaults - empty unsafeAllow', t => {
+  const parsedArgs = minimist(['validate', 'build-info.json', '--unsafeAllow']);
+  t.throws(() => withDefaults(parsedArgs), {
+    message: `Invalid option: --unsafeAllow cannot be empty`,
+  });
+});
+
+test('withDefaults - unsafeAllow multiple times', t => {
+  const parsedArgs = minimist([
+    'validate',
+    'build-info.json',
+    '--unsafeAllow',
+    'selfdestruct',
+    '--unsafeAllow',
+    'delegatecall',
+    '--unsafeAllow',
+    'constructor',
+  ]);
+  const opts = withDefaults(parsedArgs);
+  t.deepEqual(opts.unsafeAllow, ['selfdestruct', 'delegatecall', 'constructor']);
+});

package/src/cli/validate.ts

@@ -16,7 +16,9 @@ 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>  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. Not compatible with --unsafeSkipStorageCheck. 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(
+  --referenceBuildInfoDirs "<BUILD_INFO_DIR>[,<BUILD_INFO_DIR>...]"  Optional paths of additional build info directories from previous versions of the project to use for storage layout comparisons. When using this option, refer to one of these directories using prefix '<dirName>:' before the contract name or fully qualified name in the --reference option or @custom:oz-upgrades-from annotation, where <dirName> is the directory short name. Each directory short name must be unique, including compared to the main build info directory. If passing in multiple directories, separate them with commas or call the option multiple times, once for each directory.
+  --exclude "<GLOB_PATTERN>" [--exclude "<GLOB_PATTERN>"...]  Exclude validations for contracts in source file paths that match any of the given glob patterns. For example, --exclude "contracts/mocks/**/*.sol". Does not apply to reference contracts. If passing in multiple patterns, call the option multiple times, once for each pattern.
+  --unsafeAllow "<VALIDATION_ERROR>[,<VALIDATION_ERROR>...]"  Selectively disable one or more validation errors. Comma-separated list with one or more of the following: ${errorKinds.join(
     ', ',
   )}
   --unsafeAllowRenames  Configure storage layout check to allow variable renaming.
@@ -32,6 +34,8 @@ export async function main(args: string[]): Promise<void> {
       functionArgs.contract,
       functionArgs.reference,
       functionArgs.opts,
+      functionArgs.referenceBuildInfoDirs,
+      functionArgs.exclude,
     );
     console.log(result.explain());
     process.exitCode = result.ok ? 0 : 1;
@@ -48,7 +52,7 @@ function parseArgs(args: string[]) {
       'unsafeAllowLinkedLibraries',
       'requireReference',
     ],
-    string: ['unsafeAllow', 'contract', 'reference'],
+    string: ['unsafeAllow', 'contract', 'reference', 'referenceBuildInfoDirs', 'exclude'],
     alias: { h: 'help' },
   });
   const extraArgs = parsedArgs._;
@@ -71,6 +75,8 @@ interface FunctionArgs {
   contract?: string;
   reference?: string;
   opts: Required<ValidateUpgradeSafetyOptions>;
+  referenceBuildInfoDirs?: string[];
+  exclude?: string[];
 }
 
 /**
@@ -90,6 +96,8 @@ export function getFunctionArgs(parsedArgs: minimist.ParsedArgs, extraArgs: stri
     const contract = getAndValidateString(parsedArgs, 'contract');
     const reference = getAndValidateString(parsedArgs, 'reference');
     const opts = withDefaults(parsedArgs);
+    const referenceBuildInfoDirs = getAndValidateStringArray(parsedArgs, 'referenceBuildInfoDirs', true);
+    const exclude = getAndValidateStringArray(parsedArgs, 'exclude', false);
 
     if (contract === undefined) {
       if (reference !== undefined) {
@@ -98,18 +106,45 @@ export function getFunctionArgs(parsedArgs: minimist.ParsedArgs, extraArgs: stri
         throw new Error('The --requireReference option can only be used along with the --contract option.');
       }
     }
-    return { buildInfoDir, contract, reference, opts };
+    return { buildInfoDir, contract, reference, opts, referenceBuildInfoDirs, exclude };
   }
 }
 
 function getAndValidateString(parsedArgs: minimist.ParsedArgs, option: string): string | undefined {
   const value = parsedArgs[option];
-  if (value !== undefined && value.trim().length === 0) {
-    throw new Error(`Invalid option: --${option} cannot be empty`);
+  if (value !== undefined) {
+    assertNonEmptyString(value, option);
+  }
+  return value;
+}
+
+function getAndValidateStringArray(
+  parsedArgs: minimist.ParsedArgs,
+  option: string,
+  useCommaDelimiter: boolean,
+): string[] | undefined {
+  const value = parsedArgs[option];
+  if (value !== undefined) {
+    if (Array.isArray(value)) {
+      return value;
+    } else {
+      assertNonEmptyString(value, option);
+      if (useCommaDelimiter) {
+        return value.split(/[\s,]+/);
+      } else {
+        return [value];
+      }
+    }
   }
   return value;
 }
 
+function assertNonEmptyString(value: unknown, option: string) {
+  if (typeof value !== 'string' || value.trim().length === 0) {
+    throw new Error(`Invalid option: --${option} cannot be empty`);
+  }
+}
+
 function validateOptions(parsedArgs: minimist.ParsedArgs) {
   const invalidArgs = Object.keys(parsedArgs).filter(
     key =>
@@ -125,6 +160,8 @@ function validateOptions(parsedArgs: minimist.ParsedArgs) {
         'contract',
         'reference',
         'requireReference',
+        'referenceBuildInfoDirs',
+        'exclude',
       ].includes(key),
   );
   if (invalidArgs.length > 0) {
@@ -132,18 +169,13 @@ function validateOptions(parsedArgs: minimist.ParsedArgs) {
   }
 }
 
-function getUnsafeAllowKinds(unsafeAllow: string | undefined): ValidationError['kind'][] {
+function getUnsafeAllowKinds(parseArgs: minimist.ParsedArgs): ValidationError['kind'][] {
   type errorKindsType = (typeof errorKinds)[number];
 
-  if (unsafeAllow === undefined) {
-    return [];
-  }
-
-  const unsafeAllowTokens: string[] = unsafeAllow.split(/[\s,]+/);
+  const unsafeAllowTokens: string[] = getAndValidateStringArray(parseArgs, 'unsafeAllow', true) ?? [];
   if (unsafeAllowTokens.some(token => !errorKinds.includes(token as errorKindsType))) {
-    // This includes empty strings
     throw new Error(
-      `Invalid option: --unsafeAllow "${unsafeAllow}". Supported values for the --unsafeAllow option are: ${errorKinds.join(
+      `Invalid option: --unsafeAllow "${parseArgs['unsafeAllow']}". Supported values for the --unsafeAllow option are: ${errorKinds.join(
         ', ',
       )}`,
     );
@@ -159,7 +191,7 @@ export function withDefaults(parsedArgs: minimist.ParsedArgs): Required<Validate
     unsafeSkipStorageCheck: parsedArgs['unsafeSkipStorageCheck'],
     unsafeAllowCustomTypes: parsedArgs['unsafeAllowCustomTypes'],
     unsafeAllowLinkedLibraries: parsedArgs['unsafeAllowLinkedLibraries'],
-    unsafeAllow: getUnsafeAllowKinds(parsedArgs['unsafeAllow']),
+    unsafeAllow: getUnsafeAllowKinds(parsedArgs),
     requireReference: parsedArgs['requireReference'],
   };
 

package/src/storage/extract.ts

@@ -203,7 +203,8 @@ export function loadLayoutType(typeName: TypeName | null | undefined, layout: St
 function getRetypedRenamed(varDecl: VariableDeclaration) {
   let retypedFrom, renamedFrom;
   if ('documentation' in varDecl) {
-    const docs = typeof varDecl.documentation === 'string' ? varDecl.documentation : varDecl.documentation?.text ?? '';
+    const docs =
+      typeof varDecl.documentation === 'string' ? varDecl.documentation : (varDecl.documentation?.text ?? '');
     for (const { groups } of execall(
       /^\s*(?:@(?<title>\w+)(?::(?<tag>[a-z][a-z-]*))? )?(?<args>(?:(?!^\s@\w+)[^])*)/m,
       docs,

package/src/utils/annotations.ts

@@ -48,7 +48,7 @@ export function getAnnotationArgs(doc: string, tag: string, supportedArgs?: read
  */
 export function getDocumentation(node: Node) {
   if ('documentation' in node) {
-    return typeof node.documentation === 'string' ? node.documentation : node.documentation?.text ?? '';
+    return typeof node.documentation === 'string' ? node.documentation : (node.documentation?.text ?? '');
   } else {
     return '';
   }