HandsOnChain

発行体の画面を作る

作るもの

このレッスンを終えると、発行体がブラウザから利用者のアカウントへ、入金に応じて円トークンを発行できます。
利用者は自分の画面から償還を頼めます。
発行した円トークンの合計、利用者ごとの残高、発行と償還と送金の履歴も画面で見られます。

背景

銀行の事務の画面は、入金の確認や払い戻しのような操作を権限のある担当者にだけ見せます。
円トークンの発行体の画面にも同じ操作があります。
ただし、権限の確認は画面ではなくコントラクトが行います。
画面を誰が作っても、役割を持たないアカウントの操作はコントラクトが拒むため、画面の作りを誤っても事故につながりません。

画面の操作 呼ぶ関数 要る役割
入金に応じて発行する issue 発行
償還を頼む redeem 要らない。
持ち主が自分の残高だけを償還する

履歴は、コントラクトが残したイベントから作ります。
発行はIssued、償還はRedemptionRequested、送金はERC-20のTransferのイベントです。
銀行の取引の明細と違い、誰でも同じイベントを読めるため、発行体の帳簿と利用者の見る履歴が食い違いません。

実装

まず、役割を持たないアカウントが発行しようとした時に出す理由の文を、app/src/lib/format.tsに足します。

const reasons: Record<string, string> = {
  ERC20InsufficientBalance: "残高が足りません",
  AccessControlUnauthorizedAccount: "このアカウントは、この操作をする役割を持っていません",
};

次に、円トークンのイベントを読んで履歴を出すapp/src/components/history.tsxを作ります。
useContractEventsは、コントラクトが残したイベントを全て読み、イベントの名前と中身を型つきで返します。

"use client";

import { jpyTokenAbi } from "@contracts/generated/abi";
import { hexToString, zeroAddress } from "viem";
import { useContractEvents } from "wagmi";

import { labelOf } from "@/lib/chains";
import { formatYen, shortAddress } from "@/lib/format";

import { useSession } from "./session";
import { Badge, Card, type Tone } from "./ui";

type Row = { key: string; block: bigint; index: number; title: string; tone: Tone; detail: string; accounts: string[] };

function who(address: string): string {
  return labelOf(address) ?? shortAddress(address);
}

function depositRef(ref: `0x${string}`): string {
  try {
    return hexToString(ref, { size: 32 }).replace(/\0+$/, "") || ref;
  } catch {
    return ref;
  }
}

// 円トークンが残したイベントを新しい順に並べる。only を渡すと、そのアカウントに関わる行だけにする
export function History({ only }: { only?: `0x${string}` }) {
  const { token, chainId } = useSession();
  const events = useContractEvents({
    address: token,
    abi: jpyTokenAbi,
    chainId,
    fromBlock: 0n,
    query: { enabled: Boolean(token), refetchInterval: 4_000 },
  });

  const rows: Row[] = [];
  for (const log of events.data ?? []) {
    const base = { key: `${log.transactionHash}-${log.logIndex}`, block: log.blockNumber ?? 0n, index: log.logIndex ?? 0 };
    switch (log.eventName) {
      case "Issued":
        rows.push({ ...base, title: "発行", tone: "good", detail: `${who(log.args.to!)}へ${formatYen(log.args.amount)} (照合番号 ${depositRef(log.args.depositRef!)})`, accounts: [log.args.to!] });
        break;
      case "RedemptionRequested":
        rows.push({ ...base, title: "償還の依頼", tone: "warn", detail: `${who(log.args.holder!)}が${formatYen(log.args.amount)}をburnし、払い戻しを頼んだ`, accounts: [log.args.holder!] });
        break;
      case "Transfer":
        // 発行と償還は Issued と RedemptionRequested の行で出すため、送金だけを出す
        if (log.args.from === zeroAddress || log.args.to === zeroAddress) break;
        rows.push({ ...base, title: "送金", tone: "info", detail: `${who(log.args.from!)}から${who(log.args.to!)}へ${formatYen(log.args.value)}`, accounts: [log.args.from!, log.args.to!] });
        break;
    }
  }

  const visible = rows
    .filter((row) => !only || row.accounts.length === 0 || row.accounts.some((account) => account.toLowerCase() === only.toLowerCase()))
    .sort((a, b) => (a.block === b.block ? b.index - a.index : a.block > b.block ? -1 : 1))
    .slice(0, 50);

  return (
    <Card title="履歴" description="コントラクトが残したイベントを、新しい順に最大50件出します。">
      {visible.length === 0 ? (
        <p className="muted">まだ何も起きていません。</p>
      ) : (
        <ol className="history">
          {visible.map((row) => (
            <li key={row.key}>
              <span className="history-title">
                <Badge tone={row.tone}>{row.title}</Badge>
              </span>
              <span className="history-detail">{row.detail}</span>
              <span className="history-block">ブロック {row.block.toString()}</span>
            </li>
          ))}
        </ol>
      )}
    </Card>
  );
}
コード 意味
fromBlock: 0n 最初のブロックから全てのイベントを読む
switch (log.eventName) イベントの名前で分ける。
log.argsの型は名前ごとに決まり、IssuedならtoとamountとdepositRefを持つ
log.args.from === zeroAddress 発行と償還の時はTransferも出るため、送金でないTransferを飛ばす
only 利用者の画面で、自分に関わる行だけを出す
tone 行の種類ごとのバッジの色。
発行は緑、送金は濃紺、償還の依頼は琥珀にする。
行の種類を色でも見分けられるようにする

