Skip to content

fix: Clamp VaultClawback to assetsAvailable for zero-amount clawback #6646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tapanito wants to merge 3 commits into
base: develop
Choose a base branch
from
+220 −9
Open

fix: Clamp VaultClawback to assetsAvailable for zero-amount clawback #6646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70f8b1d
fix: Clamp VaultClawback to assetsAvailable for zero-amount clawback
Tapanito Mar 25, 2026
42debc4
test: Add pre-amendment coverage and tighten VaultClawback assertions
Tapanito Mar 25, 2026
1dbf8dd
fix: Merge origin/develop; replace fixAssortedFixes with fixSecurity3…
Tapanito Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 32 additions & 9 deletions src/libxrpl/tx/transactors/vault/VaultClawback.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
#include <xrpl/tx/transactors/vault/VaultClawback.h>

#include <optional>
#include <utility>

namespace xrpl {
NotTEC
Expand Down Expand Up @@ -226,7 +227,11 @@ VaultClawback::assetsToClawback(
auto const mptIssuanceID = *vault->at(sfShareMPTID);
MPTIssue const share{mptIssuanceID};

if (clawbackAmount == beast::zero)
// Pre-fixSecurity3_1_3: zero-amount clawback returned early without
// clamping to assetsAvailable, allowing more assets to be recovered
// than available when there was an outstanding loan. Retained for
// ledger replay compatibility.
if (!ctx_.view().rules().enabled(fixSecurity3_1_3) && clawbackAmount == beast::zero)
Comment on lines +230 to +234
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR description mentions keeping the legacy behavior behind a !fixAssortedFixes gate, but the code gates it on !fixSecurity3_1_3. Since fixAssortedFixes doesn't appear to exist in the codebase, please either update the PR description to match the actual feature flag or switch the gate to the intended amendment if different.

Copilot uses AI. Check for mistakes.
{
auto const sharesDestroyed = accountHolds(
view(),
Expand All @@ -243,22 +248,40 @@ VaultClawback::assetsToClawback(
}

STAmount sharesDestroyed;
STAmount assetsRecovered = clawbackAmount;
STAmount assetsRecovered;

try
{
if (clawbackAmount == beast::zero)
{
sharesDestroyed = accountHolds(
view(),
holder,
share,
FreezeHandling::fhIGNORE_FREEZE,
AuthHandling::ahIGNORE_AUTH,
j_);
auto const maybeAssets =
sharesToAssetsWithdraw(vault, sleShareIssuance, sharesDestroyed);
if (!maybeAssets)
return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE

assetsRecovered = *maybeAssets;
}
else
{
auto const maybeShares =
assetsToSharesWithdraw(vault, sleShareIssuance, assetsRecovered);
assetsToSharesWithdraw(vault, sleShareIssuance, clawbackAmount);
if (!maybeShares)
return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE
sharesDestroyed = *maybeShares;
}

auto const maybeAssets = sharesToAssetsWithdraw(vault, sleShareIssuance, sharesDestroyed);
if (!maybeAssets)
return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE
assetsRecovered = *maybeAssets;

auto const maybeAssets =
sharesToAssetsWithdraw(vault, sleShareIssuance, sharesDestroyed);
if (!maybeAssets)
return Unexpected(tecINTERNAL); // LCOV_EXCL_LINE
assetsRecovered = *maybeAssets;
}
// Clamp to maximum.
if (assetsRecovered > *assetsAvailable)
{
Expand Down
188 changes: 188 additions & 0 deletions src/test/app/Vault_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4785,6 +4785,7 @@ class Vault_test : public beast::unit_test::suite
using namespace loanBroker;
using namespace loan;
Env env(*this);
env.enableFeature(fixSecurity3_1_3);

auto const setupVault = [&](PrettyAsset const& asset,
Account const& owner,
Expand All @@ -4798,6 +4799,7 @@ class Vault_test : public beast::unit_test::suite

auto const& vaultSle = env.le(vaultKeylet);
BEAST_EXPECT(vaultSle != nullptr);
env.memoize(Account("vault", vaultSle->at(sfAccount)));
env(vault.deposit(
{.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}),
ter(tesSUCCESS));
Expand Down Expand Up @@ -4954,6 +4956,124 @@ class Vault_test : public beast::unit_test::suite
}),
ter(tesSUCCESS));
}

{
testcase(
"VaultClawback (asset) - " + prefix +
" zero-amount clawback clamped with outstanding loan");
auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer);

auto const vaultSle = env.le(vaultKeylet);
BEAST_EXPECT(vaultSle != nullptr);
if (!vaultSle)
return;

PrettyAsset shares = MPTIssue(vaultSle->at(sfShareMPTID));

// Create a loan broker backed by this vault
auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner));
env(set(owner, vaultKeylet.key));
env.close();

// Depositor borrows 40 units, reducing assetsAvailable to 60
// while assetsTotal stays at 100
env(set(depositor, brokerKeylet.key, asset(40).value()),
loan::interestRate(TenthBips32(0)),
gracePeriod(60),
paymentInterval(120),
paymentTotal(10),
sig(sfCounterpartySignature, owner),
fee(env.current()->fees().base * 2),
ter(tesSUCCESS));
env.close();

