@openzeppelin/upgrades-core 1.24.1 → 1.26.0

package/src/manifest.ts

@@ -5,7 +5,7 @@ import { EthereumProvider, getChainId, getHardhatMetadata, networkNames } from '
 import lockfile from 'proper-lockfile';
 import { compare as compareVersions } from 'compare-versions';
 
-import type { Deployment } from './deployment';
+import type { Deployment, RemoteDeploymentId } from './deployment';
 import type { StorageLayout } from './storage';
 import { pick } from './utils/pick';
 import { mapValues } from './utils/map-values';
@@ -18,9 +18,9 @@ const currentManifestVersion = '3.2';
 export interface ManifestData {
   manifestVersion: string;
   impls: {
-    [version in string]?: ImplDeployment;
+    [version in string]?: ImplDeployment & RemoteDeploymentId;
   };
-  proxies: ProxyDeployment[];
+  proxies: (ProxyDeployment & RemoteDeploymentId)[];
   admin?: Deployment;
 }
 
@@ -318,11 +318,14 @@ export function normalizeManifestData(input: ManifestData): ManifestData {
   };
 }
 
-function normalizeDeployment<D extends Deployment>(input: D): Deployment;
-function normalizeDeployment<D extends Deployment, K extends keyof D>(input: D, include: K[]): Deployment & Pick<D, K>;
-function normalizeDeployment<D extends Deployment, K extends keyof D>(
+function normalizeDeployment<D extends Deployment & RemoteDeploymentId>(input: D): Deployment & RemoteDeploymentId;
+function normalizeDeployment<D extends Deployment & RemoteDeploymentId, K extends keyof D>(
+  input: D,
+  include: K[],
+): Deployment & RemoteDeploymentId & Pick<D, K>;
+function normalizeDeployment<D extends Deployment & RemoteDeploymentId, K extends keyof D>(
   input: D,
   include: K[] = [],
-): Deployment & Pick<D, K> {
-  return pick(input, ['address', 'txHash', ...include]);
+): Deployment & RemoteDeploymentId & Pick<D, K> {
+  return pick(input, ['address', 'txHash', 'remoteDeploymentId', ...include]);
 }

package/src/provider.ts

@@ -127,10 +127,14 @@ export const networkNames: { [chainId in number]?: string } = Object.freeze({
   137: 'polygon',
   420: 'optimism-goerli',
   80001: 'polygon-mumbai',
+  42161: 'arbitrum-one',
+  42170: 'arbitrum-nova',
+  421613: 'arbitrum-goerli',
   43113: 'avalanche-fuji',
   43114: 'avalanche',
   42220: 'celo',
   44787: 'celo-alfajores',
+  11155111: 'sepolia',
 });
 
 export async function isDevelopmentNetwork(provider: EthereumProvider): Promise<boolean> {

package/src/usage-error.ts

@@ -42,6 +42,9 @@ export class LoadProxyUnsupportedError extends UpgradesError {
   }
 }
 
+/**
+ * @deprecated No longer used since prepareUpgrade() supports using an implementation contract as the reference address.
+ */
 export class PrepareUpgradeUnsupportedError extends UpgradesError {
   constructor(proxyOrBeaconAddress: string) {
     super(
@@ -82,6 +85,16 @@ export class ValidateUpdateRequiresKindError extends UpgradesError {
   }
 }
 
+export class PrepareUpgradeRequiresKindError extends UpgradesError {
+  constructor() {
+    super(
+      'The `kind` option must be provided',
+      () =>
+        'When preparing 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/error.ts

@@ -9,3 +9,9 @@ export class ValidationErrors extends UpgradesError {
     );
   }
 }
+
+export class ContractSourceNotFoundError extends UpgradesError {
+  constructor() {
+    super('The requested contract was not found. Make sure the source code is available for compilation');
+  }
+}

package/src/validate/index.ts

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

package/src/validate/query.ts

@@ -3,7 +3,7 @@ import { ValidationRunData, ValidationError, isOpcodeError } from './run';
 import { StorageLayout } from '../storage/layout';
 import { unlinkBytecode } from '../link-refs';
 import { ValidationOptions, processExceptions } from './overrides';
-import { ValidationErrors } from './error';
+import { ContractSourceNotFoundError, ValidationErrors } from './error';
 import { ValidationData, normalizeValidationData } from './data';
 import { ProxyDeployment } from '../manifest';
 
@@ -72,7 +72,7 @@ export function getContractNameAndRunValidation(data: ValidationData, version: V
   }
 
   if (fullContractName === undefined || runValidation === undefined) {
-    throw new Error('The requested contract was not found. Make sure the source code is available for compilation');
+    throw new ContractSourceNotFoundError();
   }
 
   return [fullContractName, runValidation];