Keylet computation functions. 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 & | feeSettings () 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 | book (Book const &b) |
| The beginning of an order book. | |
| Keylet | quality (Keylet const &k, std::uint64_t q) noexcept |
| The initial directory page for a specific quality. | |
| Keylet | next (Keylet const &k) |
| The directory for the next lower quality. | |
| Keylet | signerList (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 | payChannel (AccountID const &src, AccountID const &dst, std::uint32_t seq) noexcept |
| A PaymentChannel. | |
| Keylet | nftokenOffer (AccountID const &owner, std::uint32_t seq) |
| An offer from an account to buy or sell an NFT. | |
| Keylet | nftokenOffer (uint256 const &offer) |
| Keylet | nftBuys (uint256 const &id) noexcept |
| The directory of buy offers for the specified NFT. | |
| Keylet | nftSells (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 | mptokenIssuance (std::uint32_t seq, AccountID const &issuer) noexcept |
| Keylet | mptokenIssuance (MPTID const &issuanceID) noexcept |
| Keylet | mptokenIssuance (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 | signerList (AccountID const &account, std::uint32_t page) noexcept |
| Keylet | trustLine (AccountID const &id0, AccountID const &id1, Currency const ¤cy) noexcept |
| The index of a trust line for a given currency. | |
| Keylet | trustLine (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 | ticket (AccountID const &id, std::uint32_t ticketSeq) |
| A ticket belonging to an account. | |
| Keylet | ticket (AccountID const &id, SeqProxy ticketSeq) |
| Keylet | ticket (uint256 const &key) |
| 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 | nftokenPageMin (AccountID const &owner) |
| NFT page keylets. | |
| Keylet | nftokenPageMax (AccountID const &owner) |
| A keylet for the owner's last possible NFT page. | |
| Keylet | nftokenPage (Keylet const &k, uint256 const &token) |
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()
AccountID root.
Definition at line 186 of file Indexes.cpp.
◆ amendments()
|
noexcept |
The index of the amendment table.
Definition at line 214 of file Indexes.cpp.
◆ child()
Any item that can be in an owner dir.
Definition at line 192 of file Indexes.cpp.
◆ skip() [1/2]
|
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 198 of file Indexes.cpp.
◆ skip() [2/2]
|
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 205 of file Indexes.cpp.
◆ feeSettings()
|
noexcept |
The (fixed) index of the object containing the ledger fees.
Definition at line 221 of file Indexes.cpp.
◆ negativeUNL()
|
noexcept |
The (fixed) index of the object containing the ledger negativeUNL.
Definition at line 228 of file Indexes.cpp.
◆ book()
The beginning of an order book.
Definition at line 235 of file Indexes.cpp.
◆ trustLine() [1/2]
|
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 241 of file Indexes.cpp.
◆ trustLine() [2/2]
◆ offer() [1/2]
|
noexcept |
An offer from an account.
Definition at line 264 of file Indexes.cpp.
◆ offer() [2/2]
◆ quality()
|
noexcept |
The initial directory page for a specific quality.
Definition at line 270 of file Indexes.cpp.
◆ next()
The directory for the next lower quality.
Definition at line 288 of file Indexes.cpp.
◆ ticket() [1/3]
| Keylet xrpl::keylet::ticket | ( | AccountID const & | id, |
| std::uint32_t | ticketSeq ) |
A ticket belonging to an account.
Definition at line 295 of file Indexes.cpp.
◆ ticket() [2/3]
Definition at line 301 of file Indexes.cpp.
◆ ticket() [3/3]
◆ signerList() [1/2]
A SignerList.
Definition at line 316 of file Indexes.cpp.
◆ check() [1/2]
|
noexcept |
A Check.
Definition at line 322 of file Indexes.cpp.
◆ check() [2/2]
◆ depositPreauth() [1/3]
|
noexcept |
Definition at line 328 of file Indexes.cpp.
◆ depositPreauth() [2/3]
|
noexcept |
Definition at line 335 of file Indexes.cpp.
◆ depositPreauth() [3/3]
◆ unchecked()
Any ledger entry.
Definition at line 351 of file Indexes.cpp.
◆ ownerDir()
The root page of an account's directory.
Definition at line 357 of file Indexes.cpp.
◆ page() [1/2]
|
noexcept |
A page in a directory.
Definition at line 363 of file Indexes.cpp.
◆ page() [2/2]
|
noexcept |
◆ escrow()
|
noexcept |
An escrow entry.
Definition at line 372 of file Indexes.cpp.
◆ payChannel()
|
noexcept |
A PaymentChannel.
Definition at line 378 of file Indexes.cpp.
◆ nftokenPageMin()
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 384 of file Indexes.cpp.
◆ nftokenPageMax()
A keylet for the owner's last possible NFT page.
Definition at line 392 of file Indexes.cpp.
◆ nftokenPage()
Definition at line 400 of file Indexes.cpp.
◆ nftokenOffer() [1/2]
| Keylet xrpl::keylet::nftokenOffer | ( | AccountID const & | owner, |
| std::uint32_t | seq ) |
An offer from an account to buy or sell an NFT.
Definition at line 407 of file Indexes.cpp.
◆ nftokenOffer() [2/2]
◆ nftBuys()
The directory of buy offers for the specified NFT.
Definition at line 413 of file Indexes.cpp.
◆ nftSells()
The directory of sell offers for the specified NFT.
Definition at line 419 of file Indexes.cpp.
◆ amm() [1/2]
AMM entry.
Definition at line 425 of file Indexes.cpp.
◆ amm() [2/2]
Definition at line 459 of file Indexes.cpp.
◆ delegate()
|
noexcept |
A keylet for Delegate object.
Definition at line 465 of file Indexes.cpp.
◆ bridge()
| Keylet xrpl::keylet::bridge | ( | STXChainBridge const & | bridge, |
| STXChainBridge::ChainType | chainType ) |
Definition at line 471 of file Indexes.cpp.
◆ xChainClaimID()
| Keylet xrpl::keylet::xChainClaimID | ( | STXChainBridge const & | bridge, |
| std::uint64_t | seq ) |
Definition at line 481 of file Indexes.cpp.
◆ xChainCreateAccountClaimID()
| Keylet xrpl::keylet::xChainCreateAccountClaimID | ( | STXChainBridge const & | bridge, |
| std::uint64_t | seq ) |
Definition at line 495 of file Indexes.cpp.
◆ did()
Definition at line 509 of file Indexes.cpp.
◆ oracle()
|
noexcept |
Definition at line 515 of file Indexes.cpp.
◆ credential() [1/2]
|
noexcept |
Definition at line 545 of file Indexes.cpp.
◆ credential() [2/2]
◆ mptokenIssuance() [1/3]
|
noexcept |
Definition at line 521 of file Indexes.cpp.
◆ mptokenIssuance() [2/3]
Definition at line 527 of file Indexes.cpp.
◆ mptokenIssuance() [3/3]
◆ mptoken() [1/3]
Definition at line 533 of file Indexes.cpp.
◆ mptoken() [2/3]
◆ mptoken() [3/3]
Definition at line 539 of file Indexes.cpp.
◆ vault() [1/2]
|
noexcept |
Definition at line 551 of file Indexes.cpp.
◆ vault() [2/2]
◆ loanBroker() [1/2]
|
noexcept |
Definition at line 557 of file Indexes.cpp.
◆ loanBroker() [2/2]
◆ loan() [1/2]
|
noexcept |
Definition at line 563 of file Indexes.cpp.
◆ loan() [2/2]
◆ permissionedDomain() [1/2]
|
noexcept |
Definition at line 569 of file Indexes.cpp.
◆ permissionedDomain() [2/2]
Definition at line 575 of file Indexes.cpp.
◆ signerList() [2/2]
|
staticnoexcept |
Definition at line 310 of file Indexes.cpp.
Generated by
1.16.1