Changes per Git issue 1487 #1510

DennisDawson · 2022-09-08T20:31:33Z

No description provided.

github-actions · 2022-09-08T20:42:16Z

Link check report. 420542 links checked.
1 broken links found:
File: out/account_nfts.html Link: nftoken.html#taxon

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/Issue_1487/

ckniffen · 2022-09-08T20:53:44Z

content/references/protocol-reference/transactions/transaction-types/nftokenmint.md

@@ -49,7 +48,6 @@ This transaction assumes that the issuer, `rNCFjv8Ek5oDrNiMJ3pw6eLLFtMjZLJnf2`,
 | Field         | JSON Type           | [Internal Type][] | Description        |
 |:--------------|:--------------------|:------------------|:-------------------|
 | `NFTokenTaxon` | Number | UInt32 | The taxon associated with the token. The taxon is generally a value chosen by the minter of the token. A given taxon can be used for multiple tokens. Taxon identifiers greater than `0xFFFF'FFFF` are disallowed. |
-| `Issuer` | String | AccountID | _(Optional)_ The issuer of the token, if the sender of the account is issuing it on behalf of another account. This field must be omitted if the account sending the transaction is the issuer of the `NFToken`. If provided, the issuer's [AccountRoot object][] must have the `NFTokenMinter` field set to the sender of this transaction (this transaction's `Account` field). |


I thought this field was necessary when acting as a minter.

Yes but per the Git issue, it's a complex example to start with, given that there's an example of an authorized minter later in the topic. Ach - but I have to remove the paragraph above. Gotcha.

I get removing it from the example above but this block is what lists all possible fields. Without this block there is no full definition of the field.

github-actions · 2022-09-08T21:59:08Z

Link check report. 420542 links checked.
1 broken links found:
File: out/account_nfts.html Link: nftoken.html#taxon

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/Issue_1487/

Style Report

github-actions · 2022-09-08T22:22:11Z

Link check report. 420542 links checked.
1 broken links found:
File: out/account_nfts.html Link: nftoken.html#taxon

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/Issue_1487/

Style Report

github-actions · 2022-09-08T22:59:40Z

Link check report. 420542 links checked.
1 broken links found:
File: out/ja/account_nfts.html Link: nftoken.html#nftokentaxon

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/Issue_1487/

Style Report

github-actions · 2022-09-09T17:06:54Z

Link check report. 420544 links checked.
1 broken links found:
File: out/ja/account_nfts.html Link: nftoken.html#nftokentaxon

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/Issue_1487/

Style Report

mDuo13

There are a couple changes I'd like to see in there (several of them being things that slipped through before this PR) but assuming those are adequately addressed, this is a 👍 from me.

mDuo13 · 2022-09-09T20:21:41Z

content/references/protocol-reference/data-types/nftoken.md



 ### Example

-This value sets the transfer fee to 314 bps, or 3.14%.
+This value sets the transfer fee to 314, or .00314%.

 ![Txr Fee](img/nftokenb.png "Txr Fee")


Just noticed, this might be the only place the docs use "txr" to abbreviate "transfer".

Suggested change

![Txr Fee](img/nftokenb.png "Txr Fee")

![Transfer Fee](img/nftokenb.png "Transfer Fee")

mDuo13 · 2022-09-09T20:24:24Z

content/references/protocol-reference/data-types/nftoken.md


-An issuer might issue several NFTs with the same taxon; to ensure that NFTs are spread across multiple pages, the taxon is scrambled using the fifth section, a dumb sequential number, as the seed for a random number generator. The scrambled value is stored with the `NFToken`, but the unscrambled value is the actual taxon.
+An issuer might issue several `NFToken` objects with the same `NFTokenTaxon`; to ensure that `NFToken` objects are spread across multiple pages, the `NFTokenTaxon` is scrambled using the fifth section, a dumb sequential number, as the seed for a random number generator. The scrambled value is stored with the `NFToken`, but the unscrambled value is the actual NFTokenTaxon.


