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

This commit is contained in:
Vito Tumas
2026-04-06 17:13:03 +02:00
committed by Mayukha Vadari
parent b30b4e1d65
commit 18d5e3e226
2 changed files with 693 additions and 25 deletions

View File

@@ -13,6 +13,7 @@
#include <xrpl/tx/transactors/vault/VaultClawback.h>
#include <optional>
#include <utility>
namespace xrpl {
NotTEC
@@ -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)
{
auto const sharesDestroyed = accountHolds(
view(),
@@ -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)
{

View File

@@ -2,6 +2,7 @@
#include <test/jtx/AMMTest.h>
#include <test/jtx/Env.h>
#include <test/jtx/amount.h>
#include <test/jtx/escrow.h>
#include <test/jtx/mpt.h>
#include <xrpl/basics/base_uint.h>
@@ -3370,10 +3371,10 @@ class Vault_test : public beast::unit_test::suite
[&](OpenView& view, beast::Journal j) -> bool {
Sandbox sb(&view, tapNONE);
auto vault = sb.peek(keylet::vault(keylet.key));
if (!BEAST_EXPECT(vault != nullptr))
if (!BEAST_EXPECT(vault))
return false;
auto shares = sb.peek(keylet::mptIssuance(vault->at(sfShareMPTID)));
if (!BEAST_EXPECT(shares != nullptr))
if (!BEAST_EXPECT(shares))
return false;
if (fn(*vault, *shares))
{
@@ -4102,6 +4103,66 @@ class Vault_test : public beast::unit_test::suite
BEAST_EXPECT(env.balance(d.vaultAccount, d.shares).number() == 0);
}
});
// Non-1:1 ratio (scale=1, 10:1 shares:assets) with an outstanding loan.
// Deposit 100 IOU → 1000 shares. Borrow 40 → assetsAvailable=60.
// Clawback 80 IOU → clamped to 60, then share math uses truncation.
testCase(1, [&, this](Env& env, Data d) {
using namespace loanBroker;
using namespace loan;
testcase("Scale clawback clamped with outstanding loan");
auto tx = d.vault.deposit(
{.depositor = d.depositor,
.id = d.keylet.key,
.amount = STAmount(d.asset, Number(100, 0))});
env(tx);
env.close();
BEAST_EXPECT(env.balance(d.depositor, d.shares) == d.share(1000));
// Create a loan broker backed by this vault
auto const brokerKeylet = keylet::loanbroker(d.owner.id(), env.seq(d.owner));
env(set(d.owner, d.keylet.key));
env.close();
// Borrow 40: assetsAvailable=60, assetsTotal=100
env(set(d.depositor, brokerKeylet.key, STAmount(d.asset, Number(40, 0))),
loan::interestRate(TenthBips32(0)),
gracePeriod(60),
paymentInterval(120),
paymentTotal(10),
sig(sfCounterpartySignature, d.owner),
fee(env.current()->fees().base * 2),
ter(tesSUCCESS));
env.close();
{
auto const sle = env.le(d.keylet);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == STAmount(d.asset, Number(60, 0)));
BEAST_EXPECT(sle->at(sfAssetsTotal) == STAmount(d.asset, Number(100, 0)));
}
// Request 80 IOU clawback — clamped to assetsAvailable (60)
// With scale=1 (10:1), 60 assets = 600 shares destroyed
tx = d.vault.clawback(
{.issuer = d.issuer,
.id = d.keylet.key,
.holder = d.depositor,
.amount = STAmount(d.asset, Number(80, 0))});
env(tx, ter(tesSUCCESS));
env.close();
{
auto const sle = env.le(d.keylet);
BEAST_EXPECT(sle != nullptr);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == STAmount(d.asset, Number(0, 0)));
BEAST_EXPECT(sle->at(sfAssetsTotal) == STAmount(d.asset, Number(40, 0)));
// 600 of 1000 shares destroyed, 400 remain
BEAST_EXPECT(env.balance(d.depositor, d.shares) == d.share(400));
}
});
}
void
@@ -4648,8 +4709,7 @@ class Vault_test : public beast::unit_test::suite
"VaultClawback (share) - " + prefix + " owner incomplete share clawback fails");
auto [vault, vaultKeylet] = setupVault(asset, owner, depositor);
auto const& vaultSle = env.le(vaultKeylet);
BEAST_EXPECT(vaultSle != nullptr);
if (!vaultSle)
if (!BEAST_EXPECT(vaultSle))
return;
Asset const share = vaultSle->at(sfShareMPTID);
env(vault.clawback({
@@ -4684,8 +4744,7 @@ class Vault_test : public beast::unit_test::suite
" owner explicit complete share clawback succeeds");
auto [vault, vaultKeylet] = setupVault(asset, owner, depositor);
auto const& vaultSle = env.le(vaultKeylet);
BEAST_EXPECT(vaultSle != nullptr);
if (!vaultSle)
if (!BEAST_EXPECT(vaultSle))
return;
Asset const share = vaultSle->at(sfShareMPTID);
env(vault.clawback({
@@ -4701,8 +4760,7 @@ class Vault_test : public beast::unit_test::suite
testcase("VaultClawback (share) - " + prefix + " owner can clawback own shares");
auto [vault, vaultKeylet] = setupVault(asset, owner, owner);
auto const& vaultSle = env.le(vaultKeylet);
BEAST_EXPECT(vaultSle != nullptr);
if (!vaultSle)
if (!BEAST_EXPECT(vaultSle))
return;
Asset const share = vaultSle->at(sfShareMPTID);
env(vault.clawback({
@@ -4719,7 +4777,7 @@ class Vault_test : public beast::unit_test::suite
testcase("VaultClawback (share) - " + prefix + " empty vault share clawback fails");
auto [vault, vaultKeylet] = setupVault(asset, owner, owner);
auto const& vaultSle = env.le(vaultKeylet);
if (BEAST_EXPECT(vaultSle != nullptr))
if (!BEAST_EXPECT(vaultSle))
return;
Asset const share = vaultSle->at(sfShareMPTID);
env(vault.clawback({
@@ -4735,6 +4793,7 @@ class Vault_test : public beast::unit_test::suite
.issuer = owner,
.id = vaultKeylet.key,
.holder = owner,
.amount = share(vaultShareBalance(vaultKeylet)).value(),
}),
ter(tecNO_PERMISSION));
env.close();
@@ -4786,6 +4845,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,
@@ -4799,6 +4859,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));
@@ -4899,8 +4960,7 @@ class Vault_test : public beast::unit_test::suite
testcase("VaultClawback (asset) - " + prefix + " issuer share clawback fails");
auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer);
auto const& vaultSle = env.le(vaultKeylet);
BEAST_EXPECT(vaultSle != nullptr);
if (!vaultSle)
if (!BEAST_EXPECT(vaultSle))
return;
Asset const share = vaultSle->at(sfShareMPTID);
@@ -4955,6 +5015,288 @@ 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);
if (!BEAST_EXPECT(vaultSle))
return;
PrettyAsset const 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);
if (!BEAST_EXPECT(vaultSle))
return;
PrettyAsset const 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());
}
// 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}));
}
}
{
testcase(
"VaultClawback (asset) - " + prefix +
" partial clawback below available with outstanding loan");
auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer);
auto const vaultSle = env.le(vaultKeylet);
if (!BEAST_EXPECT(vaultSle))
return;
PrettyAsset const 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: assetsAvailable=60, assetsTotal=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());
}
// Clawback 30 — well under available (60), no clamping needed
env(vault.clawback({
.issuer = issuer,
.id = vaultKeylet.key,
.holder = depositor,
.amount = asset(30).value(),
}),
ter(tesSUCCESS));
env.close();
{
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle != nullptr);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(30).value());
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(70).value());
// 30 of 100 shares destroyed (1:1 ratio), 70 remain
auto const sharesAfter = env.balance(depositor, shares);
BEAST_EXPECT(sharesAfter == shares(Number{7, sle->at(sfScale) + 1}));
}
}
{
testcase(
"VaultClawback (asset) - " + prefix +
" clawback exactly equal to available with outstanding loan");
auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer);
auto const vaultSle = env.le(vaultKeylet);
if (!BEAST_EXPECT(vaultSle))
return;
PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID));
auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner));
env(set(owner, vaultKeylet.key));
env.close();
// Depositor borrows 40 units: assetsAvailable=60, assetsTotal=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();
// Clawback exactly 60 — at the boundary, no clamping needed
env(vault.clawback({
.issuer = issuer,
.id = vaultKeylet.key,
.holder = depositor,
.amount = asset(60).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}));
}
}
{
testcase(
"VaultClawback (asset) - " + prefix +
" clawback with zero available (fully borrowed)");
auto [vault, vaultKeylet] = setupVault(asset, owner, depositor, issuer);
auto const vaultSle = env.le(vaultKeylet);
if (!BEAST_EXPECT(vaultSle))
return;
PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID));
auto const brokerKeylet = keylet::loanbroker(owner.id(), env.seq(owner));
env(set(owner, vaultKeylet.key));
env.close();
// Depositor borrows all 100 units: assetsAvailable=0, assetsTotal=100
env(set(depositor, brokerKeylet.key, asset(100).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(0).value());
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(100).value());
}
auto const sharesBefore = env.balance(depositor, shares);
// Zero-amount clawback — nothing available, clamped to 0,
// resulting in zero shares destroyed → tecPRECISION_LOSS
env(vault.clawback({
.issuer = issuer,
.id = vaultKeylet.key,
.holder = depositor,
}),
ter(tecPRECISION_LOSS));
env.close();
// Explicit amount clawback — also nothing available
env(vault.clawback({
.issuer = issuer,
.id = vaultKeylet.key,
.holder = depositor,
.amount = asset(50).value(),
}),
ter(tecPRECISION_LOSS));
env.close();
{
// Nothing changed — vault and shares unchanged
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle != nullptr);
BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(0).value());
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(100).value());
auto const sharesAfter = env.balance(depositor, shares);
BEAST_EXPECT(sharesAfter == sharesBefore);
}
}
};
Account owner{"alice"};
@@ -4972,10 +5314,10 @@ class Vault_test : public beast::unit_test::suite
PrettyAsset const IOU = issuer["IOU"];
env(fset(issuer, asfAllowTrustLineClawback));
env.close();
env.trust(IOU(1000), owner);
env.trust(IOU(1000), depositor);
env(pay(issuer, owner, IOU(1000)));
env(pay(issuer, depositor, IOU(1000)));
env.trust(IOU(2000), owner);
env.trust(IOU(2000), depositor);
env(pay(issuer, owner, IOU(2000)));
env(pay(issuer, depositor, IOU(2000)));
env.close();
testCase(IOU, "IOU", owner, depositor, issuer);
@@ -4985,9 +5327,77 @@ class Vault_test : public beast::unit_test::suite
PrettyAsset const MPT = mptt.issuanceID();
mptt.authorize({.account = owner});
mptt.authorize({.account = depositor});
env(pay(issuer, depositor, MPT(1000)));
env(pay(issuer, depositor, MPT(2000)));
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 const 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
@@ -5231,6 +5641,240 @@ class Vault_test : public beast::unit_test::suite
}
}
void
testVaultEscrowedMPT()
{
using namespace test::jtx;
using namespace std::literals;
// Verify vault deposit/withdraw/clawback respect sfLockedAmount.
// When MPT tokens are escrowed, sfMPTAmount is reduced and
// sfLockedAmount is increased. Vault operations go through
// accountSend/accountHolds which read sfMPTAmount, so escrowed
// tokens are naturally excluded.
{
testcase("Vault deposit fails when MPT asset is escrowed");
Env env{*this, testable_amendments()};
auto const baseFee = env.current()->fees().base;
Account const owner{"owner"};
Account const depositor{"depositor"};
Account const issuer{"issuer"};
Account const bob{"bob"};
env.fund(XRP(10000), issuer, owner, depositor, bob);
env.close();
MPTTester mptt{env, issuer, mptInitNoFund};
mptt.create(
{.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock | tfMPTCanEscrow});
mptt.authorize({.account = owner});
mptt.authorize({.account = depositor});
mptt.authorize({.account = bob});
PrettyAsset const asset = mptt.issuanceID();
env(pay(issuer, depositor, asset(100)));
env.close();
// Escrow 60 of 100 MPT tokens: sfMPTAmount drops to 40
auto const escrowSeq = env.seq(depositor);
env(escrow::create(depositor, bob, asset(60)),
escrow::condition(escrow::cb1),
escrow::finish_time(env.now() + 1s),
fee(baseFee * 150),
ter(tesSUCCESS));
env.close();
Vault const vault{env};
auto [tx, vaultKeylet] = vault.create({.owner = owner, .asset = asset});
env(tx, ter(tesSUCCESS));
env.close();
// Deposit 100 should fail — only 40 spendable
env(vault.deposit(
{.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}),
ter(tecINSUFFICIENT_FUNDS));
env.close();
// Deposit 40 (the unlocked balance) should succeed
env(vault.deposit({.depositor = depositor, .id = vaultKeylet.key, .amount = asset(40)}),
ter(tesSUCCESS));
env.close();
{
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(40).value());
}
// Clean up escrow
env(escrow::finish(bob, depositor, escrowSeq),
escrow::condition(escrow::cb1),
escrow::fulfillment(escrow::fb1),
fee(baseFee * 150),
ter(tesSUCCESS));
env.close();
}
{
testcase("Vault withdraw respects escrowed shares");
Env env{*this, testable_amendments()};
auto const baseFee = env.current()->fees().base;
Account const owner{"owner"};
Account const depositor{"depositor"};
Account const issuer{"issuer"};
Account const bob{"bob"};
env.fund(XRP(10000), issuer, owner, depositor, bob);
env.close();
MPTTester mptt{env, issuer, mptInitNoFund};
mptt.create(
{.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock | tfMPTCanEscrow});
mptt.authorize({.account = owner});
mptt.authorize({.account = depositor});
PrettyAsset const asset = mptt.issuanceID();
env(pay(issuer, depositor, asset(100)));
env.close();
Vault const vault{env};
auto [tx, vaultKeylet] = vault.create({.owner = owner, .asset = asset});
env(tx, ter(tesSUCCESS));
env.close();
// Deposit 100 → get shares
env(vault.deposit(
{.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}),
ter(tesSUCCESS));
env.close();
auto const vaultSle = env.le(vaultKeylet);
if (!BEAST_EXPECT(vaultSle))
return;
env.memoize(Account("vault", vaultSle->at(sfAccount)));
PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID));
// Authorize bob for share MPT so he can receive escrowed shares
auto const shareMPTID = vaultSle->at(sfShareMPTID);
{
Json::Value jv;
jv[jss::Account] = bob.human();
jv[sfMPTokenIssuanceID] = to_string(shareMPTID);
jv[jss::TransactionType] = jss::MPTokenAuthorize;
env(jv, ter(tesSUCCESS));
env.close();
}
// Escrow 60% of shares
auto const escrowAmount = shares(Number{6, vaultSle->at(sfScale) + 1});
env(escrow::create(depositor, bob, escrowAmount),
escrow::condition(escrow::cb1),
escrow::finish_time(env.now() + 1s),
fee(baseFee * 150),
ter(tesSUCCESS));
env.close();
// Withdraw all 100 should fail — only 40% of shares are unlocked
env(vault.withdraw(
{.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}),
ter(tecINSUFFICIENT_FUNDS));
env.close();
// Withdraw 40 (matching unlocked shares) should succeed
env(vault.withdraw(
{.depositor = depositor, .id = vaultKeylet.key, .amount = asset(40)}),
ter(tesSUCCESS));
env.close();
{
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(60).value());
}
}
{
testcase("Vault clawback only recovers unlocked shares");
Env env{*this, testable_amendments() | fixSecurity3_1_3};
auto const baseFee = env.current()->fees().base;
Account const owner{"owner"};
Account const depositor{"depositor"};
Account const issuer{"issuer"};
Account const bob{"bob"};
env.fund(XRP(10000), issuer, owner, depositor, bob);
env.close();
MPTTester mptt{env, issuer, mptInitNoFund};
mptt.create(
{.flags = tfMPTCanClawback | tfMPTCanTransfer | tfMPTCanLock | tfMPTCanEscrow});
mptt.authorize({.account = owner});
mptt.authorize({.account = depositor});
PrettyAsset const asset = mptt.issuanceID();
env(pay(issuer, depositor, asset(100)));
env.close();
Vault const vault{env};
auto [tx, vaultKeylet] = vault.create({.owner = owner, .asset = asset});
env(tx, ter(tesSUCCESS));
env.close();
// Deposit 100 → get shares
env(vault.deposit(
{.depositor = depositor, .id = vaultKeylet.key, .amount = asset(100)}),
ter(tesSUCCESS));
env.close();
auto const vaultSle = env.le(vaultKeylet);
if (!BEAST_EXPECT(vaultSle))
return;
env.memoize(Account("vault", vaultSle->at(sfAccount)));
PrettyAsset const shares = MPTIssue(vaultSle->at(sfShareMPTID));
// Authorize bob for share MPT so he can receive escrowed shares
auto const shareMPTID = vaultSle->at(sfShareMPTID);
{
Json::Value jv;
jv[jss::Account] = bob.human();
jv[sfMPTokenIssuanceID] = to_string(shareMPTID);
jv[jss::TransactionType] = jss::MPTokenAuthorize;
env(jv, ter(tesSUCCESS));
env.close();
}
// Escrow 60% of shares
auto const escrowAmount = shares(Number{6, vaultSle->at(sfScale) + 1});
env(escrow::create(depositor, bob, escrowAmount),
escrow::condition(escrow::cb1),
escrow::finish_time(env.now() + 1s),
fee(baseFee * 150),
ter(tesSUCCESS));
env.close();
// Zero-amount clawback ("all") — should only recover assets
// corresponding to unlocked shares (40%)
env(vault.clawback({
.issuer = issuer,
.id = vaultKeylet.key,
.holder = depositor,
}),
ter(tesSUCCESS));
env.close();
{
auto const sle = env.le(vaultKeylet);
BEAST_EXPECT(sle != nullptr);
// Only 40 of 100 assets recovered (matching 40% unlocked shares)
BEAST_EXPECT(sle->at(sfAssetsTotal) == asset(60).value());
BEAST_EXPECT(sle->at(sfAssetsAvailable) == asset(60).value());
// Depositor's unlocked shares are now 0
auto const sharesAfter = env.balance(depositor, shares);
BEAST_EXPECT(sharesAfter == shares(0));
}
}
}
// Reproduction: canWithdraw IOU limit check bypassed when
// withdrawal amount is specified in shares (MPT) rather than in assets.
void
@@ -5346,6 +5990,7 @@ public:
testRPC();
testVaultClawbackBurnShares();
testVaultClawbackAssets();
testVaultEscrowedMPT();
testAssetsMaximum();
testBug6_LimitBypassWithShares();
}