HandsOnChain

解約の口数に上限を掛ける

作るもの

このレッスンを終えると、ファンドのコントラクトが、同じ投資家が同じ約定日に注文した解約の口数を合計します。
合計が100万口を超える解約の注文は拒みます。
600,000口と400,000口の2件に分けた解約はちょうど100万口なので受け付け、その後の1口はOverRedeemLimit(1, 0)のエラーで拒みます。
取り消した注文の口数は合計から外れ、15時を過ぎた注文は次の約定日の合計に数え、他の投資家の注文は合計に数えません。

背景

多くの投資信託は、営業日ならいつでも解約を申し込めます。
ただし、1日に大口の解約が集まると、運用会社は短い間に多くの資産を売って代金を用意しなければなりません。
急いで売ると値段が下がりやすく、持ち続ける人の基準価額も下がります。
そのため目論見書には、ファンドの資金管理を円滑に行うために、大口の換金に制限を設ける場合があると書かれています。

取引所の取引が止まった時のように、やむを得ない事情がある時は換金の受付を止めることがあるとも書かれています。
何を大口とし、どう制限するかはファンドごとに決まります。
このコースでは、この制限を具体的な口数で決め、1人の投資家が1つの約定日に解約できる口数を100万口までにします。

上限を1件の注文ごとに見ると、大きな解約を小さな注文に分けて上限を避けられます。
そこで、同じ投資家が同じ約定日に注文した解約の口数を全て足し、合計で上限と比べます。
ブラインド方式では注文の時に代金の円が決まらないので、上限は円ではなく口数で数えます。

注文 合計に数えるか
同じ投資家の同じ約定日の解約 数える
取り消した解約 数えない。
取り消すと合計から引く
15時を過ぎた解約と土日の解約 次の営業日の約定日の合計に数える
他の投資家の解約 数えない。
投資家ごとに100万口まで
申込 数えない
同じ約定日の解約を合計で数える
投資家Aの解約の合計木曜600,000口1,000,000口金曜1,000,000口投資家A200万口を持つファンドのコントラクトTokenizedFund11223344redeem(600,000)redeem(600,000)redeem(400,000)redeem(400,000)redeem(1)redeem(1)OverRedeemLimit(1, 0)OverRedeemLimit(1, 0)redeem(1,000,000)

オンチェーンでは、注文を受け付けるファンドのコントラクト自身が合計を数え、上限を超える注文をその場で拒みます。
拒んだ注文は取引ごと元に戻るので、口数は投資家から動かず、注文の列にも入りません。
投資家ごとの合計はチェーンに残り、誰でも読めます。
コントラクトは投資家をアカウントで見分けるので、上限もアカウントごとに数えます。

実装

starter/contracts/contracts/TokenizedFund.solを開き、RETENTION_BPSの後に解約の上限を足します。

    /// @notice 信託財産留保額の率 (1万分率。30で0.3%)
    uint256 public constant RETENTION_BPS = 30;
    /// @notice 1人の投資家が1つの約定日に解約できる口数の上限
    uint256 public constant REDEEM_LIMIT = 1_000_000;

trustFeeTotalの後に、投資家ごとの解約の合計を足します。

    /// @notice 運用会社が受け取った信託報酬の合計
    uint256 public trustFeeTotal;
    /// @notice 投資家ごとの、約定日に注文した解約の口数の合計
    mapping(uint256 day => mapping(address investor => uint256)) public redeemedOn;

エラーの末尾に、上限を超えた時のエラーを足します。

    error NothingToClaim(uint256 day);
    error OverRedeemLimit(uint256 units, uint256 remaining);
行 意味
REDEEM_LIMIT = 1_000_000 1人の投資家が1つの約定日に解約できる口数。
1口が最小単位なので、100万口をそのまま書く
redeemedOn 約定日の番号と投資家のアドレスごとに、注文した解約の口数の合計を持つ。
取り消した分は含まない
OverRedeemLimit(units, remaining) 注文しようとした口数と、その約定日にあと何口まで注文できるかを返す