I suggest striking the word "dumb" from this sentence, since it's not necessary and can be an emotionally-charged word. Also, I noticed an inconsistent use of code font for NFTokenTaxon here.

Suggested change

An issuer might issue several `NFToken` objects with the same `NFTokenTaxon`; to ensure that `NFToken` objects are spread across multiple pages, the `NFTokenTaxon` is scrambled using the fifth section, a dumb sequential number, as the seed for a random number generator. The scrambled value is stored with the `NFToken`, but the unscrambled value is the actual NFTokenTaxon.

An issuer might issue several `NFToken` objects with the same `NFTokenTaxon`; to ensure that `NFToken` objects are spread across multiple pages, the `NFTokenTaxon` is scrambled using the fifth section, a sequential number, as the seed for a random number generator. The scrambled value is stored with the `NFToken`, but the unscrambled value is the actual `NFTokenTaxon`.

mDuo13 · 2022-09-09T20:25:39Z

content/references/protocol-reference/ledger-data/ledger-object-types/nftokenoffer.md

+  <!-- tr>
   <td><code>lsfAuthorized</code>
   </td>
   <td><code>0x00000002</code>
   </td>
   <td>If set, the offer has been approved by the issuer. This flag can only be set by the <code>Issuer</code> of the token or an account authorized by the issuer (for example, the <code>MintAccount</code> listed in the account root of the <code>Issuer</code>) and only if the token has the flag indicating that authorization is required.
   </td>
-  </tr>
+  </tr -->


Rather than commenting out this item, I suggest deleting it. The text is still there in the Git history if we need to go back and dig it up for some reason.

mDuo13 · 2022-09-09T20:26:57Z

content/references/protocol-reference/ledger-data/ledger-object-types/nftokenpage.md

@@ -11,7 +11,7 @@ status: not_enabled
 # NFTokenPage
 {% include '_snippets/nfts-disclaimer.md' %}

-The `NFTokenPage` object represents a collection of `NFToken` objects owned by the same account. An account can have multiple `NFTokenPage` ledger objects, which form a doubly-linked list (DLL).
+The `NFTokenPage` object represents a collection of `NFToken` objects owned by the same account. An account can have multiple `NFTokenPage` ledger objects, which form a doubly linked list (DLL).


Since the abbreviation "DLL" isn't used again (and .dll has a different meaning in Windows files, so people could get led astray thinking about those), I suggest removing it.

Suggested change

The `NFTokenPage` object represents a collection of `NFToken` objects owned by the same account. An account can have multiple `NFTokenPage` ledger objects, which form a doubly linked list (DLL).

The `NFTokenPage` object represents a collection of `NFToken` objects owned by the same account. An account can have multiple `NFTokenPage` ledger objects, which form a doubly linked list.

mDuo13 · 2022-09-09T20:27:35Z

content/references/protocol-reference/transactions/transaction-types/nftokenacceptoffer.md

@@ -3,7 +3,7 @@ html: nftokenacceptoffer.html
 parent: transaction-types.html
 blurb: Accept an offer to buy or sell an NFToken.
 labels:
-  - NFTs, Non-fungible Tokens
+  - NFTokens, Non-fungible Tokens


If you change this label it won't work as a link anymore, so I suggest reverting this instance

mDuo13 · 2022-09-09T20:28:08Z

content/references/protocol-reference/transactions/transaction-types/nftokenacceptoffer.md