{
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(60).value());
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(100).value());
}

// Zero-amount clawback (= "clawback all") should succeed,
// clamped to assetsAvailable (60) rather than the full
// share value (100).
env(vault.clawback({
.issuer = issuer,
.id = vaultKeylet.key,
.holder = depositor,
}),
ter(tesSUCCESS));
env.close();

// Only 60 assets clawed back; loan's 40 still outstanding
{
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle != nullptr);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(0).value());
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(40).value());

// 60 of 100 shares destroyed (1:1 ratio), 40 remain
auto const sharesAfter = env.balance(depositor, shares);
BEAST_EXPECT(sharesAfter == shares(Number{4, sle->at(sfScale) + 1}));
}
}

{
testcase(
"VaultClawback (asset) - " + prefix +
" non-zero clawback clamped with outstanding loan");
auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer);

auto const vaultSle = env.le(vaultKeylet);
BEAST_EXPECT(vaultSle != nullptr);
if (!vaultSle)
return;
PrettyAsset shares = MPTIssue(vaultSle->at(sfShareMPTID));

// Create a loan broker backed by this vault
auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner));
env(set(owner, vaultKeylet.key));
env.close();

// Depositor borrows 40 units
env(set(depositor, brokerKeylet.key, asset(40).value()),
loan::interestRate(TenthBips32(0)),
gracePeriod(60),
paymentInterval(120),
paymentTotal(10),
sig(sfCounterpartySignature, owner),
fee(env.current()->fees().base * 2),
ter(tesSUCCESS));
env.close();

{
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(60).value());
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(100).value());
}

auto const sharesBefore = env.balance(depositor, shares);

Comment on lines +5054 to +5055
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sharesBefore is computed but never used in this test case, which can trigger an unused-variable warning (often treated as an error in CI). Please remove it or use it in an assertion (e.g., verify the expected reduction in shares).

Suggested change
auto const sharesBefore = env.balance(depositor, shares);

Copilot uses AI. Check for mistakes.
// Request 100 but only 60 available — clamped to 60
env(vault.clawback({
.issuer = issuer,
.id = vaultKeylet.key,
.holder = depositor,
.amount = asset(100).value(),
}),
ter(tesSUCCESS));
env.close();

{
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle != nullptr);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(0).value());
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(40).value());

// 60 of 100 shares destroyed (1:1 ratio), 40 remain
auto const sharesAfter = env.balance(depositor, shares);
BEAST_EXPECT(sharesAfter == shares(Number{4, sle->at(sfScale) + 1}));
}
}
};

Account owner{"alice"};
Expand Down Expand Up @@ -4987,6 +5107,74 @@ class Vault_test : public beast::unit_test::suite
env(pay(issuer, depositor, MPT(1000)));
env.close();
testCase(MPT, "MPT", owner, depositor, issuer);

// Test pre-fixSecurity3_1_3 legacy path: zero-amount clawback
// returns early without clamping to assetsAvailable.
{
testcase(
"VaultClawback (asset) - IOU pre-fixSecurity3_1_3"
" zero-amount clawback unclamped with outstanding loan");

env.disableFeature(fixSecurity3_1_3);

auto [vault, vaultKeylet] = setupVault(IOU, owner, depositor, issuer);

auto const vaultSle = env.le(vaultKeylet);
BEAST_EXPECT(vaultSle != nullptr);
if (!vaultSle)
return;

PrettyAsset shares = MPTIssue(vaultSle->at(sfShareMPTID));

// Create a loan broker backed by this vault
auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner));
env(set(owner, vaultKeylet.key));
env.close();

// Depositor borrows 40 units, reducing assetsAvailable to 60
// while assetsTotal stays at 100
env(set(depositor, brokerKeylet.key, IOU(40).value()),
loan::interestRate(TenthBips32(0)),
gracePeriod(60),
paymentInterval(120),
paymentTotal(10),
sig(sfCounterpartySignature, owner),
fee(env.current()->fees().base * 2),
ter(tesSUCCESS));
env.close();

{
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == IOU(60).value());
BEAST_EXPECT(sle->at(sfAssetsTotal) == IOU(100).value());
}

auto const sharesBefore = env.balance(depositor, shares);

// Legacy: zero-amount clawback tries to recover the full
// share value (100) without clamping to assetsAvailable (60).
// This causes the vault balance to go negative, triggering
// the sanity check in doApply → tefINTERNAL.
env(vault.clawback({
.issuer = issuer,
.id = vaultKeylet.key,
.holder = depositor,
}),
ter(tefINTERNAL));
env.close();

{
// Transaction rolled back — vault and shares unchanged
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle != nullptr);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == IOU(60).value());
BEAST_EXPECT(sle->at(sfAssetsTotal) == IOU(100).value());
auto const sharesAfter = env.balance(depositor, shares);
BEAST_EXPECT(sharesAfter == sharesBefore);
}

env.enableFeature(fixSecurity3_1_3);
}
}

void
Expand Down
Loading