スマートコントラクトをアップグレードできるUpgradable Contractsを1からわかりやすく解説

$ mkdir proxy-pattern
$ cd proxy-pattern

$ npm i @openzeppelin/contracts @openzeppelin/contracts-upgradeable @openzeppelin/hardhat-upgrades chai dotenv hardhat hardhat-gas-reporter

$ npx hardhat

888    888                      888 888               888
888    888                      888 888               888
888    888                      888 888               888
8888888888  8888b.  888d888 .d88888 88888b.   8888b.  888888
888    888     "88b 888P"  d88" 888 888 "88b     "88b 888
888    888 .d888888 888    888  888 888  888 .d888888 888
888    888 888  888 888    Y88b 888 888  888 888  888 Y88b.
888    888 "Y888888 888     "Y88888 888  888 "Y888888  "Y888

👷 Welcome to Hardhat v2.12.5 👷‍

? What do you want to do? … 
❯ Create a JavaScript project
  Create a TypeScript project
  Create an empty hardhat.config.js
  Quit

Give Hardhat a star on Github if you're enjoying it! 💞✨

     https://github.com/NomicFoundation/hardhat

Please take a moment to complete the 2022 Solidity Survey: https://hardhat.org/solidity-survey-2022

.
├── README.md
├── contracts
│   └── Lock.sol
├── hardhat.config.js
├── node_modules
├── package-lock.json
├── package.json
├── scripts
│   └── deploy.js
└── test
    └── Lock.js

require("@nomicfoundation/hardhat-toolbox");
require('@openzeppelin/hardhat-upgrades');

require("dotenv").config();
require("hardhat-gas-reporter")

module.exports = {
  solidity: {
    version: "0.8.17",
    settings: {
      optimizer: {
        enabled: true,
        runs: 200,
      },
    },
  },
  networks: {
    hardhat: {
      blockGasLimit: 30_000_000,
    },
  },
  gasReporter: {
    enabled: true,
    currency: 'USD',
    gasPrice: 21
  }
};

$ touch contracts/TransparentLogic.sol
$ touch contracts/TransparentLogicV2.sol

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";

contract TransparentLogic is Initializable {
    address public owner;
    string public name;
    uint256 public age;

    /// @notice 一度だけ実行される関数。constructorの代わり。
    function initialize() public initializer {
        owner = msg.sender;
    }

    /// @notice プロフィール情報を更新する関数。
    /// @param _name 名前。
    /// @param _age 年齢。
    function setProfile(string memory _name, uint256 _age) external {
        name = _name;
        age = _age;
    }

    /// @notice プロフィール情報を取得する関数。
    /// @return name 名前。
    /// @return age 年齢。
    function getProfile() external view returns(string memory, uint256){
        return (name, age);
    }

}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";

contract TransparentLogicV2 is Initializable {
    address public owner;
    string public name;
    uint256 public age;
    string public favoriteFruit;


    /// @notice 一度だけ実行される関数。constructorの代わり。
    function initialize() public initializer {
        owner = msg.sender;
    }

    /// @notice プロフィール情報を更新する関数。
    /// @param _name 名前。
    /// @param _fruit 好きな果物。
    /// @param _age 年齢。
    function setProfile(
        string memory _name,
        string memory _fruit,
        uint256 _age
    ) external {
        name = _name;
        favoriteFruit = _fruit;
        age = _age;
    }

    /// @notice プロフィール情報を取得する関数。
    /// @return name 名前。
    /// @return favoriteFruit 好きな果物。
    /// @return age 年齢。
    function getProfile() external view returns(
        string memory, string memory, uint256
    ){
        return (name, favoriteFruit, age);
    }

}

$ touch test/test-transparent.js

const { expect } = require("chai");
const { ethers, upgrades } = require("hardhat");

