@openzeppelin/upgrades-core 1.17.0 → 1.19.1

package/src/usage-error.ts

@@ -51,6 +51,9 @@ export class PrepareUpgradeUnsupportedError extends UpgradesError {
   }
 }
 
+/**
+ * @deprecated No longer used since forceImport() supports importing any contract.
+ */
 export class ForceImportUnsupportedError extends UpgradesError {
   constructor(proxyOrBeaconAddress: string) {
     super(
@@ -60,6 +63,25 @@ export class ForceImportUnsupportedError extends UpgradesError {
   }
 }
 
+export class NoContractImportError extends UpgradesError {
+  constructor(address: string) {
+    super(
+      `No contract at address ${address}`,
+      () => `The address could not be imported because no contract was found at the address.`,
+    );
+  }
+}
+
+export class ValidateUpdateRequiresKindError extends UpgradesError {
+  constructor() {
+    super(
+      'The `kind` option must be provided',
+      () =>
+        'When validating an upgrade from an implementation address, pass in the `kind` option for the kind of proxy that you are using.',
+    );
+  }
+}
+
 export async function assertNotProxy(provider: EthereumProvider, address: string) {
   if (await isTransparentOrUUPSProxy(provider, address)) {
     throw new UpgradesError(

package/src/validate/data.ts

@@ -1,4 +1,4 @@
-import versions from 'compare-versions';
+import * as versions from 'compare-versions';
 
 import { ValidationRunData } from './run';
 

package/src/validate/index.ts

@@ -1,5 +1,5 @@
 export { validate, ValidationRunData, ContractValidation } from './run';
-export { ValidationOptions, withValidationDefaults } from './overrides';
+export { ProxyKindOption, StandaloneValidationOptions, ValidationOptions, withValidationDefaults } from './overrides';
 export { ValidationErrors } from './error';
 export { RunValidation, ValidationLog, Validation, ValidationResult } from './compat';
 export { ValidationData, ValidationDataCurrent, isCurrentValidationData, concatRunData } from './data';

package/src/validate/overrides.ts

@@ -5,13 +5,49 @@ import { logWarning } from '../utils/log';
 // Backwards compatibility
 export { silenceWarnings } from '../utils/log';
 
-export interface ValidationOptions {
+/**
+ * Option for the kind of proxy that will be used.
+ */
+export interface ProxyKindOption {
+  /**
+   * The kind of proxy to deploy, upgrade or import, or the kind of proxy that the implementation will be used with. Defaults to `"transparent"`.
+   */
+  kind?: ProxyDeployment['kind'];
+}
+
+/**
+ * Validation options in a standalone context (without storage layout comparisons with a previous implementation).
+ */
+export interface StandaloneValidationOptions extends ProxyKindOption {
+  /**
+   * @deprecated Equivalent to including "struct-definition" and "enum-definition" in unsafeAllow. No longer necessary.
+   */
   unsafeAllowCustomTypes?: boolean;
+
+  /**
+   * @deprecated Equivalent to including `"external-library-linking"` in {@link unsafeAllow}.
+   */
   unsafeAllowLinkedLibraries?: boolean;
+
+  /**
+   * Selectively disable one or more validation errors.
+   */
+  unsafeAllow?: ValidationError['kind'][];
+}
+
+/**
+ * Validation options in the context of an upgrade (with storage layout comparisions with a previous implementation).
+ */
+export interface ValidationOptions extends StandaloneValidationOptions {
+  /**
+   * Configure storage layout check to allow variable renaming.
+   */
   unsafeAllowRenames?: boolean;
+
+  /**
+   * Upgrades the proxy or beacon without first checking for storage layout compatibility errors. This is a dangerous option meant to be used as a last resort.
+   */
   unsafeSkipStorageCheck?: boolean;
-  unsafeAllow?: ValidationError['kind'][];
-  kind?: ProxyDeployment['kind'];
 }
 
 export const ValidationErrorUnsafeMessages: Record<ValidationError['kind'], string[]> = {