ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-24 21:55:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update variable names in TokenOffers note.

Browse Source 
Renaming the variable to nft_offer_index makes the distinction less critical. Ultimately we'll probably remove the note on line 45 entirely.
This commit is contained in:
Dennis Dawson
2022-04-07 10:47:40 -07:00
committed by GitHub
parent cd1977b271
commit 953f0ba387
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
content/references/protocol-reference/transactions/transaction-types/nftokencanceloffer.md
View File

@@ -38,11 +38,11 @@ This transaction removes the listed `NFTokenOffer` object from the ledger, if pr
| Field | JSON Type | [Internal Type][] | Description | | Field | JSON Type | [Internal Type][] | Description |
|:------------------|:----------|:------------------|:-------------------------| |:------------------|:----------|:------------------|:-------------------------|
| `TransactionType` | String | UInt16 | NFTokenCancelOffer transaction type. The integer identifier is 28. | | `TransactionType` | String | UInt16 | NFTokenCancelOffer transaction type. The integer identifier is 28. |
| `TokenOffers` | Array | VECTOR256 | An array of IDs of the `NFTokenOffer` objects to cancel (not the IDs of `NFToken` objects, but the IDs of the `NFTokenOffer` objects). Each entry must be a different [object ID](ledger-object-ids.html) of an [NFTokenOffer](nftokenoffer.html) object; the transaction is invalid if the array contains duplicate entries. | | `TokenOffers` | Array | VECTOR256 | An array of IDs of the `NFTokenOffer` objects to cancel (not the `nft_id` values of `NFToken` objects, but the `nft_offer_index` values of `NFTokenOffer` objects). Each entry must be a different [object ID](ledger-object-ids.html) of an [NFTokenOffer](nftokenoffer.html) object; the transaction is invalid if the array contains duplicate entries. |
The transaction can succeed even if one or more of the IDs in the `TokenOffers` field do not refer to objects that currently exist in the ledger. (For example, those token offers might already have been taken.) The transaction can succeed even if one or more of the IDs in the `TokenOffers` field do not refer to objects that currently exist in the ledger. (For example, those token offers might already have been deleted.)
It is important to note that if you inadvertently provide a `NFTokenID` rather than a `NFTokenOfferID`, you might receive a `tesSuccess` response. The reason is that when passed a properly formatted VECTOR256 value that is not found, the system assumes that the NFTokenOffer has already been deleted. It is important to note that if you inadvertently provide a `nft_id` rather than a `nft_offer_index`, you might receive a `tesSuccess` response. The reason is that when passed a properly formatted ID value that is not found, the system assumes that the `NFTokenOffer` has already been deleted.
The transaction fails with an error if one of the IDs points to an object that does exist, but is not a [NFTokenOffer](nftokenoffer.html) object. The transaction fails with an error if one of the IDs points to an object that does exist, but is not a [NFTokenOffer](nftokenoffer.html) object.