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.

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

NFT doc discrepancies #1487

Closed
mDuo13 opened this issue Sep 1, 2022 · 2 comments
Closed

NFT doc discrepancies #1487

mDuo13 opened this issue Sep 1, 2022 · 2 comments
Assignees
Labels
bug Typo or other small documentation error content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts

Comments

@mDuo13
Copy link
Collaborator

mDuo13 commented Sep 1, 2022

As originally reported by @Silkjaer:

https://xrpl.org/nftokenpage.html - Example uses Tokens for the page content, the documentation uses NonFungibleTokens, but the actual key is NFTokens – also the example content is a bit off, as it's actually an array like the screenshot attached
screenshot

There is a discrepancy between XRPLF/XRPL-Standards#46 and https://xrpl.org/nftokenoffer.html regarding the flag of an NFTokenOffer 0x00000001. Documentation says its a lsfBuyToken flag and if not set, it's a sell offer. XLS20 says the exact opposite, its a lsfSellToken. LedgerFormats.h says its a lsfSellNFToken (so updated to NFToken naming convention and agrees with standard, but not documentation. But what is the flag actually?

On the same page, documentation refers to lsfAuthorized which i think is not part of the implemententation?

https://xrpl.org/nftokencanceloffer.html refers to TokenOffers but should be NFTokenOffers

@mDuo13 mDuo13 added bug Typo or other small documentation error content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts labels Sep 1, 2022
@Silkjaer
Copy link
Contributor

Silkjaer commented Sep 2, 2022

Elaborating on the original post, I have made a more thorough walkthrough of the documentation related to NFTokens and here's an updated list organized by page:

https://xrpl.org/nftoken.html

  • TokenID should be NFTokenID (multiple occurrences)
  • Could consider using NFTokenTaxon instead of Taxon, as that is specified in the NFTokenMint transaction.

https://xrpl.org/nftokenoffer.html

  • TokenID should be NFTokenID
  • lsfAuthorized is not implemented and should be removed from documentation
  • lsfBuyToken should be lsfSellNFToken with this description: If set, indicates that the offer is a sell offer. Otherwise, the offer is a buy offer.
  • NFTokenOfferNode is missing

https://xrpl.org/nftokenpage.html

  • The example data structure needs to change to reflect the implementation (see OP)
  • NonFungibleTokens should be NFTokens

https://xrpl.org/nftokenacceptoffer.html

  • NFT should be NFToken
  • TransferRate should be TransferFee

https://xrpl.org/nftokencanceloffer.html

  • TokenOffers should be NFTokenOffers

https://xrpl.org/nftokencreateoffer.html

  • tfSellToken should be tfSellNFToken

https://xrpl.org/nftokenmint.html

  • First example should probably be simpler – not showing a case of issuing on behalf of another account as there is an example for that later on the same page.

@mDuo13
Copy link
Collaborator Author

mDuo13 commented Sep 15, 2022

Just checked, and all of the issues have been addressed by #1510

@mDuo13 mDuo13 closed this as completed Sep 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Typo or other small documentation error content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts
Projects
None yet
Development

No branches or pull requests

3 participants