describe("TransparentLogic", function () {
    beforeEach(async function () {
        // アドレスの作成
        [owner, wallet1, wallet2] = await ethers.getSigners();

        // TransparentLogicとTransparentLogicV2コントラクトを取得。
        transparentLogic = await ethers.getContractFactory("TransparentLogic", owner);
        transparentLogicV2 = await ethers.getContractFactory("TransparentLogicV2", owner);

        // TransparentLogicコントラクトをデプロイ。
        transparentLogicInstance = await upgrades.deployProxy(transparentLogic);
    });

    describe('test TransparentLogic', function () {
        it("Owner変数の値を確認", async function () {
            expect((await transparentLogicInstance.owner())).to.equal(owner.address);
        })

        it("setProfile関数を実行して、name: Cardene, age: 23を格納", async function () {
            await transparentLogicInstance.setProfile("Cardene", 23);
            expect((await transparentLogicInstance.name())).to.equal("Cardene");
            expect((await transparentLogicInstance.age())).to.equal(23);

        })

        it("transparentLogicV2コントラクトに更新", async function () {
            const transparentLogicV2Instance = await upgrades.upgradeProxy(
                transparentLogicInstance.address,
                transparentLogicV2
            );
        })

        it("setProfile関数を実行して、name: Cardene V2, favoriteFruit: Pear, age: 30を格納", async function () {
            await transparentLogicV2Instance.setProfile("Cardene V2", "Pear", 30);
            expect((await transparentLogicV2Instance.name())).to.equal("Cardene V2");
            expect((await transparentLogicV2Instance.age())).to.equal(30);
            expect((await transparentLogicV2Instance.favoriteFruit())).to.equal("Pear");
        })
    });
});

$ npx hardhat compile
$ npx hardhat test

Compiled 2 Solidity files successfully

  TransparentLogic
    test TransparentLogic
Owner Address: [object Promise]
      ✓ Owner変数の値を確認
Name: [object Promise]
Age: [object Promise]
      ✓ name: Cardene, age: 23の格納
Name V2: [object Promise]
Age V2: [object Promise]
Fruit V2: [object Promise]
      ✓ Upgrade Contract

·-------------------------------------|---------------------------|-------------|-----------------------------·
|        Solc version: 0.8.17         ·  Optimizer enabled: true  ·  Runs: 200  ·  Block limit: 30000000 gas  │
······································|···························|·············|······························
|  Methods                                                                                                    │
·······················|··············|·············|·············|·············|···············|··············
|  Contract            ·  Method      ·  Min        ·  Max        ·  Avg        ·  # calls      ·  usd (avg)  │
·······················|··············|·············|·············|·············|···············|··············
|  TransparentLogic    ·  setProfile  ·          -  ·          -  ·      74204  ·            1  ·          -  │
·······················|··············|·············|·············|·············|···············|··············
|  TransparentLogicV2  ·  setProfile  ·          -  ·          -  ·      97662  ·            1  ·          -  │
·······················|··············|·············|·············|·············|···············|··············
|  Deployments                        ·                                         ·  % of limit   ·             │
······································|·············|·············|·············|···············|··············
|  TransparentLogic                   ·          -  ·          -  ·     395099  ·        1.3 %  ·          -  │
······································|·············|·············|·············|···············|··············
|  TransparentLogicV2                 ·          -  ·          -  ·     459451  ·        1.5 %  ·          -  │
·-------------------------------------|-------------|-------------|-------------|---------------|-------------·

  3 passing (2s)

$ touch contracts/UUPSLogic.sol
$ touch contracts/UUPSLogicV2.sol

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";

contract UUPSLogic is Initializable, ERC20Upgradeable, UUPSUpgradeable, OwnableUpgradeable {
    string public myName;
    uint256 public myAge;

    /// @notice 一度だけ実行される関数。constructorの代わり。
    function initialize() public initializer {
        __ERC20_init("Cardene Token", "CARD");
        __Ownable_init();
        __UUPSUpgradeable_init();
        _mint(msg.sender, 1000 * 10 ** decimals());
    }

    /// @notice msg.senderがコントラクトのアプグレード許可されていない時に処理を元に戻す関数。
    /// @dev 基本的にonlyOwnerなどのアクセス修飾子をつける。
    function _authorizeUpgrade(address) internal override onlyOwner {}

    /// @notice プロフィール情報を更新する関数。
    /// @param _name 名前。
    /// @param _age 年齢。
    function setProfile(string memory _name, uint256 _age) external {
        myName = _name;
        myAge = _age;
    }

    /// @notice プロフィール情報を取得する関数。
    /// @return name 名前。
    /// @return age 年齢。
    function getProfile() external view returns(string memory, uint256){
        return (myName, myAge);
    }

}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";

