[ALPHANET] Coupon Payments #35
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| #pragma once | ||
|
|
||
| #include <xrpl/beast/utility/Journal.h> | ||
| #include <xrpl/ledger/ApplyView.h> | ||
| #include <xrpl/ledger/ReadView.h> | ||
| #include <xrpl/protocol/AccountID.h> | ||
| #include <xrpl/protocol/STAmount.h> | ||
| #include <xrpl/protocol/STLedgerEntry.h> | ||
| #include <xrpl/protocol/TER.h> | ||
| #include <xrpl/protocol/XRPAmount.h> | ||
|
|
||
| #include <cstdint> | ||
| #include <optional> | ||
|
|
||
| namespace xrpl { | ||
|
|
||
| /** | ||
| * Settle coupon accrual on a registration. | ||
| * | ||
| * Computes the coupon dates elapsed since the registration's | ||
| * LastSettledTime (strictly before the schedule's Expiration, if any), | ||
| * adds count * RegisteredUnits * CouponAmount to AccruedAmount — | ||
| * rounded once, downward, to the coupon asset's precision — and | ||
| * advances LastSettledTime to the latest elapsed date. O(1) in the | ||
| * number of elapsed dates. The caller must view.update() the | ||
| * registration on tesSUCCESS. | ||
| */ | ||
| [[nodiscard]] TER | ||
| couponSettle( | ||
| SLE::const_ref schedule, | ||
| SLE::ref registration, | ||
| std::uint32_t parentCloseTime, | ||
| beast::Journal j); | ||
|
|
||
| /** | ||
| * Eligibility for locking bond units into a registration. | ||
| * | ||
| * Mirrors the token Escrow lock gates: issuer opt-in | ||
| * (lsfAllowTrustLineLocking / lsfMPTCanEscrow), authorization, freeze | ||
| * and lock state, and the holder's spendable balance. | ||
| */ | ||
| [[nodiscard]] TER | ||
| couponLockPreclaim( | ||
| ReadView const& view, | ||
|
There was a problem hiding this comment. The IOU specialization of the lock preclaim uses |
||
| AccountID const& holder, | ||
| STAmount const& units, | ||
| beast::Journal j); | ||
|
|
||
| /** | ||
| * Lock bond units: IOU balances park on the bond issuer's trust line, | ||
| * MPT amounts move into sfLockedAmount — the token Escrow mechanics. | ||
| */ | ||
| [[nodiscard]] TER | ||
| couponLockUnits(ApplyView& view, AccountID const& holder, STAmount const& units, beast::Journal j); | ||
|
|
||
| /** | ||
| * Release locked bond units back to the holder's spendable balance. | ||
| * No transfer fee applies (round trip to self). | ||
| */ | ||
| [[nodiscard]] TER | ||
| couponUnlockUnits( | ||
| ApplyViewContext ctx, | ||
| SLE::ref sleHolder, | ||
| XRPAmount preFeeBalance, | ||
| STAmount const& units, | ||
| AccountID const& holder, | ||
| beast::Journal j); | ||
|
|
||
| /** | ||
| * Delete a registration if its RegisteredUnits and AccruedAmount are | ||
| * both zero: remove it from the holder's directory, refund the owner | ||
| * reserve, and decrement the schedule's RegistrationCount. The caller | ||
| * must view.update() the schedule when a deletion is reported. | ||
| * | ||
| * @return std::nullopt if the registration is not empty (not deleted); | ||
| * tesSUCCESS if it was deleted; an error TER on failure. | ||
| */ | ||
| [[nodiscard]] std::optional<TER> | ||
| couponDeleteRegistrationIfEmpty( | ||
| ApplyView& view, | ||
| SLE::ref schedule, | ||
| SLE::ref registration, | ||
| AccountID const& holder, | ||
| beast::Journal j); | ||
|
|
||
| } // namespace xrpl | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| #pragma once | ||
|
|
||
| #include <xrpl/beast/utility/Journal.h> | ||
| #include <xrpl/ledger/ReadView.h> | ||
| #include <xrpl/protocol/STTx.h> | ||
| #include <xrpl/protocol/TER.h> | ||
| #include <xrpl/protocol/XRPAmount.h> | ||
| #include <xrpl/tx/ApplyContext.h> | ||
| #include <xrpl/tx/Transactor.h> | ||
|
|
||
| namespace xrpl { | ||
|
|
||
| class CouponClaim : public Transactor | ||
| { | ||
| public: | ||
| static constexpr auto kConsequencesFactory = ConsequencesFactoryType::Normal; | ||
|
|
||
| explicit CouponClaim(ApplyContext& ctx) : Transactor(ctx) | ||
| { | ||
| } | ||
|
|
||
| static NotTEC | ||
| preflight(PreflightContext const& ctx); | ||
|
|
||
| static TER | ||
| preclaim(PreclaimContext const& ctx); | ||
|
|
||
| TER | ||
| doApply() override; | ||
|
|
||
| void | ||
| visitInvariantEntry(bool isDelete, SLE::const_ref before, SLE::const_ref after) override; | ||
|
|
||
| [[nodiscard]] bool | ||
| finalizeInvariants( | ||
| STTx const& tx, | ||
| TER result, | ||
| XRPAmount fee, | ||
| ReadView const& view, | ||
| beast::Journal const& j) override; | ||
| }; | ||
|
|
||
| } // namespace xrpl |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| #pragma once | ||
|
|
||
| #include <xrpl/beast/utility/Journal.h> | ||
| #include <xrpl/ledger/ReadView.h> | ||
| #include <xrpl/protocol/STTx.h> | ||
| #include <xrpl/protocol/TER.h> | ||
| #include <xrpl/protocol/XRPAmount.h> | ||
| #include <xrpl/tx/ApplyContext.h> | ||
| #include <xrpl/tx/Transactor.h> | ||
|
|
||
| namespace xrpl { | ||
|
|
||
| class CouponRegister : public Transactor | ||
| { | ||
| public: | ||
| static constexpr auto kConsequencesFactory = ConsequencesFactoryType::Normal; | ||
|
|
||
| explicit CouponRegister(ApplyContext& ctx) : Transactor(ctx) | ||
| { | ||
| } | ||
|
|
||
| static NotTEC | ||
| preflight(PreflightContext const& ctx); | ||
|
|
||
| static TER | ||
| preclaim(PreclaimContext const& ctx); | ||
|
|
||
| TER | ||
| doApply() override; | ||
|
|
||
| void | ||
| visitInvariantEntry(bool isDelete, SLE::const_ref before, SLE::const_ref after) override; | ||
|
|
||
| [[nodiscard]] bool | ||
| finalizeInvariants( | ||
| STTx const& tx, | ||
| TER result, | ||
| XRPAmount fee, | ||
| ReadView const& view, | ||
| beast::Journal const& j) override; | ||
| }; | ||
|
|
||
| } // namespace xrpl |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The accrual computation constructs
additionAmtviaSTAmount{couponAmount.asset(), addition}(CouponHelpers.cpp:68) before thecanAddoverflow guard on the next line has any chance to run. Whencount * RegisteredUnits * CouponAmountexceeds the asset's representable range — which is fully attacker-controlled via registration units and elapsed intervals — theSTAmountconstructor throwsstd::overflow_errororstd::runtime_error. None of the three transactors that callcouponSettle(CouponClaim, CouponRegister, CouponUnregister) catch this exception, so it bubbles to the outerapplyStepshandler and becomestefEXCEPTION. BecausesfLastSettledTimeis written on lines 77-78, after the throw, it never advances — and sinceCouponUnregister::doApplycallscouponSettlebefore releasing locked units, the holder can neither claim nor exit, permanently locking their registered bond units. Fix: bound-check theNumbermultiplication before constructing the STAmount, or wrap the construction in a try/catch that translates totecPRECISION_LOSS.