redeemで、_checkInvestorの行の次に、上限を確かめる行を足します。

    /// @notice 口数で解約する。口数は注文の時に預かり、約定日の基準価額で代金が決まる
    function redeem(uint256 units) external returns (uint256 day, uint256 index) {
        if (units == 0) revert ZeroAmount();
        _checkInvestor(msg.sender);
        // 同じ約定日に注文した解約の口数を足し、上限を超える注文を断る
        uint256 tradeDay = tradeDayOf(block.timestamp);
        uint256 ordered = redeemedOn[tradeDay][msg.sender];
        if (ordered + units > REDEEM_LIMIT) revert OverRedeemLimit(units, REDEEM_LIMIT - ordered);
        redeemedOn[tradeDay][msg.sender] = ordered + units;
        _transfer(msg.sender, address(this), units);
        heldUnits += units;
        return _placeOrder(Kind.Redeem, units);
    }
行 意味
tradeDayOf(block.timestamp) 注文した時刻から約定日を決める。
_placeOrderが注文を入れる約定日と同じ日になる
redeemedOn[tradeDay][msg.sender] この投資家がこの約定日にもう注文した解約の口数の合計
ordered + units > REDEEM_LIMIT 今までの合計に今回の口数を足して比べる。
>なので、合計がちょうど100万口の注文は受け付ける
REDEEM_LIMIT - ordered あと何口まで注文できるかをエラーに添える。
合計が100万口の投資家には0を返す
redeemedOn[tradeDay][msg.sender] = ordered + units 確かめた後で合計を書き換え、その後に口数を預かる

0口の注文と許可リストにない人の注文は、これまでどおり上限を確かめる前に拒みます。
上限を確かめる行は口数を預かる_transferより前に置くので、拒んだ注文では口数が動きません。

cancelで、解約の注文を取り消す側に、合計から引く行を足します。

        } else {
            heldUnits -= order.amount;
            redeemedOn[day][msg.sender] -= order.amount;
            _transfer(address(this), msg.sender, order.amount);
        }
行 意味
redeemedOn[day][msg.sender] -= order.amount 取り消した解約の口数を、その約定日の合計から引く。
cancelは注文した本人だけが呼べるので、msg.senderは注文した投資家になる

cancelは締め切りの15時までしか呼べないので、合計から引くのも締め切りの前だけです。
取り消した分は合計から外れ、同じ約定日にもう一度注文できます。

解約の注文を受け付けるかは、次の順に決まります。

解約の注文を受け付けるか決める順
超える始まり終わりredeemを呼ぶ注文した時刻から約定日を決める合計が100万口を超える?合計に足して口数を預かるOverRedeemLimitで拒む11223344超えない

最後に、starter/contracts/test/TokenizedFund.t.solのTokenizedFundTestの末尾に、上限のテストを4つ足します。

    function test_RevertWhen_RedeemTotalOverLimit() public {
        fund.mintForTest(alice, 2_000_000);
        vm.startPrank(alice);
        // 2件に分けても、合計でちょうど100万口までは受け付ける
        fund.redeem(600_000);
        fund.redeem(400_000);
        vm.expectRevert(abi.encodeWithSelector(TokenizedFund.OverRedeemLimit.selector, 1, 0));
        fund.redeem(1);
        vm.stopPrank();
        assertEq(fund.redeemedOn(THU, alice), 1_000_000);
        assertEq(fund.balanceOf(alice), 1_000_000);
        assertEq(fund.heldUnits(), 1_000_000);
    }

    function test_CancelFreesRedeemLimit() public {
        fund.mintForTest(alice, 2_000_000);
        vm.startPrank(alice);
        fund.redeem(1_000_000);
        fund.cancel(THU, 0);
        assertEq(fund.redeemedOn(THU, alice), 0);
        // 取り消した分は、もう一度注文できる
        fund.redeem(1_000_000);
        vm.stopPrank();
        assertEq(fund.redeemedOn(THU, alice), 1_000_000);
    }

    function test_RedeemLimitCountsPerTradeDate() public {
        fund.mintForTest(alice, 2_000_000);
        vm.prank(alice);
        fund.redeem(1_000_000);
        // 15時を過ぎた解約は金曜の合計に数えるので、木曜の合計が100万口でも受け付ける
        vm.warp(_at(0, 15, 0) + 1);
        vm.prank(alice);
        (uint256 day,) = fund.redeem(1_000_000);
        assertEq(day, THU + 1);
        assertEq(fund.redeemedOn(THU, alice), 1_000_000);
        assertEq(fund.redeemedOn(THU + 1, alice), 1_000_000);
    }

    function test_RedeemLimitPerInvestor() public {
        fund.mintForTest(alice, 1_000_000);
        fund.mintForTest(bob, 1_000_000);
        vm.prank(alice);
        fund.redeem(1_000_000);
        // 投資家Aの合計は投資家Bに数えないので、投資家Bも100万口を解約できる
        vm.prank(bob);
        fund.redeem(1_000_000);
        assertEq(fund.redeemedOn(THU, bob), 1_000_000);
        assertEq(fund.heldUnits(), 2_000_000);
    }
