HandsOnChain

締め切りの前に注文を取り消す

作るもの

このレッスンを終えると、投資家が締め切りの15時までに自分の注文を取り消せます。
申込を取り消すと預けた円が、解約を取り消すと預けた口数が投資家へ戻ります。
取り消した注文は列から消えずに残り、状態がCancelledに変わります。

15時を1秒でも過ぎた取り消しはCancelAfterCutoffのエラーで拒みます。
他人の注文の取り消しは、NotYourOrderのエラーで拒みます。

背景

投資信託の申込と解約は、締め切りの前なら販売会社で取り消せます。
締め切りを過ぎた注文は、その日の分として運用会社へ伝える手続きに入るため、取り消せなくなります。

締め切りの後の取り消しを許すと、ブラインド方式が崩れます。
締め切りの後に出た知らせやその日の値動きを見てから、得になる注文だけを残せてしまうためです。
注文した人だけが後から有利な方を選べると、値段を知らずに注文した他の人との公平さが保てません。
そのため取り消しの期限は、注文を受け付ける締め切りと同じ時刻にそろえます。

このコースでも、取り消せるのは約定日の15時ちょうどまでにします。
期限は注文した日ではなく約定日の締め切りなので、土曜の注文は月曜の15時まで取り消せます。
取り消せるのは注文した投資家だけで、運用会社も他の投資家も取り消せません。

チェーンの上では、取り消しも投資家が自分でcancelを呼ぶ取引になります。
ファンドのコントラクトが預かっていた円か口数は、その取引の中で投資家へ戻ります。
取り消した注文は列から消さず、状態を取消に変えて残すので、取り消したことも誰でも後から読めます。

1件の注文の状態
脇道今回は通らない1つの状態から入れる次の節で約定する始まり終わり約定の前Pending取り消したCancelled約定したSettled1122subscribe(300,000)subscribe(300,000)subscribe(300,000)cancel(20517, 0)
取り消そうとする人と時刻 結果
注文した投資家が15:00:00までに 取り消せて、預けた円か口数が戻る
注文した投資家が15:00:01から CancelAfterCutoffで拒む
注文した投資家とは別の人 NotYourOrderで拒む
もう取り消した注文をもう一度 NotPendingで拒む

実装

starter/contracts/contracts/TokenizedFund.solを開き、イベントの末尾に取り消しのイベントを足します。

    event Ordered(uint256 indexed day, uint256 index, address indexed investor, Kind kind, uint256 amount);
    event Cancelled(uint256 indexed day, uint256 index, address indexed investor);

エラーの末尾に、取り消しを拒む3つのエラーを足します。

    error NotBusinessDay(uint256 day);
    error NotYourOrder(uint256 day, uint256 index);
    error NotPending(uint256 day, uint256 index);
    error CancelAfterCutoff(uint256 day);
行 意味
Cancelled 取り消した注文の約定日と列の番号と投資家を残す
NotYourOrder その番号の注文が列にない時か、注文した人と呼んだ人が違う時に拒む
NotPending 取り消した注文と約定した注文を取り消そうとした
CancelAfterCutoff 約定日の15時を過ぎてから取り消そうとした。
エラーに約定日が入る

redeemの後に、取り消しの関数を足します。

    /// @notice 締め切りの前なら、注文を取り消して預けた円か口数を戻す
    function cancel(uint256 day, uint256 index) external {
        if (index >= _orders[day].length || _orders[day][index].investor != msg.sender) revert NotYourOrder(day, index);
        Order storage order = _orders[day][index];
        if (order.status != Status.Pending) revert NotPending(day, index);
        if (block.timestamp > cutoffAt(day)) revert CancelAfterCutoff(day);
        order.status = Status.Cancelled;
        if (order.kind == Kind.Subscribe) {
            pendingYen -= order.amount;
            jpy.transfer(msg.sender, order.amount * YEN);
        } else {
            heldUnits -= order.amount;
            _transfer(address(this), msg.sender, order.amount);
        }
        emit Cancelled(day, index, msg.sender);
    }
行 意味
index >= _orders[day].length その番号の注文が列にない時は拒む。
||は左が真なら右を読まないので、列の外を読まずに済む
_orders[day][index].investor != msg.sender 注文した人と呼んだ人が違えば拒む。
ない注文と他人の注文は同じNotYourOrderにする
order.status != Status.Pending 約定の前の注文だけを取り消せる
block.timestamp > cutoffAt(day) 約定日の15時を過ぎたかを見る。
>なので、15時ちょうどはまだ取り消せる
order.status = Status.Cancelled 円か口数を戻す前に、状態を取消に変える
pendingYen -= order.amount 預かった円の合計から引き、jpy.transferで投資家へ戻す
heldUnits -= order.amount 預かった口数の合計から引き、_transferでファンドのコントラクトから投資家へ戻す

期限は、前のレッスンのcutoffAtで約定日の15時を出して比べます。
渡すdayは注文した日ではなく約定日なので、土曜の注文は月曜の15時が期限になります。