利用者の画面のapp/src/components/holder-view.tsxに、償還の欄と履歴を足します。
まず、履歴のコンポーネントを読み込み、償還の額を持つ値を足します。

import { History } from "./history";
  const [sendAmount, setSendAmount] = useState("");
  const [redeemAmount, setRedeemAmount] = useState("");
  const sendValue = parseYen(sendAmount);
  const redeemValue = parseYen(redeemAmount);

送金の欄の隣に償還の欄を置き、通知の行の下に履歴を置きます。
送金の欄を入れたgrid-2の枠では、欄が2つになると半分ずつの幅で並びます。

        </Card>

        <Card title="償還する" description="円トークンをburnし、発行体へ銀行口座への払い戻しを頼みます。">
          <form
            className="form"
            onSubmit={async (event) => {
              event.preventDefault();
              if (redeemValue === undefined) return;
              const ok = await send("redeem", `${formatYen(redeemValue)}の払い戻しを頼みました`, "redeem", [redeemValue]);
              if (ok) setRedeemAmount("");
            }}
          >
            <Field label="額 (円)" hint="残高を超える額は償還できません" unit="円">
              <input inputMode="numeric" value={redeemAmount} onChange={(event) => setRedeemAmount(event.target.value)} placeholder="1000" />
            </Field>
            <button className="button" type="submit" disabled={redeemValue === undefined || pending !== undefined}>
              {pending === "redeem" ? "償還しています" : "償還する"}
            </button>
          </form>
        </Card>
      </div>

      <NoticeLine notice={notice} />
      <History only={me} />

続けて、発行体の画面のapp/src/components/issuer-view.tsxを作ります。

"use client";

import { useState } from "react";
import { stringToHex } from "viem";

import { labelOf, localAccounts } from "@/lib/chains";
import { formatYen, parseYen, shortAddress } from "@/lib/format";

import { History } from "./history";
import { NotDeployed } from "./not-deployed";
import { useSession } from "./session";
import { Amount, Card, Field, NoticeLine } from "./ui";
import { useSend } from "./use-send";
import { useTokenState } from "./use-token";

// 照合番号は銀行の入金を照らし合わせる番号で、32バイトに収まる英数字と記号で書く
function toDepositRef(text: string): `0x${string}` | undefined {
  if (!/^[\x21-\x7e]{1,32}$/.test(text)) return undefined;
  return stringToHex(text, { size: 32 });
}

