スマートコントラクトのアップグレードを理解しよう！

# はじめに

初めまして。
**CryptoGames**というブロックチェーンゲーム企業でエンジニアをしている **cardene（かるでね）** です！
スマートコントラクトを書いたり、フロントエンド・バックエンド・インフラと幅広く触れています。

https://cryptogames.co.jp/

代表的なゲームは**クリプトスペルズ**というブロックチェーンゲームです。

https://cryptospells.jp/

今回はスマートコントラクトのアップグレードについて解説していきます。
以下の勉強会で使用したスライドをもとに解説していきます。

https://cryptogames.connpass.com/event/277513/

https://speakerdeck.com/cardene/upgradable-contractnituitewakariyasukujie-shuo

勉強会の動画もあります。

https://www.youtube.com/watch?v=UcpXz7hKxrk

また、より詳しいことは以下の記事にまとめています。

https://chaldene.net/upgradable-contracts

前置きは早々に早速中身を見ていきましょう！

# コントラクトのアップグレードとは？

## コントラクトは更新できないのではないか？

![7.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/087b5563-d7ce-e257-294b-b3b08cf2ecdd.png)

「**コントラクトはアップデートできない。**」
このように聞いたことはあると思います。
ではコントラクトをアップグレードするとはどういうことでしょうか？

![8.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/db6c0ef5-58af-8eb1-e695-666bbb09fbfc.png)

先ほど言ったことは真実で、コントラクト自体を編集してアップグレードすることはできません。
ここで言っているアップグレードとは、「**コントラクトを新しいコントラクトに置き換える**」ということです。
つまり、1つのコントラクトを編集して新しい状態にするのではなく、新たにコントラクトを作成してそちらを使用するということです。

## アップグレードする具体的な場面

![9.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/c55f293c-041b-fa93-105b-59c817eee806.png)

ではアップグレードする場面としてはどのような場面があるでしょうか？
今回は具体例をもとに説明していきます。
例えば資金を入出金できるコントラクトがあるとします。
実はこのコントラクトには脆弱性がありますが、ユーザーや運営はそれを知らずコントラクトを使用してしまいます。
ある日、運営が脆弱性に気付きます。
しかし、コントラクトをアップグレードできない状態だと、ハッカーに資金を抜かれ放題になってしまいます。

![10.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/e818a02f-a722-890d-7e8d-2193f58d19bf.png)

ここでコントラクトのアップグレードが役立ちます。
コントラクトをアップグレードすることで、脆弱性を修正することができ資金を抜かれる心配がなくなります。

## CEIパターン

![11.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/502c77c1-5a02-527c-baa4-817306b9bb94.png)

ここでちょっとした補足なのですが、先ほどのコントラクトの脆弱性は「**CEIパターン**」に沿っていないことが原因となっています（小さくて読みにくいですが画像内のコントラクトはちゃんと脆弱性がある状態になっています）。

資金を引き出す処理をもとに「**CEIパターン**」を説明します。

### Check
まずは「**Check**」、確認をする必要があります。
- 引き出せる資金はいくらか？
- 資金を預け入れているアドレスか？

上記のような確認をまずは行います。

### Effect

次に「**Effect**」、データの書き換えを行います。
実際の処理を行う前にコントラクト内のデータを書き換えることが大切です。

### Interaction

次に「**Interaction**」、具体的な処理を実行します。

### CEIパターンに従わないとどうなる？

では「**CEIパターン**」に従わないとどうなるのでしょうか？
例えば「Check→Interaction→Effect」の順に実行するとします。
「条件を確認→資金を送金→データを書き換える」
一見良さそうですが、資金を送金した後に処理がそこで終わってしまったらどうでしょうか？
データが書きかわらないため、再び資金を引き出すことができてしまいます。
これが「**リエントランシー攻撃**」と言われる有名な攻撃手法です。

リエントランシー攻撃については以下の記事で詳しく説明しています。

https://chaldene.net/solidity-reentrancy-attack

## コントラクトをアップグレードできるメリット・デメリット

コントラクトをアップグレードすることはもちろんメリットもありますが、デメリットも存在します。

### メリット

![12.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/0f71eb0b-f80f-7a3b-f325-f2a270c8f229.png)

メリットは上記4点が挙げられます。

**機能追加**
新機能の追加を行いたい時に役立ちます。

**ユーザーからの信頼性**
脆弱性があっても修正ができる状態ということで、ユーザーからの信頼性が高まります。

