From 0636d4695d46b13b41e8cb7d846bb40949c41fa4 Mon Sep 17 00:00:00 2001 From: Bronek Kozicki Date: Wed, 26 Mar 2025 19:19:30 +0000 Subject: [PATCH] Rename sfAsset... fields to sfAssets... --- .../xrpl/protocol/detail/ledger_entries.macro | 6 +++--- include/xrpl/protocol/detail/sfields.macro | 6 +++--- .../xrpl/protocol/detail/transactions.macro | 4 ++-- src/test/app/Vault_test.cpp | 18 +++++++++--------- src/xrpld/app/tx/detail/VaultClawback.cpp | 6 +++--- src/xrpld/app/tx/detail/VaultCreate.cpp | 10 +++++----- src/xrpld/app/tx/detail/VaultDelete.cpp | 4 ++-- src/xrpld/app/tx/detail/VaultDeposit.cpp | 8 ++++---- src/xrpld/app/tx/detail/VaultSet.cpp | 12 ++++++------ src/xrpld/app/tx/detail/VaultWithdraw.cpp | 6 +++--- src/xrpld/ledger/detail/View.cpp | 6 +++--- 11 files changed, 43 insertions(+), 43 deletions(-) diff --git a/include/xrpl/protocol/detail/ledger_entries.macro b/include/xrpl/protocol/detail/ledger_entries.macro index 8601be1538..a999cd8ea3 100644 --- a/include/xrpl/protocol/detail/ledger_entries.macro +++ b/include/xrpl/protocol/detail/ledger_entries.macro @@ -475,9 +475,9 @@ LEDGER_ENTRY(ltVAULT, 0x0083, Vault, vault, ({ {sfAccount, soeREQUIRED}, {sfData, soeOPTIONAL}, {sfAsset, soeREQUIRED}, - {sfAssetTotal, soeREQUIRED}, - {sfAssetAvailable, soeREQUIRED}, - {sfAssetMaximum, soeDEFAULT}, + {sfAssetsTotal, soeREQUIRED}, + {sfAssetsAvailable, soeREQUIRED}, + {sfAssetsMaximum, soeDEFAULT}, {sfLossUnrealized, soeREQUIRED}, {sfMPTokenIssuanceID, soeREQUIRED}, // sfShare {sfWithdrawalPolicy, soeREQUIRED}, diff --git a/include/xrpl/protocol/detail/sfields.macro b/include/xrpl/protocol/detail/sfields.macro index b78a78363a..07248372c9 100644 --- a/include/xrpl/protocol/detail/sfields.macro +++ b/include/xrpl/protocol/detail/sfields.macro @@ -196,9 +196,9 @@ TYPED_SFIELD(sfVaultID, UINT256, 35) // number (common) TYPED_SFIELD(sfNumber, NUMBER, 1) -TYPED_SFIELD(sfAssetAvailable, NUMBER, 2) -TYPED_SFIELD(sfAssetMaximum, NUMBER, 3) -TYPED_SFIELD(sfAssetTotal, NUMBER, 4) +TYPED_SFIELD(sfAssetsAvailable, NUMBER, 2) +TYPED_SFIELD(sfAssetsMaximum, NUMBER, 3) +TYPED_SFIELD(sfAssetsTotal, NUMBER, 4) TYPED_SFIELD(sfLossUnrealized, NUMBER, 5) // currency amount (common) diff --git a/include/xrpl/protocol/detail/transactions.macro b/include/xrpl/protocol/detail/transactions.macro index f902f7b8db..52e9799464 100644 --- a/include/xrpl/protocol/detail/transactions.macro +++ b/include/xrpl/protocol/detail/transactions.macro @@ -468,7 +468,7 @@ TRANSACTION(ttPERMISSIONED_DOMAIN_DELETE, 63, PermissionedDomainDelete, ({ /** This transaction creates a single asset vault. */ TRANSACTION(ttVAULT_CREATE, 64, VaultCreate, ({ {sfAsset, soeREQUIRED, soeMPTSupported}, - {sfAssetMaximum, soeOPTIONAL}, + {sfAssetsMaximum, soeOPTIONAL}, {sfMPTokenMetadata, soeOPTIONAL}, {sfDomainID, soeOPTIONAL}, // PermissionedDomainID {sfWithdrawalPolicy, soeOPTIONAL}, @@ -478,7 +478,7 @@ TRANSACTION(ttVAULT_CREATE, 64, VaultCreate, ({ /** This transaction updates a single asset vault. */ TRANSACTION(ttVAULT_SET, 65, VaultSet, ({ {sfVaultID, soeREQUIRED}, - {sfAssetMaximum, soeOPTIONAL}, + {sfAssetsMaximum, soeOPTIONAL}, {sfDomainID, soeOPTIONAL}, // PermissionedDomainID {sfData, soeOPTIONAL}, })) diff --git a/src/test/app/Vault_test.cpp b/src/test/app/Vault_test.cpp index 35c91440db..dea7a0b820 100644 --- a/src/test/app/Vault_test.cpp +++ b/src/test/app/Vault_test.cpp @@ -71,7 +71,7 @@ class Vault_test : public beast::unit_test::suite { testcase(prefix + " fail to set negative maximum"); auto tx = vault.set({.owner = owner, .id = keylet.key}); - tx[sfAssetMaximum] = negativeAmount(asset).number(); + tx[sfAssetsMaximum] = negativeAmount(asset).number(); env(tx, ter{temMALFORMED}); } @@ -138,7 +138,7 @@ class Vault_test : public beast::unit_test::suite { testcase(prefix + " fail to update because wrong owner"); auto tx = vault.set({.owner = issuer, .id = keylet.key}); - tx[sfAssetMaximum] = asset(50).number(); + tx[sfAssetsMaximum] = asset(50).number(); env(tx, ter(tecNO_PERMISSION)); } @@ -153,21 +153,21 @@ class Vault_test : public beast::unit_test::suite testcase( prefix + " fail to set maximum lower than current amount"); auto tx = vault.set({.owner = owner, .id = keylet.key}); - tx[sfAssetMaximum] = asset(50).number(); + tx[sfAssetsMaximum] = asset(50).number(); env(tx, ter(tecLIMIT_EXCEEDED)); } { testcase(prefix + " fail to set zero vault"); auto tx = vault.set({.owner = owner, .id = beast::zero}); - tx[sfAssetMaximum] = asset(150).number(); + tx[sfAssetsMaximum] = asset(150).number(); env(tx, ter(temMALFORMED)); } { testcase(prefix + " set maximum higher than current amount"); auto tx = vault.set({.owner = owner, .id = keylet.key}); - tx[sfAssetMaximum] = asset(150).number(); + tx[sfAssetsMaximum] = asset(150).number(); env(tx); } @@ -197,7 +197,7 @@ class Vault_test : public beast::unit_test::suite { testcase(prefix + " reset maximum to zero i.e. not enforced"); auto tx = vault.set({.owner = owner, .id = keylet.key}); - tx[sfAssetMaximum] = asset(0).number(); + tx[sfAssetsMaximum] = asset(0).number(); env(tx); } @@ -428,7 +428,7 @@ class Vault_test : public beast::unit_test::suite Vault& vault) { testcase("nothing to set"); auto tx = vault.set({.owner = owner, .id = keylet::skip().key}); - tx[sfAssetMaximum] = asset(0).number(); + tx[sfAssetsMaximum] = asset(0).number(); env(tx, ter(tecNO_ENTRY)); }); @@ -714,7 +714,7 @@ class Vault_test : public beast::unit_test::suite BEAST_EXPECT( jvVault[jss::result][jss::node][jss::ShareTotal] == "100"); BEAST_EXPECT( - jvVault[jss::result][jss::node][sfAssetTotal.fieldName] == + jvVault[jss::result][jss::node][sfAssetsTotal.fieldName] == "100"); // Vault pseudo-account @@ -756,7 +756,7 @@ class Vault_test : public beast::unit_test::suite BEAST_EXPECT( jvVault[jss::result][jss::node][jss::ShareTotal] == "50"); BEAST_EXPECT( - jvVault[jss::result][jss::node][sfAssetTotal.fieldName] == + jvVault[jss::result][jss::node][sfAssetsTotal.fieldName] == "50"); } diff --git a/src/xrpld/app/tx/detail/VaultClawback.cpp b/src/xrpld/app/tx/detail/VaultClawback.cpp index 4cd9b261c7..cde04b8331 100644 --- a/src/xrpld/app/tx/detail/VaultClawback.cpp +++ b/src/xrpld/app/tx/detail/VaultClawback.cpp @@ -156,7 +156,7 @@ VaultClawback::doApply() } // Clamp to maximum. - Number maxAssets = *vault->at(sfAssetAvailable); + Number maxAssets = *vault->at(sfAssetsAvailable); if (assets > maxAssets) { assets = maxAssets; @@ -166,8 +166,8 @@ VaultClawback::doApply() if (shares == beast::zero) return tecINSUFFICIENT_FUNDS; - vault->at(sfAssetTotal) -= assets; - vault->at(sfAssetAvailable) -= assets; + vault->at(sfAssetsTotal) -= assets; + vault->at(sfAssetsAvailable) -= assets; view().update(vault); auto const& vaultAccount = vault->at(sfAccount); diff --git a/src/xrpld/app/tx/detail/VaultCreate.cpp b/src/xrpld/app/tx/detail/VaultCreate.cpp index 37417ea96d..d2f9736e5b 100644 --- a/src/xrpld/app/tx/detail/VaultCreate.cpp +++ b/src/xrpld/app/tx/detail/VaultCreate.cpp @@ -68,7 +68,7 @@ VaultCreate::preflight(PreflightContext const& ctx) return temMALFORMED; // DomainID only allowed on private vaults } - if (auto const assetMax = ctx.tx[~sfAssetMaximum]) + if (auto const assetMax = ctx.tx[~sfAssetsMaximum]) { if (*assetMax < beast::zero) return temMALFORMED; @@ -187,12 +187,12 @@ VaultCreate::doApply() vault->at(sfOwner) = ownerId; vault->at(sfAccount) = pseudoId; vault->at(sfAsset) = tx[sfAsset]; - vault->at(sfAssetTotal) = Number(0); - vault->at(sfAssetAvailable) = Number(0); + vault->at(sfAssetsTotal) = Number(0); + vault->at(sfAssetsAvailable) = Number(0); vault->at(sfLossUnrealized) = Number(0); // Leave default values for AssetTotal and AssetAvailable, both zero. - if (auto value = tx[~sfAssetMaximum]) - vault->at(sfAssetMaximum) = *value; + if (auto value = tx[~sfAssetsMaximum]) + vault->at(sfAssetsMaximum) = *value; vault->at(sfMPTokenIssuanceID) = share; if (auto value = tx[~sfData]) vault->at(sfData) = *value; diff --git a/src/xrpld/app/tx/detail/VaultDelete.cpp b/src/xrpld/app/tx/detail/VaultDelete.cpp index bb94e36161..9385bd8da6 100644 --- a/src/xrpld/app/tx/detail/VaultDelete.cpp +++ b/src/xrpld/app/tx/detail/VaultDelete.cpp @@ -56,10 +56,10 @@ VaultDelete::preclaim(PreclaimContext const& ctx) if (vault->at(sfOwner) != ctx.tx[sfAccount]) return tecNO_PERMISSION; - if (vault->at(sfAssetAvailable) != 0) + if (vault->at(sfAssetsAvailable) != 0) return tecHAS_OBLIGATIONS; - if (vault->at(sfAssetTotal) != 0) + if (vault->at(sfAssetsTotal) != 0) return tecHAS_OBLIGATIONS; return tesSUCCESS; diff --git a/src/xrpld/app/tx/detail/VaultDeposit.cpp b/src/xrpld/app/tx/detail/VaultDeposit.cpp index 9cd8d59871..785f0991b6 100644 --- a/src/xrpld/app/tx/detail/VaultDeposit.cpp +++ b/src/xrpld/app/tx/detail/VaultDeposit.cpp @@ -166,13 +166,13 @@ VaultDeposit::doApply() shares.asset() != assets.asset(), "ripple::VaultDeposit::doApply : assets are not shares"); - vault->at(sfAssetTotal) += assets; - vault->at(sfAssetAvailable) += assets; + vault->at(sfAssetsTotal) += assets; + vault->at(sfAssetsAvailable) += assets; view().update(vault); // A deposit must not push the vault over its limit. - auto const maximum = *vault->at(sfAssetMaximum); - if (maximum != 0 && *vault->at(sfAssetTotal) > maximum) + auto const maximum = *vault->at(sfAssetsMaximum); + if (maximum != 0 && *vault->at(sfAssetsTotal) > maximum) return tecLIMIT_EXCEEDED; // Transfer assets from depositor to vault. diff --git a/src/xrpld/app/tx/detail/VaultSet.cpp b/src/xrpld/app/tx/detail/VaultSet.cpp index e874492548..df1aa17f17 100644 --- a/src/xrpld/app/tx/detail/VaultSet.cpp +++ b/src/xrpld/app/tx/detail/VaultSet.cpp @@ -61,14 +61,14 @@ VaultSet::preflight(PreflightContext const& ctx) return temMALFORMED; } - if (auto const assetMax = ctx.tx[~sfAssetMaximum]) + if (auto const assetMax = ctx.tx[~sfAssetsMaximum]) { if (*assetMax < beast::zero) return temMALFORMED; } if (!ctx.tx.isFieldPresent(sfDomainID) && - !ctx.tx.isFieldPresent(sfAssetMaximum) && + !ctx.tx.isFieldPresent(sfAssetsMaximum) && !ctx.tx.isFieldPresent(sfData)) return temMALFORMED; @@ -132,12 +132,12 @@ VaultSet::doApply() // Update mutable flags and fields if given. if (tx.isFieldPresent(sfData)) vault->at(sfData) = tx[sfData]; - if (tx.isFieldPresent(sfAssetMaximum)) + if (tx.isFieldPresent(sfAssetsMaximum)) { - if (tx[sfAssetMaximum] != 0 && - tx[sfAssetMaximum] < *vault->at(sfAssetTotal)) + if (tx[sfAssetsMaximum] != 0 && + tx[sfAssetsMaximum] < *vault->at(sfAssetsTotal)) return tecLIMIT_EXCEEDED; - vault->at(sfAssetMaximum) = tx[sfAssetMaximum]; + vault->at(sfAssetsMaximum) = tx[sfAssetsMaximum]; } if (tx.isFieldPresent(sfDomainID)) { diff --git a/src/xrpld/app/tx/detail/VaultWithdraw.cpp b/src/xrpld/app/tx/detail/VaultWithdraw.cpp index 0bf84a6375..cb106324b7 100644 --- a/src/xrpld/app/tx/detail/VaultWithdraw.cpp +++ b/src/xrpld/app/tx/detail/VaultWithdraw.cpp @@ -160,11 +160,11 @@ VaultWithdraw::doApply() // The vault must have enough assets on hand. The vault may hold assets that // it has already pledged. That is why we look at AssetAvailable instead of // the pseudo-account balance. - if (*vault->at(sfAssetAvailable) < assets) + if (*vault->at(sfAssetsAvailable) < assets) return tecINSUFFICIENT_FUNDS; - vault->at(sfAssetTotal) -= assets; - vault->at(sfAssetAvailable) -= assets; + vault->at(sfAssetsTotal) -= assets; + vault->at(sfAssetsAvailable) -= assets; view().update(vault); auto const& vaultAccount = vault->at(sfAccount); diff --git a/src/xrpld/ledger/detail/View.cpp b/src/xrpld/ledger/detail/View.cpp index c8d980ab77..cd18b0d770 100644 --- a/src/xrpld/ledger/detail/View.cpp +++ b/src/xrpld/ledger/detail/View.cpp @@ -2524,7 +2524,7 @@ assetsToSharesDeposit( XRPL_ASSERT( assets.asset() == vault->at(sfAsset), "ripple::assetsToSharesDeposit : assets and vault match"); - Number assetTotal = vault->at(sfAssetTotal); + Number assetTotal = vault->at(sfAssetsTotal); STAmount shares{ vault->at(sfMPTokenIssuanceID), static_cast(assets)}; if (assetTotal == 0) @@ -2543,7 +2543,7 @@ assetsToSharesWithdraw( XRPL_ASSERT( assets.asset() == vault->at(sfAsset), "ripple::assetsToSharesWithdraw : assets and vault match"); - Number assetTotal = vault->at(sfAssetTotal); + Number assetTotal = vault->at(sfAssetsTotal); assetTotal -= vault->at(sfLossUnrealized); STAmount shares{vault->at(sfMPTokenIssuanceID)}; if (assetTotal == 0) @@ -2562,7 +2562,7 @@ sharesToAssetsWithdraw( XRPL_ASSERT( shares.asset() == vault->at(sfMPTokenIssuanceID), "ripple::sharesToAssetsWithdraw : shares and vault match"); - Number assetTotal = vault->at(sfAssetTotal); + Number assetTotal = vault->at(sfAssetsTotal); assetTotal -= vault->at(sfLossUnrealized); STAmount assets{vault->at(sfAsset)}; if (assetTotal == 0)