488 bool const enforce = view.
rules().
enabled(featureSingleAssetVault);
489 bool const fix340Enabled = view.
rules().
enabled(fixCleanup3_4_0);
490 bool const fix350Enabled = view.
rules().
enabled(fixCleanup3_5_0);
500 "Invariant failed: vault operation succeeded without modifying "
502 XRPL_ASSERT(enforce,
"xrpl::ValidVault::finalize : vault noop invariant");
512 "Invariant failed: vault updated by a wrong transaction type";
515 "xrpl::ValidVault::finalize : illegal vault transaction "
523 "Invariant failed: vault operation updated more than single vault";
524 XRPL_ASSERT(enforce,
"xrpl::ValidVault::finalize : single vault invariant");
534 if (txnType != ttVAULT_DELETE)
537 "Invariant failed: vault deleted by a wrong transaction type";
540 "xrpl::ValidVault::finalize : illegal vault deletion "
555 if (e.share.getMptID() == beforeVault.shareMPTID)
563 JLOG(j.
fatal()) <<
"Invariant failed: deleted vault must also "
565 XRPL_ASSERT(enforce,
"xrpl::ValidVault::finalize : shares deletion invariant");
570 if (deletedShares->sharesTotal != 0)
572 JLOG(j.
fatal()) <<
"Invariant failed: deleted vault must have no "
573 "shares outstanding";
576 if (beforeVault.assetsTotal !=
kZero)
578 JLOG(j.
fatal()) <<
"Invariant failed: deleted vault must have no "
579 "assets outstanding";
582 if (beforeVault.assetsAvailable !=
kZero)
584 JLOG(j.
fatal()) <<
"Invariant failed: deleted vault must have no "
591 if (txnType == ttVAULT_DELETE)
593 JLOG(j.
fatal()) <<
"Invariant failed: vault deletion succeeded without "
595 XRPL_ASSERT(enforce,
"xrpl::ValidVault::finalize : vault deletion invariant");
603 "xrpl::ValidVault::finalize : single vault operation");
613 if (e.share.getMptID() == afterVault.shareMPTID)
629 if (afterVault.asset != beforeVault.asset || afterVault.pseudoId != beforeVault.pseudoId ||
630 afterVault.shareMPTID != beforeVault.shareMPTID)
632 JLOG(j.
fatal()) <<
"Invariant failed: violation of vault immutable data";
639 JLOG(j.
fatal()) <<
"Invariant failed: updated vault must have shares";
640 XRPL_ASSERT(enforce,
"xrpl::ValidVault::finalize : vault has shares invariant");
644 if (updatedShares->sharesTotal == 0)
646 if (afterVault.assetsTotal !=
kZero)
648 JLOG(j.
fatal()) <<
"Invariant failed: updated zero sized "
649 "vault must have no assets outstanding";
652 if (afterVault.assetsAvailable !=
kZero)
654 JLOG(j.
fatal()) <<
"Invariant failed: updated zero sized "
655 "vault must have no assets available";
659 afterVault.assetsDeployed !=
kZero)
661 JLOG(j.
fatal()) <<
"Invariant failed: updated zero sized "
662 "vault must have no AssetsDeployed";
666 else if (updatedShares->sharesTotal > updatedShares->sharesMaximum)
669 <<
"Invariant failed: updated shares must not exceed maximum "
670 << updatedShares->sharesMaximum;
674 if (afterVault.assetsAvailable <
kZero)
676 JLOG(j.
fatal()) <<
"Invariant failed: assets available must not be negative";
680 if (afterVault.assetsAvailable > afterVault.assetsTotal)
682 JLOG(j.
fatal()) <<
"Invariant failed: assets available must "
683 "not be greater than assets outstanding";
688 bool const gapExceeded = [&] {
695 return afterVault.lossUnrealized > afterVault.assetsDeployed;
699 return afterVault.lossUnrealized >
700 afterVault.assetsTotal - afterVault.assetsAvailable;
703 auto const s =
scale(afterVault.assetsTotal, afterVault.asset);
704 return !lessOrEqualPlusOneUnit(
705 afterVault.lossUnrealized,
706 afterVault.assetsTotal - afterVault.assetsAvailable,
713 <<
"Invariant failed: loss unrealized must not exceed "
714 "the difference between assets outstanding and available";
721 if (afterVault.assetsDeployed <
kZero)
723 JLOG(j.
fatal()) <<
"Invariant failed: AssetsDeployed must not be negative";
728 afterVault.assetsDeployed)
731 <<
"Invariant failed: AssetsDeployed must be exactly representable "
732 "at the vault asset's precision";
736 Number const expectedAssetsTotal = [&] {
739 STAmount{afterVault.asset, afterVault.assetsAvailable + afterVault.assetsDeployed});
741 if (afterVault.assetsTotal != expectedAssetsTotal)
744 <<
"Invariant failed: stored AssetsTotal must equal AssetsAvailable "
745 "plus AssetsDeployed, rounded Downward";
749 if (afterVault.yieldUnrealized <
kZero)
751 JLOG(j.
fatal()) <<
"Invariant failed: YieldUnrealized must not be negative";
756 if (fix340Enabled && afterVault.lossUnrealized <
kZero)
758 JLOG(j.
fatal()) <<
"Invariant failed: loss unrealized must not be negative";
762 if (afterVault.assetsTotal <
kZero)
764 JLOG(j.
fatal()) <<
"Invariant failed: assets outstanding must not be negative";
768 if (afterVault.assetsMaximum <
kZero)
770 JLOG(j.
fatal()) <<
"Invariant failed: assets maximum must not be negative";
779 "Invariant failed: vault created by a wrong transaction type";
780 XRPL_ASSERT(enforce,
"xrpl::ValidVault::finalize : vault creation invariant");
788 afterVault.assetsDeployed !=
beforeVault_[0].assetsDeployed && txnType != ttLOAN_SET &&
789 txnType != ttLOAN_PAY && txnType != ttLOAN_MANAGE)
792 "Invariant failed: vault transaction must not change AssetsDeployed";
797 txnType != ttLOAN_MANAGE && txnType != ttLOAN_PAY)
800 "Invariant failed: vault transaction must not change loss "
806 afterVault.yieldUnrealized !=
beforeVault_[0].yieldUnrealized && txnType != ttLOAN_SET &&
807 txnType != ttLOAN_PAY && txnType != ttLOAN_MANAGE)
810 "Invariant failed: vault transaction must not change yield "
825 if (e.share.getMptID() == beforeVault.shareMPTID)
836 JLOG(j.
fatal()) <<
"Invariant failed: vault operation succeeded "
837 "without updating shares";
838 XRPL_ASSERT(enforce,
"xrpl::ValidVault::finalize : shares noop invariant");
842 auto const& vaultAsset = afterVault.asset;
851 case ttVAULT_CREATE: {
857 <<
"Invariant failed: create operation must not have "
862 if (afterVault.assetsAvailable !=
kZero || afterVault.assetsTotal !=
kZero ||
863 afterVault.lossUnrealized !=
kZero || updatedShares->sharesTotal != 0 ||
865 (afterVault.assetsDeployed !=
kZero || afterVault.yieldUnrealized !=
kZero)))
868 <<
"Invariant failed: created vault must be empty";
872 if (afterVault.pseudoId != updatedShares->share.getIssuer())
875 <<
"Invariant failed: shares issuer and vault "
876 "pseudo-account must be the same";
880 auto const sleSharesIssuer =
882 if (!sleSharesIssuer)
885 <<
"Invariant failed: shares issuer must exist";
892 <<
"Invariant failed: shares issuer must be a "
897 if (
auto const vaultId = (*sleSharesIssuer)[~sfVaultID];
898 !vaultId || *vaultId != afterVault.key)
901 <<
"Invariant failed: shares issuer pseudo-account "
902 "must point back to the vault";
906 if (isClosedEnded(afterVault.vaultKind))
908 if (!afterVault.subscriptionDate || !afterVault.redemptionDate)
911 <<
"Invariant failed: closed-ended vault must have SubscriptionDate "
912 "and RedemptionDate";
916 *afterVault.subscriptionDate, *afterVault.redemptionDate))
919 <<
"Invariant failed: closed-ended vault RedemptionDate - "
920 "SubscriptionDate must be within [MIN_INVESTMENT_PERIOD, "
921 "MAX_INVESTMENT_PERIOD)";
932 !
beforeVault_.empty(),
"xrpl::ValidVault::finalize : set updated a vault");
935 auto const vaultDeltaAssets =
deltaAssets(afterVault.pseudoId);
936 if (vaultDeltaAssets)
939 "Invariant failed: set must not change vault balance";
943 if (beforeVault.assetsTotal != afterVault.assetsTotal)
946 "Invariant failed: set must not change assets "
954 if (afterVault.assetsMaximum >
kZero &&
955 afterVault.assetsTotal > afterVault.assetsMaximum &&
957 beforeVault.assetsMaximum != afterVault.assetsMaximum))
960 "Invariant failed: set assets outstanding must not "
961 "exceed assets maximum";
965 if (beforeVault.assetsAvailable != afterVault.assetsAvailable)
968 "Invariant failed: set must not change assets "
973 if (beforeShares && updatedShares &&
974 beforeShares->sharesTotal != updatedShares->sharesTotal)
977 "Invariant failed: set must not change shares "
984 case ttVAULT_DEPOSIT: {
988 !
beforeVault_.empty(),
"xrpl::ValidVault::finalize : deposit updated a vault");
995 afterVault.vaultKind,
996 afterVault.subscriptionDate,
997 afterVault.redemptionDate);
1001 "Invariant failed: deposit only allowed in "
1002 "Subscription or NoPhase";
1006 auto const maybeVaultDeltaAssets =
deltaAssets(afterVault.pseudoId);
1007 if (!maybeVaultDeltaAssets)
1010 "Invariant failed: deposit must change vault balance";
1017 auto const vaultDeltaAssets =
1018 roundToAsset(vaultAsset, maybeVaultDeltaAssets->delta, minScale);
1019 auto const txAmount =
roundToAsset(vaultAsset, tx[sfAmount], minScale);
1021 if (vaultDeltaAssets > txAmount)
1024 "Invariant failed: deposit must not change vault "
1025 "balance by more than deposited amount";
1035 Number const exactVaultDeltaAssets = maybeVaultDeltaAssets->delta;
1036 Number const signCheckDeltaAssets =
1037 isFixedPrecision ? exactVaultDeltaAssets : vaultDeltaAssets;
1039 if (signCheckDeltaAssets <=
kZero)
1042 "Invariant failed: deposit must increase vault balance";
1048 bool const issuerDeposit = [&] ->
bool {
1049 if (vaultAsset.native())
1051 return tx[sfAccount] == vaultAsset.getIssuer();
1056 auto const maybeAccDeltaAssets =
1058 if (!maybeAccDeltaAssets)
1061 <<
"Invariant failed: deposit must change depositor balance";
1064 auto const localMinScale =
1067 auto const accountDeltaAssets =
1068 roundToAsset(vaultAsset, maybeAccDeltaAssets->delta, localMinScale);
1069 auto const localVaultDeltaAssets =
1070 roundToAsset(vaultAsset, vaultDeltaAssets, localMinScale);
1075 if (accountDeltaAssets >=
kZero)
1078 <<
"Invariant failed: deposit must decrease depositor balance";
1082 bool const acctVaultAddsUp = fix340Enabled
1083 ? agreesWithinOneUnit(
1084 localVaultDeltaAssets * -1,
1088 : localVaultDeltaAssets * -1 == accountDeltaAssets;
1089 if (!acctVaultAddsUp)
1091 JLOG(j.
fatal()) <<
"Invariant failed: " <<
1092 "deposit must change vault and depositor balance by equal amount";
1097 if (afterVault.assetsMaximum >
kZero &&
1098 afterVault.assetsTotal > afterVault.assetsMaximum)
1100 JLOG(j.
fatal()) <<
"Invariant failed: " <<
1101 "deposit assets outstanding must not exceed assets maximum";
1105 auto const maybeAccDeltaShares =
deltaShares(tx[sfAccount]);
1106 if (!maybeAccDeltaShares)
1108 JLOG(j.
fatal()) <<
"Invariant failed: deposit must change depositor shares";
1112 auto const& accountDeltaShares = *maybeAccDeltaShares;
1113 if (accountDeltaShares.delta <=
kZero)
1115 JLOG(j.
fatal()) <<
"Invariant failed: deposit must increase depositor shares";
1119 auto const maybeVaultDeltaShares =
deltaShares(afterVault.pseudoId);
1120 if (!maybeVaultDeltaShares || maybeVaultDeltaShares->delta ==
kZero)
1122 JLOG(j.
fatal()) <<
"Invariant failed: deposit must change vault shares";
1127 auto const& vaultDeltaShares = *maybeVaultDeltaShares;
1128 if (vaultDeltaShares.delta * -1 != accountDeltaShares.delta)
1130 JLOG(j.
fatal()) <<
"Invariant failed: " <<
1131 "deposit must change depositor and vault shares by equal amount";
1142 exactVaultDeltaAssets,
1149 case ttVAULT_WITHDRAW: {
1154 "xrpl::ValidVault::finalize : withdrawal updated a vault");
1161 afterVault.vaultKind,
1162 afterVault.subscriptionDate,
1166 "Invariant failed: withdrawal not allowed during "
1171 auto const maybeVaultDeltaAssets =
deltaAssets(afterVault.pseudoId);
1183 bool const zeroDeltaIsLegitimate = fix340Enabled && !maybeVaultDeltaAssets &&
1184 beforeVault.assetsTotal == beforeVault.lossUnrealized;
1186 if (!maybeVaultDeltaAssets && !zeroDeltaIsLegitimate)
1188 JLOG(j.
fatal()) <<
"Invariant failed: withdrawal must change vault balance";
1192 DeltaInfo const vaultDeltaAssets = maybeVaultDeltaAssets.value_or(
1198 auto const vaultPseudoDeltaAssets =
1208 Number const signCheckDeltaAssets =
1209 isFixedPrecision ? vaultDeltaAssets.
delta : vaultPseudoDeltaAssets;
1211 if (!zeroDeltaIsLegitimate && signCheckDeltaAssets >=
kZero)
1213 JLOG(j.
fatal()) <<
"Invariant failed: withdrawal must decrease vault balance";
1219 bool const issuerWithdrawal = [&] ->
bool {
1220 if (vaultAsset.native())
1222 auto const destination = tx[~sfDestination].value_or(tx[sfAccount]);
1223 return destination == vaultAsset.getIssuer();
1226 if (!issuerWithdrawal)
1236 auto const destinationField = tx[~sfDestination];
1237 AccountID const recipient = destinationField.value_or(tx[sfAccount]);
1238 bool const distinctDestination =
1239 destinationField.has_value() && *destinationField != tx[sfAccount];
1243 if (distinctDestination &&
1248 "Invariant failed: withdrawal must change one destination balance";
1252 auto const maybeRecipientDelta =
1255 if (!maybeRecipientDelta.has_value())
1260 if (!zeroDeltaIsLegitimate)
1263 "Invariant failed: withdrawal must change one destination balance";
1272 auto const destinationDelta = *maybeRecipientDelta;
1277 auto const localMinScale =
std::max(minScale, destinationScale);
1279 auto const roundedDestinationDelta =
1280 roundToAsset(vaultAsset, destinationDelta.delta, localMinScale);
1287 bool const tolerateZeroDelta =
1288 view.
rules().
enabled(fixCleanup3_2_0) && !vaultAsset.integral();
1289 auto const invalidBalanceChange = tolerateZeroDelta
1290 ? roundedDestinationDelta <
kZero
1291 : roundedDestinationDelta <=
kZero;
1292 if (invalidBalanceChange)
1295 "Invariant failed: withdrawal must increase destination balance";
1299 auto const localPseudoDeltaAssets =
1300 roundToAsset(vaultAsset, vaultPseudoDeltaAssets, localMinScale);
1302 bool const feeAdjustedWithdrawal = fix350Enabled && distinctDestination &&
1303 !vaultAsset.native() && tx[sfAccount] != vaultAsset.getIssuer() &&
1305 auto expectedDestinationDelta = localPseudoDeltaAssets * -1;
1306 if (feeAdjustedWithdrawal)
1308 expectedDestinationDelta =
1310 STAmount{vaultAsset, expectedDestinationDelta}, rate)
1321 auto const destroyedIsSubUlp = !feeAdjustedWithdrawal &&
1322 tolerateZeroDelta &&
1325 vaultDeltaAssets.
delta * -1 - destinationDelta.delta,
1328 bool const withdrawAddsUp = fix340Enabled
1329 ? agreesWithinOneUnit(
1330 expectedDestinationDelta,
1331 roundedDestinationDelta,
1334 : expectedDestinationDelta == roundedDestinationDelta;
1335 if (!destroyedIsSubUlp && !withdrawAddsUp)
1337 JLOG(j.
fatal()) <<
"Invariant failed: " <<
1338 "withdrawal must change vault and destination balance by equal "
1346 auto const accountDeltaShares =
deltaShares(tx[sfAccount]);
1347 if (!accountDeltaShares)
1349 JLOG(j.
fatal()) <<
"Invariant failed: withdrawal must change depositor shares";
1353 if (accountDeltaShares->delta >=
kZero)
1356 <<
"Invariant failed: withdrawal must decrease depositor shares";
1361 auto const vaultDeltaShares =
deltaShares(afterVault.pseudoId);
1362 if (!vaultDeltaShares || vaultDeltaShares->delta ==
kZero)
1364 JLOG(j.
fatal()) <<
"Invariant failed: withdrawal must change vault shares";
1368 if (vaultDeltaShares->delta * -1 != accountDeltaShares->delta)
1370 JLOG(j.
fatal()) <<
"Invariant failed: " <<
1371 "withdrawal must change depositor and vault shares by equal amount";
1381 vaultPseudoDeltaAssets,
1382 vaultDeltaAssets.
delta,
1389 case ttVAULT_CLAWBACK: {
1393 !
beforeVault_.empty(),
"xrpl::ValidVault::finalize : clawback updated a vault");
1396 if (vaultAsset.native() || vaultAsset.getIssuer() != tx[sfAccount])
1400 if (!(beforeShares && beforeShares->sharesTotal > 0 &&
1401 isVaultEmpty(beforeVault) && beforeVault.owner == tx[sfAccount]))
1403 JLOG(j.
fatal()) <<
"Invariant failed: " <<
1404 "clawback may only be performed by the asset issuer, or by the vault "
1405 "owner of an empty vault";
1410 auto const maybeVaultDeltaAssets =
deltaAssets(afterVault.pseudoId);
1411 if (maybeVaultDeltaAssets)
1413 auto const minScale =
1415 auto const vaultDeltaAssets =
1416 roundToAsset(vaultAsset, maybeVaultDeltaAssets->delta, minScale);
1423 bool const isFixedPrecision =
1425 Number const signCheckDeltaAssets =
1426 isFixedPrecision ? maybeVaultDeltaAssets->delta : vaultDeltaAssets;
1427 if (signCheckDeltaAssets >=
kZero)
1429 JLOG(j.
fatal()) <<
"Invariant failed: clawback must decrease vault balance";
1440 maybeVaultDeltaAssets->delta,
1448 "Invariant failed: clawback must change vault balance";
1453 auto const maybeAccountDeltaShares =
deltaShares(tx[sfHolder]);
1454 if (!maybeAccountDeltaShares)
1457 "Invariant failed: clawback must change holder shares";
1460 if (maybeAccountDeltaShares->delta >=
kZero)
1463 "Invariant failed: clawback must decrease holder shares";
1468 auto const vaultDeltaShares =
deltaShares(afterVault.pseudoId);
1469 if (!vaultDeltaShares || vaultDeltaShares->delta ==
kZero)
1472 "Invariant failed: clawback must change vault shares";
1476 if (vaultDeltaShares->delta * -1 != maybeAccountDeltaShares->delta)
1478 JLOG(j.
fatal()) <<
"Invariant failed: " <<
1479 "clawback must change holder and vault shares by equal amount";
1494 UNREACHABLE(
"xrpl::ValidVault::finalize : unknown transaction type");
1504 XRPL_ASSERT(enforce,
"xrpl::ValidVault::finalize : vault invariants");