Minimal Proxy Contract について

Minimal Proxy Contract について調べたのでメモ

Minimal Proxy Contract とは

ERC1167 で定義されている、コントラクトを安価に複製する実装パターン

何も考えず、コントラクトを複製するとなるとメソッド内でnewするだけであるが、

これだと、ガス代がかかりすぎる

function clone() public {
    new Sample();
}

そうではなく、ロジックをまるっと記述しておく Logic コントラクトと、

そのロジックを参照し、データをストアするだけの Proxy コントラクトを複製していく Factory コントラクトを作る。

複製対象のコントラクトは中身がすっからかんなので、デプロイも安価に済む。

やり方

1. Logic コントラクトを実装する

このコントラクトはロジックだけを持つので、変数に値をセットしたり、それを読んだりすることはできない。

このようなロジックだけを保存しておくコントラクトは一般的なInitializersを使用する

Initializers

ドキュメントでは、Upgradable なコントラクトを記述するための道具として説明されているが、Proxy コントラクトを作るためにも使える。

コントラクトの初期化にはconstructorを使用するが、

Proxy からそれを呼び出すみたいなことはできないので、

代わりとなるinitializeメソッドを用意する

import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";

contract LogicContract is Initializable {
    function initialize(uint256 _x) public initializer {
        x = _x;
    }
}

コントラクトを複製する際にこのメソッドを呼び出すことで初期化できるようになる。

このメソッドは一度しか呼び出すことができない。

そのため、攻撃者はこのメソッドを呼び出すことができない。

これ以外は普通にコントラクトのロジックを実装していく。

2. Factory コントラクトを実装する

Factory のコントラクトも、至ってシンプル。

Clonesライブラリをaddressにusingする
Logic コントラクトのアドレスからcloneする
cloneしたコントラクトをinitializeする

import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";

contract LogicContractFactory {
    using Clones for address; // 1

    address public implementation;

    constructor(_implementation) public {
          implementation = _implementation;
    }

    function clone() public returns (address) {
        bytes memory data = _encode(4649);
        bytes32 salt = keccak256(abi.encodePacked(data));
        address deployedProxy = implementation.cloneDeterministic(salt); // 2
        deployedProxy.functionCall(data); // 3
        return deployedProxy;
    }

    function _encode(uint256 x) internal pure returns (bytes memory) {
        return
            abi.encodeWithSignature(
                "initialize(uint256)",
                x,
            );
    }
}

Clonesライブラリをaddressにusingすることで、cloneDeterministicメソッドを使用することができるようになる。

cloneDeterministicアドレスのロジックを呼び出すProxyコントラクトをデプロイしてくれる。

渡した salt を元に決定論的にアドレスを生成する。

あとは普通のコントラクトのようにメソッドを呼び出してやれば良いだけ。

function do() {
    address proxy = factory.clone();
    ILogic(proxy).do();
}

非常に便利。