xrpl::keylet Namespace Reference

Keylet computation functions. 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.
Keylet const &	amendments () noexcept
	The index of the amendment table.
Keylet	child (uint256 const &key) noexcept
	Any item that can be in an owner dir.
Keylet const &	skip () noexcept
	The index of the "short" skip list.
Keylet	skip (LedgerIndex ledger) noexcept
	The index of the long skip for a particular ledger range.
Keylet const &	fees () noexcept
	The (fixed) index of the object containing the ledger fees.
Keylet const &	negativeUNL () noexcept
	The (fixed) index of the object containing the ledger negativeUNL.
Keylet	quality (Keylet const &k, std::uint64_t q) noexcept
	The initial directory page for a specific quality.
Keylet	signers (AccountID const &account) noexcept
	A SignerList.
Keylet	unchecked (uint256 const &key) noexcept
	Any ledger entry.
Keylet	ownerDir (AccountID const &id) noexcept
	The root page of an account's directory.
Keylet	escrow (AccountID const &src, std::uint32_t seq) noexcept
	An escrow entry.
Keylet	payChan (AccountID const &src, AccountID const &dst, std::uint32_t seq) noexcept
	A PaymentChannel.
Keylet	nftoffer (AccountID const &owner, std::uint32_t seq)
	An offer from an account to buy or sell an NFT.
Keylet	nftoffer (uint256 const &offer)
Keylet	nft_buys (uint256 const &id) noexcept
	The directory of buy offers for the specified NFT.
Keylet	nft_sells (uint256 const &id) noexcept
	The directory of sell offers for the specified NFT.
Keylet	amm (Asset const &issue1, Asset const &issue2) noexcept
	AMM entry.
Keylet	amm (uint256 const &amm) noexcept
Keylet	delegate (AccountID const &account, AccountID const &authorizedAccount) noexcept
	A keylet for Delegate object.
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	credential (AccountID const &subject, AccountID const &issuer, Slice const &credType) noexcept
Keylet	credential (uint256 const &key) noexcept
Keylet	mptIssuance (std::uint32_t seq, AccountID const &issuer) noexcept
Keylet	mptIssuance (MPTID const &issuanceID) noexcept
Keylet	mptIssuance (uint256 const &issuanceKey)
Keylet	mptoken (MPTID const &issuanceID, AccountID const &holder) noexcept
Keylet	mptoken (uint256 const &mptokenKey)
Keylet	mptoken (uint256 const &issuanceKey, AccountID const &holder) noexcept
Keylet	vault (AccountID const &owner, std::uint32_t seq) noexcept
Keylet	vault (uint256 const &vaultKey)
Keylet	loanbroker (AccountID const &owner, std::uint32_t seq) noexcept
Keylet	loanbroker (uint256 const &key)
Keylet	loan (uint256 const &loanBrokerID, std::uint32_t loanSeq) noexcept
Keylet	loan (uint256 const &key)
Keylet	permissionedDomain (AccountID const &account, std::uint32_t seq) noexcept
Keylet	permissionedDomain (uint256 const &domainID) noexcept
static Keylet	signers (AccountID const &account, std::uint32_t page) noexcept
Keylet	line (AccountID const &id0, AccountID const &id1, Currency const &currency) noexcept
	The index of a trust line for a given currency.
Keylet	line (AccountID const &id, Issue const &issue) noexcept
Keylet	offer (AccountID const &id, std::uint32_t seq) noexcept
	An offer from an account.
Keylet	offer (uint256 const &key) noexcept
Keylet	check (AccountID const &id, std::uint32_t seq) noexcept
	A Check.
Keylet	check (uint256 const &key) noexcept
Keylet	depositPreauth (AccountID const &owner, AccountID const &preauthorized) noexcept
	A DepositPreauth.
Keylet	depositPreauth (AccountID const &owner, std::set< std::pair< AccountID, Slice > > const &authCreds) noexcept
Keylet	depositPreauth (uint256 const &key) noexcept
Keylet	page (uint256 const &root, std::uint64_t index=0) noexcept
	A page in a directory.
