HandsOnChain

本人確認と凍結の画面を作る

作るもの

このレッスンを終えると、発行体はブラウザから利用者のアカウントを許可リストに足したり外したりできます。
アカウントを凍結したり全体を一時停止したりすることもでき、どちらも元に戻せます。

利用者は自分の画面で、自分のアカウントが許可リストにあるか、凍結されていないかを見られます。
全体が止まっていないかも、同じ画面で見られます。
コントラクトが送金を拒んだ時は、許可リストか凍結か一時停止のどれで止まったのかが日本語の文で出ます。

背景

銀行は、銀行口座を開く時の本人確認の記録と、取引を止めた銀行口座の記録を事務の画面で管理します。
窓口の担当者は銀行口座ごとの状態を見て、止める操作と戻す操作を同じ画面で行います。

円トークンでも、発行体の画面にアカウントごとの状態を並べ、その行から許可リストと凍結を切り替えます。
状態はコントラクトが持つため、画面は書き込む取引を送り、読み直した結果を出すだけです。

画面の操作 呼ぶ関数 必要な役割
本人確認の結果を書く setAllowed 本人確認
凍結する、凍結を解く setFrozen 本人確認
一時停止する、停止を解く pause、unpause 停止

実装

まず、アカウントごとの許可リストと凍結、全体の一時停止を読むapp/src/components/use-compliance.tsを作ります。
use-token.tsと同じ形で、読む関数だけが違います。

"use client";

import { jpyTokenAbi } from "@contracts/generated/abi";
import { useReadContracts } from "wagmi";

import { useSession } from "./session";

export type AccountStatus = {
  allowed: boolean | undefined;
  frozen: boolean | undefined;
};

// アカウントごとの許可リストと凍結、全体の一時停止をまとめて読む。4秒ごとに読み直す
export function useCompliance(addresses: readonly `0x${string}`[]) {
  const { token, chainId } = useSession();
  const contract = { address: token, abi: jpyTokenAbi, chainId } as const;

  const result = useReadContracts({
    allowFailure: true,
    contracts: [
      { ...contract, functionName: "paused" },
      ...addresses.flatMap((address) => [
        { ...contract, functionName: "isAllowed", args: [address] } as const,
        { ...contract, functionName: "isFrozen", args: [address] } as const,
      ]),
    ],
    query: { enabled: Boolean(token), refetchInterval: 4_000 },
  });

  const data = result.data ?? [];
  // addresses と同じ順の状態。読めていない間は undefined
  const accounts: AccountStatus[] = addresses.map((_, index) => ({
    allowed: data[1 + index * 2]?.result as boolean | undefined,
    frozen: data[2 + index * 2]?.result as boolean | undefined,
  }));

  return { paused: data[0]?.result as boolean | undefined, accounts };
}
コード 意味
functionName: "paused" ERC20Pausableの関数で、全体が止まっているかを返す
functionName: "isAllowed"と"isFrozen" Solidityがpublicのmappingから作る読み取りの関数。
アカウントのアドレスを渡すとtrueかfalseを返す
data[1 + index * 2] 最初の1つがpausedで、その後にアカウントごとの2つが並ぶので、その位置から読む

コントラクトが拒んだ理由を示す文を、app/src/lib/format.tsに3つ足します。

const reasons: Record<string, string> = {
  ERC20InsufficientBalance: "残高が足りません",
  AccessControlUnauthorizedAccount: "このアカウントは、この操作をする役割を持っていません",
  NotAllowed: "許可リストにないアカウントなので、送ることも受け取ることもできません",
  AccountFrozen: "凍結されたアカウントなので、送ることも受け取ることもできません",
  EnforcedPause: "発行体が全体を一時停止しているため、今は動かせません",
};

利用者の画面のapp/src/components/holder-view.tsxには、自分のアカウントの状態を足します。
BadgeとuseComplianceを読み込み、操作しているアカウントの状態を読みます。

import { Amount, Badge, Card, Field, NoticeLine } from "./ui";
import { useCompliance } from "./use-compliance";
  const balance = state.balances[0];
  const compliance = useCompliance(me ? [me] : []);
  const mine = compliance.accounts[0];

残高の隣に、3つの状態の一覧を置きます。

          <p className="hero-sub">{shortAddress(me)}</p>
        </div>
        <ul className="status-list" aria-label="アカウントの状態">
          <li>
            <span>本人確認</span>
            {mine?.allowed ? <Badge tone="good">許可リストにある</Badge> : <Badge tone="warn">未確認</Badge>}
          </li>
          <li>
            <span>凍結</span>
            {mine?.frozen ? <Badge tone="bad">凍結中</Badge> : <Badge tone="plain">なし</Badge>}
          </li>
          <li>
            <span>全体</span>
            {compliance.paused ? <Badge tone="bad">一時停止中</Badge> : <Badge tone="plain">動いている</Badge>}
          </li>
        </ul>
      </div>

発行体の画面のapp/src/components/issuer-view.tsxには、一時停止の欄と、表の2つの列を足します。
読み込みの行と状態を読む行は、利用者の画面と同じ形で足します。

import { Amount, Badge, Card, Field, NoticeLine } from "./ui";
import { useCompliance } from "./use-compliance";
  const state = useTokenState(holders);
  const compliance = useCompliance(holders);