contract UUPSLogicV2 is Initializable, ERC20Upgradeable, UUPSUpgradeable, OwnableUpgradeable {
    string public myName;
    uint256 public myAge;
    string public favoriteFruit;

    /// @notice 一度だけ実行される関数。constructorの代わり。
    function initialize() public initializer {
        __ERC20_init("Cardene Token", "CARD");
        __Ownable_init();
        __UUPSUpgradeable_init();
    }

    /// @notice msg.senderがコントラクトのアプグレード許可されていない時に処理を元に戻す関数。
    /// @dev 基本的にonlyOwnerなどのアクセス修飾子をつける。
    function _authorizeUpgrade(address) internal override onlyOwner {}

    /// @notice プロフィール情報を更新する関数。
    /// @param _name 名前。
    /// @param _fruit 好きな果物。
    /// @param _age 年齢。
    function setProfile(
        string memory _name,
        string memory _fruit,
        uint256 _age
    ) external {
        myName = _name;
        favoriteFruit = _fruit;
        myAge = _age;
    }

    /// @notice プロフィール情報を取得する関数。
    /// @return name 名前。
    /// @return favoriteFruit 好きな果物。
    /// @return age 年齢。
    function getProfile() external view returns(
        string memory, string memory, uint256
    ){
        return (myName, favoriteFruit, myAge);
    }

}

$ touch test/test-uups.js

const { expect } = require("chai");
const { ethers, upgrades } = require("hardhat");

describe("UUPSLogic", function () {
    beforeEach(async function () {
        // アドレスの作成
        [owner, wallet1, wallet2] = await ethers.getSigners();

        // UUPSLogicとUUPSLogicV2コントラクトを取得。
        UUPSLogic = await ethers.getContractFactory("UUPSLogic", owner);
        UUPSLogicV2 = await ethers.getContractFactory("UUPSLogicV2", owner);

        // UUPSLogicコントラクトをデプロイ。
        UUPSLogicInstance = await upgrades.deployProxy(
            UUPSLogic,
            { kind: 'uups' }
        );
    });

    describe('test UUPSLogic', function () {
        it("setProfile関数を実行して、name: Cardene, age: 23を格納", async function () {
            await UUPSLogicInstance.setProfile("Cardene", 23);
            expect((await UUPSLogicInstance.myName())).to.equal("Cardene");
            expect((await UUPSLogicInstance.myAge())).to.equal(23);

        })

        it("UUPSLogicV2コントラクトに更新", async function () {
            UUPSLogicV2Instance = await upgrades.upgradeProxy(
                UUPSLogicInstance.address,
                UUPSLogicV2
            );
        })

        it("setProfile関数を実行して、name: Cardene V2, favoriteFruit: Pear, age: 30を格納", async function () {
            await UUPSLogicV2Instance.setProfile("Cardene V2", "Pear", 30);
            expect((await UUPSLogicV2Instance.myName())).to.equal("Cardene V2");
            expect((await UUPSLogicV2Instance.myAge())).to.equal(30);
            expect((await UUPSLogicV2Instance.favoriteFruit())).to.equal("Pear");
        })
    });
});

$ npx hardhat compile
$ npx hardhat test test/test-uups.js

UUPSLogic
    test UUPSLogic
Warning: A proxy admin was previously deployed on this network

    This is not natively used with the current kind of proxy ('uups').
    Changes to the admin will have no effect on this new proxy.

      ✓ setProfile関数を実行して、name: Cardene, age: 23を格納
Warning: A proxy admin was previously deployed on this network

    This is not natively used with the current kind of proxy ('uups').
    Changes to the admin will have no effect on this new proxy.

      ✓ UUPSLogicV2コントラクトに更新
