ripple::test::jtx::oracle::Oracle Class Reference

Oracle class facilitates unit-testing of the Price Oracle feature. More...

#include <Oracle.h>

Collaboration diagram for ripple::test::jtx::oracle::Oracle:

Public Member Functions
	Oracle (Env &env, CreateArg const &arg, bool submit=true)
void	remove (RemoveArg const &arg)
void	set (CreateArg const &arg)
void	set (UpdateArg const &arg)
std::uint32_t	documentID () const
bool	exists () const
bool	expectPrice (DataSeries const &pricess) const
bool	expectLastUpdateTime (std::uint32_t lastUpdateTime) const
Json::Value	ledgerEntry (std::optional< std::string > const &index=std::nullopt) const

Static Public Member Functions
static Json::Value	aggregatePrice (Env &env, std::optional< AnyValue > const &baseAsset, std::optional< AnyValue > const &quoteAsset, std::optional< OraclesData > const &oracles=std::nullopt, std::optional< AnyValue > const &trim=std::nullopt, std::optional< AnyValue > const &timeTreshold=std::nullopt)
static bool	exists (Env &env, AccountID const &account, std::uint32_t documentID)
static Json::Value	ledgerEntry (Env &env, std::optional< std::variant< AccountID, std::string > > const &account, std::optional< AnyValue > const &documentID, std::optional< std::string > const &index=std::nullopt)
static void	setFee (std::uint32_t f)

Private Member Functions
void	submit (Json::Value const &jv, std::optional< jtx::msig > const &msig, std::optional< jtx::seq > const &seq, std::optional< ter > const &err)

Private Attributes
Env &	env_
AccountID	owner_
std::uint32_t	documentID_

Static Private Attributes
static std::uint32_t	fee = 0

Friends
std::ostream &	operator<< (std::ostream &strm, Oracle const &oracle)

Detailed Description

Oracle class facilitates unit-testing of the Price Oracle feature.

It defines functions to create, update, and delete the Oracle object, to query for various states, and to call APIs.

Definition at line 100 of file Oracle.h.

Constructor & Destructor Documentation

Oracle()

ripple::test::jtx::oracle::Oracle::Oracle	(	Env &	env,
		CreateArg const &	arg,
		bool	submit = true
	)

Definition at line 15 of file Oracle.cpp.

Member Function Documentation

submit()

void ripple::test::jtx::oracle::Oracle::submit ( Json::Value const &  jv, std::optional< jtx::msig > const &  msig, std::optional< jtx::seq > const &  seq, std::optional< ter > const &  err  )

private

Definition at line 53 of file Oracle.cpp.

remove()

void ripple::test::jtx::oracle::Oracle::remove

(

RemoveArg const &

arg

)

Definition at line 35 of file Oracle.cpp.

set() [1/2]

void ripple::test::jtx::oracle::Oracle::set

(

CreateArg const &

arg

)

Definition at line 250 of file Oracle.cpp.

set() [2/2]

void ripple::test::jtx::oracle::Oracle::set

(

UpdateArg const &

arg

)

Definition at line 174 of file Oracle.cpp.

aggregatePrice()

Json::Value ripple::test::jtx::oracle::Oracle::aggregatePrice ( Env &  env, std::optional< AnyValue > const &  baseAsset, std::optional< AnyValue > const &  quoteAsset, std::optional< OraclesData > const &  oracles = std::nullopt, std::optional< AnyValue > const &  trim = std::nullopt, std::optional< AnyValue > const &  timeTreshold = std::nullopt  )

static

Definition at line 127 of file Oracle.cpp.

documentID()

std::uint32_t ripple::test::jtx::oracle::Oracle::documentID

(

)

const

Definition at line 138 of file Oracle.h.

exists() [1/2]

bool ripple::test::jtx::oracle::Oracle::exists

(

)

const

Definition at line 144 of file Oracle.h.

exists() [2/2]

bool ripple::test::jtx::oracle::Oracle::exists ( Env &  env, AccountID const &  account, std::uint32_t  documentID  )

static

Definition at line 82 of file Oracle.cpp.

expectPrice()

bool ripple::test::jtx::oracle::Oracle::expectPrice

(

DataSeries const &

pricess

)

const

Definition at line 89 of file Oracle.cpp.

expectLastUpdateTime()

bool ripple::test::jtx::oracle::Oracle::expectLastUpdateTime

(

std::uint32_t

lastUpdateTime

)

const

Definition at line 120 of file Oracle.cpp.

ledgerEntry() [1/2]

Json::Value ripple::test::jtx::oracle::Oracle::ledgerEntry ( Env &  env, std::optional< std::variant< AccountID, std::string > > const &  account, std::optional< AnyValue > const &  documentID, std::optional< std::string > const &  index = std::nullopt  )

static

Definition at line 268 of file Oracle.cpp.

ledgerEntry() [2/2]

Json::Value ripple::test::jtx::oracle::Oracle::ledgerEntry

(

std::optional< std::string > const &

index = std::nullopt

)

const

Definition at line 166 of file Oracle.h.

setFee()

static void ripple::test::jtx::oracle::Oracle::setFee ( std::uint32_t  f )

static

Definition at line 172 of file Oracle.h.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  strm, Oracle const &  oracle  )

friend

Definition at line 177 of file Oracle.h.

Member Data Documentation

fee

std::uint32_t ripple::test::jtx::oracle::Oracle::fee = 0

staticprivate

Definition at line 104 of file Oracle.h.

env_

Env& ripple::test::jtx::oracle::Oracle::env_

private

Definition at line 105 of file Oracle.h.

owner_

AccountID ripple::test::jtx::oracle::Oracle::owner_

private

Definition at line 106 of file Oracle.h.

documentID_

std::uint32_t ripple::test::jtx::oracle::Oracle::documentID_

private

Definition at line 107 of file Oracle.h.