@openzeppelin/upgrades-core 1.26.2 → 1.27.1

package/src/cli/validate/project-report.ts

@@ -0,0 +1,44 @@
+import { UpgradeableContractReport } from './contract-report';
+import { Report } from '../../standalone';
+
+export class ProjectReport implements Report {
+  constructor(readonly upgradeableContractReports: UpgradeableContractReport[]) {}
+
+  get ok(): boolean {
+    return this.upgradeableContractReports.every(r => r.ok);
+  }
+
+  explain(color = true): string {
+    if (this.numTotal === 0) {
+      return 'No upgradeable contracts detected.';
+    } else {
+      const lines = this.upgradeableContractReports.map(r => r.explain(color));
+      const numFailed = this.numTotal - this.numPassed;
+      const plural = numFailed === 1 ? '' : 's';
+      const status = this.ok ? 'SUCCESS' : 'FAILED';
+
+      lines.push(
+        `${status} (${this.numTotal} upgradeable contract${plural} detected, ${this.numPassed} passed, ${numFailed} failed)`,
+      );
+      return lines.join('\n\n');
+    }
+  }
+
+  /**
+   * Number of contracts that passed upgrade safety checks.
+   */
+  get numPassed(): number {
+    return this.upgradeableContractReports.filter(r => r.ok).length;
+  }
+
+  /**
+   * Total number of upgradeable contracts detected.
+   */
+  get numTotal(): number {
+    return this.upgradeableContractReports.length;
+  }
+}
+
+export function getProjectReport(upgradeableContractReports: UpgradeableContractReport[]): ProjectReport {
+  return new ProjectReport(upgradeableContractReports);
+}

package/src/cli/validate/upgradeability-assessment.ts

@@ -0,0 +1,137 @@
+import { getAnnotationArgs, getDocumentation } from '../../utils/annotations';
+import { inferInitializable, inferUUPS } from '../../validate/query';
+import { ValidateCommandError } from './error';
+import { SourceContract } from './validations';
+
+export class ReferenceContractNotFound extends Error {
+  /**
+   * The contract reference that could not be found.
+   */
+  readonly reference: string;
+
+  /**
+   * The fully qualified name of the contract that referenced the missing contract.
+   */
+  readonly origin: string;
+
+  constructor(reference: string, origin: string) {
+    super(`Could not find contract ${reference} referenced in ${origin}.`);
+    this.reference = reference;
+    this.origin = origin;
+  }
+}
+
+interface AnnotationAssessment {
+  upgradeable: boolean;
+  referenceName?: string;
+}
+
+export interface UpgradeabilityAssessment {
+  upgradeable: boolean;
+  referenceContract?: SourceContract;
+  uups?: boolean;
+}
+
+export function getUpgradeabilityAssessment(
+  contract: SourceContract,
+  allContracts: SourceContract[],
+): UpgradeabilityAssessment {
+  const fullContractName = contract.fullyQualifiedName;
+  const contractValidation = contract.validationData[fullContractName];
+
+  const isUUPS = inferUUPS(contract.validationData, fullContractName);
+
+  const annotationAssessment = getAnnotationAssessment(contract);
+  if (annotationAssessment.upgradeable) {
+    let referenceContract = undefined;
+    let isReferenceUUPS = false;
+    if (annotationAssessment.referenceName !== undefined) {
+      referenceContract = getReferenceContract(annotationAssessment.referenceName, contract, allContracts);
+      isReferenceUUPS = inferUUPS(referenceContract.validationData, referenceContract.fullyQualifiedName);
+    }
+
+    return {
+      upgradeable: true,
+      referenceContract: referenceContract,
+      uups: isReferenceUUPS || isUUPS,
+    };
+  } else {
+    const initializable = inferInitializable(contractValidation);
+    return {
+      upgradeable: initializable || isUUPS,
+      uups: isUUPS,
+    };
+  }
+}
+
+function getReferenceContract(reference: string, origin: SourceContract, allContracts: SourceContract[]) {
+  const referenceContracts = allContracts.filter(c => c.fullyQualifiedName === reference || c.name === reference);
+
+  if (referenceContracts.length > 1) {
+    throw new ValidateCommandError(
+      `Found multiple contracts with name ${reference} referenced in ${origin.fullyQualifiedName}.`,
+      () =>
+        `This may be caused by old copies of build info files. Clean and recompile your project, then run the command again with the updated files.`,
+    );
+  } else if (referenceContracts.length === 1) {
+    return referenceContracts[0];
+  } else {
+    throw new ReferenceContractNotFound(reference, origin.fullyQualifiedName);
+  }
+}
+
+function getAnnotationAssessment(contract: SourceContract): AnnotationAssessment {
+  const node = contract.node;
+
+  if ('documentation' in node) {
+    const doc = getDocumentation(node);
+
+    const tag = 'oz-upgrades';
+    const hasUpgradeAnnotation = hasAnnotationTag(doc, tag);
+    if (hasUpgradeAnnotation) {
+      getAndValidateAnnotationArgs(doc, tag, contract, 0);
+    }
+
+    const upgradesFrom = getUpgradesFrom(doc, contract);
+    if (upgradesFrom !== undefined) {
+      return {
+        upgradeable: true,
+        referenceName: upgradesFrom,
+      };
+    } else {
+      return {
+        upgradeable: hasUpgradeAnnotation,
+      };
+    }
+  } else {
+    return {
+      upgradeable: false,
+    };
+  }
+}
+
+function getAndValidateAnnotationArgs(doc: string, tag: string, contract: SourceContract, expectedLength: number) {
+  const annotationArgs = getAnnotationArgs(doc, tag, undefined);
+  if (annotationArgs.length !== expectedLength) {
+    throw new ValidateCommandError(
+      `Invalid number of arguments for @custom:${tag} annotation in contract ${contract.fullyQualifiedName}.`,
+      () => `Found ${annotationArgs.length}, expected ${expectedLength}.`,
+    );
+  }
+  return annotationArgs;
+}
+
+function hasAnnotationTag(doc: string, tag: string): boolean {
+  const regex = new RegExp(`^\\s*(@custom:${tag})(\\s|$)`, 'm');
+  return regex.test(doc);
+}
+
+function getUpgradesFrom(doc: string, contract: SourceContract): string | undefined {
+  const tag = 'oz-upgrades-from';
+  if (hasAnnotationTag(doc, tag)) {
+    const annotationArgs = getAndValidateAnnotationArgs(doc, tag, contract, 1);
+    return annotationArgs[0];
+  } else {
+    return undefined;
+  }
+}

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

