mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
Introduce AMM support (XLS-30d): (#4294)
Add AMM functionality: - InstanceCreate - Deposit - Withdraw - Governance - Auctioning - payment engine integration To support this functionality, add: - New RPC method, `amm_info`, to fetch pool and LPT balances - AMM Root Account - trust line for each IOU AMM token - trust line to track Liquidity Provider Tokens (LPT) - `ltAMM` object The `ltAMM` object tracks: - fee votes - auction slot bids - AMM tokens pair - total outstanding tokens balance - `AMMID` to AMM `RootAccountID` mapping Add new classes to facilitate AMM integration into the payment engine. `BookStep` uses these classes to infer if AMM liquidity can be consumed. The AMM formula implementation uses the new Number class added in #4192. IOUAmount and STAmount use Number arithmetic. Add AMM unit tests for all features. AMM requires the following amendments: - featureAMM - fixUniversalNumber - featureFlowCross Notes: - Current trading fee threshold is 1% - AMM currency is generated by: 0x03 + 152 bits of sha256{cur1, cur2} - Current max AMM Offers is 30 --------- Co-authored-by: Howard Hinnant <howard.hinnant@gmail.com>
This commit is contained in:
Gregory Tsipenyuk
committed by
GitHub
GitHub
parent
eeb8b41889
commit
3c9db4b69e
177
src/test/rpc/AMMInfo_test.cpp
Normal file
177
src/test/rpc/AMMInfo_test.cpp
Normal file
@@ -0,0 +1,177 @@
|
||||
//------------------------------------------------------------------------------
|
||||
/*
|
||||
This file is part of rippled: https://github.com/ripple/rippled
|
||||
Copyright (c) 2023 Ripple Labs Inc.
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any
|
||||
purpose with or without fee is hereby granted, provided that the above
|
||||
copyright notice and this permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
//==============================================================================
|
||||
|
||||
#include <ripple/protocol/Feature.h>
|
||||
#include <ripple/protocol/jss.h>
|
||||
#include <test/jtx.h>
|
||||
#include <test/jtx/AMM.h>
|
||||
#include <test/jtx/AMMTest.h>
|
||||
|
||||
#include <unordered_map>
|
||||
|
||||
namespace ripple {
|
||||
namespace test {
|
||||
|
||||
class AMMInfo_test : public jtx::AMMTestBase
|
||||
{
|
||||
public:
|
||||
void
|
||||
testErrors()
|
||||
{
|
||||
testcase("Errors");
|
||||
|
||||
using namespace jtx;
|
||||
// Invalid tokens pair
|
||||
testAMM([&](AMM& ammAlice, Env&) {
|
||||
Account const gw("gw");
|
||||
auto const USD = gw["USD"];
|
||||
auto const jv =
|
||||
ammAlice.ammRpcInfo({}, {}, {{USD.issue(), USD.issue()}});
|
||||
BEAST_EXPECT(jv[jss::error_message] == "Account not found.");
|
||||
});
|
||||
|
||||
// Invalid LP account id
|
||||
testAMM([&](AMM& ammAlice, Env&) {
|
||||
Account bogie("bogie");
|
||||
auto const jv = ammAlice.ammRpcInfo(bogie.id());
|
||||
BEAST_EXPECT(jv[jss::error_message] == "Account malformed.");
|
||||
});
|
||||
}
|
||||
|
||||
void
|
||||
testSimpleRpc()
|
||||
{
|
||||
testcase("RPC simple");
|
||||
|
||||
using namespace jtx;
|
||||
testAMM([&](AMM& ammAlice, Env&) {
|
||||
BEAST_EXPECT(ammAlice.expectAmmRpcInfo(
|
||||
XRP(10000), USD(10000), IOUAmount{10000000, 0}));
|
||||
});
|
||||
}
|
||||
|
||||
void
|
||||
testVoteAndBid()
|
||||
{
|
||||
testcase("Vote and Bid");
|
||||
|
||||
using namespace jtx;
|
||||
testAMM([&](AMM& ammAlice, Env& env) {
|
||||
BEAST_EXPECT(ammAlice.expectAmmRpcInfo(
|
||||
XRP(10000), USD(10000), IOUAmount{10000000, 0}));
|
||||
std::unordered_map<std::string, std::uint16_t> votes;
|
||||
votes.insert({alice.human(), 0});
|
||||
for (int i = 0; i < 7; ++i)
|
||||
{
|
||||
Account a(std::to_string(i));
|
||||
votes.insert({a.human(), 50 * (i + 1)});
|
||||
fund(env, gw, {a}, {USD(10000)}, Fund::Acct);
|
||||
ammAlice.deposit(a, 10000000);
|
||||
ammAlice.vote(a, 50 * (i + 1));
|
||||
}
|
||||
BEAST_EXPECT(ammAlice.expectTradingFee(175));
|
||||
Account ed("ed");
|
||||
Account bill("bill");
|
||||
env.fund(XRP(1000), bob, ed, bill);
|
||||
ammAlice.bid(alice, 100, std::nullopt, {carol, bob, ed, bill});
|
||||
BEAST_EXPECT(ammAlice.expectAmmRpcInfo(
|
||||
XRP(80000), USD(80000), IOUAmount{79994400}));
|
||||
std::unordered_set<std::string> authAccounts = {
|
||||
carol.human(), bob.human(), ed.human(), bill.human()};
|
||||
auto const ammInfo = ammAlice.ammRpcInfo();
|
||||
auto const& amm = ammInfo[jss::amm];
|
||||
try
|
||||
{
|
||||
// votes
|
||||
auto const voteSlots = amm[jss::vote_slots];
|
||||
for (std::uint8_t i = 0; i < 8; ++i)
|
||||
{
|
||||
if (!BEAST_EXPECT(
|
||||
votes[voteSlots[i][jss::account].asString()] ==
|
||||
voteSlots[i][jss::trading_fee].asUInt() &&
|
||||
voteSlots[i][jss::vote_weight].asUInt() == 12500))
|
||||
return;
|
||||
votes.erase(voteSlots[i][jss::account].asString());
|
||||
}
|
||||
if (!BEAST_EXPECT(votes.empty()))
|
||||
return;
|
||||
|
||||
// bid
|
||||
auto const auctionSlot = amm[jss::auction_slot];
|
||||
for (std::uint8_t i = 0; i < 4; ++i)
|
||||
{
|
||||
if (!BEAST_EXPECT(authAccounts.contains(
|
||||
auctionSlot[jss::auth_accounts][i][jss::account]
|
||||
.asString())))
|
||||
return;
|
||||
authAccounts.erase(
|
||||
auctionSlot[jss::auth_accounts][i][jss::account]
|
||||
.asString());
|
||||
}
|
||||
if (!BEAST_EXPECT(authAccounts.empty()))
|
||||
return;
|
||||
BEAST_EXPECT(
|
||||
auctionSlot[jss::account].asString() == alice.human() &&
|
||||
auctionSlot[jss::discounted_fee].asUInt() == 17 &&
|
||||
auctionSlot[jss::price][jss::value].asString() == "5600" &&
|
||||
auctionSlot[jss::price][jss::currency].asString() ==
|
||||
to_string(ammAlice.lptIssue().currency) &&
|
||||
auctionSlot[jss::price][jss::issuer].asString() ==
|
||||
to_string(ammAlice.lptIssue().account));
|
||||
}
|
||||
catch (std::exception const& e)
|
||||
{
|
||||
fail(e.what(), __FILE__, __LINE__);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
void
|
||||
testFreeze()
|
||||
{
|
||||
using namespace jtx;
|
||||
testAMM([&](AMM& ammAlice, Env& env) {
|
||||
env(fset(gw, asfGlobalFreeze));
|
||||
env.close();
|
||||
auto test = [&](bool freeze) {
|
||||
auto const info = ammAlice.ammRpcInfo();
|
||||
BEAST_EXPECT(
|
||||
info[jss::amm][jss::asset2_frozen].asBool() == freeze);
|
||||
};
|
||||
test(true);
|
||||
env(fclear(gw, asfGlobalFreeze));
|
||||
env.close();
|
||||
test(false);
|
||||
});
|
||||
}
|
||||
|
||||
void
|
||||
run() override
|
||||
{
|
||||
testErrors();
|
||||
testSimpleRpc();
|
||||
testVoteAndBid();
|
||||
testFreeze();
|
||||
}
|
||||
};
|
||||
|
||||
BEAST_DEFINE_TESTSUITE(AMMInfo, app, ripple);
|
||||
|
||||
} // namespace test
|
||||
} // namespace ripple
|
||||
Reference in New Issue
Block a user