【保存版】更新可能なコントラクトを作ってみよう（なぜ可能かも理解しましょう）

こんにちは、CryptoGamesの高橋です。

クリスペの会社です。

CryptoSpells

また、CryptoMaidsのアンバサダーを務めさせていただいております。

CryptoMaids

始める前に
・秘密鍵を扱うことになります。慣れないうちは、テストアカウントで実施するようにお願いします。秘密鍵の扱いは厳重にお願いします。

０　はじめに

まず、基本的にコントラクトは変更することができませんね。

でも、バグが見つかったり、機能を追加したいなどでコントラクト（コード）を修正することができたら幅が広がりそうです。

実は、Openzeppelinのプラグインを使うことで、状態である

①state、②balance、③addressを保持したまま、コードを変えることができます！

１　Hardhatを使ってテストをしてみよう

では、実際にHardhatを使って、更新可能なコントラクトを作ってみましょう。

Hardhatの使い方が不明な場合は、こちらをご参照ください。

また、こちらのOpenZeppelinの公式ドキュメントを元に進めておりますので、コードのコピペなど、こちらをご利用ください。

Upgrading smart contracts - OpenZeppelin Docs

では進めていきましょう。

２　「deployProxy」を使ってデプロイしよう

実はdeployProxyを使ってデプロイをすることで、後にアップグレードが可能となります。

なお、アップグレードができるのは、最初にデプロイを行ったアドレスだけです。

また、内部処理としましては、「deployProxy」は次の３つをデプロイします。（大事です。）

①　実装コントラクト（Boxコントラクト）
②　ProxyAdminコントラクト
③　proxy コントラクト

３　Upgradable用のコントラクトを作る

OpeenZeppelinのコード貼り付けました。

こちらが基本となるコードとなります。

４　Hardhat-upgradesの環境設定

４ー１　インストール

下のように、インストールを行いましょう。

npm install --save-dev @openzeppelin/hardhat-upgrades

４ー２　hardhat.config.jsの設定

インストールしたhardhat-upgradesを使用するために「hardhat.config.js」で下のように設定します。

コードはこちらです。

require("@nomiclabs/hardhat-waffle");
require("@nomiclabs/hardhat-ethers");
require("@openzeppelin/hardhat-upgrades");

/** * @type import('hardhat/config').HardhatUserConfig */module.exports = { solidity: "0.8.0",};

なお、Ethers.jsとWaffleプラグインを利用するため、すでに下のコマンドも実施済みです。

npm install --save-dev @nomiclabs/hardhat-ethers ethers @nomiclabs/hardhat-waffle ethereum-waffle chai

５　デプロイ用のファイルを作る

アップグレードができるコントラクトを作るためにはデプロイ時のやり方がいつもと異なります。

下のように「deployProxy」を使います。

今回は初期化のために「store」を呼び出し、初期値として42を設定します。

hardhatとしてはこんな感じです。

６　Rinkebyでのデプロイの実施

では、Rinkebyでデプロイを行なってみましょう。
（ローカルネットワークで最終的にうまくいかなかったため。）

このようになれば成功です。

0x8033F3eb4b811F09C482eaB47b8C764b57701579

として作られたようです。

npx hardhat run scripts/deploy_upgradeable_box.js --network rinkeby

７　コントラクトに設定した値を確認する

hardhat consoleを用いて、コントラクトの中身を確認してみましょう。

npx hardhat console --network rinkeby

上のように、今回作られたコントラクトアドレスを入れています。
（皆さん自身のコントラクトアドレスを入れてください。）

box.retrieve()を行うと、第５章で設定した「42」という値が返ってきました。

８　更新用コントラクトを作成する

では、更新用のコントラクトを作ってみましょう。

内容は格納されている値に１を加える機能の追加です。

先ほどの値は「42」でしたので、これを使うことができれば、値を「43」にすることができます。

コードはこちらです。

// Increments the stored value by 1
function increment() public {
 _value = _value + 1;
emit ValueChanged(_value);
 }

９　upgradeProxyを準備する

アップグレードを行うために、「upgradeProxy」を使います。

ちなみに、「upgradeProxy」が作るトランザクションは

①　実装コントラクト（BoxV2 コントラクト）
②　proxyContractをアップデートするためにProxyAdminを呼び出す

ちなみに、ProxyAdminは「deployProxy」で作られましたね。

１０　デプロイしてみよう

コンソール画面のままの場合はCtrl + Cで抜けましょう。

抜けましたら、デプロイを行ってみましょう。

npx hardhat run scripts/upgrade_box.js --network rinkeby

１１　コントラクトが更新されたことを確認しよう

hardhat consoleを使ってコントラクトが更新されたことを確認しましょう。

更新前は+1を行う機能がありませんでした。

そのため、+1の機能を実行でき、結果を確認することができれば、コントラクトが更新されたことを確認できます。

上のように、コントラクトが更新されたことが確認できました。

１２　アップグレードの仕組みは？

ここがとても大事だと思います。

なぜ状態を保持したまま、コードの更新ができるのでしょうか？

それは、コードとステートのコントラクトが分離しているからです。

ご興味のある方は、ぜひ、公式のドキュメントも読んでみてください。

以上です。