mirror of
https://github.com/XRPLF/rippled.git
synced 2026-07-24 15:40:26 +00:00
72 lines
2.3 KiB
C++
72 lines
2.3 KiB
C++
#pragma once
|
|
|
|
#include <xrpl/beast/utility/Journal.h>
|
|
#include <xrpl/core/ServiceRegistry.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 {
|
|
|
|
/**
|
|
* AMMVote implements AMM vote Transactor.
|
|
* This transactor allows for the TradingFee of the AMM instance be a votable
|
|
* parameter. Any account (LP) that holds the corresponding LPTokens can cast
|
|
* a vote using the new AMMVote transaction. VoteSlots array in ltAMM object
|
|
* keeps track of upto eight active votes (VoteEntry) for the instance.
|
|
* VoteEntry contains:
|
|
* Account - account id that cast the vote.
|
|
* FeeVal - proposed fee in basis points.
|
|
* VoteWeight - LPTokens owned by the account in basis points.
|
|
* TradingFee is calculated as sum(VoteWeight_i * fee_i)/sum(VoteWeight_i).
|
|
* Every time AMMVote transaction is submitted, the transactor
|
|
* - Fails the transaction if the account doesn't hold LPTokens
|
|
* - Removes VoteEntry for accounts that don't hold LPTokens
|
|
* - If there are fewer than eight VoteEntry objects then add new VoteEntry
|
|
* object for the account.
|
|
* - If all eight VoteEntry slots are full, then remove VoteEntry that
|
|
* holds less LPTokens than the account. If all accounts hold more
|
|
* LPTokens then fail transaction.
|
|
* - If the account already holds a vote, then update VoteEntry.
|
|
* - Calculate and update TradingFee.
|
|
* @see [XLS30d:Governance: Trading Fee Voting
|
|
* Mechanism](https://github.com/XRPLF/XRPL-Standards/discussions/78)
|
|
*/
|
|
class AMMVote : public Transactor
|
|
{
|
|
public:
|
|
static constexpr auto kConsequencesFactory = ConsequencesFactoryType::Normal;
|
|
|
|
explicit AMMVote(ApplyContext& ctx) : Transactor(ctx)
|
|
{
|
|
}
|
|
|
|
static bool
|
|
checkExtraFeatures(PreflightContext const& 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
|