@openzeppelin/upgrades-core 1.25.0 → 1.26.1

package/src/impl-store.ts

@@ -1,7 +1,14 @@
 import debug from './utils/debug';
 import { Manifest, ManifestData, ImplDeployment } from './manifest';
 import { EthereumProvider, isDevelopmentNetwork } from './provider';
-import { Deployment, InvalidDeployment, resumeOrDeploy, waitAndValidateDeployment } from './deployment';
+import {
+  Deployment,
+  RemoteDeploymentId,
+  RemoteDeployment,
+  InvalidDeployment,
+  resumeOrDeploy,
+  waitAndValidateDeployment,
+} from './deployment';
 import { Version } from './version';
 import assert from 'assert';
 import { DeployOpts } from '.';
@@ -26,6 +33,7 @@ export interface ManifestField<T> {
  * @param deploy the deploy function
  * @param opts options containing the timeout and pollingInterval parameters. If undefined, assumes the timeout is not configurable and will not mention those parameters in the error message for TransactionMinedTimeout.
  * @param merge if true, adds a deployment to existing deployment by merging their addresses. Defaults to false.
+ * @param getRemoteDeployment a function to get the remote deployment status by id. If the deployment id is not found, returns undefined.
  * @returns the deployment
  * @throws {InvalidDeployment} if the deployment is invalid
  * @throws {TransactionMinedTimeout} if the transaction was not confirmed within the timeout period
@@ -36,6 +44,7 @@ async function fetchOrDeployGeneric<T extends Deployment, U extends T = T>(
   deploy: () => Promise<U>,
   opts?: DeployOpts,
   merge?: boolean,
+  getRemoteDeployment?: (remoteDeploymentId: string) => Promise<RemoteDeployment | undefined>,
 ): Promise<U | Deployment> {
   const manifest = await Manifest.forNetwork(provider);
 
@@ -51,7 +60,16 @@ async function fetchOrDeployGeneric<T extends Deployment, U extends T = T>(
       }
 
       const stored = deployment.get();
-      const updated = await resumeOrDeploy(provider, stored, deploy, lens.type, opts, deployment, merge);
+      const updated = await resumeOrDeploy(
+        provider,
+        stored,
+        deploy,
+        lens.type,
+        opts,
+        deployment,
+        merge,
+        getRemoteDeployment,
+      );
       if (updated !== stored) {
         if (merge && deployment.merge) {
           // only check primary addresses for clashes, since the address could already exist in an allAddresses field
@@ -67,7 +85,7 @@ async function fetchOrDeployGeneric<T extends Deployment, U extends T = T>(
       return updated;
     });
 
-    await waitAndValidateDeployment(provider, deployment, lens.type, opts);
+    await waitAndValidateDeployment(provider, deployment, lens.type, opts, getRemoteDeployment);
 
     return deployment;
   } catch (e) {
@@ -98,6 +116,18 @@ export function deleteDeployment(deployment: ManifestField<Deployment>) {
   deployment.set(undefined);
 }
 
+/**
+ * Fetches the deployment address from the manifest, or deploys it if not found and returns the address.
+ *
+ * @param version the contract version
+ * @param provider the Ethereum provider
+ * @param deploy the deploy function
+ * @param opts options containing the timeout and pollingInterval parameters. If undefined, assumes the timeout is not configurable and will not mention those parameters in the error message for TransactionMinedTimeout.
+ * @param merge if true, adds a deployment to existing deployment by merging their addresses. Defaults to false.
+ * @returns the deployment address
+ * @throws {InvalidDeployment} if the deployment is invalid
+ * @throws {TransactionMinedTimeout} if the transaction was not confirmed within the timeout period
+ */
 export async function fetchOrDeploy(
   version: Version,
   provider: EthereumProvider,
@@ -108,14 +138,35 @@ export async function fetchOrDeploy(
   return (await fetchOrDeployGeneric(implLens(version.linkedWithoutMetadata), provider, deploy, opts, merge)).address;
 }
 
+/**
+ * Fetches the deployment from the manifest, or deploys it if not found and returns the deployment.
+ *
+ * @param version the contract version
+ * @param provider the Ethereum provider
+ * @param deploy the deploy function
+ * @param opts options containing the timeout and pollingInterval parameters. If undefined, assumes the timeout is not configurable and will not mention those parameters in the error message for TransactionMinedTimeout.
+ * @param merge if true, adds a deployment to existing deployment by merging their addresses. Defaults to false.
+ * @param getRemoteDeployment a function to get the remote deployment status by id. If the deployment id is not found, returns undefined.
+ * @returns the deployment
+ * @throws {InvalidDeployment} if the deployment is invalid
+ * @throws {TransactionMinedTimeout} if the transaction was not confirmed within the timeout period
+ */
 export async function fetchOrDeployGetDeployment<T extends ImplDeployment>(
   version: Version,
   provider: EthereumProvider,
   deploy: () => Promise<T>,
   opts?: DeployOpts,
   merge?: boolean,
+  getRemoteDeployment?: (remoteDeploymentId: string) => Promise<RemoteDeployment | undefined>,
 ): Promise<T | Deployment> {
-  return fetchOrDeployGeneric(implLens(version.linkedWithoutMetadata), provider, deploy, opts, merge);
+  return fetchOrDeployGeneric(
+    implLens(version.linkedWithoutMetadata),
+    provider,
+    deploy,
+    opts,
+    merge,
+    getRemoteDeployment,
+  );
 }
 
 const implLens = (versionWithoutMetadata: string) =>
@@ -171,7 +222,7 @@ function lens<T>(description: string, type: string, fn: (data: ManifestData) =>
 async function checkForAddressClash(
   provider: EthereumProvider,
   data: ManifestData,
-  updated: Deployment,
+  updated: Deployment & RemoteDeploymentId,
   checkAllAddresses: boolean,
 ): Promise<void> {
   const clash = lookupDeployment(data, updated.address, checkAllAddresses);
@@ -180,11 +231,18 @@ async function checkForAddressClash(
       debug('deleting a previous deployment at address', updated.address);
       clash.set(undefined);
     } else {
-      throw new Error(
-        `The following deployment clashes with an existing one at ${updated.address}\n\n` +
-          JSON.stringify(updated, null, 2) +
-          `\n\n`,
-      );
+      const existing = clash.get();
+      // it's a clash if there is no deployment id or if deployment ids don't match
+      if (
+        existing !== undefined &&
+        (existing.remoteDeploymentId === undefined || existing.remoteDeploymentId !== updated.remoteDeploymentId)
+      ) {
+        throw new Error(
+          `The following deployment clashes with an existing one at ${updated.address}\n\n` +
+            JSON.stringify(updated, null, 2) +
+            `\n\n`,
+        );
+      }
     }
   }
 }
@@ -193,7 +251,7 @@ function lookupDeployment(
   data: ManifestData,
   address: string,
   checkAllAddresses: boolean,
-): ManifestField<Deployment> | undefined {
+): ManifestField<Deployment & RemoteDeploymentId> | undefined {
   if (data.admin?.address === address) {
     return adminLens(data);
   }

package/src/manifest.test.ts

@@ -434,6 +434,7 @@ test('normalize manifest', t => {
   const deployment = {
     address: '0x1234',
     txHash: '0x1234',
+    remoteDeploymentId: 'abc',
     kind: 'uups' as const,
     layout: { solcVersion: '0.8.9', types: {}, storage: [] },
     deployTransaction: {},

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/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];