状態を先に変えてから円を送るのは、同じ注文をもう一度取り消そうとしてもNotPendingで拒むためです。
注文を列から抜かないのは、抜くと後ろの注文の番号がずれ、約定日と番号の組で注文を名指せなくなるためです。
戻す口数も_transferを通るので、受け取る投資家が許可リストにいるかを_updateが確かめます。

取り消してよいかを確かめる順を図にすると、次の形になります。

注文を取り消してよいかを確かめる
他人の注文取消済みか約定済み15時を過ぎた始まり終わりcancelを呼ぶ自分の注文?約定の前?15時ちょうどまで?円か口数を戻す拒む1122334455自分の注文自分の注文自分の注文約定の前約定の前約定の前15時まで

starter/contracts/test/TokenizedFund.t.solのTokenizedFundTestの末尾に、取り消しのテストを3つ足します。

    function test_CancelBeforeCutoff() public {
        fund.mintForTest(alice, 500_000);
        vm.startPrank(alice);
        fund.subscribe(300_000);
        fund.redeem(200_000);
        // 15時ちょうどまでは取り消せる
        vm.warp(_at(0, 15, 0));
        fund.cancel(THU, 0);
        fund.cancel(THU, 1);
        vm.stopPrank();
        assertEq(jpy.balanceOf(alice), 5_000_000 * YEN);
        assertEq(fund.balanceOf(alice), 500_000);
        assertEq(fund.pendingYen(), 0);
        assertEq(fund.heldUnits(), 0);
        assertEq(uint8(fund.ordersOf(THU)[0].status), uint8(TokenizedFund.Status.Cancelled));
    }

    function test_RevertWhen_CancelAfterCutoff() public {
        vm.prank(alice);
        fund.subscribe(300_000);
        vm.warp(_at(0, 15, 0) + 1);
        vm.prank(alice);
        vm.expectRevert(abi.encodeWithSelector(TokenizedFund.CancelAfterCutoff.selector, THU));
        fund.cancel(THU, 0);
        assertEq(fund.pendingYen(), 300_000);
        assertEq(uint8(fund.ordersOf(THU)[0].status), uint8(TokenizedFund.Status.Pending));
    }

    function test_RevertWhen_CancelOthersOrder() public {
        vm.prank(alice);
        fund.subscribe(300_000);
        vm.prank(bob);
        vm.expectRevert(abi.encodeWithSelector(TokenizedFund.NotYourOrder.selector, THU, 0));
        fund.cancel(THU, 0);
        assertEq(fund.pendingYen(), 300_000);
    }
テスト 確かめること
test_CancelBeforeCutoff 10時に300,000円の申込と200,000口の解約を出し、15時ちょうどに両方を取り消す。
円は5,000,000円に、口数は500,000口に戻り、預かった合計は0になる
test_RevertWhen_CancelAfterCutoff 15:00:01の取り消しはCancelAfterCutoffで拒まれ、預かった300,000円と約定の前の状態はそのまま残る
test_RevertWhen_CancelOthersOrder aliceの注文をbobが取り消そうとするとNotYourOrderで拒まれ、預かった300,000円は動かない

vm.startPrank(alice)からvm.stopPrank()までの呼び出しは、全てaliceが送ったものとして扱われます。
申込が列の番号0に、解約が番号1に入るので、cancel(THU, 0)とcancel(THU, 1)で2件を取り消します。
aliceはsetUpで5,000,000円を持ち、mintForTestで500,000口を受け取っているので、取り消した後は両方とも初めの数に戻ります。

確かめる

starter/contractsのディレクトリで、Foundryのテストを実行します。

forge test

次の行が出れば、締め切りの前の取り消しは正しく動いています。

[PASS] test_CancelBeforeCutoff()
[PASS] test_RevertWhen_CancelAfterCutoff()
[PASS] test_RevertWhen_CancelOthersOrder()
Suite result: ok. 13 passed; 0 failed; 0 skipped

15時ちょうどまで取り消せることも確かめます。
cancelのblock.timestamp > cutoffAt(day)の>を>=に書き換えて実行します。

        if (block.timestamp >= cutoffAt(day)) revert CancelAfterCutoff(day);

15時ちょうどの取り消しも締め切りの後として拒むので、test_CancelBeforeCutoffが失敗します。

[FAIL: CancelAfterCutoff(20517 [2.051e4])] test_CancelBeforeCutoff()

エラーに入った20517は、木曜の約定日の番号です。
確かめたら、元の>に戻しておきます。

持ち主を確かめる行が効いていることも試しておきます。
cancelの1行目の|| _orders[day][index].investor != msg.senderを消して実行すると、test_RevertWhen_CancelOthersOrderが失敗します。

[FAIL: next call did not revert as expected] test_RevertWhen_CancelOthersOrder()

持ち主を確かめないと、bobがaliceの注文を取り消せてしまいます。
cancelは呼んだ人へ円を戻すので、aliceが預けた300,000円がbobへ送られます。
確かめたら、消した所を戻しておきます。
次のレッスンで、投資家のページから申し込み、注文の表で約定日と状態を見て取り消せるようにします。