refactor: Rename (mostly keylet) functions to more closely match the docs #7059
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -68,7 +68,7 @@ skip(LedgerIndex ledger) noexcept; | |
|
|
||
| /** The (fixed) index of the object containing the ledger fees. */ | ||
| Keylet const& | ||
| feeSettings() noexcept; | ||
|
|
||
| /** The (fixed) index of the object containing the ledger negativeUNL. */ | ||
| Keylet const& | ||
|
|
@@ -93,12 +93,12 @@ static book_t const book{}; | |
| */ | ||
| /** @{ */ | ||
| Keylet | ||
| rippleState(AccountID const& id0, AccountID const& id1, Currency const& currency) noexcept; | ||
|
|
||
| inline Keylet | ||
| rippleState(AccountID const& id, Issue const& issue) noexcept | ||
| { | ||
| return rippleState(id, issue.account, issue.currency); | ||
| } | ||
|
Comment on lines
69
to
102
There was a problem hiding this comment. The PR description says these are “internal names” with “API Impact: N/A”, but this file is part of the installed/packaged public headers (see cmake/XrplInstall.cmake:35-39 and conanfile.py:144-151). Renaming exported keylet functions like |
||
| /** @} */ | ||
|
|
||
|
|
@@ -149,7 +149,7 @@ static ticket_t const ticket{}; | |
|
|
||
| /** A SignerList */ | ||
| Keylet | ||
| signerList(AccountID const& account) noexcept; | ||
|
|
||
| /** A Check */ | ||
| /** @{ */ | ||
|
|
@@ -209,7 +209,7 @@ escrow(AccountID const& src, std::uint32_t seq) noexcept; | |
|
|
||
| /** A PaymentChannel */ | ||
| Keylet | ||
| payChannel(AccountID const& src, AccountID const& dst, std::uint32_t seq) noexcept; | ||
|
|
||
| /** NFT page keylets | ||
|
|
||
|
|
@@ -221,22 +221,22 @@ payChan(AccountID const& src, AccountID const& dst, std::uint32_t seq) noexcept; | |
| /** @{ */ | ||
| /** A keylet for the owner's first possible NFT page. */ | ||
| Keylet | ||
| nftokenPage_min(AccountID const& owner); | ||
|
Collaborator
There was a problem hiding this comment. This should be cammel case, as per the new clang-tidy rules. |
||
|
|
||
| /** A keylet for the owner's last possible NFT page. */ | ||
| Keylet | ||
| nftokenPage_max(AccountID const& owner); | ||
|
|
||
|
|
||
| Keylet | ||
| nftokenPage(Keylet const& k, uint256 const& token); | ||
| /** @} */ | ||
|
|
||
| /** An offer from an account to buy or sell an NFT */ | ||
| Keylet | ||
| nftokenOffer(AccountID const& owner, std::uint32_t seq); | ||
|
|
||
| inline Keylet | ||
| nftokenOffer(uint256 const& offer) | ||
| { | ||
| return {ltNFTOKEN_OFFER, offer}; | ||
| } | ||
|
|
@@ -287,13 +287,13 @@ credential(uint256 const& key) noexcept | |
| } | ||
|
|
||
| Keylet | ||
| mptokenIssuance(std::uint32_t seq, AccountID const& issuer) noexcept; | ||
|
|
||
| Keylet | ||
| mptokenIssuance(MPTID const& issuanceID) noexcept; | ||
|
|
||
| inline Keylet | ||
| mptokenIssuance(uint256 const& issuanceKey) | ||
| { | ||
| return {ltMPTOKEN_ISSUANCE, issuanceKey}; | ||
| } | ||
|
|
@@ -320,10 +320,10 @@ vault(uint256 const& vaultKey) | |
| } | ||
|
|
||
| Keylet | ||
| loanBroker(AccountID const& owner, std::uint32_t seq) noexcept; | ||
|
|
||
| inline Keylet | ||
| loanBroker(uint256 const& key) | ||
| { | ||
| return {ltLOAN_BROKER, key}; | ||
| } | ||
|
|
@@ -376,11 +376,15 @@ struct keyletDesc | |
| std::array<keyletDesc<AccountID const&>, 6> const directAccountKeylets{ | ||
| {{.function = &keylet::account, .expectedLEName = jss::AccountRoot, .includeInTests = false}, | ||
| {.function = &keylet::ownerDir, .expectedLEName = jss::DirectoryNode, .includeInTests = true}, | ||
| {.function = &keylet::signerList, .expectedLEName = jss::SignerList, .includeInTests = true}, | ||
| // It's normally impossible to create an item at nftpage_min, but | ||
| // test it anyway, since the invariant checks for it. | ||
| {.function = &keylet::nftokenPage_min, | ||
| .expectedLEName = jss::NFTokenPage, | ||
| .includeInTests = true}, | ||
| {.function = &keylet::nftokenPage_max, | ||
| .expectedLEName = jss::NFTokenPage, | ||
| .includeInTests = true}, | ||
| {.function = &keylet::did, .expectedLEName = jss::DID, .includeInTests = true}}}; | ||
|
|
||
| MPTID | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you rename this to
trustLine? WhilerippleStateis the official object name, everywhere else it's referred to as trustline.