Warning: A proxy admin was previously deployed on this network

    This is not natively used with the current kind of proxy ('uups').
    Changes to the admin will have no effect on this new proxy.

      ✓ setProfile関数を実行して、name: Cardene V2, favoriteFruit: Pear, age: 30を格納

·-------------------------------------|---------------------------|-------------|-----------------------------·
|        Solc version: 0.8.17         ·  Optimizer enabled: true  ·  Runs: 200  ·  Block limit: 30000000 gas  │
······································|···························|·············|······························
|  Methods                                                                                                    │
·······················|··············|·············|·············|·············|···············|··············
|  Contract            ·  Method      ·  Min        ·  Max        ·  Avg        ·  # calls      ·  usd (avg)  │
·······················|··············|·············|·············|·············|···············|··············
|  TransparentLogic    ·  setProfile  ·          -  ·          -  ·      71934  ·            1  ·          -  │
·······················|··············|·············|·············|·············|···············|··············
|  TransparentLogicV2  ·  setProfile  ·          -  ·          -  ·      95317  ·            1  ·          -  │
·······················|··············|·············|·············|·············|···············|··············
|  UUPSLogic           ·  upgradeTo   ·          -  ·          -  ·      39160  ·            2  ·          -  │
·······················|··············|·············|·············|·············|···············|··············
|  Deployments                        ·                                         ·  % of limit   ·             │
······································|·············|·············|·············|···············|··············
|  UUPSLogic                          ·          -  ·          -  ·    1566159  ·        5.2 %  ·          -  │
······································|·············|·············|·············|···············|··············
|  UUPSLogicV2                        ·          -  ·          -  ·    1518171  ·        5.1 %  ·          -  │
·-------------------------------------|-------------|-------------|-------------|---------------|-------------·

  3 passing (2s)

$ touch contracts/BeaconLogic.sol
$ touch contracts/BeaconLogicV2.sol

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";

contract BeaconLogic is Initializable {
    address public owner;
    string public name;
    uint256 public age;

    /// @notice 一度だけ実行される関数。constructorの代わり。
    function initialize() public initializer {
        owner = msg.sender;
    }

    /// @notice プロフィール情報を更新する関数。
    /// @param _name 名前。
    /// @param _age 年齢。
    function setProfile(string memory _name, uint256 _age) external {
        name = _name;
        age = _age;
    }

    /// @notice プロフィール情報を取得する関数。
    /// @return name 名前。
    /// @return age 年齢。
    function getProfile() external view returns(string memory, uint256){
        return (name, age);
    }

}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";

contract BeaconLogicV2 is Initializable {
    address public owner;
    string public name;
    uint256 public age;
    string public favoriteFruit;


    /// @notice 一度だけ実行される関数。constructorの代わり。
    function initialize() public initializer {
        owner = msg.sender;
    }

    /// @notice プロフィール情報を更新する関数。
    /// @param _name 名前。
    /// @param _fruit 好きな果物。
    /// @param _age 年齢。
    function setProfile(
        string memory _name,
        string memory _fruit,
        uint256 _age
    ) external {
        name = _name;
        favoriteFruit = _fruit;
        age = _age;
    }

    /// @notice プロフィール情報を取得する関数。
    /// @return name 名前。
    /// @return favoriteFruit 好きな果物。
    /// @return age 年齢。
    function getProfile() external view returns(
        string memory, string memory, uint256
    ){
        return (name, favoriteFruit, age);
    }

}

$ touch test/test-beacon.js

const { expect } = require("chai");
const { ethers, upgrades } = require("hardhat");

