続きから分けて約定する
作るもの
このレッスンを終えると、運用会社がsettleに件数を渡し、約定日の注文を何回かに分けて約定できます。
2回目からは、前の回が約定し終えた注文の続きから約定します。
分けて約定しても、どの注文も全件を1回で約定した時と同じ口数を受け取ります。
入れ忘れた約定日の純資産は後から入れられ、その日の注文はその日の基準価額で約定します。
前の約定日を約定し終えるまで、次の約定日の純資産は入れられません。
背景
投資信託の注文は、締め切りの後にまとめて委託会社へ伝わり、その日の基準価額で約定します。
注文が多い日も少ない日も、その日の注文は全てその日の基準価額で約定します。
後から出た別の日の基準価額で約定すると、締め切りの後に出るその日の値段で約定するブラインド方式の決まりと合わなくなります。
オンチェーンでは、1つのブロックに入るガスに上限があり、1つのトランザクションもそれを超えられません。
前のレッスンのsettleは、約定日の注文を1回の呼び出しで全て約定します。
注文が多い日はループの回数が増えてガスの上限を超え、何度呼んでも約定できなくなります。
その日の注文を約定できないと、預かった円も口数も動かせません。
| やり方 | 起きること |
|---|---|
| 1日の注文の数に上限を置く | 上限に届いた後の投資家は、その日に注文できない。 1円の申込を並べるだけで、他の投資家を締め出せる |
| 件数で区切り、続きから約定する | 何件あっても、何回かに分けて呼べば全件を約定できる |
このコースは2つ目のやり方を採り、注文の数に上限を置きません。
続きから約定するために、ファンドのコントラクトに2つの値を残します。
| 値 | 持つもの |
|---|---|
settledCount[day] |
約定日ごとの、約定し終えた注文の数。 次の呼び出しはこの番号の注文から始める |
dayCursor |
次に約定する約定日が、注文のある約定日の配列_orderDaysの何番目か |
_orderDaysは、注文のある約定日を古い順に並べた配列です。
約定日は注文した時刻から決まり、時刻は進むだけなので、新しく足す約定日は前に足した約定日より前になりません。
そのため_orderDays[dayCursor]は、約定し終えていない約定日のうち最も古い日です。
前の約定日を約定し終えるまで次の約定日の純資産を入れられないのは、2つの理由からです。
1つ目は、setNavがlastNavDay以前の約定日を断ることです。
金曜の純資産を先に入れると木曜の純資産はもう入れられず、木曜の注文は約定できないまま残ります。
締め切りを過ぎた注文は取り消せないので、預けた円と口数も戻せません。
2つ目は、基準価額を出す時に割る発行済みの口数です。
木曜の申込の口数を渡し終え、解約の口数を消し終えてから割らないと、金曜の基準価額がずれます。
運用会社が木曜の純資産を入れ忘れても、金曜の夜に木曜の分から順に入れられます。
木曜の注文は木曜の基準価額で約定し、金曜の注文は金曜の基準価額で約定します。
実装
starter/contracts/contracts/TokenizedFund.solのsettledCountの下に、次に約定する約定日の位置を足します。
/// @notice 約定日ごとの、約定し終えた注文の数
mapping(uint256 day => uint256) public settledCount;
/// @notice 次に約定する約定日の、注文のある約定日の配列での位置
uint256 public dayCursor;
エラーの末尾のAlreadySettledの下に、約定日を飛ばした時のエラーを足します。
error AlreadySettled(uint256 day);
error NavSkipsDay(uint256 day, uint256 pendingDay);
| 行 | 意味 |
|---|---|
dayCursor |
_orderDaysの何番目の約定日を次に約定するか。0から始まり、約定日を1つ約定し終えるたびに1つ進む |
NavSkipsDay |
約定し終えていない前の約定日を飛ばして、後の約定日の純資産を入れようとした。 2つ目の引数は、先に約定する約定日 |
setNavのNavBeforeCutoffの行の下に、前の約定日を飛ばしていないかを確かめる行を足します。
if (block.timestamp <= cutoffAt(day)) revert NavBeforeCutoff(day);
// 前の約定日を約定し終えるまで、次の約定日の純資産は入れられない
if (dayCursor < _orderDays.length && day > _orderDays[dayCursor]) revert NavSkipsDay(day, _orderDays[dayCursor]);
| 行 | 意味 |
|---|---|
dayCursor < _orderDays.length |
約定し終えていない約定日が残っているか。 全ての約定日を約定し終えていれば、どの日の純資産も入れられる |
day > _orderDays[dayCursor] |
入れる約定日が、約定し終えていない最も古い約定日より後か。 同じ日か、注文のない前の日なら入れられる |
入れ忘れた日を後から入れる時に、別の決まりは要りません。
setNavはlastNavDayより後の営業日なら、今日より前の日でも締め切りを過ぎていれば受け付けます。
運用会社は約定し終えていない最も古い日から順に、純資産を入れて約定します。
settleに件数の引数を足し、約定する範囲の終わりを件数で区切ります。
全件を約定し終えたら、dayCursorを次の約定日へ進めます。
/// @notice 運用会社が、純資産を入れた約定日の注文を前から順にまとめて約定する
/// 1回で終わらない時は、countの件数ずつ分けて呼ぶと続きから約定する
function settle(uint256 day, uint256 count) external onlyRole(MANAGER_ROLE) {
Order[] storage orders = _orders[day];
uint256 end = settledCount[day] + Math.min(count, orders.length - settledCount[day]);
uint256 nav = navOf[day];
if (nav == 0) revert NavNotSet(day);
uint256 start = settledCount[day];
if (start == orders.length) revert AlreadySettled(day);
for (uint256 i = start; i < end; i++) {
Order storage order = orders[i];
if (order.status != Status.Pending) continue;
order.status = Status.Settled;
if (order.kind == Kind.Subscribe) {
_settleSubscription(order, nav);
} else {
_settleRedemption(order, nav);
}
emit Settled(day, i, order.investor, order.units, order.yen);
}
settledCount[day] = end;
if (end == orders.length) dayCursor += 1;
}
| 行 | 意味 |
|---|---|
uint256 count |
この回で約定する注文の数。 取り消した注文も1件に数える |
orders.length - settledCount[day] |
まだ約定していない注文の数 |
Math.min(count, ...) |
件数が残りより多い時は、残りの数だけ約定する |
settledCount[day] + ... |
前の回が約定し終えた所から、件数の分だけ先を範囲の終わりにする |
if (end == orders.length) dayCursor += 1 |
その約定日の注文を全て約定し終えた時だけ、次の約定日へ進める |
どの注文の口数も、その注文の円とnavOf[day]だけで決まります。
navOf[day]はsetNavの時に書いた値なので、何回に分けて約定しても同じ基準価額で数えます。
そのため、分けて約定しても全件を1回で約定しても、どの注文も同じ口数になります。
次に、starter/contracts/test/TokenizedFund.t.solの_settleAllを、件数を渡す形に直します。
// 約定日の注文を全て約定する
function _settleAll(uint256 day) internal {
vm.prank(manager);
fund.settle(day, type(uint256).max);
}
件数にuint256の最大の値を渡すと、Math.minで残りの数に縮まり、1回で全件を約定します。
前のレッスンのテストは、_settleAllを通して約定しているので書き換えずに済みます。
TokenizedFundTestの末尾に、分けて約定するテストを足します。
function test_SettleInBatchesFromCursor() public {
fund.mintForTest(bob, 120_000_000);
uint256[5] memory amounts = [uint256(100_000), 250_000, 333_333, 50_000, 120_001];
for (uint256 i = 0; i < amounts.length; i++) {
vm.prank(i % 2 == 0 ? alice : bob);
fund.subscribe(amounts[i]);
}
_setNavAfterCutoff(THU, 122_868_000);
// 2件ずつ3回に分けて約定すると、続きから約定する
vm.startPrank(manager);
fund.settle(THU, 2);
assertEq(fund.settledCount(THU), 2);
fund.settle(THU, 2);
assertEq(fund.settledCount(THU), 4);
assertEq(fund.dayCursor(), 0);
fund.settle(THU, 2);
assertEq(fund.settledCount(THU), 5);
assertEq(fund.dayCursor(), 1);
// 約定し終えた約定日はもう約定できない
vm.expectRevert(abi.encodeWithSelector(TokenizedFund.AlreadySettled.selector, THU));
fund.settle(THU, 1);
vm.stopPrank();
// どの注文も、全件を1回で約定した時と同じ口数 (円 × 1万 ÷ 基準価額の切り捨て) になる
TokenizedFund.Order[] memory orders = fund.ordersOf(THU);
for (uint256 i = 0; i < amounts.length; i++) {
assertEq(orders[i].units, amounts[i] * 10_000 / 10_239);
}
}
aliceとbobが交互に5件を申し込み、前のレッスンと同じ基準価額10,239円で約定します。
3回目は残りが1件なので、件数の2より少ない1件だけを約定し、dayCursorが1へ進みます。
| 番号 | 投資家 | 申込の円 | 円 × 10,000 ÷ 10,239 | 渡す口数 |
|---|---|---|---|---|
| 0 | alice |
100,000円 | 97,665.79 | 97,665口 |
| 1 | bob |
250,000円 | 244,164.47 | 244,164口 |
| 2 | alice |
333,333円 | 325,552.30 | 325,552口 |
| 3 | bob |
50,000円 | 48,832.89 | 48,832口 |
| 4 | alice |
120,001円 | 117,199.92 | 117,199口 |
テストの最後のループは、各注文の口数を、全件を1回で約定した時の式amounts[i] * 10_000 / 10_239と比べます。
0番と1番を約定した後に口数が増えても、2番からの注文は同じ10,239円で数えるので、表の口数のとおりになります。
続けて、約定日を飛ばせないことと、入れ忘れた日を後から入れられることを確かめるテストを足します。
function test_RevertWhen_NavSkipsDay() public {
vm.prank(alice);
fund.subscribe(100_000);
// 木曜の注文を約定しないまま、金曜の純資産は入れられない
vm.warp(_at(1, 18, 0));
vm.prank(manager);
vm.expectRevert(abi.encodeWithSelector(TokenizedFund.NavSkipsDay.selector, THU + 1, THU));
fund.setNav(THU + 1, 0);
// 木曜の純資産を入れても、約定し終えるまでは金曜を入れられない
vm.prank(manager);
fund.setNav(THU, 0);
vm.prank(manager);
vm.expectRevert(abi.encodeWithSelector(TokenizedFund.NavSkipsDay.selector, THU + 1, THU));
fund.setNav(THU + 1, 0);
// 木曜を約定し終えると、金曜の純資産を入れられる
_settleAll(THU);
vm.prank(manager);
fund.setNav(THU + 1, 100_000);
assertGt(fund.navOf(THU + 1), 0);
}
function test_LateNavSettlesAtOwnDay() public {
fund.mintForTest(bob, 120_000_000);
vm.prank(alice);
fund.subscribe(300_000);
// 木曜の純資産を入れ忘れたまま、金曜にも申込が溜まる
vm.warp(_at(1, 10, 0));
vm.prank(alice);
fund.subscribe(100_000);
// 金曜の夜に、入れ忘れた木曜の純資産を後から入れると、木曜の注文は木曜の基準価額で約定する
vm.warp(_at(1, 18, 0));
vm.prank(manager);
fund.setNav(THU, 122_868_000);
_settleAll(THU);
assertEq(fund.ordersOf(THU)[0].units, 292_997);
// 続けて金曜の純資産を入れると、金曜の注文は金曜の基準価額で約定する
vm.prank(manager);
fund.setNav(THU + 1, 123_500_000);
_settleAll(THU + 1);
uint256 friday = fund.ordersOf(THU + 1)[0].units;
assertEq(friday, 100_000 * 10_000 / fund.navOf(THU + 1));
assertEq(fund.balanceOf(alice), 292_997 + friday);
}
| テスト | 確かめること |
|---|---|
test_SettleInBatchesFromCursor |
2件ずつ3回に分けるとsettledCountは2と4と5に進み、最後の回でdayCursorが1になる。約定し終えた約定日は AlreadySettledで断られ、どの注文も1回で約定した時と同じ口数になる |
test_RevertWhen_NavSkipsDay |
木曜の注文が残る間は、木曜の純資産を入れる前も入れた後も、金曜の純資産をNavSkipsDayで断る。木曜を約定し終えると入れられる |
test_LateNavSettlesAtOwnDay |
金曜の夜に入れた木曜の純資産で、木曜の注文が木曜の基準価額10,239円で約定する。 金曜の注文は金曜の基準価額で約定する |
test_RevertWhen_NavSkipsDayの金曜には注文がありません。
木曜を約定し終えるとdayCursorが1になり、_orderDaysの長さの1と並ぶので、金曜の純資産を入れられます。
test_LateNavSettlesAtOwnDayでは、木曜の約定でaliceが292,997口を受け取り、発行済みの口数は1億2,029万2,997口になります。
金曜の純資産の総額123,500,000円をこの口数で割ると、基準価額は10,266円です。
金曜の100,000円の申込は、100,000 × 10,000 ÷ 10,266 = 97,408.92口の1口未満を切り捨てて97,408口になります。
確かめる
starter/contractsのディレクトリで、ファンドのテストを実行します。
forge test
次の行が出れば、分けて約定でき、約定日を飛ばせなくなっています。
[PASS] test_LateNavSettlesAtOwnDay()
[PASS] test_RevertWhen_NavSkipsDay()
[PASS] test_SettleInBatchesFromCursor()
Suite result: ok. 20 passed; 0 failed; 0 skipped
約定日を飛ばせないことが効いているかも確かめます。
setNavのif (dayCursor < _orderDays.length && day > _orderDays[dayCursor]) revert NavSkipsDay(day, _orderDays[dayCursor]);の行を消して実行すると、test_RevertWhen_NavSkipsDayが失敗します。
[FAIL: next call did not revert as expected] test_RevertWhen_NavSkipsDay()
行を消したままでは、金曜の純資産を先に入れた後に木曜の純資産を入れようとすると、NavOutOfOrderで断られます。
木曜のsettleもNavNotSetで断られ、木曜の注文はどちらにも進めなくなります。
試したら行を戻しておきます。
次のレッスンで、約定した解約の代金を受渡日から受け取れるようにします。