ARCHIVE/xahaud
3
0
Fork 0
mirror of https://github.com/Xahau/xahaud.git synced 2026-06-05 01:36:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ae1d8a4fdd61234f93b6a14fa7554d9a7b738e
xahaud/src/test/app/Oracle_test.cpp
Gregory Tsipenyuk 37ae1d8a4f Price Oracle (XLS-47d): (#4789) (#4789) 
Implement native support for Price Oracles.

 A Price Oracle is used to bring real-world data, such as market prices,
 onto the blockchain, enabling dApps to access and utilize information
 that resides outside the blockchain.

 Add Price Oracle functionality:
 - OracleSet: create or update the Oracle object
 - OracleDelete: delete the Oracle object

 To support this functionality add:
 - New RPC method, `get_aggregate_price`, to calculate aggregate price for a token pair of the specified oracles
 - `ltOracle` object

 The `ltOracle` object maintains:
 - Oracle Owner's account
 - Oracle's metadata
 - Up to ten token pairs with the scaled price
 - The last update time the token pairs were updated

 Add Oracle unit-tests
2026-02-20 07:01:17 +09:00

699 lines
24 KiB
C++
Raw Blame History

//------------------------------------------------------------------------------
/*
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/jss.h>
#include <test/jtx/Oracle.h>
namespace ripple {
namespace test {
namespace jtx {
namespace oracle {
struct Oracle_test : public beast::unit_test::suite
{
private:
// Helper function that returns the owner count of an account root.
static std::uint32_t
ownerCount(jtx::Env const& env, jtx::Account const& acct)
{
std::uint32_t ret{0};
if (auto const sleAcct = env.le(acct))
ret = sleAcct->at(sfOwnerCount);
return ret;
}
void
testInvalidSet()
{
testcase("Invalid Set");
using namespace jtx;
Account const owner("owner");
{
// Invalid account
Env env(*this);
Account const bad("bad");
env.memoize(bad);
Oracle oracle(
env, {.owner = bad, .seq = seq(1), .err = ter(terNO_ACCOUNT)});
}
// Insufficient reserve
{
Env env(*this);
env.fund(env.current()->fees().accountReserve(0), owner);
Oracle oracle(
env, {.owner = owner, .err = ter(tecINSUFFICIENT_RESERVE)});
}
// Insufficient reserve if the data series extends to greater than 5
{
Env env(*this);
env.fund(
env.current()->fees().accountReserve(1) +
env.current()->fees().base * 2,
owner);
Oracle oracle(env, {.owner = owner});
BEAST_EXPECT(oracle.exists());
oracle.set(UpdateArg{
.series =
{
{"XRP", "EUR", 740, 1},
{"XRP", "GBP", 740, 1},
{"XRP", "CNY", 740, 1},
{"XRP", "CAD", 740, 1},
{"XRP", "AUD", 740, 1},
},
.err = ter(tecINSUFFICIENT_RESERVE)});
}
{
Env env(*this);
env.fund(XRP(1'000), owner);
Oracle oracle(env, {.owner = owner}, false);
// Invalid flag
oracle.set(
CreateArg{.flags = tfSellNFToken, .err = ter(temINVALID_FLAG)});
// Duplicate token pair
oracle.set(CreateArg{
.series = {{"XRP", "USD", 740, 1}, {"XRP", "USD", 750, 1}},
.err = ter(temMALFORMED)});
// Price is not included
oracle.set(CreateArg{
.series =
{{"XRP", "USD", 740, 1}, {"XRP", "EUR", std::nullopt, 1}},
.err = ter(temMALFORMED)});
// Token pair is in update and delete
oracle.set(CreateArg{
.series =
{{"XRP", "USD", 740, 1}, {"XRP", "USD", std::nullopt, 1}},
.err = ter(temMALFORMED)});
// Token pair is in add and delete
oracle.set(CreateArg{
.series =
{{"XRP", "EUR", 740, 1}, {"XRP", "EUR", std::nullopt, 1}},
.err = ter(temMALFORMED)});
// Array of token pair is 0 or exceeds 10
oracle.set(CreateArg{
.series =
{{"XRP", "US1", 740, 1},
{"XRP", "US2", 750, 1},
{"XRP", "US3", 740, 1},
{"XRP", "US4", 750, 1},
{"XRP", "US5", 740, 1},
{"XRP", "US6", 750, 1},
{"XRP", "US7", 740, 1},
{"XRP", "US8", 750, 1},
{"XRP", "US9", 740, 1},
{"XRP", "U10", 750, 1},
{"XRP", "U11", 740, 1}},
.err = ter(temARRAY_TOO_LARGE)});
oracle.set(CreateArg{.series = {}, .err = ter(temARRAY_EMPTY)});
}
// Array of token pair exceeds 10 after update
{
Env env{*this};
env.fund(XRP(1'000), owner);
Oracle oracle(
env,
CreateArg{
.owner = owner, .series = {{{"XRP", "USD", 740, 1}}}});
oracle.set(UpdateArg{
.series =
{
{"XRP", "US1", 740, 1},
{"XRP", "US2", 750, 1},
{"XRP", "US3", 740, 1},
{"XRP", "US4", 750, 1},
{"XRP", "US5", 740, 1},
{"XRP", "US6", 750, 1},
{"XRP", "US7", 740, 1},
{"XRP", "US8", 750, 1},
{"XRP", "US9", 740, 1},
{"XRP", "U10", 750, 1},
},
.err = ter(tecARRAY_TOO_LARGE)});
}
{
Env env(*this);
env.fund(XRP(1'000), owner);
Oracle oracle(env, {.owner = owner}, false);
// Symbol class or provider not included on create
oracle.set(CreateArg{
.assetClass = std::nullopt,
.provider = "provider",
.err = ter(temMALFORMED)});
oracle.set(CreateArg{
.assetClass = "currency",
.provider = std::nullopt,
.uri = "URI",
.err = ter(temMALFORMED)});
// Symbol class or provider are included on update
// and don't match the current values
oracle.set(CreateArg{});
BEAST_EXPECT(oracle.exists());
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 740, 1}},
.provider = "provider1",
.err = ter(temMALFORMED)});
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 740, 1}},
.assetClass = "currency1",
.err = ter(temMALFORMED)});
}
{
Env env(*this);
env.fund(XRP(1'000), owner);
Oracle oracle(env, {.owner = owner}, false);
// Fields too long
// Symbol class
std::string assetClass(17, '0');
oracle.set(
CreateArg{.assetClass = assetClass, .err = ter(temMALFORMED)});
// provider
std::string const large(257, '0');
oracle.set(CreateArg{.provider = large, .err = ter(temMALFORMED)});
// URI
oracle.set(CreateArg{.uri = large, .err = ter(temMALFORMED)});
}
{
// Different owner creates a new object and fails because
// of missing fields currency/provider
Env env(*this);
Account const some("some");
env.fund(XRP(1'000), owner);
env.fund(XRP(1'000), some);
Oracle oracle(env, {.owner = owner});
BEAST_EXPECT(oracle.exists());
oracle.set(UpdateArg{
.owner = some,
.series = {{"XRP", "USD", 740, 1}},
.err = ter(temMALFORMED)});
}
{
// Invalid update time
using namespace std::chrono;
Env env(*this);
env.fund(XRP(1'000), owner);
Oracle oracle(env, {.owner = owner});
BEAST_EXPECT(oracle.exists());
env.close(seconds(400));
// Less than the last close time - 300s
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 740, 1}},
.lastUpdateTime = testStartTime.count() + 400 - 301,
.err = ter(tecINVALID_UPDATE_TIME)});
// Greater than last close time + 300s
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 740, 1}},
.lastUpdateTime = testStartTime.count() + 400 + 301,
.err = ter(tecINVALID_UPDATE_TIME)});
oracle.set(UpdateArg{.series = {{"XRP", "USD", 740, 1}}});
BEAST_EXPECT(
oracle.expectLastUpdateTime(testStartTime.count() + 450));
// Less than the previous lastUpdateTime
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 740, 1}},
.lastUpdateTime = testStartTime.count() + 449,
.err = ter(tecINVALID_UPDATE_TIME)});
}
{
// delete token pair that doesn't exist
Env env(*this);
env.fund(XRP(1'000), owner);
Oracle oracle(env, {.owner = owner});
BEAST_EXPECT(oracle.exists());
oracle.set(UpdateArg{
.series = {{"XRP", "EUR", std::nullopt, std::nullopt}},
.err = ter(tecTOKEN_PAIR_NOT_FOUND)});
// delete all token pairs
oracle.set(UpdateArg{
.series = {{"XRP", "USD", std::nullopt, std::nullopt}},
.err = ter(tecARRAY_EMPTY)});
}
{
// same BaseAsset and QuoteAsset
Env env(*this);
env.fund(XRP(1'000), owner);
Oracle oracle(
env,
{.owner = owner,
.series = {{"USD", "USD", 740, 1}},
.err = ter(temMALFORMED)});
}
{
// Scale is greater than maxPriceScale
Env env(*this);
env.fund(XRP(1'000), owner);
Oracle oracle(
env,
{.owner = owner,
.series = {{"USD", "BTC", 740, maxPriceScale + 1}},
.err = ter(temMALFORMED)});
}
}
void
testCreate()
{
testcase("Create");
using namespace jtx;
Account const owner("owner");
auto test = [&](Env& env, DataSeries const& series, std::uint16_t adj) {
env.fund(XRP(1'000), owner);
auto const count = ownerCount(env, owner);
Oracle oracle(env, {.owner = owner, .series = series});
BEAST_EXPECT(oracle.exists());
BEAST_EXPECT(ownerCount(env, owner) == (count + adj));
BEAST_EXPECT(oracle.expectLastUpdateTime(946694810));
};
{
// owner count is adjusted by 1
Env env(*this);
test(env, {{"XRP", "USD", 740, 1}}, 1);
}
{
// owner count is adjusted by 2
Env env(*this);
test(
env,
{{"XRP", "USD", 740, 1},
{"BTC", "USD", 740, 1},
{"ETH", "USD", 740, 1},
{"CAN", "USD", 740, 1},
{"YAN", "USD", 740, 1},
{"GBP", "USD", 740, 1}},
2);
}
{
// Different owner creates a new object
Env env(*this);
Account const some("some");
env.fund(XRP(1'000), owner);
env.fund(XRP(1'000), some);
Oracle oracle(env, {.owner = owner});
BEAST_EXPECT(oracle.exists());
oracle.set(CreateArg{
.owner = some, .series = {{"912810RR9", "USD", 740, 1}}});
BEAST_EXPECT(Oracle::exists(env, some, oracle.documentID()));
}
}
void
testInvalidDelete()
{
testcase("Invalid Delete");
using namespace jtx;
Env env(*this);
Account const owner("owner");
env.fund(XRP(1'000), owner);
Oracle oracle(env, {.owner = owner});
BEAST_EXPECT(oracle.exists());
{
// Invalid account
Account const bad("bad");
env.memoize(bad);
oracle.remove(
{.owner = bad, .seq = seq(1), .err = ter(terNO_ACCOUNT)});
}
// Invalid Sequence
oracle.remove({.documentID = 2, .err = ter(tecNO_ENTRY)});
// Invalid owner
Account const invalid("invalid");
env.fund(XRP(1'000), invalid);
oracle.remove({.owner = invalid, .err = ter(tecNO_ENTRY)});
}
void
testDelete()
{
testcase("Delete");
using namespace jtx;
Account const owner("owner");
auto test = [&](Env& env, DataSeries const& series, std::uint16_t adj) {
env.fund(XRP(1'000), owner);
Oracle oracle(env, {.owner = owner, .series = series});
auto const count = ownerCount(env, owner);
BEAST_EXPECT(oracle.exists());
oracle.remove({});
BEAST_EXPECT(!oracle.exists());
BEAST_EXPECT(ownerCount(env, owner) == (count - adj));
};
{
// owner count is adjusted by 1
Env env(*this);
test(env, {{"XRP", "USD", 740, 1}}, 1);
}
{
// owner count is adjusted by 2
Env env(*this);
test(
env,
{
{"XRP", "USD", 740, 1},
{"BTC", "USD", 740, 1},
{"ETH", "USD", 740, 1},
{"CAN", "USD", 740, 1},
{"YAN", "USD", 740, 1},
{"GBP", "USD", 740, 1},
},
2);
}
{
// deleting the account deletes the oracles
Env env(*this);
auto const alice = Account("alice");
auto const acctDelFee{drops(env.current()->fees().increment)};
env.fund(XRP(1'000), owner);
env.fund(XRP(1'000), alice);
Oracle oracle(
env, {.owner = owner, .series = {{"XRP", "USD", 740, 1}}});
Oracle oracle1(
env,
{.owner = owner,
.documentID = 2,
.series = {{"XRP", "EUR", 740, 1}}});
BEAST_EXPECT(ownerCount(env, owner) == 2);
BEAST_EXPECT(oracle.exists());
BEAST_EXPECT(oracle1.exists());
auto const index = env.closed()->seq();
auto const hash = env.closed()->info().hash;
for (int i = 0; i < 256; ++i)
env.close();
env(acctdelete(owner, alice), fee(acctDelFee));
env.close();
BEAST_EXPECT(!oracle.exists());
BEAST_EXPECT(!oracle1.exists());
// can still get the oracles via the ledger index or hash
auto verifyLedgerData = [&](auto const& field, auto const& value) {
Json::Value jvParams;
jvParams[field] = value;
jvParams[jss::binary] = false;
jvParams[jss::type] = jss::oracle;
Json::Value jrr = env.rpc(
"json",
"ledger_data",
boost::lexical_cast<std::string>(jvParams));
BEAST_EXPECT(jrr[jss::result][jss::state].size() == 2);
};
verifyLedgerData(jss::ledger_index, index);
verifyLedgerData(jss::ledger_hash, to_string(hash));
}
}
void
testUpdate()
{
testcase("Update");
using namespace jtx;
Account const owner("owner");
{
Env env(*this);
env.fund(XRP(1'000), owner);
auto count = ownerCount(env, owner);
Oracle oracle(env, {.owner = owner});
BEAST_EXPECT(oracle.exists());
// update existing pair
oracle.set(UpdateArg{.series = {{"XRP", "USD", 740, 2}}});
BEAST_EXPECT(oracle.expectPrice({{"XRP", "USD", 740, 2}}));
// owner count is increased by 1 since the oracle object is added
// with one token pair
count += 1;
BEAST_EXPECT(ownerCount(env, owner) == count);
// add new pairs, not-included pair is reset
oracle.set(UpdateArg{.series = {{"XRP", "EUR", 700, 2}}});
BEAST_EXPECT(oracle.expectPrice(
{{"XRP", "USD", 0, 0}, {"XRP", "EUR", 700, 2}}));
// owner count is not changed since the number of pairs is 2
BEAST_EXPECT(ownerCount(env, owner) == count);
// update both pairs
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 741, 2}, {"XRP", "EUR", 710, 2}}});
BEAST_EXPECT(oracle.expectPrice(
{{"XRP", "USD", 741, 2}, {"XRP", "EUR", 710, 2}}));
// owner count is not changed since the number of pairs is 2
BEAST_EXPECT(ownerCount(env, owner) == count);
// owner count is increased by 1 since the number of pairs is 6
oracle.set(UpdateArg{
.series = {
{"BTC", "USD", 741, 2},
{"ETH", "EUR", 710, 2},
{"YAN", "EUR", 710, 2},
{"CAN", "EUR", 710, 2},
}});
count += 1;
BEAST_EXPECT(ownerCount(env, owner) == count);
// update two pairs and delete four
oracle.set(UpdateArg{
.series = {{"BTC", "USD", std::nullopt, std::nullopt}}});
oracle.set(UpdateArg{
.series = {
{"XRP", "USD", 742, 2},
{"XRP", "EUR", 711, 2},
{"ETH", "EUR", std::nullopt, std::nullopt},
{"YAN", "EUR", std::nullopt, std::nullopt},
{"CAN", "EUR", std::nullopt, std::nullopt}}});
BEAST_EXPECT(oracle.expectPrice(
{{"XRP", "USD", 742, 2}, {"XRP", "EUR", 711, 2}}));
// owner count is decreased by 1 since the number of pairs is 2
count -= 1;
BEAST_EXPECT(ownerCount(env, owner) == count);
}
// Min reserve to create and update
{
Env env(*this);
env.fund(
env.current()->fees().accountReserve(1) +
env.current()->fees().base * 2,
owner);
Oracle oracle(env, {.owner = owner});
oracle.set(UpdateArg{.series = {{"XRP", "USD", 742, 2}}});
}
}
void
testMultisig(FeatureBitset features)
{
testcase("Multisig");
using namespace jtx;
Oracle::setFee(100'000);
Env env(*this, features);
Account const alice{"alice", KeyType::secp256k1};
Account const bogie{"bogie", KeyType::secp256k1};
Account const ed{"ed", KeyType::secp256k1};
Account const becky{"becky", KeyType::ed25519};
Account const zelda{"zelda", KeyType::secp256k1};
Account const bob{"bob", KeyType::secp256k1};
env.fund(XRP(10'000), alice, becky, zelda, ed, bob);
// alice uses a regular key with the master disabled.
Account const alie{"alie", KeyType::secp256k1};
env(regkey(alice, alie));
env(fset(alice, asfDisableMaster), sig(alice));
// Attach signers to alice.
env(signers(alice, 2, {{becky, 1}, {bogie, 1}, {ed, 2}}), sig(alie));
env.close();
// if multiSignReserve disabled then its 2 + 1 per signer
int const signerListOwners{features[featureMultiSignReserve] ? 1 : 5};
env.require(owners(alice, signerListOwners));
// Create
// Force close (true) and time advancement because the close time
// is no longer 0.
Oracle oracle(env, CreateArg{.owner = alice, .close = true}, false);
oracle.set(CreateArg{.msig = msig(becky), .err = ter(tefBAD_QUORUM)});
oracle.set(
CreateArg{.msig = msig(zelda), .err = ter(tefBAD_SIGNATURE)});
oracle.set(CreateArg{.msig = msig(becky, bogie)});
BEAST_EXPECT(oracle.exists());
// Update
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 740, 1}},
.msig = msig(becky),
.err = ter(tefBAD_QUORUM)});
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 740, 1}},
.msig = msig(zelda),
.err = ter(tefBAD_SIGNATURE)});
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 741, 1}}, .msig = msig(becky, bogie)});
BEAST_EXPECT(oracle.expectPrice({{"XRP", "USD", 741, 1}}));
// remove the signer list
env(signers(alice, jtx::none), sig(alie));
env.close();
env.require(owners(alice, 1));
// create new signer list
env(signers(alice, 2, {{zelda, 1}, {bob, 1}, {ed, 2}}), sig(alie));
env.close();
// old list fails
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 740, 1}},
.msig = msig(becky, bogie),
.err = ter(tefBAD_SIGNATURE)});
// updated list succeeds
oracle.set(UpdateArg{
.series = {{"XRP", "USD", 7412, 2}}, .msig = msig(zelda, bob)});
BEAST_EXPECT(oracle.expectPrice({{"XRP", "USD", 7412, 2}}));
oracle.set(
UpdateArg{.series = {{"XRP", "USD", 74245, 3}}, .msig = msig(ed)});
BEAST_EXPECT(oracle.expectPrice({{"XRP", "USD", 74245, 3}}));
// Remove
oracle.remove({.msig = msig(bob), .err = ter(tefBAD_QUORUM)});
oracle.remove({.msig = msig(becky), .err = ter(tefBAD_SIGNATURE)});
oracle.remove({.msig = msig(ed)});
BEAST_EXPECT(!oracle.exists());
}
void
testAmendment()
{
testcase("Amendment");
using namespace jtx;
auto const features = supported_amendments() - featurePriceOracle;
Account const owner("owner");
Env env(*this, features);
env.fund(XRP(1'000), owner);
{
Oracle oracle(env, {.owner = owner, .err = ter(temDISABLED)});
}
{
Oracle oracle(env, {.owner = owner}, false);
oracle.remove({.err = ter(temDISABLED)});
}
}
void
testLedgerEntry()
{
testcase("Ledger Entry");
using namespace jtx;
Env env(*this);
std::vector<AccountID> accounts;
std::vector<std::uint32_t> oracles;
for (int i = 0; i < 10; ++i)
{
Account const owner(std::string("owner") + std::to_string(i));
env.fund(XRP(1'000), owner);
// different accounts can have the same asset pair
Oracle oracle(env, {.owner = owner, .documentID = i});
accounts.push_back(owner.id());
oracles.push_back(oracle.documentID());
// same account can have different asset pair
Oracle oracle1(env, {.owner = owner, .documentID = i + 10});
accounts.push_back(owner.id());
oracles.push_back(oracle1.documentID());
}
for (int i = 0; i < accounts.size(); ++i)
{
auto const jv = [&]() {
// document id is uint32
if (i % 2)
return Oracle::ledgerEntry(env, accounts[i], oracles[i]);
// document id is string
return Oracle::ledgerEntry(
env, accounts[i], std::to_string(oracles[i]));
}();
try
{
BEAST_EXPECT(
jv[jss::node][jss::Owner] == to_string(accounts[i]));
}
catch (...)
{
fail();
}
}
}
public:
void
run() override
{
using namespace jtx;
auto const all = supported_amendments();
testInvalidSet();
testInvalidDelete();
testCreate();
testDelete();
testUpdate();
testAmendment();
for (auto const& features :
{all,
all - featureMultiSignReserve - featureExpandedSignerList,
all - featureExpandedSignerList})
testMultisig(features);
testLedgerEntry();
}
};
BEAST_DEFINE_TESTSUITE(Oracle, app, ripple);
} // namespace oracle
} // namespace jtx
} // namespace test
} // namespace ripple
Reference in New Issue View Git Blame Copy Permalink