describe("TransparentLogic", function () {
    beforeEach(async function () {
        // アドレスの作成
        [owner, wallet1, wallet2] = await ethers.getSigners();

        // BeaconLogicとBeaconLogicV2コントラクトを取得。
        beaconLogic = await ethers.getContractFactory("BeaconLogic", owner);
        beaconLogicV2 = await ethers.getContractFactory("BeaconLogicV2", owner);

        // BeaconLogicコントラクトをデプロイ。
        beaconInstance = await upgrades.deployBeacon(beaconLogic);
        beaconLogicInstance = await upgrades.deployBeaconProxy(
            beaconInstance,
            beaconLogic
        );
    });

    describe('test BeaconLogic', function () {
        it("Owner変数の値を確認", async function () {
            expect((await beaconLogicInstance.owner())).to.equal(owner.address);
        })

        it("setProfile関数を実行して、name: Cardene, age: 23を格納", async function () {
            await beaconLogicInstance.setProfile("Cardene", 23);
            expect((await beaconLogicInstance.name())).to.equal("Cardene");
            expect((await beaconLogicInstance.age())).to.equal(23);

        })

        it("transparentLogicV2コントラクトに更新", async function () {
            await upgrades.upgradeBeacon(
                beaconInstance.address,
                beaconLogicV2
            );
            beaconLogicV2Instance = beaconLogicV2.attach(beaconLogicInstance.address)
        })

        it("setProfile関数を実行して、name: Cardene V2, favoriteFruit: Pear, age: 30を格納", async function () {
            await beaconLogicV2Instance.setProfile("Cardene V2", "Pear", 30);
            expect((await beaconLogicV2Instance.name())).to.equal("Cardene V2");
            expect((await beaconLogicV2Instance.age())).to.equal(30);
            expect((await beaconLogicV2Instance.favoriteFruit())).to.equal("Pear");
        })
    });
});

$ npx hardhat compile
$ npx hardhat test test/test-beacon.js

TransparentLogic
    test BeaconLogic
Warning: A proxy admin was previously deployed on this network

    This is not natively used with the current kind of proxy ('beacon').
    Changes to the admin will have no effect on this new proxy.

      ✓ Owner変数の値を確認
Warning: A proxy admin was previously deployed on this network

    This is not natively used with the current kind of proxy ('beacon').
    Changes to the admin will have no effect on this new proxy.

      ✓ setProfile関数を実行して、name: Cardene, age: 23を格納
Warning: A proxy admin was previously deployed on this network

    This is not natively used with the current kind of proxy ('beacon').
    Changes to the admin will have no effect on this new proxy.

      ✓ transparentLogicV2コントラクトに更新
Warning: A proxy admin was previously deployed on this network

    This is not natively used with the current kind of proxy ('beacon').
    Changes to the admin will have no effect on this new proxy.

      ✓ setProfile関数を実行して、name: Cardene V2, favoriteFruit: Pear, age: 30を格納

·--------------------------------|---------------------------|-------------|-----------------------------·
|      Solc version: 0.8.17      ·  Optimizer enabled: true  ·  Runs: 200  ·  Block limit: 30000000 gas  │
·································|···························|·············|······························
|  Methods                                                                                               │
··················|··············|·············|·············|·············|···············|··············
|  Contract       ·  Method      ·  Min        ·  Max        ·  Avg        ·  # calls      ·  usd (avg)  │
··················|··············|·············|·············|·············|···············|··············
|  BeaconLogic    ·  setProfile  ·          -  ·          -  ·      77106  ·            1  ·          -  │
··················|··············|·············|·············|·············|···············|··············
|  BeaconLogicV2  ·  setProfile  ·          -  ·          -  ·     100564  ·            1  ·          -  │
··················|··············|·············|·············|·············|···············|··············
|  UUPSLogic      ·  upgradeTo   ·          -  ·          -  ·      32699  ·            1  ·          -  │
··················|··············|·············|·············|·············|···············|··············
|  Deployments                   ·                                         ·  % of limit   ·             │
·································|·············|·············|·············|···············|··············
|  BeaconLogic                   ·          -  ·          -  ·     395099  ·        1.3 %  ·          -  │
·································|·············|·············|·············|···············|··············
|  BeaconLogicV2                 ·          -  ·          -  ·     459451  ·        1.5 %  ·          -  │
·--------------------------------|-------------|-------------|-------------|---------------|-------------·

  4 passing (3s)