Keylet computation funclets. More...

Classes
struct	book_t
	The beginning of an order book. More...

struct	next_t
	The directory for the next lower quality. More...

struct	ticket_t
	A ticket belonging to an account. More...

Functions
Keylet	account (AccountID const &id) noexcept
	AccountID root. More...

Keylet	child (uint256 const &key) noexcept
	Any item that can be in an owner dir. More...

Keylet const &	skip () noexcept
	The index of the "short" skip list. More...

Keylet	skip (LedgerIndex ledger) noexcept
	The index of the long skip for a particular ledger range. More...

Keylet const &	amendments () noexcept
	The index of the amendment table. More...

Keylet const &	fees () noexcept
	The (fixed) index of the object containing the ledger fees. More...

Keylet const &	negativeUNL () noexcept
	The (fixed) index of the object containing the ledger negativeUNL. More...

Keylet	quality (Keylet const &k, std::uint64_t q) noexcept
	The initial directory page for a specific quality. More...

static Keylet	signers (AccountID const &account, std::uint32_t page) noexcept

Keylet	signers (AccountID const &account) noexcept
	A SignerList. More...

Keylet	unchecked (uint256 const &key) noexcept
	Any ledger entry. More...

Keylet	ownerDir (AccountID const &id) noexcept
	The root page of an account's directory. More...

Keylet	escrow (AccountID const &src, std::uint32_t seq) noexcept
	An escrow entry. More...

Keylet	payChan (AccountID const &src, AccountID const &dst, std::uint32_t seq) noexcept
	A PaymentChannel. More...

Keylet	nftoffer (AccountID const &owner, std::uint32_t seq)
	An offer from an account to buy or sell an NFT. More...

Keylet	nft_buys (uint256 const &id) noexcept
	The directory of buy offers for the specified NFT. More...

Keylet	nft_sells (uint256 const &id) noexcept
	The directory of sell offers for the specified NFT. More...

Keylet	amm (Issue const &issue1, Issue const &issue2) noexcept
	AMM entry. More...

Keylet	amm (uint256 const &id) noexcept

Keylet	bridge (STXChainBridge const &bridge, STXChainBridge::ChainType chainType)

Keylet	xChainClaimID (STXChainBridge const &bridge, std::uint64_t seq)

Keylet	xChainCreateAccountClaimID (STXChainBridge const &bridge, std::uint64_t seq)

Keylet	did (AccountID const &account) noexcept

Keylet	oracle (AccountID const &account, std::uint32_t const &documentID) noexcept

Keylet	nftoffer (uint256 const &offer)

Variables
static const book_t	book {}

static const next_t	next {}

static const ticket_t	ticket {}

Detailed Description

Keylet computation funclets.

Entries in the ledger are located using 256-bit locators. The locators are calculated using a wide range of parameters specific to the entry whose locator we are calculating (e.g. an account's locator is derived from the account's address, whereas the locator for an offer is derived from the account and the offer sequence.)

To enhance type safety during lookup and make the code more robust, we use keylets, which contain not only the locator of the object but also the type of the object being referenced.

These functions each return a type-specific keylet.

Function Documentation

◆ account()

Keylet ripple::keylet::account ( AccountID const & id )

noexcept

AccountID root.

Definition at line 143 of file Indexes.cpp.

◆ child()

Keylet ripple::keylet::child ( uint256 const & key )

noexcept

Any item that can be in an owner dir.

Definition at line 149 of file Indexes.cpp.

◆ skip() [1/2]

Keylet const & ripple::keylet::skip ( )

noexcept

The index of the "short" skip list.

The "short" skip list is a node (at a fixed index) that holds the hashes of ledgers since the last flag ledger. It will contain, at most, 256 hashes.

Definition at line 155 of file Indexes.cpp.

◆ skip() [2/2]

Keylet ripple::keylet::skip ( LedgerIndex ledger )

noexcept

The index of the long skip for a particular ledger range.

The "long" skip list is a node that holds the hashes of (up to) 256 flag ledgers.

It can be used to efficiently skip back to any ledger using only two hops: the first hop gets the "long" skip list for the ledger it wants to retrieve and uses it to get the hash of the flag ledger whose short skip list will contain the hash of the requested ledger.

Definition at line 163 of file Indexes.cpp.

◆ amendments()

