add proxy test

Author: shunjizhan

.gitignore

@@ -74,3 +74,6 @@ lib
 ## yarn cache
 **/.yarn/cache
 **/.yarn/install-state.gz
+
+## openzeppelin cache
+**/.openzeppelin/

e2e-tests/e2e-hardhat/contracts/Echo.sol

@@ -1,4 +1,4 @@
-pragma solidity =0.8.9;
+pragma solidity =0.8.20;
 
 contract Echo{
     string public echo;

e2e-tests/e2e-hardhat/contracts/Greeter.sol

@@ -0,0 +1,22 @@
+pragma solidity =0.8.20;
+
+import "hardhat/console.sol";
+import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+
+contract Greeter is Initializable  {
+    string private greeting;
+
+    function initialize(string memory _greeting) public initializer {
+        console.log("Deploying a Greeter with greeting:", _greeting);
+        greeting = _greeting;
+    }
+
+    function greet() public view returns (string memory) {
+        return greeting;
+    }
+
+    function setGreeting(string memory _greeting) public {
+        console.log("Changing greeting from '%s' to '%s'", greeting, _greeting);
+        greeting = _greeting;
+    }
+}

e2e-tests/e2e-hardhat/contracts/GreeterV2.sol

@@ -0,0 +1,15 @@
+pragma solidity =0.8.20;
+
+import "hardhat/console.sol";
+import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+import "./Greeter.sol";
+
+contract GreeterV2 is Greeter  {
+    string private greeting;
+
+    function setGreetingV2(string memory _greeting) public {
+        string memory newGreeting = string(abi.encodePacked(_greeting, " - V2"));
+        console.log("<V2> Changing greeting from '%s' to '%s'", greeting, newGreeting);
+        setGreeting(newGreeting);
+    }
+}

e2e-tests/e2e-hardhat/contracts/HelloWorld.sol

@@ -1,4 +1,4 @@
-pragma solidity =0.8.9;
+pragma solidity =0.8.20;
 
 contract HelloWorld{
     string public helloWorld = 'Hello World!';

e2e-tests/e2e-hardhat/contracts/Token.sol

@@ -1,4 +1,4 @@
-pragma solidity =0.8.9;
+pragma solidity =0.8.20;
 
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 

e2e-tests/e2e-hardhat/hardhat.config.ts

@@ -1,8 +1,9 @@
 import '@nomicfoundation/hardhat-toolbox';
+import '@openzeppelin/hardhat-upgrades';
 import { HardhatUserConfig } from 'hardhat/config';
 
 const config: HardhatUserConfig = {
-  solidity: '0.8.9',
+  solidity: '0.8.20',
   networks: {
     acalaFork: {
       chainId: 787,

e2e-tests/e2e-hardhat/package.json

@@ -7,7 +7,7 @@
   "scripts": {
     "build": "hardhat compile",
     "lint": "eslint .",
-    "clean": "rm -rf artifacts/ cache/ typechain-types/",
+    "clean": "rm -rf artifacts/ cache/ typechain-types/ .openzeppelin/",
     "test": "hardhat test",
     "test:acalaFork": "hardhat test --network acalaFork"
   },
@@ -18,6 +18,8 @@
     "@nomicfoundation/hardhat-toolbox": "^4.0.0",
     "@nomicfoundation/hardhat-verify": "^2.0.0",
     "@openzeppelin/contracts": "^4.9.0",
+    "@openzeppelin/contracts-upgradeable": "5.0.1",
+    "@openzeppelin/hardhat-upgrades": "3.0.0",
     "@typechain/ethers-v6": "^0.5.0",
     "@typechain/hardhat": "^9.0.0",
     "@types/chai": "^4.2.0",

e2e-tests/e2e-hardhat/test/upgradeable-greeter.ts

@@ -0,0 +1,73 @@
+import { ethers, upgrades } from 'hardhat';
+import { expect } from 'chai';
+import { getImplementationAddress } from '@openzeppelin/upgrades-core';
+
+import { Greeter, GreeterV2, GreeterV2__factory, Greeter__factory } from '../typechain-types';
+
+describe('UpgradeableGreeter contract', () => {
+  let greeterFactory: Greeter__factory;
+  let greeterV2Factory: GreeterV2__factory;
+  let instance: Greeter;
+  let instanceV2: GreeterV2;
+  let proxyAddr: string;
+  let implAddrV1: string;
+
+  const msg0 = 'Hello, Goku!';
+  const msg1 = 'Hello, Kakarot!';
+  const msg2 = 'Hello, Vegeta!';
+
+  before(async () => {
+    console.log('deploying greater V1 and proxy ..');
+    greeterFactory = await ethers.getContractFactory('Greeter');
+    instance = await upgrades.deployProxy(greeterFactory, [msg0]) as unknown as Greeter;
+    await instance.waitForDeployment();
+
+    proxyAddr = await instance.getAddress();
+    implAddrV1 = await getImplementationAddress(ethers.provider, proxyAddr);
+    console.log('proxy with greeter v1 deployed at', proxyAddr);
+    console.log('implementation address', implAddrV1);
+  });
+
+  describe('Deployment', () => {
+    it('should return the greeting set at deployment', async () => {
+      expect(await instance.greet()).to.equal(msg0);
+    });
+
+    it('should return a new greeting when one is set', async () => {
+      await (await instance.setGreeting(msg1)).wait();
+      expect(await instance.greet()).to.equal(msg1);
+    });
+  });
+
+  describe('Upgrade', () => {
+    before(async () => {
+      console.log('upgrading to greeter V2 ...');
+      greeterV2Factory = await ethers.getContractFactory('GreeterV2');
+      instanceV2 = await upgrades.upgradeProxy(await instance.getAddress(), greeterV2Factory) as unknown as GreeterV2;
+
+      let implAddrV2 = await getImplementationAddress(ethers.provider, proxyAddr);
+      while (implAddrV2 === implAddrV1) {
+        // there is no better way to check if the upgrade is done?
+        console.log('still waiting for upgrade confirmation ...');
+        await new Promise(resolve => setTimeout(resolve, 1000));
+        implAddrV2 = await getImplementationAddress(ethers.provider, proxyAddr);
+      }
+      console.log('proxy with greeter V2 upgraded at', await instanceV2.getAddress());
+      console.log('implementation address V2: ', implAddrV2);
+    });
+
+    it('should maintain the greeting after the upgrade', async () => {
+      expect(await instanceV2.greet()).to.equal(msg1);
+    });
+
+    it('should maintain the original method', async () => {
+      await (await instanceV2.setGreeting(msg2)).wait();
+      expect(await instanceV2.greet()).to.equal(msg2);
+    });
+
+    it('should add a new method', async () => {
+      await (await instanceV2.setGreetingV2(msg2)).wait();
+      expect(await instanceV2.greet()).to.equal(`${msg2} - V2`);
+    });
+  });
+});