Use proxy transactionHash for implementation contract abstraction in Truffle (#737)

Co-authored-by: Eric Lau <ericglau@outlook.com>

Author: llwslc

packages/plugin-truffle/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Use proxy transaction hash for implementation contract abstraction. ([#737](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/737))
+
 ## 1.17.0 (2022-09-27)
 
 - Include solc version in storage layouts in manifest files. ([#662](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/662))

packages/plugin-truffle/src/deploy-beacon-proxy.ts

@@ -82,6 +82,7 @@ export async function deployBeaconProxy(
   await manifest.addProxy(proxyDeployment);
 
   attachTo.address = proxyDeployment.address;
+  attachTo.transactionHash = proxyDeployment.txHash;
   const contract = new attachTo(proxyDeployment.address);
   contract.transactionHash = proxyDeployment.txHash;
   return contract;

packages/plugin-truffle/src/deploy-proxy.ts

@@ -71,6 +71,7 @@ export async function deployProxy(
   await manifest.addProxy(proxyDeployment);
 
   Contract.address = proxyDeployment.address;
+  Contract.transactionHash = proxyDeployment.txHash;
   const contract = new Contract(proxyDeployment.address);
   contract.transactionHash = proxyDeployment.txHash;
   return contract;

packages/plugin-truffle/src/upgrade-proxy.ts

@@ -26,13 +26,16 @@ export async function upgradeProxy(
   const upgradeTo = await getUpgrader(provider, Contract, proxyAddress);
   const { impl: nextImpl } = await deployProxyImpl(Contract, opts, proxyAddress);
   const call = encodeCall(Contract, opts.call);
-  await upgradeTo(nextImpl, call);
+  const { tx: txHash } = await upgradeTo(nextImpl, call);
 
   Contract.address = proxyAddress;
-  return new Contract(proxyAddress);
+  Contract.transactionHash = txHash;
+  const contract = new Contract(proxyAddress);
+  contract.transactionHash = txHash;
+  return contract;
 }
 
-type Upgrader = (nextImpl: string, call?: string) => Promise<void>;
+type Upgrader = (nextImpl: string, call?: string) => Promise<{ tx: string }>;
 
 async function getUpgrader(
   provider: EthereumProvider,
@@ -47,7 +50,9 @@ async function getUpgrader(
     const TransparentUpgradeableProxyFactory = getTransparentUpgradeableProxyFactory(contractTemplate);
     const proxy = new TransparentUpgradeableProxyFactory(proxyAddress);
 
-    return (nextImpl, call) => (call ? proxy.upgradeToAndCall(nextImpl, call) : proxy.upgradeTo(nextImpl));
+    return (nextImpl, call) => {
+      return call ? proxy.upgradeToAndCall(nextImpl, call) : proxy.upgradeTo(nextImpl);
+    };
   } else {
     // Admin contract: redirect upgrade call through it
     const manifest = await Manifest.forNetwork(provider);
@@ -59,8 +64,9 @@ async function getUpgrader(
       throw new Error('Proxy admin is not the one registered in the network manifest');
     }
 
-    return (nextImpl, call) =>
-      call ? admin.upgradeAndCall(proxyAddress, nextImpl, call) : admin.upgrade(proxyAddress, nextImpl);
+    return (nextImpl, call) => {
+      return call ? admin.upgradeAndCall(proxyAddress, nextImpl, call) : admin.upgrade(proxyAddress, nextImpl);
+    };
   }
 }
 

packages/plugin-truffle/src/utils/truffle.ts

@@ -18,6 +18,7 @@ export interface ContractClass {
   class_defaults: ContractClassDefaults;
   contractName: string;
   address?: string;
+  transactionHash?: string;
   networks?: {
     [id: string]: NetworkObject;
   };

packages/plugin-truffle/test/migrations/2_1_deploy_greeter_transparent.js

@@ -2,8 +2,17 @@ const Greeter = artifacts.require('Greeter');
 const GreeterV2 = artifacts.require('GreeterV2');
 
 const { deployProxy, upgradeProxy } = require('@openzeppelin/truffle-upgrades');
+const assert = require('assert');
 
 module.exports = async function (deployer) {
   const g = await deployProxy(Greeter, ['Hello Truffle'], { deployer, kind: 'transparent' });
-  await upgradeProxy(g, GreeterV2, { deployer });
+
+  assert.equal(Greeter.address, g.address);
+  assert.equal(Greeter.transactionHash, g.transactionHash);
+
+  const upgraded = await upgradeProxy(g, GreeterV2, { deployer });
+
+  assert.equal(GreeterV2.address, upgraded.address);
+  assert.equal(GreeterV2.transactionHash, upgraded.transactionHash);
+  assert.notEqual(GreeterV2.transactionHash, Greeter.transactionHash);
 };

packages/plugin-truffle/test/migrations/2_2_deploy_greeter_uups.js

@@ -2,8 +2,17 @@ const Greeter = artifacts.require('GreeterProxiable');
 const GreeterV2 = artifacts.require('GreeterV2Proxiable');
 
 const { deployProxy, upgradeProxy } = require('@openzeppelin/truffle-upgrades');
+const assert = require('assert');
 
 module.exports = async function (deployer) {
   const g = await deployProxy(Greeter, ['Hello Truffle'], { deployer, kind: 'uups' });
-  await upgradeProxy(g, GreeterV2, { deployer });
+
+  assert.equal(Greeter.address, g.address);
+  assert.equal(Greeter.transactionHash, g.transactionHash);
+
+  const upgraded = await upgradeProxy(g, GreeterV2, { deployer });
+
+  assert.equal(GreeterV2.address, upgraded.address);
+  assert.equal(GreeterV2.transactionHash, upgraded.transactionHash);
+  assert.notEqual(GreeterV2.transactionHash, Greeter.transactionHash);
 };

packages/plugin-truffle/test/migrations/2_3_deploy_greeter_beacon.js

@@ -2,9 +2,15 @@ const GreeterBeaconImpl = artifacts.require('GreeterBeaconImpl');
 const GreeterV2 = artifacts.require('GreeterV2');
 
 const { deployBeacon, deployBeaconProxy, upgradeBeacon } = require('@openzeppelin/truffle-upgrades');
+const assert = require('assert');
 
 module.exports = async function (deployer) {
   const beacon = await deployBeacon(GreeterBeaconImpl, { deployer });
-  await deployBeaconProxy(beacon, GreeterBeaconImpl, ['Hello Truffle'], { deployer });
+
+  const proxy = await deployBeaconProxy(beacon, GreeterBeaconImpl, ['Hello Truffle'], { deployer });
+
+  assert.equal(GreeterBeaconImpl.address, proxy.address);
+  assert.equal(GreeterBeaconImpl.transactionHash, proxy.transactionHash);
+
   await upgradeBeacon(beacon, GreeterV2, { deployer });
 };