Keylet const & ripple::keylet::amendments ( )

noexcept

The index of the amendment table.

Definition at line 173 of file Indexes.cpp.

◆ fees()

Keylet const & ripple::keylet::fees ( )

noexcept

The (fixed) index of the object containing the ledger fees.

Definition at line 181 of file Indexes.cpp.

◆ negativeUNL()

Keylet const & ripple::keylet::negativeUNL ( )

noexcept

The (fixed) index of the object containing the ledger negativeUNL.

Definition at line 189 of file Indexes.cpp.

◆ line() [1/2]

Keylet ripple::keylet::line	(	AccountID const &	id0,
		AccountID const &	id1,
		Currency const &	currency
	)

noexcept

The index of a trust line for a given currency.

Note that a trustline is shared between two accounts (commonly referred to as the issuer and the holder); if Alice sets up a trust line to Bob for BTC, and Bob trusts Alice for BTC, here is only a single BTC trust line between them.

Definition at line 203 of file Indexes.cpp.

◆ offer() [1/2]

Keylet ripple::keylet::offer	(	AccountID const &	id,
		std::uint32_t	seq
	)

noexcept

An offer from an account.

Definition at line 232 of file Indexes.cpp.

◆ quality()

Keylet ripple::keylet::quality	(	Keylet const &	k,
		std::uint64_t	q
	)

noexcept

The initial directory page for a specific quality.

Definition at line 238 of file Indexes.cpp.

◆ signers() [1/2]

static Keylet ripple::keylet::signers	(	AccountID const &	account,
		std::uint32_t	page
	)

staticnoexcept

Definition at line 278 of file Indexes.cpp.

◆ signers() [2/2]

Keylet ripple::keylet::signers ( AccountID const & account )

noexcept

A SignerList.

Definition at line 285 of file Indexes.cpp.

◆ check() [1/2]

Keylet ripple::keylet::check	(	AccountID const &	id,
		std::uint32_t	seq
	)

noexcept

A Check.

Definition at line 291 of file Indexes.cpp.

◆ depositPreauth() [1/2]

Keylet ripple::keylet::depositPreauth	(	AccountID const &	owner,
		AccountID const &	preauthorized
	)

noexcept

A DepositPreauth.

Definition at line 297 of file Indexes.cpp.

◆ unchecked()

Keylet ripple::keylet::unchecked ( uint256 const & key )

noexcept

Any ledger entry.

Definition at line 307 of file Indexes.cpp.

◆ ownerDir()

Keylet ripple::keylet::ownerDir ( AccountID const & id )

noexcept

The root page of an account's directory.

Definition at line 313 of file Indexes.cpp.

◆ page() [1/2]

Keylet ripple::keylet::page	(	uint256 const &	key,
		std::uint64_t	index
	)

noexcept

A page in a directory.

Definition at line 319 of file Indexes.cpp.

◆ escrow()

Keylet ripple::keylet::escrow	(	AccountID const &	src,
		std::uint32_t	seq
	)

noexcept

An escrow entry.

Definition at line 328 of file Indexes.cpp.

◆ payChan()

Keylet ripple::keylet::payChan	(	AccountID const &	src,
		AccountID const &	dst,
		std::uint32_t	seq
	)

noexcept

A PaymentChannel.

Definition at line 334 of file Indexes.cpp.

◆ nftpage_min()

Keylet ripple::keylet::nftpage_min ( AccountID const & owner )

NFT page keylets.

Unlike objects whose ledger identifiers are produced by hashing data, NFT page identifiers are composite identifiers, consisting of the owner's 160-bit AccountID, followed by a 96-bit value that determines which NFT tokens are candidates for that page. A keylet for the owner's first possible NFT page.

Definition at line 342 of file Indexes.cpp.

◆ nftpage_max()

Keylet ripple::keylet::nftpage_max ( AccountID const & owner )

A keylet for the owner's last possible NFT page.

Definition at line 350 of file Indexes.cpp.

◆ nftpage()

Keylet ripple::keylet::nftpage	(	Keylet const &	k,
		uint256 const &	token
	)

Definition at line 358 of file Indexes.cpp.

◆ nftoffer() [1/2]

Keylet ripple::keylet::nftoffer	(	AccountID const &	owner,
		std::uint32_t	seq
	)