@@ -0,0 +1,102 @@
+import test from 'ava';
+
+import { promises as fs } from 'fs';
+import rimrafAsync from 'rimraf';
+import util from 'util';
+import path from 'path';
+import os from 'os';
+
+import { artifacts } from 'hardhat';
+import { validateUpgradeSafety } from './validate-upgrade-safety';
+import { ReferenceContractNotFound } from './upgradeability-assessment';
+
+const rimraf = util.promisify(rimrafAsync);
+
+test.before(async () => {
+  process.chdir(await fs.mkdtemp(path.join(os.tmpdir(), 'upgrades-core-test-')));
+});
+
+test.after(async () => {
+  await rimraf(process.cwd());
+});
+
+test('validate upgrade safety', async t => {
+  const buildInfo = await artifacts.getBuildInfo(`contracts/test/cli/Validate.sol:Safe`);
+
+  await fs.mkdir('validate-upgrade-safety');
+  await fs.writeFile('validate-upgrade-safety/1.json', JSON.stringify(buildInfo));
+
+  const report = await validateUpgradeSafety('validate-upgrade-safety');
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('ambiguous upgrades-from', async t => {
+  const buildInfo = await artifacts.getBuildInfo(`contracts/test/cli/Validate.sol:Safe`);
+
+  await fs.mkdir('ambiguous-upgrades-from');
+  await fs.writeFile('ambiguous-upgrades-from/1.json', JSON.stringify(buildInfo));
+  await fs.writeFile('ambiguous-upgrades-from/2.json', JSON.stringify(buildInfo));
+
+  const error = await t.throwsAsync(validateUpgradeSafety('ambiguous-upgrades-from'));
+  t.true(error?.message.includes('Found multiple contracts with name'), error?.message);
+});
+
+test('bad upgrade from 0.8.8 to 0.8.9', async t => {
+  await fs.mkdir('bad-upgrade');
+
+  const buildInfo = await artifacts.getBuildInfo(`contracts/test/cli/Storage088.sol:Storage088`);
+  await fs.writeFile('bad-upgrade/storage088.json', JSON.stringify(buildInfo));
+
+  const buildInfo2 = await artifacts.getBuildInfo(`contracts/test/cli/Storage089.sol:Storage089`);
+  await fs.writeFile('bad-upgrade/storage089.json', JSON.stringify(buildInfo2));
+
+  const report = await validateUpgradeSafety('bad-upgrade');
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('reference contract not found', async t => {
+  const buildInfo = await artifacts.getBuildInfo(`contracts/test/cli/Storage089.sol:Storage089`);
+  await fs.mkdir('ref-not-found');
+  await fs.writeFile('ref-not-found/storage089.json', JSON.stringify(buildInfo));
+
+  const error = await t.throwsAsync(validateUpgradeSafety('ref-not-found'));
+  t.true(error instanceof ReferenceContractNotFound);
+  t.is(
+    error?.message,
+    'Could not find contract Storage088 referenced in contracts/test/cli/Storage089.sol:Storage089.',
+  );
+});
+
+test('invalid annotation args - upgrades-from', async t => {
+  const fullyQualifiedName = `contracts/test/cli/InvalidAnnotationArgsUpgradesFrom.sol:InvalidAnnotationArgsUpgradesFrom`;
+
+  const buildInfo = await artifacts.getBuildInfo(fullyQualifiedName);
+  await fs.mkdir('invalid-annotation-args-upgrades-from');
+  await fs.writeFile('invalid-annotation-args-upgrades-from/1.json', JSON.stringify(buildInfo));
+
+  const error = await t.throwsAsync(validateUpgradeSafety('invalid-annotation-args-upgrades-from'));
+  t.true(
+    error?.message.includes(
+      `Invalid number of arguments for @custom:oz-upgrades-from annotation in contract ${fullyQualifiedName}.`,
+    ),
+  );
+  t.true(error?.message.includes('Found 0, expected 1'));
+});
+
+test('invalid annotation args - upgrades', async t => {
+  const fullyQualifiedName = `contracts/test/cli/InvalidAnnotationArgsUpgrades.sol:InvalidAnnotationArgsUpgrades`;
+
+  const buildInfo = await artifacts.getBuildInfo(fullyQualifiedName);
+  await fs.mkdir('invalid-annotation-args-upgrades');
+  await fs.writeFile('invalid-annotation-args-upgrades/1.json', JSON.stringify(buildInfo));
+
+  const error = await t.throwsAsync(validateUpgradeSafety('invalid-annotation-args-upgrades'));
+  t.true(
+    error?.message.includes(
+      `Invalid number of arguments for @custom:oz-upgrades annotation in contract ${fullyQualifiedName}.`,
+    ),
+  );
+  t.true(error?.message.includes('Found 1, expected 0'));
+});

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

@@ -0,0 +1,98 @@
+# Snapshot report for `src/cli/validate/validate-upgrade-safety.test.ts`
+
+The actual snapshot is saved in `validate-upgrade-safety.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## validate upgrade safety
+
+> Snapshot 1
+
+    ` ✔  contracts/test/cli/Validate.sol:Safe␊
+    ␊
+     ✔  contracts/test/cli/Validate.sol:HasInitializer␊
+    ␊
+     ✔  contracts/test/cli/Validate.sol:HasUpgradeTo␊
+    ␊
+     ✘  contracts/test/cli/Validate.sol:HasUpgradeToConstructorUnsafe␊
+    ␊
+          contracts/test/cli/Validate.sol:33: Contract \`HasUpgradeToConstructorUnsafe\` has a constructor␊
+              Define an initializer instead␊
+              https://zpl.in/upgrades/error-001␊
+    ␊
+     ✘  contracts/test/cli/Validate.sol:MultipleUnsafe␊
+    ␊
+          contracts/test/cli/Validate.sol:53: Use of delegatecall is not allowed␊
+              https://zpl.in/upgrades/error-002␊
+          ␊
+          contracts/test/cli/Validate.sol:58: Use of delegatecall is not allowed␊
+              https://zpl.in/upgrades/error-002␊
+          ␊
+          contracts/test/cli/Validate.sol:44: Use of selfdestruct is not allowed␊
+              https://zpl.in/upgrades/error-003␊
+    ␊
+     ✘  contracts/test/cli/Validate.sol:InheritsMultipleUnsafe␊
+    ␊
+          contracts/test/cli/Validate.sol:53: Use of delegatecall is not allowed␊
+              https://zpl.in/upgrades/error-002␊
+          ␊
+          contracts/test/cli/Validate.sol:58: Use of delegatecall is not allowed␊
+              https://zpl.in/upgrades/error-002␊
+          ␊
+          contracts/test/cli/Validate.sol:44: Use of selfdestruct is not allowed␊
+              https://zpl.in/upgrades/error-003␊
+    ␊
+     ✘  contracts/test/cli/Validate.sol:UpgradesFromUUPS (upgrades from contracts/test/cli/Validate.sol:HasUpgradeTo)␊
+    ␊
+          contracts/test/cli/Validate.sol:72: Implementation is missing a public \`upgradeTo(address)\` function␊
+              Inherit UUPSUpgradeable to include this function in your contract␊
+              @openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol␊
+              https://zpl.in/upgrades/error-008␊
+    ␊
+     ✔  contracts/test/cli/Validate.sol:UpgradesFromTransparent (upgrades from contracts/test/cli/Validate.sol:HasInitializer)␊
+    ␊
+     ✘  contracts/test/cli/Validate.sol:UnsafeAndStorageLayoutErrors (upgrades from contracts/test/cli/Validate.sol:StorageV1)␊
+    ␊
+          contracts/test/cli/Validate.sol:97: Use of selfdestruct is not allowed␊
+              https://zpl.in/upgrades/error-003␊
+    ␊
+          contracts/test/cli/Validate.sol:94: Layout changed for \`__gap\` (uint256[49] -> uint256[49])␊
+            - Slot changed from 1 to 2␊
+            > Set __gap array to size 48␊
+    ␊
+     ✔  contracts/test/cli/Validate.sol:BecomesSafe (upgrades from contracts/test/cli/Validate.sol:MultipleUnsafe)␊
+    ␊
+     ✘  contracts/test/cli/Validate.sol:BecomesBadLayout (upgrades from contracts/test/cli/Validate.sol:BecomesSafe)␊
+    ␊
+          BecomesSafe: Deleted \`x\`␊
+            > Keep the variable even if unused␊
+    ␊
+     ✘  contracts/test/cli/Validate.sol:StillUnsafe (upgrades from contracts/test/cli/Validate.sol:NonUpgradeable)␊
+    ␊
+          contracts/test/cli/Validate.sol:119: Use of selfdestruct is not allowed␊
+              https://zpl.in/upgrades/error-003␊
+    ␊
+     ✔  contracts/test/cli/Validate.sol:InheritsAbstractUpgradeable␊
+    ␊
+     ✘  contracts/test/cli/Validate.sol:BothAnnotationsUnsafe (upgrades from contracts/test/cli/Validate.sol:StorageV1)␊
+    ␊
+          contracts/test/cli/Validate.sol:140: Use of selfdestruct is not allowed␊
+              https://zpl.in/upgrades/error-003␊
+    ␊
+          contracts/test/cli/Validate.sol:137: Layout changed for \`__gap\` (uint256[49] -> uint256[49])␊
+            - Slot changed from 1 to 2␊
+            > Set __gap array to size 48␊
+    ␊
+    FAILED (14 upgradeable contracts detected, 6 passed, 8 failed)`
+
+## bad upgrade from 0.8.8 to 0.8.9
+
+> Snapshot 1
+
+    ` ✘  contracts/test/cli/Storage089.sol:Storage089 (upgrades from contracts/test/cli/Storage088.sol:Storage088)␊
+    ␊
+          contracts/test/cli/Storage089.sol:9: Upgraded \`my_user_value\` to an incompatible type␊
+            - Bad upgrade from Storage088.MyUserValueType to Storage089.MyUserValueType␊
+              Different representation sizes␊
+    ␊
+    FAILED (1 upgradeable contract detected, 0 passed, 1 failed)`

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

@@ -0,0 +1,29 @@
+import { ValidationOptions } from '../..';
+
+import { getBuildInfoFiles } from './build-info-file';
+import { getContractReports } from './contract-report';
+import { ProjectReport, getProjectReport } from './project-report';
+import { validateBuildInfoContracts } from './validations';
+
+/**
+ * Validation options for upgrade safety checks.
+ */
+export type ValidateUpgradeSafetyOptions = Omit<ValidationOptions, 'kind'>;
+
+/**
+ * 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 opts Validation options, or undefined to use the default validation options.
+ * @returns The project report.
+ */
+export async function validateUpgradeSafety(
+  buildInfoDir?: string,
+  opts: ValidateUpgradeSafetyOptions = {},
+): Promise<ProjectReport> {
+  const buildInfoFiles = await getBuildInfoFiles(buildInfoDir);
+  const sourceContracts = validateBuildInfoContracts(buildInfoFiles);
+  const contractReports = getContractReports(sourceContracts, opts);
+  return getProjectReport(contractReports);
+}

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

@@ -0,0 +1,72 @@
+import _test, { ExecutionContext, TestFn } from 'ava';
+
+import { artifacts } from 'hardhat';
+import { validateBuildInfoContracts } from './validations';
+import { UpgradeableContractReport, getContractReports } from './contract-report';
+
+interface Context {
+  reports: UpgradeableContractReport[];
+}
+
+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`);
+
+  if (buildInfo === undefined) {
+    t.fail();
+  } else {
+    const sourceContracts = validateBuildInfoContracts([buildInfo]);
+    t.context.reports = getContractReports(sourceContracts, {});
+  }
+});
+
+function getReport(t: ExecutionContext<Context>, contractName: string) {
+  return t.context.reports.find(r => r.contract === `${SOURCE_FILE}:${contractName}`);
+}
+
+function assertReport(
+  t: ExecutionContext<Context>,
+  report: UpgradeableContractReport | undefined,
+  valid: boolean | undefined,
+) {
+  if (valid === undefined) {
+    t.true(report === undefined);
+  } else if (valid === true) {
+    t.true(report !== undefined);
+    t.true(report?.ok);
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    t.regex(report!.explain(), /✔/);
+  } else if (valid === false) {
+    t.true(report !== undefined);
+    t.false(report?.ok);
+    t.snapshot(report?.explain());
+  }
+}
+
+function testValid(name: string, valid: boolean | undefined) {
+  const expectationString = valid === undefined ? 'ignores' : valid ? 'accepts' : 'rejects';
+  const testName = [expectationString, name].join(' ');
+  test(testName, t => {
+    const report = getReport(t, name);
+    assertReport(t, report, valid);
+  });
+}
+
+testValid('Safe', true);
+testValid('MultipleUnsafe', false);
+testValid('NonUpgradeable', undefined);
+testValid('HasInitializer', true);
+testValid('HasUpgradeTo', true);
+testValid('HasUpgradeToConstructorUnsafe', false);
+testValid('InheritsMultipleUnsafe', false);
+testValid('UpgradesFromUUPS', false);
+testValid('UpgradesFromTransparent', true);
+testValid('UnsafeAndStorageLayoutErrors', false);
+testValid('BecomesSafe', true);
+testValid('BecomesBadLayout', false);
+testValid('StillUnsafe', false);
+testValid('AbstractUpgradeable', undefined);
+testValid('InheritsAbstractUpgradeable', true);

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

@@ -0,0 +1,87 @@
+# Snapshot report for `src/cli/validate/validations.test.ts`
+
+The actual snapshot is saved in `validations.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## rejects MultipleUnsafe
+
+> Snapshot 1
+
+    ` ✘  contracts/test/cli/Validate.sol:MultipleUnsafe␊
+    ␊
+          contracts/test/cli/Validate.sol:53: Use of delegatecall is not allowed␊
+              https://zpl.in/upgrades/error-002␊
+          ␊
+          contracts/test/cli/Validate.sol:58: Use of delegatecall is not allowed␊
+              https://zpl.in/upgrades/error-002␊
+          ␊
+          contracts/test/cli/Validate.sol:44: Use of selfdestruct is not allowed␊
+              https://zpl.in/upgrades/error-003`
+
+## rejects HasUpgradeToConstructorUnsafe
+
+> Snapshot 1
+
+    ` ✘  contracts/test/cli/Validate.sol:HasUpgradeToConstructorUnsafe␊
+    ␊
+          contracts/test/cli/Validate.sol:33: Contract \`HasUpgradeToConstructorUnsafe\` has a constructor␊
+              Define an initializer instead␊
+              https://zpl.in/upgrades/error-001`
+
+## rejects InheritsMultipleUnsafe
+
+> Snapshot 1
+
+    ` ✘  contracts/test/cli/Validate.sol:InheritsMultipleUnsafe␊
+    ␊
+          contracts/test/cli/Validate.sol:53: Use of delegatecall is not allowed␊
+              https://zpl.in/upgrades/error-002␊
+          ␊
+          contracts/test/cli/Validate.sol:58: Use of delegatecall is not allowed␊
+              https://zpl.in/upgrades/error-002␊
+          ␊
+          contracts/test/cli/Validate.sol:44: Use of selfdestruct is not allowed␊
+              https://zpl.in/upgrades/error-003`
+
+## rejects UpgradesFromUUPS
+
+> Snapshot 1
+
+    ` ✘  contracts/test/cli/Validate.sol:UpgradesFromUUPS (upgrades from contracts/test/cli/Validate.sol:HasUpgradeTo)␊
+    ␊
+          contracts/test/cli/Validate.sol:72: Implementation is missing a public \`upgradeTo(address)\` function␊
+              Inherit UUPSUpgradeable to include this function in your contract␊
+              @openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol␊
+              https://zpl.in/upgrades/error-008`
+
+## rejects UnsafeAndStorageLayoutErrors
+
+> Snapshot 1
+
+    ` ✘  contracts/test/cli/Validate.sol:UnsafeAndStorageLayoutErrors (upgrades from contracts/test/cli/Validate.sol:StorageV1)␊
+    ␊
+          contracts/test/cli/Validate.sol:97: Use of selfdestruct is not allowed␊
+              https://zpl.in/upgrades/error-003␊
+    ␊
+          contracts/test/cli/Validate.sol:94: Layout changed for \`__gap\` (uint256[49] -> uint256[49])␊
+            - Slot changed from 1 to 2␊
+            > Set __gap array to size 48`
+
+## rejects BecomesBadLayout
+
+> Snapshot 1
+
+    ` ✘  contracts/test/cli/Validate.sol:BecomesBadLayout (upgrades from contracts/test/cli/Validate.sol:BecomesSafe)␊
+    ␊
+          BecomesSafe: Deleted \`x\`␊
+            > Keep the variable even if unused`
+
+## rejects StillUnsafe
+
+> Snapshot 1
+
+    ` ✘  contracts/test/cli/Validate.sol:StillUnsafe (upgrades from contracts/test/cli/Validate.sol:NonUpgradeable)␊
+    ␊
+          contracts/test/cli/Validate.sol:119: Use of selfdestruct is not allowed␊
+              https://zpl.in/upgrades/error-003`

package/src/cli/validate/validations.ts

@@ -0,0 +1,53 @@
+import { solcInputOutputDecoder, validate, SolcOutput, SolcInput, ValidationRunData } from '../..';
+
+import debug from '../../utils/debug';
+
+import { findAll } from 'solidity-ast/utils';
+import { ContractDefinition } from 'solidity-ast';
+
+import { getFullyQualifiedName } from '../../utils/contract-name';
+import { BuildInfoFile } from './build-info-file';
+
+export interface SourceContract {
+  node: ContractDefinition;
+  name: string;
+  fullyQualifiedName: string;
+  validationData: ValidationRunData;
+}
+
+export function validateBuildInfoContracts(buildInfoFiles: BuildInfoFile[]): SourceContract[] {
+  const sourceContracts: SourceContract[] = [];
+  for (const buildInfoFile of buildInfoFiles) {
+    const validations = runValidations(buildInfoFile.input, buildInfoFile.output);
+    addContractsFromBuildInfo(buildInfoFile, validations, sourceContracts);
+  }
+  return sourceContracts;
+}
+
+function runValidations(solcInput: SolcInput, solcOutput: SolcOutput) {
+  const decodeSrc = solcInputOutputDecoder(solcInput, solcOutput);
+  const validation = validate(solcOutput, decodeSrc);
+  return validation;
+}
+
+function addContractsFromBuildInfo(
+  buildInfoFile: BuildInfoFile,
+  validationData: ValidationRunData,
+  sourceContracts: SourceContract[],
+) {
+  for (const sourcePath in buildInfoFile.output.sources) {
+    const ast = buildInfoFile.output.sources[sourcePath].ast;
+
+    for (const contractDef of findAll('ContractDefinition', ast)) {
+      const fullyQualifiedName = getFullyQualifiedName(sourcePath, contractDef.name);
+      debug('Found: ' + fullyQualifiedName);
+
+      sourceContracts.push({
+        node: contractDef,
+        name: contractDef.name,
+        fullyQualifiedName,
+        validationData: validationData,
+      });
+    }
+  }
+}