Keylet	page (Keylet const &root, std::uint64_t index=0) noexcept
Keylet	nftpage_min (AccountID const &owner)
	NFT page keylets.
Keylet	nftpage_max (AccountID const &owner)
	A keylet for the owner's last possible NFT page.
Keylet	nftpage (Keylet const &k, uint256 const &token)

Variables
static book_t const	book {}
static next_t const	next {}
static ticket_t const	ticket {}

Detailed Description

Keylet computation functions.

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 xrpl::keylet::account ( AccountID const &  id )

noexcept

AccountID root.

Definition at line 160 of file Indexes.cpp.

amendments()

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

noexcept

The index of the amendment table.

Definition at line 187 of file Indexes.cpp.

child()

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

noexcept

Any item that can be in an owner dir.

Definition at line 166 of file Indexes.cpp.

skip() [1/2]

Keylet const & xrpl::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 172 of file Indexes.cpp.

skip() [2/2]

Keylet xrpl::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 179 of file Indexes.cpp.

fees()

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

noexcept

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

Definition at line 194 of file Indexes.cpp.

negativeUNL()

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

noexcept

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

Definition at line 201 of file Indexes.cpp.

line() [1/2]

Keylet xrpl::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 214 of file Indexes.cpp.

line() [2/2]

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

noexcept

Definition at line 99 of file Indexes.h.

offer() [1/2]

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

noexcept

An offer from an account.

Definition at line 235 of file Indexes.cpp.

offer() [2/2]

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

noexcept

Definition at line 111 of file Indexes.h.

quality()

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

noexcept

The initial directory page for a specific quality.

Definition at line 241 of file Indexes.cpp.

signers() [1/2]

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

noexcept

A SignerList.

Definition at line 287 of file Indexes.cpp.

check() [1/2]

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

noexcept

A Check.

Definition at line 293 of file Indexes.cpp.

check() [2/2]

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

noexcept

Definition at line 160 of file Indexes.h.

depositPreauth() [1/3]

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

noexcept

A DepositPreauth.

Definition at line 299 of file Indexes.cpp.

depositPreauth() [2/3]

Keylet xrpl::keylet::depositPreauth ( AccountID const &  owner, std::set< std::pair< AccountID, Slice > > const &  authCreds  )

noexcept

Definition at line 306 of file Indexes.cpp.

depositPreauth() [3/3]

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

noexcept

Definition at line 175 of file Indexes.h.

unchecked()

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

noexcept

Any ledger entry.

Definition at line 319 of file Indexes.cpp.

ownerDir()

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

noexcept

The root page of an account's directory.

Definition at line 325 of file Indexes.cpp.

page() [1/2]

Keylet xrpl::keylet::page ( uint256 const &  root, std::uint64_t  index = 0  )

noexcept

A page in a directory.

Definition at line 331 of file Indexes.cpp.

page() [2/2]

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

noexcept

Definition at line 197 of file Indexes.h.

escrow()

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

noexcept

An escrow entry.

Definition at line 340 of file Indexes.cpp.

payChan()

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

noexcept

A PaymentChannel.

Definition at line 346 of file Indexes.cpp.

nftpage_min()

Keylet xrpl::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 352 of file Indexes.cpp.

nftpage_max()

Keylet xrpl::keylet::nftpage_max

(

AccountID const &

owner

)

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

Definition at line 360 of file Indexes.cpp.

nftpage()

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

Definition at line 368 of file Indexes.cpp.

nftoffer() [1/2]

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

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

Definition at line 375 of file Indexes.cpp.

nftoffer() [2/2]

Keylet xrpl::keylet::nftoffer

(

uint256 const &

offer

)

Definition at line 237 of file Indexes.h.

nft_buys()

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

noexcept

The directory of buy offers for the specified NFT.

Definition at line 381 of file Indexes.cpp.

nft_sells()

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

noexcept

The directory of sell offers for the specified NFT.

Definition at line 387 of file Indexes.cpp.

amm() [1/2]

Keylet xrpl::keylet::amm ( Asset const &  issue1, Asset const &  issue2  )

noexcept

AMM entry.

Definition at line 393 of file Indexes.cpp.

