担保の社債の利金を借り手へ渡す
作るもの
このレッスンを終えると、担保に預けた社債トークンの利金をローンのコントラクトが決済のコントラクトから受け取り、借り手へ渡せます。
借り手は利払い日の後にclaimCouponを呼び、記録日に担保として預けていた口数の分の利金を受け取ります。
記録日の後に預けた口数の分は、ローンのコントラクトからは受け取れません。
その口数の利金は、記録日に自分で社債を持っていた借り手として、決済のコントラクトから受け取ります。
背景
証券担保ローンで社債を担保に預けても、借り手は社債を売ったわけではありません。
返し終えれば社債は借り手へ戻り、担保に預けている間に生まれる利金も借り手が受け取ります。
銀行は担保を預かるだけで、利金を自分のものにはしません。
チェーンの上で担保を預けると、社債トークンは借り手のアカウントからローンのコントラクトへ移ります。
2作目の決済のコントラクトは、記録日に社債を持っていたアカウントへ利金を払います。
記録日に社債を持っているのはローンのコントラクトなので、借り手は決済のコントラクトから受け取れません。
ローンのコントラクトが何もしなければ、利金は誰も受け取らないまま決済のコントラクトに残ります。
そこで、ローンのコントラクトが借り手ごとに預けた口数の履歴を持ちます。
2作目の社債トークンがbalanceAtのために持つ口数の履歴と同じく、OpenZeppelin ContractsのCheckpointsで時刻と口数の組を積みます。
利払い日の後に、ローンのコントラクトは預かっていた全ての口数の利金を決済のコントラクトから1回だけ受け取ります。
その後に、借り手ごとに記録日に預けていた口数の分を渡します。
受け取る額を決めるのは、記録日に預けていた口数です。
記録日の後に預けた口数も、記録日の後に処分されて手放した口数も、その回の利金の額を変えません。
次の図は、借り手Aが記録日の前から10口を預け、借り手Cが記録日の次の日に10口を預けた時の図です。
第1回の利金を誰がどこから受け取るかを示します。
実装
starter/contracts/contracts/SecuritiesLoan.solを開き、Checkpointsの読み込みを足します。
import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol";
import {Checkpoints} from "@openzeppelin/contracts/utils/structs/Checkpoints.sol";
コントラクトの頭で、履歴の型にCheckpointsの関数を付けます。
contract SecuritiesLoan {
using Checkpoints for Checkpoints.Trace208;
recoveredの後に、預けた口数の履歴と、受け取った印を足します。
/// @notice 処分で買い手が払い、利息と元本に充てた円の合計
uint256 public recovered;
// 借り手ごとの預けた口数の履歴
mapping(address borrower => Checkpoints.Trace208) private _pledgeHistory;
/// @notice n回目の利金を決済のコントラクトから受け取ったか
mapping(uint256 n => bool) public couponReceived;
/// @notice 借り手がn回目の利金を受け取ったか
mapping(uint256 n => mapping(address borrower => bool)) public couponClaimed;
| 行 | 意味 |
|---|---|
Checkpoints.Trace208 |
時刻を48ビットの整数で、口数を208ビットの整数で持つ組の並び |
_pledgeHistory |
借り手ごとの、預けた口数が変わった時刻と変わった後の口数 |
couponReceived |
ローンのコントラクトが、その回の利金を決済のコントラクトから受け取ったか |
couponClaimed |
借り手が、その回の利金をローンのコントラクトから受け取ったか |
イベントとエラーを、それぞれの並びの末尾に足します。
event CouponClaimed(uint256 indexed n, address indexed borrower, uint256 amount);
error AlreadyClaimed(uint256 n, address borrower);
error NothingToClaim(uint256 n, address borrower);
| エラー | 拒む時 |
|---|---|
AlreadyClaimed |
その回の利金をもう受け取っている |
NothingToClaim |
記録日に担保として1口も預けていなかった |
預けた口数が変わる所は3つあります。
pledgeで口数を足した時、_releaseで全てを返した時、liquidateで処分した時です。
3つの所で、変わった後の口数を履歴に積みます。
pledgeのp.units += units;の次の行に足します。
p.units += units;
_recordPledge(msg.sender, p.units);
_releaseとliquidateでは、p.calledAt = 0;の次の行に足します。
p.calledAt = 0;
_recordPledge(borrower, 0);
liquidateの後に、利金を読む関数と受け取る関数と、履歴に積む関数を足します。
// 担保の利金
/// @notice ある時刻に借り手が担保として預けていた口数
function pledgedAt(address borrower, uint256 time) public view returns (uint256) {
return _pledgeHistory[borrower].upperLookupRecent(SafeCast.toUint48(time));
}
/// @notice n回目に借り手が受け取れる利金 (円)。記録日に預けていた口数に1口の利金を掛ける
function couponOf(uint256 n, address borrower) public view returns (uint256) {
return settlement.couponPerUnit(n) * pledgedAt(borrower, bond.recordDate(n));
}
/// @notice 利払い日の後に、記録日に担保として預けていた口数の利金を受け取る。
/// 最初の借り手が受け取る時に、ローンのコントラクトが決済のコントラクトから全員の分を受け取る
function claimCoupon(uint256 n) external {
if (couponClaimed[n][msg.sender]) revert AlreadyClaimed(n, msg.sender);
uint256 amount = couponOf(n, msg.sender);
if (amount == 0) revert NothingToClaim(n, msg.sender);
couponClaimed[n][msg.sender] = true;
if (!couponReceived[n]) {
couponReceived[n] = true;
settlement.claimCoupon(n);
}
jpy.transfer(msg.sender, amount * YEN);
emit CouponClaimed(n, msg.sender, amount);
}
function _recordPledge(address borrower, uint256 units) private {
_pledgeHistory[borrower].push(SafeCast.toUint48(block.timestamp), SafeCast.toUint208(units));
}
| 行 | 意味 |
|---|---|
upperLookupRecent(...) |
渡した時刻と同じか前の組のうち、最も新しい組の口数を返す。 預けたことのない借り手は0になる |
settlement.couponPerUnit(n) |
2作目の決済のコントラクトが計算する、n回目の1口の利金 (円) |
bond.recordDate(n) |
n回目の記録日。 記録日の日本時間の0時に預けていた口数を読む |
couponClaimed[n][msg.sender] = true |
円を送る前に、受け取った印を書く |
if (!couponReceived[n]) |
その回で最初の受け取りの時だけ、決済のコントラクトから受け取る。 2人目からは受け取り済みの円から渡す |
settlement.claimCoupon(n) |
決済のコントラクトは、記録日にローンのコントラクトが持っていた口数の分を送る。 利払い日の前か発行体の入金が足りない時は、決済のコントラクトが BeforePaymentDateかCouponUnfundedで拒む |
amount * YEN |
1円単位の額を、円トークンの18桁の単位へ直して送る |
_recordPledge |
今のブロックの時刻と、変わった後の口数の組を履歴に積む |
決済のコントラクトから受け取る額は、記録日にローンのコントラクトが持っていた口数の分です。
その口数は、記録日に借り手が預けていた口数の和と等しくなります。
そのため、全ての借り手が受け取り終えると、受け取った円はちょうどなくなります。
受け取った利金はcash()の帳簿に入れないので、貸し手が貸す円とも混ざりません。
次に、starter/contracts/test/SecuritiesLoan.t.solのsetUpで、募集を締めた後に発行体が2回の利金を入れておきます。
vm.warp(ISSUE_DATE);
settlement.close();
// 発行体が2回の利金を入れておく
vm.startPrank(issuer);
jpy.approve(address(settlement), type(uint256).max);
settlement.fundCoupon(0, settlement.couponDue(0));
settlement.fundCoupon(1, settlement.couponDue(1));
vm.stopPrank();
SecuritiesLoanTestの末尾に、利金のテストを2つ足します。
function test_PledgedCouponGoesToBorrower() public {
// aliceは記録日の前に10口を預け、bobは自分で10口を持ったまま記録日を迎える
_pledgeAndBorrow(alice, 10, 100_000);
vm.warp(PAY_1);
// 1口の利金は 100,000 × 0.8% × 181 / 365 = 396円
assertEq(loan.couponOf(0, alice), 3_960);
uint256 before = jpy.balanceOf(alice);
vm.prank(alice);
loan.claimCoupon(0);
assertEq(jpy.balanceOf(alice) - before, 3_960 * YEN);
assertTrue(loan.couponReceived(0));
vm.prank(bob);
settlement.claimCoupon(0);
assertEq(settlement.couponPaid(0), 7_920 * YEN);
}
function test_RevertWhen_CouponForUnitsPledgedAfterRecordDate() public {
// 記録日の後に預けた口数は、ローンのコントラクトからは受け取れない
vm.warp(RECORD_1 + 1 days);
_setPrice(PRICE);
vm.prank(alice);
loan.pledge(10);
vm.warp(PAY_1);
vm.expectRevert(abi.encodeWithSelector(SecuritiesLoan.NothingToClaim.selector, 0, alice));
vm.prank(alice);
loan.claimCoupon(0);
// 記録日に自分で持っていたので、決済のコントラクトから受け取る
vm.prank(alice);
settlement.claimCoupon(0);
assertTrue(settlement.couponClaimed(0, alice));
}
| テスト | 確かめること |
|---|---|
test_PledgedCouponGoesToBorrower |
記録日の前に10口を預けたaliceが、ローンのコントラクトから3,960円を受け取る。自分で10口を持っていた bobの分と合わせ、決済のコントラクトが払った額は7,920円になる |
test_RevertWhen_CouponForUnitsPledgedAfterRecordDate |
記録日の次の日に預けたaliceは、ローンのコントラクトからはNothingToClaimで拒まれ、決済のコントラクトから自分で受け取れる |
確かめる
starter/contractsのディレクトリで、Foundryのテストを実行します。
forge test --match-contract SecuritiesLoanTest
次の行が出れば、担保の利金のテストは通っています。
[PASS] test_PledgedCouponGoesToBorrower()
[PASS] test_RevertWhen_CouponForUnitsPledgedAfterRecordDate()
Suite result: ok. 25 passed; 0 failed; 0 skipped
履歴に積むのを忘れた時に何が起こるかも確かめます。
pledgeの_recordPledge(msg.sender, p.units);の行を消して実行すると、test_PledgedCouponGoesToBorrowerが失敗します。
[FAIL: assertion failed: 0 != 3960] test_PledgedCouponGoesToBorrower()
預けた時に履歴を積まないと、ローンのコントラクトはaliceが記録日に1口も預けていなかったと読みます。
決済のコントラクトは記録日にローンのコントラクトが持っていた10口の分を払うのに、受け取れる借り手がいなくなります。
確かめたら、消した行を戻しておきます。
次のレッスンで、返済の期限を過ぎた借り手と、不履行になった社債を担保にした借り手の担保を処分します。