Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trivial: add comments for NFToken-related invariants #4558

Merged
merged 3 commits into from
Jun 9, 2023
Merged

Trivial: add comments for NFToken-related invariants #4558

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ca5322
Add comments for NFToken-related invariants
scottschurr Jun 5, 2023
8301c72
[FOLD] Change "may" to "can" and "may not" to "cannot"
scottschurr Jun 5, 2023
4f40b8a
[FOLD] Respond to further review comments
scottschurr Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/ripple/app/tx/impl/InvariantCheck.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,17 @@ class ValidNewAccountRoot
beast::Journal const&);
};

/**
* @brief Invariant: Validates several invariants for NFToken pages.
*
* The following checks are made:
* - The page is correctly associated with the owner.
* - The page is correctly ordered between the next and previous links.
* - The page contains a valid number of NFTokens.
intelliot marked this conversation as resolved.
Show resolved Hide resolved
* - The NFTokens on this page do not belong on a lower or higher page.
* - The NFTokens are correctly sorted on the page.
* - Each URI, if present, is not empty.
*/
class ValidNFTokenPage
{
bool badEntry_ = false;
Expand All @@ -342,6 +353,19 @@ class ValidNFTokenPage
beast::Journal const&);
};

/**
* @brief Invariant: Validates counts of NFTokens after all transaction types.
*
* The following checks are made:
* - The number of minted or burned NFTokens can only be changed by
* NFTokenMint or NFTokenBurn transactions.
* - A successful NFTokenMint must increase the number of NFTokens.
* - A failed NFTokenMint must not change the number of minted NFTokens.
* - An NFTokenMint transaction cannot change the number of burned NFTokens.
* - A successful NFTokenBurn must increase the number of burned NFTokens.
* - A failed NFTokenBurn must not change the number of burned NFTokens.
* - An NFTokenBurn transaction cannot change the number of minted NFTokens.
*/
class NFTokenCountTracking
{
std::uint32_t beforeMintedTotal = 0;
Expand Down