amm() [2/2]

Keylet xrpl::keylet::amm ( uint256 const &  amm )

noexcept

Definition at line 400 of file Indexes.cpp.

delegate()

Keylet xrpl::keylet::delegate ( AccountID const &  account, AccountID const &  authorizedAccount  )

noexcept

A keylet for Delegate object.

Definition at line 406 of file Indexes.cpp.

bridge()

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

Definition at line 412 of file Indexes.cpp.

xChainClaimID()

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

Definition at line 422 of file Indexes.cpp.

xChainCreateAccountClaimID()

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

Definition at line 436 of file Indexes.cpp.

did()

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

noexcept

Definition at line 450 of file Indexes.cpp.

oracle()

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

noexcept

Definition at line 456 of file Indexes.cpp.

credential() [1/2]

Keylet xrpl::keylet::credential ( AccountID const &  subject, AccountID const &  issuer, Slice const &  credType  )

noexcept

Definition at line 486 of file Indexes.cpp.

credential() [2/2]

Keylet xrpl::keylet::credential ( uint256 const &  key )

noexcept

Definition at line 282 of file Indexes.h.

mptIssuance() [1/3]

Keylet xrpl::keylet::mptIssuance ( std::uint32_t  seq, AccountID const &  issuer  )

noexcept

Definition at line 462 of file Indexes.cpp.

mptIssuance() [2/3]

Keylet xrpl::keylet::mptIssuance ( MPTID const &  issuanceID )

noexcept

Definition at line 468 of file Indexes.cpp.

mptIssuance() [3/3]

Keylet xrpl::keylet::mptIssuance

(

uint256 const &

issuanceKey

)

Definition at line 294 of file Indexes.h.

mptoken() [1/3]

Keylet xrpl::keylet::mptoken ( MPTID const &  issuanceID, AccountID const &  holder  )

noexcept

Definition at line 474 of file Indexes.cpp.

mptoken() [2/3]

Keylet xrpl::keylet::mptoken

(

uint256 const &

mptokenKey

)

Definition at line 303 of file Indexes.h.

mptoken() [3/3]

Keylet xrpl::keylet::mptoken ( uint256 const &  issuanceKey, AccountID const &  holder  )

noexcept

Definition at line 480 of file Indexes.cpp.

vault() [1/2]

Keylet xrpl::keylet::vault ( AccountID const &  owner, std::uint32_t  seq  )

noexcept

Definition at line 492 of file Indexes.cpp.

vault() [2/2]

Keylet xrpl::keylet::vault

(

uint256 const &

vaultKey

)

Definition at line 315 of file Indexes.h.

loanbroker() [1/2]

Keylet xrpl::keylet::loanbroker ( AccountID const &  owner, std::uint32_t  seq  )

noexcept

Definition at line 498 of file Indexes.cpp.

loanbroker() [2/2]

Keylet xrpl::keylet::loanbroker

(

uint256 const &

key

)

Definition at line 324 of file Indexes.h.

loan() [1/2]

Keylet xrpl::keylet::loan ( uint256 const &  loanBrokerID, std::uint32_t  loanSeq  )

noexcept

Definition at line 504 of file Indexes.cpp.

loan() [2/2]

Keylet xrpl::keylet::loan

(

uint256 const &

key

)

Definition at line 333 of file Indexes.h.

permissionedDomain() [1/2]

Keylet xrpl::keylet::permissionedDomain ( AccountID const &  account, std::uint32_t  seq  )

noexcept

Definition at line 510 of file Indexes.cpp.

permissionedDomain() [2/2]

Keylet xrpl::keylet::permissionedDomain ( uint256 const &  domainID )

noexcept

Definition at line 516 of file Indexes.cpp.

signers() [2/2]

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

staticnoexcept

Definition at line 281 of file Indexes.cpp.

Variable Documentation

book

book_t const xrpl::keylet::book {}

static

Definition at line 85 of file Indexes.h.

next

next_t const xrpl::keylet::next {}

static

Definition at line 129 of file Indexes.h.

ticket

ticket_t const xrpl::keylet::ticket {}

static

Definition at line 148 of file Indexes.h.