@@ -28,7 +28,7 @@ The mode in which the transaction operates depends on the presence of the `NFTok

 If neither of those fields is specified, the transaction is malformed and produces a `tem` class error.

-The semantics of brokered mode are slightly different than one in direct mode: The account executing the transaction functions as a broker, bringing the two offers together and causing them to be matched, but does not acquire ownership of the involved NFT, which will, if the transaction is successful, be transferred directly from the seller to the buyer.
+The semantics of brokered mode are slightly different than one in direct mode: The account executing the transaction functions as a broker, bringing the two offers together and causing them to be matched, but does not acquire ownership of the involved NFToken, which will, if the transaction is successful, be transferred directly from the seller to the buyer.


Code font for consistency.

Suggested change

The semantics of brokered mode are slightly different than one in direct mode: The account executing the transaction functions as a broker, bringing the two offers together and causing them to be matched, but does not acquire ownership of the involved NFToken, which will, if the transaction is successful, be transferred directly from the seller to the buyer.

The semantics of brokered mode are slightly different than one in direct mode: The account executing the transaction functions as a broker, bringing the two offers together and causing them to be matched, but does not acquire ownership of the involved `NFToken`, which will, if the transaction is successful, be transferred directly from the seller to the buyer.

github-actions · 2022-09-12T18:22:12Z

Link check report. 420544 links checked.
1 broken links found:
File: out/ja/account_nfts.html Link: nftoken.html#nftokentaxon

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/Issue_1487/

Style Report

Changes per Git issue 1487

ef1e092

DennisDawson requested a review from mDuo13 September 8, 2022 20:31

ckniffen reviewed Sep 8, 2022

View reviewed changes

moar fixes I found

86c898c

Remove misplaced auth minter text

db845cd

fix link to NFTokenTaxon

3ba6eaf

re-insert Issuer field

5ac0898

mDuo13 approved these changes Sep 9, 2022

View reviewed changes

mduo13 suggestions

230ef0c

DennisDawson merged commit 5cfd209 into master Sep 12, 2022

DennisDawson deleted the Issue_1487 branch September 12, 2022 18:26

mDuo13 mentioned this pull request Sep 15, 2022

NFT doc discrepancies #1487

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes per Git issue 1487 #1510

Changes per Git issue 1487 #1510

DennisDawson commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

ckniffen Sep 8, 2022

DennisDawson Sep 8, 2022 •

edited

Loading

ckniffen Sep 8, 2022

github-actions bot commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

github-actions bot commented Sep 9, 2022

mDuo13 left a comment

mDuo13 Sep 9, 2022

mDuo13 Sep 9, 2022

mDuo13 Sep 9, 2022

mDuo13 Sep 9, 2022

mDuo13 Sep 9, 2022

mDuo13 Sep 9, 2022

github-actions bot commented Sep 12, 2022

	![Txr Fee](img/nftokenb.png "Txr Fee")
	![Transfer Fee](img/nftokenb.png "Transfer Fee")


		An issuer might issue several NFTs with the same taxon; to ensure that NFTs are spread across multiple pages, the taxon is scrambled using the fifth section, a dumb sequential number, as the seed for a random number generator. The scrambled value is stored with the `NFToken`, but the unscrambled value is the actual taxon.
		An issuer might issue several `NFToken` objects with the same `NFTokenTaxon`; to ensure that `NFToken` objects are spread across multiple pages, the `NFTokenTaxon` is scrambled using the fifth section, a dumb sequential number, as the seed for a random number generator. The scrambled value is stored with the `NFToken`, but the unscrambled value is the actual NFTokenTaxon.

	The `NFTokenPage` object represents a collection of `NFToken` objects owned by the same account. An account can have multiple `NFTokenPage` ledger objects, which form a doubly linked list (DLL).
	The `NFTokenPage` object represents a collection of `NFToken` objects owned by the same account. An account can have multiple `NFTokenPage` ledger objects, which form a doubly linked list.

	The semantics of brokered mode are slightly different than one in direct mode: The account executing the transaction functions as a broker, bringing the two offers together and causing them to be matched, but does not acquire ownership of the involved NFToken, which will, if the transaction is successful, be transferred directly from the seller to the buyer.
	The semantics of brokered mode are slightly different than one in direct mode: The account executing the transaction functions as a broker, bringing the two offers together and causing them to be matched, but does not acquire ownership of the involved `NFToken`, which will, if the transaction is successful, be transferred directly from the seller to the buyer.

Changes per Git issue 1487 #1510

Changes per Git issue 1487 #1510

Conversation

DennisDawson commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

Choose a reason for hiding this comment

DennisDawson Sep 8, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

github-actions bot commented Sep 9, 2022

mDuo13 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 12, 2022

DennisDawson Sep 8, 2022 •

edited

Loading