An offer from an account to buy or sell an NFT.

Definition at line 365 of file Indexes.cpp.

◆ nft_buys()

Keylet ripple::keylet::nft_buys ( uint256 const & id )

noexcept

The directory of buy offers for the specified NFT.

Definition at line 372 of file Indexes.cpp.

◆ nft_sells()

Keylet ripple::keylet::nft_sells ( uint256 const & id )

noexcept

The directory of sell offers for the specified NFT.

Definition at line 378 of file Indexes.cpp.

◆ amm() [1/2]

Keylet ripple::keylet::amm	(	Issue const &	issue1,
		Issue const &	issue2
	)

noexcept

AMM entry.

Definition at line 384 of file Indexes.cpp.

◆ amm() [2/2]

Keylet ripple::keylet::amm ( uint256 const & id )

noexcept

Definition at line 396 of file Indexes.cpp.

◆ bridge()

Keylet ripple::keylet::bridge	(	STXChainBridge const &	bridge,
		STXChainBridge::ChainType	chainType
	)

Definition at line 402 of file Indexes.cpp.

◆ xChainClaimID()

Keylet ripple::keylet::xChainClaimID	(	STXChainBridge const &	bridge,
		std::uint64_t	seq
	)

Definition at line 415 of file Indexes.cpp.

◆ xChainCreateAccountClaimID()

Keylet ripple::keylet::xChainCreateAccountClaimID	(	STXChainBridge const &	bridge,
		std::uint64_t	seq
	)

Definition at line 429 of file Indexes.cpp.

◆ did()

Keylet ripple::keylet::did ( AccountID const & account )

noexcept

Definition at line 443 of file Indexes.cpp.

◆ oracle()

Keylet ripple::keylet::oracle	(	AccountID const &	account,
		std::uint32_t const &	documentID
	)

noexcept

Definition at line 449 of file Indexes.cpp.

◆ line() [2/2]

Keylet ripple::keylet::line	(	AccountID const &	id,
		Issue const &	issue
	)

noexcept

Definition at line 119 of file Indexes.h.

◆ offer() [2/2]

Keylet ripple::keylet::offer ( uint256 const & key )

noexcept

Definition at line 131 of file Indexes.h.

◆ check() [2/2]

Keylet ripple::keylet::check ( uint256 const & key )

noexcept

Definition at line 180 of file Indexes.h.

◆ depositPreauth() [2/2]

Keylet ripple::keylet::depositPreauth ( uint256 const & key )

noexcept

Definition at line 192 of file Indexes.h.

◆ page() [2/2]

Keylet ripple::keylet::page	(	Keylet const &	root,
		std::uint64_t	index = `0`
	)

noexcept

Definition at line 214 of file Indexes.h.

◆ nftoffer() [2/2]

Keylet ripple::keylet::nftoffer ( uint256 const & offer )

Definition at line 254 of file Indexes.h.

Variable Documentation

◆ book

const book_t ripple::keylet::book {}

static

Definition at line 102 of file Indexes.h.

◆ next

const next_t ripple::keylet::next {}

static

Definition at line 149 of file Indexes.h.

◆ ticket

const ticket_t ripple::keylet::ticket {}

static

Definition at line 168 of file Indexes.h.

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ account()

◆ child()

◆ skip() [1/2]

◆ skip() [2/2]

◆ amendments()

◆ fees()

◆ negativeUNL()

◆ line() [1/2]

◆ offer() [1/2]

◆ quality()

◆ signers() [1/2]

◆ signers() [2/2]

◆ check() [1/2]

◆ depositPreauth() [1/2]

◆ unchecked()

◆ ownerDir()

◆ page() [1/2]

◆ escrow()

◆ payChan()

◆ nftpage_min()

◆ nftpage_max()

◆ nftpage()

◆ nftoffer() [1/2]

◆ nft_buys()

◆ nft_sells()

◆ amm() [1/2]

◆ amm() [2/2]

◆ bridge()

◆ xChainClaimID()

◆ xChainCreateAccountClaimID()

◆ did()

◆ oracle()

◆ line() [2/2]

◆ offer() [2/2]

◆ check() [2/2]

◆ depositPreauth() [2/2]

◆ page() [2/2]

◆ nftoffer() [2/2]

Variable Documentation

◆ book

◆ next

◆ ticket