export function IssuerView() {
  const session = useSession();
  const { send, pending, notice } = useSend();
  const holders = localAccounts.filter((account) => account.role === "holder").map((account) => account.address);
  const state = useTokenState(holders);

  const [issueTo, setIssueTo] = useState<`0x${string}`>(holders[0]);
  const [issueAmount, setIssueAmount] = useState("");
  const [issueRef, setIssueRef] = useState("DEP-0001");

  if (!session.token) return <NotDeployed />;
  const me = session.address;
  if (!me) return null;

  const amount = parseYen(issueAmount);
  const ref = toDepositRef(issueRef);

  return (
    <div className="stack">
      <div className="hero">
        <div>
          <p className="hero-label">発行した円トークンの合計</p>
          <p className="hero-value">
            <Amount value={state.totalSupply} />
          </p>
          <p className="hero-sub">
            操作しているアカウント {session.label ?? shortAddress(me)}
          </p>
        </div>
      </div>

      <Card title="入金に応じて発行する" description="銀行口座への入金を確かめた額だけ、利用者のアカウントへ発行します。">
        <form
          className="form form-row"
          onSubmit={async (event) => {
            event.preventDefault();
            if (amount === undefined || ref === undefined) return;
            const ok = await send("issue", `${labelOf(issueTo) ?? shortAddress(issueTo)}へ${formatYen(amount)}を発行しました`, "issue", [issueTo, amount, ref]);
            if (ok) setIssueAmount("");
          }}
        >
          <Field label="発行先">
            <select value={issueTo} onChange={(event) => setIssueTo(event.target.value as `0x${string}`)}>
              {holders.map((address) => (
                <option key={address} value={address}>
                  {labelOf(address)} {shortAddress(address)}
                </option>
              ))}
            </select>
          </Field>
          <Field label="入金の額 (円)" unit="円">
            <input inputMode="numeric" value={issueAmount} onChange={(event) => setIssueAmount(event.target.value)} placeholder="10000" />
          </Field>
          <Field label="入金の照合番号" hint="英数字で32文字まで">
            <input value={issueRef} onChange={(event) => setIssueRef(event.target.value)} spellCheck={false} />
          </Field>
          <button className="button button-primary" type="submit" disabled={amount === undefined || ref === undefined || pending !== undefined}>
            {pending === "issue" ? "発行しています" : "発行する"}
          </button>
        </form>
      </Card>

      <Card title="利用者のアカウント">
        <div className="table-wrap">
          <table className="table">
            <thead>
              <tr>
                <th>アカウント</th>
                <th className="num">残高</th>
              </tr>
            </thead>
            <tbody>
              {holders.map((address, index) => {
                const label = labelOf(address) ?? shortAddress(address);
                return (
                  <tr key={address}>
                    <td>
                      <span className="cell-title">{label}</span>
                      <span className="cell-sub">{shortAddress(address)}</span>
                    </td>
                    <td className="num">{formatYen(state.balances[index])}</td>
                  </tr>
                );
              })}
            </tbody>
          </table>
        </div>
      </Card>

      <NoticeLine notice={notice} />
      <History />
    </div>
  );
}
コード 意味
toDepositRef(issueRef) 照合番号を32バイトの値にする。
32文字を超える時と英数字以外を含む時はundefinedになり、ボタンを押せない
useTokenState(holders) 3人の利用者の残高と、発行した円トークンの合計を読む
send("issue", 文, "issue", [issueTo, amount, ref]) 発行を試してから送る。
役割を持たないアカウントの時は、試す段階で理由の文を出す
if (!me) return null ローカルノードでは、右上で選んだアカウントが必ずある。
アカウントがない時の案内は、ウォレットをつなぐ最後の節で足す

app/src/app/issuer/page.tsxを新しく作り、発行体の画面を/issuerで開けるようにします。

import { IssuerView } from "@/components/issuer-view";

export default function IssuerPage() {
  return <IssuerView />;
}

最後に、app/src/components/header.tsxに2つの画面を切り替えるタブを足します。

import Link from "next/link";
import { usePathname } from "next/navigation";
const pages = [
  { href: "/", label: "利用者の画面" },
  { href: "/issuer", label: "発行体の画面" },
];
export function Header() {
  const pathname = usePathname();
  return (
    <header className="site-header">
      <div className="site-header-inner">
        <Link href="/" className="brand">
          <span className="brand-mark" aria-hidden="true">
            ¥
          </span>
          <span>HandsOn JPY</span>
        </Link>

        <nav className="tabs" aria-label="画面">
          {pages.map((page) => (
            <Link key={page.href} href={page.href} className="tab" aria-current={pathname === page.href ? "page" : undefined}>
              {page.label}
            </Link>
          ))}
        </nav>

usePathnameは今開いているページのパスを返し、aria-currentで開いている方のタブを目立たせます。

確かめる

starter/appのディレクトリでpnpm devを実行し直し、ブラウザでhttp://localhost:3400/issuerを開きます。
pnpm devはanvilを空の状態から起動し直すため、合計は0円から始まります。
右上のアカウントが「発行体」になっていることを確かめ、発行先に「利用者A」を選び、入金の額に10000を入れて「発行する」を押します。
「利用者Aへ10,000円を発行しました」と出て、合計と利用者Aの残高が10,000円になり、履歴に照合番号DEP-0001の発行の行が出ます。

発行体が利用者Aへ入金に応じて10,000円を発行したところ
発行体が利用者Aへ入金に応じて10,000円を発行したところ

上の「利用者の画面」へ移り、右上で「利用者A」に切り替えます。
償還の欄に3000を入れて「償還する」を押すと、「3,000円の払い戻しを頼みました」と出ます。
残高は7,000円に減り、履歴に償還の依頼の行が出ます。
発行体はこの行を読み、利用者Aの銀行口座へ3,000円を振り込みます。

利用者Aが3,000円の償還を頼んだところ
利用者Aが3,000円の償還を頼んだところ

右上で「利用者A」を選んだまま発行体の画面で「発行する」を押すと、「このアカウントは、この操作をする役割を持っていません」と出ます。
画面にボタンが出ていても、役割の確認はコントラクトが行っていると分かります。

発行の役割を持たない利用者Aが発行を試して断られたところ
発行の役割を持たない利用者Aが発行を試して断られたところ

ここで節2が終わり、入金に応じた発行から償還までをブラウザから試せます。