**脆弱性の修正**
先ほども説明しましたが、何かしら脆弱性があるときに修正できます。

**コントラクトに長期的価値を与える**
Web3という業界は進展が早いです。
そのため新しい技術がどんどん出てくるため、コントラクトをアップグレードできる状態にしておくと新技術の実装をすることができるようになります。
これによりコントラクトが古くならず長期的に使用できるようになります。

![13.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/8e693492-aa40-f648-eec2-1df0f0222499.png)

次にデメリットについて説明します。

デメリットは画像内の4点が挙げられます。

**セキュリティリスク**
コントラクトをアップグレードすることにより脆弱性が生まれる危険性ももちろんあります。
そのためアップグレードした際は監査に出したりして、脆弱性がないかチェックをしっかりする必要があります。

**ガス代向上**
コントラクトをアップグレードすることにより、以前と同じ機能部分のコード量が増えることがあります。
そのため若干ですがガス代が向上する可能性があります。

**信頼性の低下**
先ほどメリットでは信頼性が向上すると述べましたが、逆に信頼性が低下する可能性もあります。
理由としては、運営が好きなようにコントラクトを変更できてしまうからです。
こっそり運営にメリットを与えるようにコントラクトを変更できてしまいます（有名なプロジェクトであればすぐバレると思いますが...）。

**互換性の問題**
新しいコントラクトにしたことで、以前のコントラクト互換性がなくなると使用するユーザーやそのコントラクトを使用しているエンジニアが混乱する可能性があります。
そのため互換性は意識しておくことが大切です。

# ストレージスロット

この部分では、コントラクト内のストレージスロットの説明をしていきます。
と思ったのですが、以下の記事でより詳しく説明しているため参考にしていただけると嬉しいです！

https://chaldene.net/solidity-private-data#st-toc-h-3

# Dekegatecakk

次に「Delegatecall」について説明していきます。
こちらも以下の記事でより詳しく説明しているので、参考にしていただけると嬉しいです！

https://chaldene.net/solidity-delegatecall#st-toc-h-1

# Proxyコントラクト

![25.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/d4da43dd-069c-2dda-5db6-e37d1e3a4ffe.png)

Proxyコントラクトとは、「**Proxy**」という意味の通り「**代理のコントラクト**」になります。
主な役割としては、他のコントラクトを呼び出す処理を行うコントラクトです。

# アップグレードの仕組み

では次にアップグレードの仕組みを見ていきましょう。

## Upgradableの仕組み

![27.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/99e04f2c-5d4e-3b42-257e-68a0353bb235.png)

現在青色のコントラクトを使用しています。
Proxyコントラクトは青色のコントラクトを呼び出しています。
しかし、新機能の追加や脆弱性の修正のためにコントラクトを新しくしたいとします。

![28.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/e60d692e-419b-29aa-72f6-5ceb899c5024.png)

新機能の追加や脆弱性の修正を行った黄色のコントラクトを用意します。
そして、Proxyコントラクトが呼び出すコントラクトを黄色のコントラクトに差し替えます。
やっていることとしてはこれだけです！
だいぶシンプルですよね。

![29.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/102e16c6-2ffc-3e3d-d0b5-4f595ebad942.png)

もう少し詳しく説明すると、Proxyコントラクトは「**Storageコントラクト**」とも呼ばれ、データはこのコントラクト内に保存されます（詳しくはDelegatecallの章を参考にしてくだい）。
そして呼び出すコントラクトは、「**Logicコントラクト**」とも呼ばれ、具体的な処理を行なっています。
「**Storageコントラクト**」と「**Logicコントラクト**」はそれぞれアドレスを持っていて、Proxyコントラクトはこのアドレスを使用して「**Logicコントラクト**」を呼び出しています。

![30.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/110ebe64-df88-48e2-c399-658fdfd6c02d.png)

ここで疑問が湧いてきます。
「**いやいや、Proxyコントラクトなんて使用せずに直接コントラクト呼び出した方がシンプルでわかりやすくない？**」

![31.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/6714c907-fd25-786b-6f27-76b68b6c3987.png)

しかし、上記の理由からそれはあまり良いとは言えません。

### 「こっちのコントラクトを使ってください！」と告知しないといけない。

新しいコントラクトを公開した後に、ユーザーやエンジニアに「古いコントラクトは使っても意味ないので、新しいコントラクトを使用してください！」と伝える必要が出てきます。
しかし、これは現実的ではありません。
全ユーザーがその告知に気づくことはまずあり得ません。

