申込で円を預かる
作るもの
このレッスンを終えると、本人確認の済んだ投資家が口数を決めて申し込み、決済のコントラクトが口数に額面を掛けた円を預かります。
申込の口数の和が発行額の30口を超える時は、コントラクトがOverIssueAmountのエラーで拒みます。
本人確認の済んでいない人の申込は、NotAllowedのエラーで拒みます。
社債はまだ発行せず、円は締め切りまで決済のコントラクトの中に置いたままにします。
締め切りの後に円と社債を入れ替える処理は、次のレッスンで足します。
背景
社債を出す会社は、発行額と利率と日程を決めて投資家を募ります。
投資家は締め切りまでに口数を決めて申し込み、払込日に代金を払い込みます。
日本の社債の多くは、社債、株式等の振替に関する法律が定める振替制度で受け渡します。
振替制度では紙の券面を使わず、証券保管振替機構(ほふり)や証券会社が持つ帳簿の記録を書き換えて持ち主を移します。
このコースでは、その帳簿に当たるものを社債トークンの残高にし、代金は円トークンで払い込みます。
このコースでは、投資家は申し込む時に代金の円を預け、締めの時に払い込みを済ませます。
申込の円を発行体が直接受け取ると、申込が集まらなかった時に発行体から返してもらうことになります。
そこで申込の円は、発行体ではなく決済のコントラクトに預けます。
決済のコントラクトには円を引き出す関数がないため、発行体も預かった円を締めより前に使えません。
発行額と申込の口数の和もチェーンの上にあるため、発行体と投資家が同じ数を読めます。
ERC-20では、ほかのコントラクトに自分の円を動かしてもらう時に、先にapproveで動かしてよい額を任せます。
任された側はtransferFromで、その額までを引き取れます。
| 呼ぶ順 | 関数 | 何をするか |
|---|---|---|
| 1 | 円トークンのapprove(決済のコントラクト, 額) |
決済のコントラクトが動かしてよい額を、円トークンに書く |
| 2 | 決済のコントラクトのsubscribe(口数) |
申込を記録し、中でtransferFromを呼んで円を引き取る |
実装
starter/contracts/contracts/BondSettlement.solを新しく作ります。
まず、円トークンと社債トークンと募集の条件を持つ形を書きます。
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {JpyToken} from "@handsonchain/jpy-stablecoin-contracts/contracts/JpyToken.sol";
import {BondToken} from "./BondToken.sol";
/// @title 社債のDvP決済
/// @notice 円トークンと社債を1つの取引で交換する。募集の払い込みも、投資家どうしの売買もここを通る
contract BondSettlement {
/// @notice 1円を円トークンの最小単位で表した数。円トークンは18桁を持つ
uint256 public constant YEN = 1e18;
JpyToken public immutable jpy;
BondToken public immutable bond;
/// @notice 払い込まれた円を受け取り、利金と償還の額を入れる発行体
address public immutable issuer;
/// @notice 発行する口数
uint256 public immutable issueAmount;
/// @notice 申込の締め切り。この時刻までの申込を受ける
uint64 public immutable deadline;
/// @notice 投資家ごとの申込の口数
mapping(address investor => uint256 units) public subscribed;
/// @notice 申込の口数の和
uint256 public totalSubscribed;
address[] private _subscribers;
event Subscribed(address indexed investor, uint256 units);
error NotAllowed(address account);
error ZeroUnits();
error OverIssueAmount(uint256 units, uint256 left);
error AfterDeadline(uint64 deadline);
constructor(JpyToken jpy_, BondToken bond_, address issuer_, uint256 issueAmount_, uint64 deadline_) {
jpy = jpy_;
bond = bond_;
issuer = issuer_;
issueAmount = issueAmount_;
deadline = deadline_;
}
| 行 | 意味 |
|---|---|
YEN = 1e18 |
円トークンは18桁を持つため、1円を1e18で表す。額面の円にこの数を掛けて円トークンの額にする |
immutable |
デプロイの時に決めた値を後から変えられないようにする。 発行額と締め切りは募集の途中で変えない |
issuer |
払い込まれた円を受け取る発行体のアカウント。 次のレッスンの締めで使う |
subscribed |
投資家ごとの申込の口数 |
totalSubscribed |
申込の口数の和。 発行額を超えないように見張る |
_subscribers |
申し込んだ投資家の並び。 締めの時に、この並びの順で社債を発行するか円を返す |
続けて、コンストラクタの後に申込の関数を足し、コントラクトを閉じます。
// 募集
/// @notice 締め切りまでに申し込み、口数に額面を掛けた円をこのコントラクトに預ける。発行額に達したら以降の申込を断る
function subscribe(uint256 units) external {
if (block.timestamp > deadline) revert AfterDeadline(deadline);
if (!jpy.isAllowed(msg.sender) || jpy.isFrozen(msg.sender)) revert NotAllowed(msg.sender);
if (units == 0) revert ZeroUnits();
uint256 left = issueAmount - totalSubscribed;
if (units > left) revert OverIssueAmount(units, left);
if (subscribed[msg.sender] == 0) _subscribers.push(msg.sender);
subscribed[msg.sender] += units;
totalSubscribed += units;
jpy.transferFrom(msg.sender, address(this), units * bond.faceValue() * YEN);
emit Subscribed(msg.sender, units);
}
}
| 行 | 意味 |
|---|---|
block.timestamp > deadline |
締め切りを過ぎた申込をAfterDeadlineで拒む。締め切りの時刻ちょうどまでは受ける |
jpy.isAllowed(msg.sender) |
円トークンの名簿を読み、本人確認の済んでいない人の申込を拒む。isFrozenで凍結された人も拒む |
units == 0 |
0口の申込をZeroUnitsで拒む |
left = issueAmount - totalSubscribed |
残りの口数。 これを超える申込は OverIssueAmountで拒み、エラーに残りの口数を添える |
_subscribers.push(msg.sender) |
初めて申し込んだ投資家だけを並びに足す。 2回目からは口数を足すだけにする |
jpy.transferFrom(...) |
口数に額面とYENを掛けた円を、投資家からこのコントラクトへ引き取る。任された額が足りない時は円トークンが拒む |
記録を書き換えてから円トークンを呼ぶのは、外のコントラクトを呼ぶ前に自分の状態を済ませておくためです。
transferFromが拒まれた時はsubscribeの取引の全てが元に戻るため、書き換えた口数も残りません。
次に、starter/contracts/test/DigitalBond.t.solで決済のコントラクトを読み込みます。
import {BondSettlement} from "../contracts/BondSettlement.sol";
社債の条件の定数の後に発行額と締め切りを足し、決済のコントラクトを持つ変数も足します。
uint256 internal constant ISSUE_AMOUNT = 30;
uint64 internal constant DEADLINE = 1768316400; // 2026-01-14
JpyToken internal jpy;
BondToken internal bond;
BondSettlement internal settlement;
setUpでは、社債の後に決済のコントラクトを作ります。
発行体のアカウントから、社債を発行する役割と円トークンの名簿の席を渡します。
bond = new BondToken(jpy, issuer, FACE, RATE_BPS, ISSUE_DATE, payments, records);
settlement = new BondSettlement(jpy, bond, issuer, ISSUE_AMOUNT, DEADLINE);
vm.startPrank(issuer);
bond.grantRole(bond.SETTLEMENT_ROLE(), minter);
bond.grantRole(bond.SETTLEMENT_ROLE(), address(settlement));
jpy.setAllowed(address(settlement), true);
| 行 | 意味 |
|---|---|
new BondSettlement(...) |
発行額を30口、締め切りを2026-01-14にして決済のコントラクトを作る |
grantRole(..., address(settlement)) |
次のレッスンの締めで社債を発行できるよう、決済のコントラクトに役割を渡す |
jpy.setAllowed(address(settlement), true) |
円トークンは名簿にないアカウントへの移転を拒む。 円を預かる決済のコントラクトも名簿に載せる |
_mintの後に、申込を1行で書くための_subscribeを足します。
function _subscribe(address investor, uint256 units) internal {
vm.startPrank(investor);
jpy.approve(address(settlement), units * FACE * YEN);
settlement.subscribe(units);
vm.stopPrank();
}
vm.startPrankからvm.stopPrankまでの呼び出しは、全て投資家のアカウントから送られます。
画面と同じく、approveで円を任せてからsubscribeで申し込みます。
最後に、DigitalBondTestの末尾に申込のテストを3つ足します。
// 節2 DvPで払い込む
function test_SubscribeEscrowsYen() public {
_subscribe(alice, 10);
assertEq(jpy.balanceOf(address(settlement)), 10 * FACE * YEN);
assertEq(jpy.balanceOf(alice), 1_000_000 * YEN);
assertEq(settlement.subscribed(alice), 10);
assertEq(settlement.totalSubscribed(), 10);
assertEq(bond.totalSupply(), 0);
}
function test_RevertWhen_SubscribeNotAllowed() public {
vm.prank(stranger);
vm.expectRevert(abi.encodeWithSelector(BondSettlement.NotAllowed.selector, stranger));
settlement.subscribe(1);
assertEq(settlement.totalSubscribed(), 0);
}
function test_RevertWhen_SubscribeOverIssueAmount() public {
_subscribe(alice, 20);
_subscribe(bob, 10);
vm.startPrank(carol);
jpy.approve(address(settlement), FACE * YEN);
vm.expectRevert(abi.encodeWithSelector(BondSettlement.OverIssueAmount.selector, 1, 0));
settlement.subscribe(1);
vm.stopPrank();
assertEq(settlement.totalSubscribed(), ISSUE_AMOUNT);
assertEq(jpy.balanceOf(carol), 2_000_000 * YEN);
}
| テスト | 確かめること |
|---|---|
test_SubscribeEscrowsYen |
10口の申込で1,000,000円が決済のコントラクトへ移り、社債はまだ0口のまま。setUpで200万円を持つaliceには100万円が残る |
test_RevertWhen_SubscribeNotAllowed |
名簿にないstrangerの申込を拒み、口数の和が0のまま |
test_RevertWhen_SubscribeOverIssueAmount |
20口と10口で30口に達した後の1口を拒み、carolの円が減っていない |
確かめる
starter/contractsのディレクトリでテストを実行します。
forge test
次の行が出れば、申込のテストは通っています。
[PASS] test_RevertWhen_SubscribeNotAllowed()
[PASS] test_RevertWhen_SubscribeOverIssueAmount()
[PASS] test_SubscribeEscrowsYen()
Suite result: ok. 7 passed; 0 failed; 0 skipped
subscribeのif (units > left) revert OverIssueAmount(units, left);の行を消して実行すると、test_RevertWhen_SubscribeOverIssueAmountが失敗に変わります。
[FAIL: next call did not revert as expected] test_RevertWhen_SubscribeOverIssueAmount()
見張りの行を消すと発行額を超える申込を受けてしまうことを、このテストで見つけられます。
確かめたら、消した行を戻しておきます。
この時点では、預かった円を動かす関数がまだありません。
次のレッスンで、締め切りの後に円と社債を入れ替える処理を足します。