合計の隣に、全体の状態と、止めるか戻すかのボタンを置きます。

        </div>
        <div className="pause-box">
          <span>全体</span>
          {compliance.paused ? <Badge tone="bad">一時停止中</Badge> : <Badge tone="plain">動いている</Badge>}
          <button
            type="button"
            className={compliance.paused ? "button" : "button button-danger"}
            disabled={pending !== undefined}
            onClick={() =>
              send("pause", compliance.paused ? "一時停止を解きました" : "全体を一時停止しました", compliance.paused ? "unpause" : "pause", [])
            }
          >
            {compliance.paused ? "停止を解く" : "一時停止する"}
          </button>
        </div>
      </div>

利用者のアカウントの表には、本人確認と凍結の列を足します。
見出しの行に2つの列を足し、各行でアカウントの状態を読んで、状態と切り替えのボタンを置きます。

                <th>アカウント</th>
                <th className="num">残高</th>
                <th>本人確認</th>
                <th>凍結</th>
                const label = labelOf(address) ?? shortAddress(address);
                const { allowed, frozen } = compliance.accounts[index];
                    <td className="num">{formatYen(state.balances[index])}</td>
                    <td>
                      <div className="cell-actions">
                        {allowed ? <Badge tone="good">許可リストにある</Badge> : <Badge tone="warn">未確認</Badge>}
                        <button
                          type="button"
                          className="button button-small"
                          aria-label={`${label}を${allowed ? "許可リストから外す" : "許可リストに足す"}`}
                          disabled={pending !== undefined}
                          onClick={() =>
                            send(
                              `allow-${address}`,
                              `${label}を${allowed ? "許可リストから外しました" : "許可リストに足しました"}`,
                              "setAllowed",
                              [address, !allowed],
                            )
                          }
                        >
                          {allowed ? "外す" : "足す"}
                        </button>
                      </div>
                    </td>
                    <td>
                      <div className="cell-actions">
                        {frozen ? <Badge tone="bad">凍結中</Badge> : <Badge tone="plain">なし</Badge>}
                        <button
                          type="button"
                          className="button button-small"
                          aria-label={`${label}${frozen ? "の凍結を解く" : "を凍結する"}`}
                          disabled={pending !== undefined}
                          onClick={() =>
                            send(`freeze-${address}`, `${label}を${frozen ? "凍結を解きました" : "凍結しました"}`, "setFrozen", [address, !frozen])
                          }
                        >
                          {frozen ? "解く" : "凍結する"}
                        </button>
                      </div>
                    </td>
コード 意味
[address, !allowed] 今の値の逆を送り、足す操作と外す操作を1つのボタンで切り替える
compliance.paused ? "unpause" : "pause" 今の状態から呼ぶ関数を選び、止める操作と戻す操作を1つのボタンで切り替える
aria-label 行ごとのボタンに「利用者Aを許可リストに足す」のような名前を付ける。
画面に出る文字は「足す」のままで、読み上げや操作を確かめる時には誰のどの操作かを見分けられる

最後に、履歴のapp/src/components/history.tsxに、許可リストと凍結と一時停止のイベントの行を足します。
Transferの行の後に、4つのcaseを足します。

      case "AllowedSet":
        rows.push({ ...base, title: log.args.allowed ? "許可リストに足した" : "許可リストから外した", tone: "plain", detail: who(log.args.account!), accounts: [log.args.account!] });
        break;
      case "FrozenSet":
        rows.push({ ...base, title: log.args.frozen ? "凍結した" : "凍結を解いた", tone: log.args.frozen ? "bad" : "plain", detail: who(log.args.account!), accounts: [log.args.account!] });
        break;
      case "Paused":
        rows.push({ ...base, title: "全体を一時停止した", tone: "bad", detail: `${who(log.args.account!)}が止めた`, accounts: [] });
        break;
      case "Unpaused":
        rows.push({ ...base, title: "一時停止を解いた", tone: "plain", detail: `${who(log.args.account!)}が戻した`, accounts: [] });
        break;

一時停止の行は特定のアカウントに関わらないため、accountsを空にして、利用者の画面でも全員に出します。
止める操作だけが目に留まるように、凍結と一時停止の行はバッジを赤にし、戻した行と許可リストの行は灰色にします。

確かめる

starter/appのディレクトリでpnpm devを実行し直し、ブラウザでhttp://localhost:3400/issuerを開きます。
デプロイし直した直後は許可リストに誰もいないため、表の3人は全て「未確認」です。
利用者Aの行の「足す」を押すと、「許可リストにある」に変わります。
続けて入金の額に10000を入れて発行すると、利用者Aへ10,000円が届きます。

発行体が利用者Aを許可リストに足してから10,000円を発行したところ
発行体が利用者Aを許可リストに足してから10,000円を発行したところ

利用者の画面へ移って右上で「利用者A」に切り替えると、状態の一覧に「許可リストにある」と出ます。
許可リストにない「利用者C」を送り先に選んで1000円を送ろうとすると、コントラクトがNotAllowedで拒みます。
画面には、その理由が文で出ます。

利用者Aが許可リストにない利用者Cへ送ろうとして断られたところ
利用者Aが許可リストにない利用者Cへ送ろうとして断られたところ

発行体の画面に戻り、利用者Aの行の「凍結する」と、合計の隣の「一時停止する」を押します。
利用者Aは「凍結中」に、全体は「一時停止中」になり、履歴に凍結と一時停止の行が出ます。
この状態で利用者Aが送ろうとすると、「凍結されたアカウントなので、送ることも受け取ることもできません」と出ます。

発行体が利用者Aを凍結し、全体を一時停止したところ
発行体が利用者Aを凍結し、全体を一時停止したところ

凍結と停止を解くと、利用者Aはまた送れるようになります。
ここで節3が終わり、ローカルノードで円トークンの全ての操作をブラウザから試せます。