### 古いコントラクトに資金を送ると、誰も取り出せなくなる可能性がある

間違って古いコントラクトに資金を送ってしまい一生取り出せなくなる心配もあります。

### データの移行にガス代が結構かかる

古いコントラクト内のデータを全て新しいコントラクトに移すために、膨大なガス代と時間がかかりません。

![32.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/ae5f4553-3a00-e21b-efd2-1ed041a17d9d.png)

これらの観点からProxyコントラクトを使用せず、直接コントラクト呼び出すのは難しいと理解できると思います。
Proxyコントラクトを使用することで、ユーザーは処理を実行するコントラクトがどれか考える必要がなくなり、データの移行も不要になります。

## Upgradableの注意点

![33.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/9b3a99f3-775d-4066-2ead-d013168fee70.png)

コントラクトをアップグレードするとき、いくつか注意点があります。

### ストレージの衝突
![34.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/cf2dc16f-28b8-5ec4-b699-109a48245df7.png)
まずはストレージの衝突です。
ストレージスロットの部分で説明しているように、コントラクト内の変数の定義順にデータがストレージに保存されていきます。
画像左がProxy（Storage）コントラクト内のストレージデータで、画像右が新しい（Logic）コントラクト内のストレージデータだと思ってください。

![35.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/6cd5e217-43cf-b463-a22d-652dda8d8362.png)

新しいコントラクト内で、既存のコントラクト内の変数定義順と異なる順番で変数を定義すると、予想外の挙動を起こしてしまいます。
例えば、新しいコントラクト内で「**WalletAddress**」という変数を呼び出すと「**name**」という変数の値が取得されるなどです。
これはデータが保存されているコントラクトと、処理を実行するコントラクトが異なるために起こる現象です。
データが保存されているProxyコントラクトの変数定義順と、処理を実行するコントラクトをの変数定義順は要注意です。

### 関数の衝突
変数のつぎは関数の衝突も問題となってきます。

![36.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/ebd8366d-156d-e69f-a00e-5bb9254d6e06.png)
![37.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/8577aec5-2aa4-819a-f1ea-cca117e58566.png)

Proxyコントラクトは、呼び出し先のコントラクト内の関数を判別するとき、関数名の先頭4Byteを使用しています。
（4Byteの理由はガス代の節約のためです）
しかし、先頭4Byteだと2つの関数で重複してしまう可能性があります。


![38.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/e7a405be-e4f9-f615-3c17-fcd73da2ecb8.png)

そうなると、「**Logicコントラクト内のAという関数を実行したはずなのに、実際にはProxyコントラクト内のBという関数が実行されてしまう。**」、なんてことが起こり得ます。

### constructorが使えない

![39.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/df34a48a-396a-32f6-80e0-d79575f45596.png)

![40.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/db373ea1-c26b-e90d-6dfd-4eacb04ed09f.png)

constructorとは、コントラクトをデプロイされた時に1回だけ実行される関数です。
コントラクトのアップグレードでは、データはProxyコントラクト内の保存されているため、デプロイ時に何かしらのデータをLogicコントラクト内の保存しても意味がないということです。

# その他のアップグレードパターン

ここまででコントラクトのアップグレードについて説明してきました。
実はコントラクトのアップグレードにはいくつかパターンが存在します。

![42.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/e40cca26-3e16-c8d0-4f7e-47899757b7d0.png)
![43.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/fddbf9f8-8e37-9ee1-7058-e06b6e0f541d.png)
![44.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/570269/0c2b7de3-eb2b-f440-0170-113fc3ff15ca.png)

気になる方は以下の記事を読んだり、ご自分でも調べてみてください。

https://chaldene.net/upgradable-contracts

# 最後に

今回はスマートコントラクトのアップグレードについて解説してきました。
質問などがある方は以下のTwitterのDMなどからお気軽に質問してください！

[Twitter @cardene777](https://twitter.com/cardene777)

# 採用強化中！

CryptoGamesでは一緒に働く仲間を大募集中です。

https://www.wantedly.com/companies/cryptogames

この記事で書いた自分の経験からもわかるように、裁量権を持って働くことができて一気に成長できる環境です。
「ブロックチェーンやWeb3、NFTに興味がある」、「スマートコントラクトの開発に携わりたい」など、少しでも興味を持っている方はまずはお話ししましょう！