テスト 確かめること
test_RevertWhen_RedeemTotalOverLimit 60万口と40万口の2件で合計がちょうど100万口になり、どちらも受け付ける。
次の1口はOverRedeemLimit(1, 0)で拒まれ、合計とファンドの預かる口数は100万口のまま。
aliceの持つ口数も200万口から100万口に減ったまま変わらない
test_CancelFreesRedeemLimit 100万口の注文を取り消すと合計が0口に戻り、同じ木曜にもう一度100万口を注文できる
test_RedeemLimitCountsPerTradeDate 木曜の15時を1秒過ぎた注文は金曜の約定日に入り、木曜の合計が100万口でも受け付ける。
木曜と金曜の合計は100万口ずつになる
test_RedeemLimitPerInvestor aliceが100万口を注文した後でも、bobは自分の100万口を注文できる。
ファンドの預かる口数は2人分の200万口になる

vm.startPrank(alice)は、vm.stopPrank()までの呼び出しを全てaliceの名義にします。
vm.expectRevertは、次の呼び出しが渡したエラーで拒まれることを確かめます。
OverRedeemLimit(1, 0)の1は注文しようとした口数で、0はあと注文できる口数です。
_at(0, 15, 0) + 1は木曜の15時0分1秒で、締め切りを1秒過ぎた時刻です。

確かめる

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

forge test --match-contract TokenizedFundTest

次の行が出れば、解約の上限のテストは通っています。

[PASS] test_CancelFreesRedeemLimit()
[PASS] test_RedeemLimitCountsPerTradeDate()
[PASS] test_RedeemLimitPerInvestor()
[PASS] test_RevertWhen_RedeemTotalOverLimit()
Suite result: ok. 32 passed; 0 failed; 0 skipped

redeemとcancelを書き換えたので、前の節で作ったinvariantのテストも実行しておきます。

forge test --match-contract TokenizedFundInvariantTest
[PASS] invariant_FundYenMatchesOrders()
[PASS] invariant_UnitsMatchHolders()
Suite result: ok. 2 passed; 0 failed; 0 skipped

上限を超えた解約は取引ごと元に戻り、口数も注文の記録も変わらないので、円と口数の釣り合いは崩れません。
上限を合計で数えることも試しておきます。
redeemのordered + units > REDEEM_LIMITを、1件の口数だけを見る次の行に書き換えて実行します。

        if (units > REDEEM_LIMIT) revert OverRedeemLimit(units, REDEEM_LIMIT - ordered);

1件ずつ見ると、合計が100万口に達した後の1口も受け付けるため、vm.expectRevertで待ったエラーが出ずにテストが失敗します。

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

注文を分ければ上限を避けられてしまうことが、このテストで分かります。
確かめたら、元の行に戻しておきます。
次のレッスンで、信託報酬と解約価額と解約の上限の残りを画面に出します。