feat: meaning proxy contract names on the chain explorers

Author: jaybuidl

contracts/deploy/utils/deployUpgradable.ts

@@ -7,29 +7,47 @@ import {
 } from "hardhat-deploy/types";
 
 // Rationale: https://github.com/kleros/kleros-v2/pull/1214#issue-1879116629
-const PROXY_OPTIONS: ProxyOptions = {
-  proxyContract: "UUPSProxy",
-  proxyArgs: ["{implementation}", "{data}"],
-  checkProxyAdmin: false, // Not relevant for UUPSProxy
-  checkABIConflict: false, // Not relevant for UUPSProxy
-  upgradeFunction: {
-    methodName: "upgradeToAndCall",
-    upgradeArgs: ["{implementation}", "{data}"],
-  },
-};
+function proxyOptions(proxyContract: string): ProxyOptions {
+  return {
+    proxyContract,
+    proxyArgs: ["{implementation}", "{data}"],
+    checkProxyAdmin: false, // Not relevant for UUPSProxy
+    checkABIConflict: false, // Not relevant for UUPSProxy
+    upgradeFunction: {
+      methodName: "upgradeToAndCall",
+      upgradeArgs: ["{implementation}", "{data}"],
+    },
+  };
+}
 
-type DeployUpgradableOptions = {
+export type DeployUpgradableOptions = {
   newImplementation?: string;
   initializer?: string;
+  proxyAlias?: string;
 } & DeployOptionsBase;
 
+/**
+ * Deploy a contract with an upgradable proxy
+ * NOTE: This function assumes the existence of a proxy contract with the name `${proxy}Proxy`, if there is none add the option `proxyAlias: "UUPSProxy"`
+ * @param deployments - The deployments extension
+ * @param proxy - The name of the proxy contract
+ * @param options - The options for the deployment
+ * @returns The deployment result
+ */
 export const deployUpgradable = async (
   deployments: DeploymentsExtension,
   proxy: string,
   options: DeployUpgradableOptions
 ): Promise<DeployResult> => {
   const { deploy } = deployments;
-  const { newImplementation, initializer, args: initializerArgs, proxy: proxyOverrides, ...otherOptions } = options;
+  const {
+    newImplementation,
+    initializer,
+    args: initializerArgs,
+    proxy: proxyOverrides,
+    proxyAlias,
+    ...otherOptions
+  } = options;
 
   const methodName = initializer ?? "initialize";
   const args = initializerArgs ?? [];
@@ -50,7 +68,7 @@ export const deployUpgradable = async (
     ...otherOptions,
     ...contract,
     proxy: {
-      ...PROXY_OPTIONS,
+      ...proxyOptions(proxyAlias ?? `${proxy}Proxy`),
       ...implementationName,
       ...((proxyOverrides as ProxyOptions) ?? {}),
       execute: {

contracts/src/proxy/KlerosProxies.sol

@@ -0,0 +1,72 @@
+//SPDX-License-Identifier: MIT
+
+pragma solidity 0.8.24;
+
+import "./UUPSProxy.sol";
+
+/// Workaround to get meaningful names for the proxy contracts
+/// Otherwise all the contracts are called `UUPSProxy` on the chain explorers
+
+contract DisputeKitClassicNeoProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract DisputeKitClassicUniversityProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract DisputeKitClassicProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract DisputeTemplateRegistryProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract EvidenceModuleProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract ForeignGatewayOnEthereumProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract HomeGatewayToEthereumProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract KlerosCoreNeoProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract KlerosCoreRulerProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract KlerosCoreUniversityProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract KlerosCoreProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract PolicyRegistryProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract RandomizerRNGProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract SortitionModuleNeoProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract SortitionModuleUniversityProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
+contract SortitionModuleProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}

contracts/src/proxy/mock/by-inheritance/UpgradedByInheritance.sol

@@ -4,8 +4,13 @@
 pragma solidity 0.8.24;
 
 import "../../UUPSProxiable.sol";
+import "../../UUPSProxy.sol";
 import "../../Initializable.sol";
 
+contract UpgradedByInheritanceV1Proxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
+
 contract UpgradedByInheritanceV1 is UUPSProxiable, Initializable {
     address public governor;
     uint256 public counter;

contracts/src/proxy/mock/by-rewrite/UpgradedByRewrite.sol

@@ -5,6 +5,11 @@ pragma solidity 0.8.24;
 
 import "../../UUPSProxiable.sol";
 import "../../Initializable.sol";
+import "../../UUPSProxy.sol";
+
+contract UpgradedByRewriteProxy is UUPSProxy {
+    constructor(address _implementation, bytes memory _data) UUPSProxy(_implementation, _data) {}
+}
 
 contract UpgradedByRewrite is UUPSProxiable, Initializable {
     //------------------------

contracts/test/proxy/index.ts

@@ -1,18 +1,18 @@
 import { expect } from "chai";
-import { log } from "console";
 import { ethers, deployments } from "hardhat";
 import { DeployResult } from "hardhat-deploy/types";
+import { HardhatEthersSigner } from "@nomicfoundation/hardhat-ethers/signers";
 import { deployUpgradable } from "../../deploy/utils/deployUpgradable";
 import { UpgradedByInheritanceV1, UpgradedByInheritanceV2 } from "../../typechain-types";
 import { UpgradedByRewrite as UpgradedByRewriteV1 } from "../../typechain-types/src/proxy/mock/by-rewrite";
 import { UpgradedByRewrite as UpgradedByRewriteV2 } from "../../typechain-types/src/proxy/mock/by-rewrite/UpgradedByRewriteV2.sol";
 
-let deployer;
-let user1;
+let deployer: HardhatEthersSigner;
+let user1: HardhatEthersSigner;
 
 let proxyDeployment: DeployResult;
-let proxy;
-let implementation;
+let proxy: any;
+let implementation: any;
 
 describe("Upgradability", async () => {
   describe("Upgradability Permissions", async () => {