HandsOnChain

全体を一時停止する

作るもの

このレッスンを終えると、停止の役割を持つアカウントが円トークン全体を一時停止できるようになります。
停止している間、コントラクトは全ての送金と発行と償還をEnforcedPauseのエラーで拒みます。
停止を解くと、元どおりに動きます。

背景

証券取引所には、相場が大きく荒れた時やシステムに不具合が見つかった時に、取引を一時的に止める仕組みがあります。
円トークンにも、コントラクトに不具合が見つかった時や発行体の鍵が盗まれた疑いがある時に、被害が広がる前に全体を止める仕組みを持たせます。

一時停止は影響の大きい操作なので、実行できるのは停止の役割を持つアカウントだけにします。
止めている間も残高は読めます。
止まるのは残高を動かす操作だけです。

実装

OpenZeppelin ContractsのERC20Pausableを継承し、停止と再開の関数を足します。

import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import {ERC20Pausable} from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Pausable.sol";
import {AccessControl} from "@openzeppelin/contracts/access/AccessControl.sol";

contract JpyToken is ERC20, ERC20Pausable, AccessControl {
    // (ここまでに書いた役割、状態、イベント、関数はそのまま)

    /// @notice 全ての送金と発行と償還を止める
    function pause() external onlyRole(PAUSER_ROLE) {
        _pause();
    }

    /// @notice 止めた送金と発行と償還を戻す
    function unpause() external onlyRole(PAUSER_ROLE) {
        _unpause();
    }

ERC20Pausableも_updateをオーバーライドしているため、_updateのoverrideに継承した2つのコントラクトを並べます。

    function _update(address from, address to, uint256 value) internal override(ERC20, ERC20Pausable) {
        if (from != address(0)) _checkAccount(from);
        if (to != address(0)) _checkAccount(to);
        super._update(from, to, value);
    }
行 意味
override(ERC20, ERC20Pausable) 2つの親が持つ_updateを、このコントラクトの_updateでまとめてオーバーライドする
super._update(...) ERC20Pausableの_updateが停止中かを確かめ、その後にERC-20の_updateが残高を動かす

テストを2つ足します。

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

    function test_RevertWhen_TransferWhilePaused() public {
        _issue(alice, 10_000 ether);
        vm.prank(issuer);
        token.pause();

        vm.expectRevert(Pausable.EnforcedPause.selector);
        vm.prank(alice);
        token.transfer(bob, 1_000 ether);

        vm.prank(issuer);
        token.unpause();
        vm.prank(alice);
        assertTrue(token.transfer(bob, 1_000 ether));
    }

    function test_RevertWhen_PauseWithoutRole() public {
        bytes32 role = token.PAUSER_ROLE();
        vm.expectRevert(abi.encodeWithSelector(IAccessControl.AccessControlUnauthorizedAccount.selector, alice, role));
        vm.prank(alice);
        token.pause();
    }

importの行は、ファイルの先頭にある他のimportの並びに足します。

確かめる

forge test

2つのテストが[PASS]になれば通っています。
1つ目のテストは、停止中に拒まれることと停止を解いた後に送れることを続けて確かめています。