xrpl::OrderBookDB Class Reference

Tracks order books in the ledger. More...

#include <OrderBookDB.h>

Inheritance diagram for xrpl::OrderBookDB:

Public Member Functions
virtual	~OrderBookDB ()=default
virtual void	setup (std::shared_ptr< ReadView const > const &ledger)=0
	Initialize or update the order book database with a new ledger.
virtual void	addOrderBook (Book const &book)=0
	Add an order book to track.
virtual std::vector< Book >	getBooksByTakerPays (Asset const &asset, std::optional< Domain > const &domain=std::nullopt)=0
	Get all order books that want a specific issue.
virtual int	getBookSize (Asset const &asset, std::optional< Domain > const &domain=std::nullopt)=0
	Get the count of order books that want a specific issue.
virtual bool	isBookToXRP (Asset const &asset, std::optional< Domain > const &domain=std::nullopt)=0
	Check if an order book to XRP exists for the given issue.

Detailed Description

Tracks order books in the ledger.

This interface provides access to order book information, including:

• Which order books exist in the ledger
• Querying order books by issue
• Managing order book subscriptions

The order book database is updated as ledgers are accepted and provides efficient lookup of order book information for pathfinding and client subscriptions.

Definition at line 28 of file OrderBookDB.h.

Constructor & Destructor Documentation

~OrderBookDB()

virtual xrpl::OrderBookDB::~OrderBookDB ( )

virtualdefault

Member Function Documentation

setup()

virtual void xrpl::OrderBookDB::setup ( std::shared_ptr< ReadView const > const & ledger )

pure virtual

Initialize or update the order book database with a new ledger.

This method should be called when a new ledger is accepted to update the order book database with the current state of all order books.

Parameters

ledger

The ledger to scan for order books

Implemented in xrpl::OrderBookDBImpl.

addOrderBook()

virtual void xrpl::OrderBookDB::addOrderBook ( Book const & book )

pure virtual

Add an order book to track.

Parameters

book	The order book to add

Implemented in xrpl::OrderBookDBImpl.

getBooksByTakerPays()

virtual std::vector< Book > xrpl::OrderBookDB::getBooksByTakerPays ( Asset const & asset, std::optional< Domain > const & domain = std::nullopt )

pure virtual

Get all order books that want a specific issue.

Returns a list of all order books where the taker pays the specified issue. This is useful for pathfinding to find all possible next hops from a given currency.

Parameters

asset	The asset to search for
domain	Optional domain restriction for the order book

Returns

Vector of books that want this issue

Implemented in xrpl::OrderBookDBImpl.

getBookSize()

virtual int xrpl::OrderBookDB::getBookSize ( Asset const & asset, std::optional< Domain > const & domain = std::nullopt )

pure virtual

Get the count of order books that want a specific issue.

Parameters

asset	The asset to search for
domain	Optional domain restriction for the order book

Returns

Number of books that want this issue

Implemented in xrpl::OrderBookDBImpl.

isBookToXRP()

virtual bool xrpl::OrderBookDB::isBookToXRP ( Asset const & asset, std::optional< Domain > const & domain = std::nullopt )

pure virtual

Check if an order book to XRP exists for the given issue.

Parameters

asset	The asset to check
domain	Optional domain restriction for the order book

Returns

true if a book from this issue to XRP exists

Implemented in xrpl::OrderBookDBImpl.