mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-04 20:05:50 +00:00
NFToken references: fix some things for consistency
This commit is contained in:
mDuo13
@@ -59,9 +59,41 @@
|
||||
[XRP、drop単位]: basic-data-types.html#通貨額の指定
|
||||
|
||||
<!-- API object types -->
|
||||
[AccountRoot object]: accountroot.html
|
||||
[AccountRootオブジェクト]: accountroot.html
|
||||
[Ticket object]: ticket.html
|
||||
{% set ledger_entries = [
|
||||
"AccountRoot",
|
||||
"Amendments",
|
||||
"Check",
|
||||
"DepositPreauth",
|
||||
"DirectoryNode",
|
||||
"Escrow",
|
||||
"FeeSettings",
|
||||
"LedgerHashes",
|
||||
"NegativeUNL",
|
||||
"NFToken",
|
||||
"NFTokenOffer",
|
||||
"NFTokenPage",
|
||||
"Offer",
|
||||
"PayChannel",
|
||||
"RippleState",
|
||||
"SignerList",
|
||||
"Ticket"
|
||||
] %}
|
||||
|
||||
{% for ledger_entry in ledger_entries %}
|
||||
{% if ledger_entry in ["amendments", "depositpreauth", "escrow"] %}
|
||||
{# objects where the naive URL is already taken #}
|
||||
[{{ledger_entry}} object]: {{ledger_entry|lower}}-object.html
|
||||
{% if target.lang == "ja" %}
|
||||
[{{ledger_entry}}オブジェクト]: {{ledger_entry|lower}}-object.html
|
||||
{% endif %}
|
||||
{% else %}
|
||||
[{{ledger_entry}} object]: {{ledger_entry|lower}}.html
|
||||
{% if target.lang == "ja" %}
|
||||
[{{ledger_entry}}オブジェクト]: {{ledger_entry|lower}}.html
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
|
||||
<!--{# Links to external sites #}-->
|
||||
[crypto-condition]: https://tools.ietf.org/html/draft-thomas-crypto-conditions-04
|
||||
|
||||
@@ -8,6 +8,11 @@
|
||||
"EscrowCancel",
|
||||
"EscrowCreate",
|
||||
"EscrowFinish",
|
||||
"NFTokenAcceptOffer",
|
||||
"NFTokenBurn",
|
||||
"NFTokenCancelOffer",
|
||||
"NFTokenCreateOffer",
|
||||
"NFTokenMint",
|
||||
"OfferCancel",
|
||||
"OfferCreate",
|
||||
"Payment",
|
||||
|
||||
@@ -27,7 +27,7 @@ Unlike other objects, `NFToken` has no field to identify the object type or curr
|
||||
|
||||
## TokenID
|
||||
|
||||
TokenID, optional, string, UINT256
|
||||
TokenID, optional, string, UInt256
|
||||
|
||||
This composite field uniquely identifies a token, and consists of the following sections.
|
||||
|
||||
|
||||
@@ -77,7 +77,7 @@ If this operation succeeds, the corresponding `NFToken` is removed. If this oper
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
<td>UInt256
|
||||
</td>
|
||||
<td>Identifies the <code>NFToken</code> object to be removed by the transaction.
|
||||
</td>
|
||||
|
||||
@@ -73,7 +73,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>string</code>
|
||||
</td>
|
||||
<td><code>UINT16</code>
|
||||
<td><code>UInt16</code>
|
||||
</td>
|
||||
<td>Indicates the new transaction type <code>NFTokenMint</code>. The integer value is <code>25</code>.
|
||||
</td>
|
||||
@@ -85,7 +85,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>string</code>
|
||||
</td>
|
||||
<td><code>ACCOUNT ID</code>
|
||||
<td><code>AccountID</code>
|
||||
</td>
|
||||
<td>Indicates the account that is minting the token. The account MUST <em>either</em>:
|
||||
<ul>
|
||||
@@ -104,7 +104,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>string</code>
|
||||
</td>
|
||||
<td><code>ACCOUNT ID</code>
|
||||
<td><code>AccountID</code>
|
||||
</td>
|
||||
<td>Indicates the account that issues the token. This value is <em>optional</em> and should only be specified if the account executing the transaction is not the <code>Issuer</code> of the <code>NFToken</code> object. If it is present, the <code>MintAccount</code> field in the <code>AccountRoot</code> of the <code>Issuer</code> field must match the <code>Account</code>. Otherwise, the transaction fails.
|
||||
</td>
|
||||
@@ -116,7 +116,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>number</code>
|
||||
</td>
|
||||
<td><code>UINT32</code>
|
||||
<td><code>UInt32</code>
|
||||
</td>
|
||||
<td>The taxon associated with the token. The taxon is generally a value chosen by the <code>minter</code> of the token. A given taxon can be used for multiple tokens. This implementation reserves all taxon identifiers greater than or equal to <code>0x80000000</code>; attempts to use mint tokens with such taxons should fail and a fee should be claimed.
|
||||
</td>
|
||||
@@ -128,7 +128,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>number</code>
|
||||
</td>
|
||||
<td><code>UINT16</code>
|
||||
<td><code>UInt16</code>
|
||||
</td>
|
||||
<td>The value specifies the fee charged by the issuer for secondary sales of the Token, if such sales are allowed. Valid values for this field are between 0 and 9999 inclusive, allowing transfer rates of between 0.00% and 99.99% in increments of 0.01.
|
||||
<p>
|
||||
@@ -154,7 +154,7 @@ The field MUST NOT be present if <code>tfTransferable</code> is not set. If it i
|
||||
</td>
|
||||
<td><code>number</code>
|
||||
</td>
|
||||
<td><code>UINT32</code>
|
||||
<td><code>UInt32</code>
|
||||
</td>
|
||||
<td>Specifies the flags used for the minting transaction. See the mint transaction flags in the following table.
|
||||
</td>
|
||||
|
||||
@@ -65,7 +65,7 @@ The unique ID (`NFTokenOfferID)` of the `NFTokenOffer` object is the result of t
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
<td>UInt16
|
||||
</td>
|
||||
<td>The type of ledger object (<code>0x0074</code>).
|
||||
</td>
|
||||
@@ -89,7 +89,7 @@ The unique ID (`NFTokenOfferID)` of the `NFTokenOffer` object is the result of t
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>Index of the ledger that contains the transaction that most recently modified this object.
|
||||
</td>
|
||||
@@ -101,7 +101,7 @@ The unique ID (`NFTokenOfferID)` of the `NFTokenOffer` object is the result of t
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
<td>UInt256
|
||||
</td>
|
||||
<td><code>TokenID</code> of the <code>NFToken</code> object referenced by this offer.
|
||||
</td>
|
||||
@@ -127,7 +127,7 @@ Sell offers that specify assets other than XRP must specify a non-zero amount. S
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>The time after which the offer is no longer active. The value is the number of seconds since the <a href="https://xrpl.org/basic-data-types.html#specifying-time">Ripple Epoch</a>.
|
||||
</td>
|
||||
@@ -151,7 +151,7 @@ Sell offers that specify assets other than XRP must specify a non-zero amount. S
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT64
|
||||
<td>UInt64
|
||||
</td>
|
||||
<td>Internal bookkeeping, indicating the page inside the owner directory where this token is being tracked. This field allows the efficient deletion of offers.
|
||||
</td>
|
||||
@@ -163,7 +163,7 @@ Sell offers that specify assets other than XRP must specify a non-zero amount. S
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT64
|
||||
<td>UInt64
|
||||
</td>
|
||||
<td>Internal bookkeeping, indicating the page inside the token buy or sell offer directory, as appropriate, where this token is being tracked. This field allows the efficient deletion of offers.
|
||||
</td>
|
||||
@@ -175,7 +175,7 @@ Sell offers that specify assets other than XRP must specify a non-zero amount. S
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>A set of flags associated with this object, used to specify various options or settings. Flags are listed in the table below.
|
||||
</td>
|
||||
@@ -276,7 +276,7 @@ Each offer costs one incremental reserve.
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
<td>UInt16
|
||||
</td>
|
||||
<td>Indicates the new transaction type <code>NFTokenCreateOffer</code>. The integer identifier is <code>27</code>.
|
||||
</td>
|
||||
@@ -346,7 +346,7 @@ The amount must be non-zero, except where this is an offer to sell and the asset
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>Indicates the time after which the offer will no longer be valid. The value is the number of seconds since the <a href="https://xrpl.org/basic-data-types.html#specifying-time">Ripple Epoch</a>.
|
||||
</td>
|
||||
@@ -372,7 +372,7 @@ If succesful, <code>NFTokenCreateOffer</code> transaction results in the creatio
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>A set of flags that specifies options or controls the behavior of the transaction. The flag is defined in the table below.
|
||||
</td>
|
||||
@@ -453,7 +453,7 @@ An `NFTokenCancelOffer` object can have the following required and optional fiel
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
<td>UInt16
|
||||
</td>
|
||||
<td><code>NFTokenCancelOffer</code> transaction type . The integer identifier is <code>28</code>.
|
||||
</td>
|
||||
@@ -590,7 +590,7 @@ In brokered mode, the `NFTokenAcceptOffer` transaction fails if:
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
<td>UInt16
|
||||
</td>
|
||||
<td>Transaction type <code>NFTokenAcceptOffer</code>. The sequence number of a previous <code>NFTokenCreateOffer</code> transaction. The integer identifier is <code>29</code>.
|
||||
</td>
|
||||
@@ -602,7 +602,7 @@ In brokered mode, the `NFTokenAcceptOffer` transaction fails if:
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
<td>UInt256
|
||||
</td>
|
||||
<td>Identifies the <code>NFTokenOffer</code> that offers to sell the <code>NFToken</code>.
|
||||
<p>
|
||||
@@ -616,7 +616,7 @@ In direct mode this field is optional, but you must specify either the <code>Sel
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
<td>UInt256
|
||||
</td>
|
||||
<td>Identifies the <code>NFTokenOffer</code> that offers to buy the <code>NFToken</code>.
|
||||
<p>
|
||||
|
||||
@@ -70,7 +70,7 @@ An `NFTokenPage` object can have the following required and optional fields:
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
<td>UInt16
|
||||
</td>
|
||||
<td>Identifies the type of ledger object. The reserved ledger entry type is <code>0x0050</code>.
|
||||
</td>
|
||||
@@ -82,7 +82,7 @@ An `NFTokenPage` object can have the following required and optional fields:
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
<td>UInt256
|
||||
</td>
|
||||
<td>The locator of the previous page, if any. Details about this field and how it should be used are outlined below, after the construction of the <code>NFTokenPageID</code> is explained.
|
||||
</td>
|
||||
@@ -94,7 +94,7 @@ An `NFTokenPage` object can have the following required and optional fields:
|
||||
</td>
|
||||
<td><code>string</code>
|
||||
</td>
|
||||
<td><code>UINT256</code>
|
||||
<td><code>UInt256</code>
|
||||
</td>
|
||||
<td>The locator of the next page, if any. Details about this field and how it should be used are outlined below, after the construction of the <code>NFTokenPageID</code> is explained.
|
||||
</td>
|
||||
@@ -118,7 +118,7 @@ An `NFTokenPage` object can have the following required and optional fields:
|
||||
</td>
|
||||
<td><code>number</code>
|
||||
</td>
|
||||
<td><code>UINT32</code>
|
||||
<td><code>UInt32</code>
|
||||
</td>
|
||||
<td>The sequence of the ledger that contains the transaction that most recently modified this <code>NFTokenPage</code> object.
|
||||
</td>
|
||||
|
||||
@@ -28,7 +28,7 @@ Unlike other objects, `NFToken` has no field to identify the object type or curr
|
||||
|
||||
## TokenID
|
||||
|
||||
TokenID, optional, string, UINT256
|
||||
TokenID, optional, string, Hash256
|
||||
|
||||
This composite field uniquely identifies a token, and consists of the following sections.
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ The unique ID (`NFTokenOfferID`) of the `NFTokenOffer` object is the result of t
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
<td>UInt16
|
||||
</td>
|
||||
<td>The type of ledger object (<code>0x0074</code>).
|
||||
</td>
|
||||
@@ -84,7 +84,7 @@ The unique ID (`NFTokenOfferID`) of the `NFTokenOffer` object is the result of t
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>Index of the ledger that contains the transaction that most recently modified this object.
|
||||
</td>
|
||||
@@ -96,7 +96,7 @@ The unique ID (`NFTokenOfferID`) of the `NFTokenOffer` object is the result of t
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
<td>Hash256
|
||||
</td>
|
||||
<td><code>TokenID</code> of the <code>NFToken</code> object referenced by this offer.
|
||||
</td>
|
||||
@@ -122,7 +122,7 @@ Sell offers that specify assets other than XRP must specify a non-zero amount. S
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>The time after which the offer is no longer active. The value is the number of seconds since the <a href="https://xrpl.org/basic-data-types.html#specifying-time">Ripple Epoch</a>.
|
||||
</td>
|
||||
@@ -134,7 +134,7 @@ Sell offers that specify assets other than XRP must specify a non-zero amount. S
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>Account ID
|
||||
<td>AccountID
|
||||
</td>
|
||||
<td>The <code>AccountID</code> for which this offer is intended. If present, only that account can accept the offer.
|
||||
</td>
|
||||
@@ -146,7 +146,7 @@ Sell offers that specify assets other than XRP must specify a non-zero amount. S
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT64
|
||||
<td>UInt64
|
||||
</td>
|
||||
<td>Internal bookkeeping, indicating the page inside the owner directory where this token is being tracked. This field allows the efficient deletion of offers.
|
||||
</td>
|
||||
@@ -158,7 +158,7 @@ Sell offers that specify assets other than XRP must specify a non-zero amount. S
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT64
|
||||
<td>UInt64
|
||||
</td>
|
||||
<td>Internal bookkeeping, indicating the page inside the token buy or sell offer directory, as appropriate, where this token is being tracked. This field allows the efficient deletion of offers.
|
||||
</td>
|
||||
@@ -170,7 +170,7 @@ Sell offers that specify assets other than XRP must specify a non-zero amount. S
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>A set of flags associated with this object, used to specify various options or settings. Flags are listed in the table below.
|
||||
</td>
|
||||
|
||||
@@ -8,7 +8,7 @@ labels:
|
||||
- Non-fungible Tokens, NFTs
|
||||
status: not_enabled
|
||||
---
|
||||
# The `NFTokenPage` Object
|
||||
# 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).
|
||||
@@ -69,7 +69,7 @@ An `NFTokenPage` object can have the following required and optional fields:
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
<td>UInt16
|
||||
</td>
|
||||
<td>Identifies the type of ledger object. The reserved ledger entry type is <code>0x0050</code>.
|
||||
</td>
|
||||
@@ -81,7 +81,7 @@ An `NFTokenPage` object can have the following required and optional fields:
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
<td>Hash256
|
||||
</td>
|
||||
<td>The locator of the previous page, if any. Details about this field and how it should be used are outlined below, after the construction of the <code>NFTokenPageID</code> is explained.
|
||||
</td>
|
||||
@@ -93,7 +93,7 @@ An `NFTokenPage` object can have the following required and optional fields:
|
||||
</td>
|
||||
<td><code>string</code>
|
||||
</td>
|
||||
<td><code>UINT256</code>
|
||||
<td><code>Hash256</code>
|
||||
</td>
|
||||
<td>The locator of the next page, if any. Details about this field and how it should be used are outlined below, after the construction of the <code>NFTokenPageID</code> is explained.
|
||||
</td>
|
||||
@@ -117,7 +117,7 @@ An `NFTokenPage` object can have the following required and optional fields:
|
||||
</td>
|
||||
<td><code>number</code>
|
||||
</td>
|
||||
<td><code>UINT32</code>
|
||||
<td><code>UInt32</code>
|
||||
</td>
|
||||
<td>The sequence of the ledger that contains the transaction that most recently modified this <code>NFTokenPage</code> object.
|
||||
</td>
|
||||
|
||||
@@ -49,7 +49,7 @@ labels:
|
||||
| `Sequence` | 数値 | UInt32 | `Offer`オブジェクトを作成した[OfferCreate][]トランザクションの`Sequence` 値。`Account`とこのフィールドの組み合わせによってこのオファーが識別されます。 |
|
||||
| `TakerPays` | 文字列またはオブジェクト | Amount | オファー作成者が要求する残額と通貨の種類。 |
|
||||
| `TakerGets` | 文字列またはオブジェクト | Amount | オファー作成者が提供する残額と通貨の種類。 |
|
||||
| `BookDirectory` | 文字列 | UInt256 | このオファーにリンクしている[オファーディレクトリー](directorynode.html)のID。 |
|
||||
| `BookDirectory` | 文字列 | Hash256 | このオファーにリンクしている[オファーディレクトリー](directorynode.html)のID。 |
|
||||
| `BookNode` | 文字列 | UInt64 | オファーディレクトリーが複数ページで構成されている場合に、このオブジェクトにリンクしているページを示すヒントです。 |
|
||||
| `OwnerNode` | 文字列 | UInt64 | 所有者ディレクトリーが複数ページで構成されている場合に、このオブジェクトにリンクしているページを示すヒントです。**注記:** このオファーには、オファーを含む所有者ディレクトリーへの直接リンクは含まれていません。これは、その値を`Account`から取得できるためです。 |
|
||||
| `PreviousTxnID` | 文字列 | Hash256 | 最後にこのオブジェクトを変更したトランザクションの識別用ハッシュ。 |
|
||||
|
||||
@@ -49,7 +49,7 @@ An `Offer` object has the following fields:
|
||||
| `Sequence` | Number | UInt32 | The `Sequence` value of the [OfferCreate][] transaction that created this `Offer` object. Used in combination with the `Account` to identify this Offer. |
|
||||
| `TakerPays` | String or Object | Amount | The remaining amount and type of currency requested by the offer creator. |
|
||||
| `TakerGets` | String or Object | Amount | The remaining amount and type of currency being provided by the offer creator. |
|
||||
| `BookDirectory` | String | UInt256 | The ID of the [Offer Directory](directorynode.html) that links to this offer. |
|
||||
| `BookDirectory` | String | Hash256 | The ID of the [Offer Directory](directorynode.html) that links to this offer. |
|
||||
| `BookNode` | String | UInt64 | A hint indicating which page of the offer directory links to this object, in case the directory consists of multiple pages. |
|
||||
| `OwnerNode` | String | UInt64 | A hint indicating which page of the owner directory links to this object, in case the directory consists of multiple pages. **Note:** The offer does not contain a direct link to the owner directory containing it, since that value can be derived from the `Account`. |
|
||||
| `PreviousTxnID` | String | Hash256 | The identifying hash of the transaction that most recently modified this object. |
|
||||
|
||||
@@ -4,6 +4,7 @@ parent: transaction-types.html
|
||||
blurb: Accept an offer to buy or sell an NFToken.
|
||||
labels:
|
||||
- NFTs, Non-fungible Tokens
|
||||
status: not_enabled
|
||||
---
|
||||
# NFTokenAcceptOffer
|
||||
{% include '_snippets/nfts-disclaimer.md' %}
|
||||
@@ -18,41 +19,11 @@ The `NFTokenAcceptOffer` transaction is used to accept offers to `buy` or `sell`
|
||||
|
||||
The mode in which the transaction operates depends on the presence of the `SellOffer` and `BuyOffer` fields of the transaction:
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><strong><code>SellOffer</code></strong>
|
||||
</td>
|
||||
<td><strong><code>BuyOffer</code></strong>
|
||||
</td>
|
||||
<td><strong>Mode</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>✔️
|
||||
</td>
|
||||
<td>✔️
|
||||
</td>
|
||||
<td>Brokered
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>✔️
|
||||
</td>
|
||||
<td><B>X</B>
|
||||
</td>
|
||||
<td>Direct
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><B>X</B>
|
||||
</td>
|
||||
<td>✔️
|
||||
</td>
|
||||
<td>Direct
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
| `SellOffer` | `BuyOffer` | Mode |
|
||||
|:------------|:-----------|:---------|
|
||||
| ✔️ | ✔️ | Brokered |
|
||||
| ✔️ | X | Direct |
|
||||
| X | ✔️ | Direct |
|
||||
|
||||
|
||||
If neither of those fields is specified, the transaction is malformed and produces a `tem` class error.
|
||||
@@ -67,11 +38,9 @@ The semantics of brokered mode are slightly different than one in direct mode: T
|
||||
|
||||
In direct mode, `NFTokenAcceptOffer` transaction fails if:
|
||||
|
||||
|
||||
|
||||
* The `NFTokenOffer` against which `NFTokenAcceptOffer` transaction is placed is an offer to `buy `the `NFToken` and the account executing the `NFTokenAcceptOffer` is not, at the time of execution, the current owner of the corresponding `NFToken`.
|
||||
* The `NFTokenOffer` against which `NFTokenAcceptOffer` transaction is placed is an offer to `sell `the `NFToken` and was placed by an account which is not, at the time of execution, the current owner of the `NFToken`
|
||||
* The `NFTokenOffer` against which `NFTokenAcceptOffer` transaction is placed is an offer to `sell `the `NFToken` and was placed by an account which is not, at the time of execution, the `Account` in the recipient field of the `NFTokenOffer`, if there exist one.
|
||||
* The `NFTokenOffer` against which `NFTokenAcceptOffer` transaction is placed is an offer to `buy` the `NFToken` and the account executing the `NFTokenAcceptOffer` is not, at the time of execution, the current owner of the corresponding `NFToken`.
|
||||
* The `NFTokenOffer` against which `NFTokenAcceptOffer` transaction is placed is an offer to `sell` the `NFToken` and was placed by an account which is not, at the time of execution, the current owner of the `NFToken`
|
||||
* The `NFTokenOffer` against which `NFTokenAcceptOffer` transaction is placed is an offer to `sell` the `NFToken` and was placed by an account which is not, at the time of execution, the `Account` in the recipient field of the `NFTokenOffer`, if there exist one.
|
||||
* The `NFTokenOffer` against which `NFTokenAcceptOffer` transaction is placed specifies an `expiration` time and the close time field of the parent of the ledger in which the transaction would be included has already passed.
|
||||
* The `NFTokenOffer` against which `NFTokenAcceptOffer` transaction is placed to buy or sell the `NFToken `is owned by the account executing the `NFTokenAcceptOffer`.
|
||||
|
||||
@@ -87,8 +56,6 @@ If the transaction is executed successfully then:
|
||||
|
||||
In brokered mode, the `NFTokenAcceptOffer` transaction fails if:
|
||||
|
||||
|
||||
|
||||
* The `buy` `NFTokenOffer` against which the `NFTokenAcceptOffer` transaction is placed is owned by the account executing the transaction.
|
||||
* The `sell` `NFTokenOffer` against which the `NFTokenAcceptOffer` transaction is placed is owned by the account executing the transaction.
|
||||
* The account that placed the offer to sell the `NFToken` is not, at the time of execution, the current owner of the corresponding `NFToken`.
|
||||
@@ -98,73 +65,14 @@ In brokered mode, the `NFTokenAcceptOffer` transaction fails if:
|
||||
## Fields
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><strong>Field Name</strong>
|
||||
</td>
|
||||
<td><strong>Required?</strong>
|
||||
</td>
|
||||
<td><strong>JSON Type</strong>
|
||||
</td>
|
||||
<td><strong>Internal Type</strong>
|
||||
</td>
|
||||
<td><strong>Description</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>TransactionType</code>
|
||||
</td>
|
||||
<td>Yes
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
</td>
|
||||
<td>Transaction type <code>NFTokenAcceptOffer</code>. The sequence number of a previous <code>NFTokenCreateOffer</code> transaction. The integer identifier is <code>29</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>SellOffer</code>
|
||||
</td>
|
||||
<td>No
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
</td>
|
||||
<td>Identifies the <code>NFTokenOffer</code> that offers to sell the <code>NFToken</code>.
|
||||
<p>
|
||||
In direct mode this field is optional, but you must specify either the <code>SellOffer</code> or the <code>BuyOffer</code>. In brokered mode, you must specify both the <code>SellOffer</code> and the <code>BuyOffer</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>BuyOffer</code>
|
||||
</td>
|
||||
<td>No
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
</td>
|
||||
<td>Identifies the <code>NFTokenOffer</code> that offers to buy the <code>NFToken</code>.
|
||||
<p>
|
||||
In direct mode, this field is optional, but you must specify either the <code>SellOffer</code> or the <code>BuyOffer</code>. In brokered mode, you must specify both the <code>SellOffer</code> and the <code>BuyOffer</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>BrokerFee</code>
|
||||
</td>
|
||||
<td>no
|
||||
</td>
|
||||
<td>object or string
|
||||
</td>
|
||||
<td>Amount
|
||||
</td>
|
||||
<td>This field is only valid in brokered mode, and specifies the amount that the broker keeps as part of their fee for bringing the two offers together; the remaining amount is sent to the seller of the <code>NFToken</code> being bought. If specified, the fee must be such that, prior to accounting for the transfer fee charged by the issuer, the amount that the seller would receive is at least as much as the amount indicated in the sell offer.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
| Field | JSON Type | [Internal Type][] | Description |
|
||||
|:----------------|:-----------------|:------------------|:--------------------|
|
||||
| `TransactionType` | String | UInt16 | Transaction type `NFTokenAcceptOffer`. The integer identifier is 29. |
|
||||
| `SellOffer` | String | Hash256 | _(Optional)_ Identifies the `NFTokenOffer` that offers to sell the `NFToken`. |
|
||||
| `BuyOffer` | String | Hash256 | _(Optional)_ Identifies the `NFTokenOffer` that offers to buy the `NFToken`. |
|
||||
| `BrokerFee` | [Currency Amount][] | Amount | _(Optional)_ This field is only valid in brokered mode, and specifies the amount that the broker keeps as part of their fee for bringing the two offers together; the remaining amount is sent to the seller of the NFToken being bought. If specified, the fee must be such that, prior to accounting for the transfer fee charged by the issuer, the amount that the seller would receive is at least as much as the amount indicated in the sell offer. |
|
||||
|
||||
In direct mode, you must specify **either** the `SellOffer` or the `BuyOffer`. In brokered mode, you must specify **both** the `SellOffer` and the `BuyOffer`.
|
||||
|
||||
This functionality is intended to allow the `owner` of an `NFToken` to offer their token for sale to a third party broker, who may then attempt to sell the `NFToken` on for a larger amount, without the broker having to own the `NFToken` or custody funds.
|
||||
|
||||
|
||||
@@ -2,10 +2,8 @@
|
||||
html: nftokenburn.html
|
||||
parent: transaction-types.html
|
||||
blurb: Use TokenBurn to permanently destroy NFTs.
|
||||
filters:
|
||||
- include_code
|
||||
labels:
|
||||
- Non-fungible Tokens, NFTs
|
||||
- Non-fungible Tokens, NFTs
|
||||
status: not_enabled
|
||||
---
|
||||
# NFTokenBurn
|
||||
@@ -62,7 +60,7 @@ If this operation succeeds, the corresponding `NFToken` is removed. If this oper
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>Account ID
|
||||
<td>AccountID
|
||||
</td>
|
||||
<td>The <code>AccountID</code> that submitted this transaction. The account must be either the present <code>owner</code> of the token or, if the <code>lsfBurnable</code> flag is set in the <code>NFToken</code>, the <code>issuer</code> account or an account authorized by the issuer, (that is, the <code>MintAccount</code>).
|
||||
</td>
|
||||
@@ -74,7 +72,7 @@ If this operation succeeds, the corresponding `NFToken` is removed. If this oper
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT256
|
||||
<td>Hash256
|
||||
</td>
|
||||
<td>Identifies the <code>NFToken</code> object to be removed by the transaction.
|
||||
</td>
|
||||
@@ -112,7 +110,7 @@ Issuers might want to issue NFTs from their well known account, while at the sam
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>Account ID
|
||||
<td>AccountID
|
||||
</td>
|
||||
<td>The <code>MintAccount</code> field, if set, specifies an alternate account which is allowed to execute the <code>NFTokenMint</code> and <code>NFTokenBurn</code> operations on behalf of the account.
|
||||
</td>
|
||||
|
||||
@@ -4,6 +4,7 @@ parent: transaction-types.html
|
||||
blurb: Cancel existing token offers to buy or sell an NFToken.
|
||||
labels:
|
||||
- NFTs, Non-fungible Tokens
|
||||
status: not_enabled
|
||||
---
|
||||
# NFTokenCancelOffer
|
||||
{% include '_snippets/nfts-disclaimer.md' %}
|
||||
@@ -14,18 +15,16 @@ The `NFTokenCancelOffer` transaction can be used to cancel existing token offers
|
||||
|
||||
```json
|
||||
{
|
||||
"TransactionType": "NFTokenCancelOffer",
|
||||
"Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"TokenIDs": "000100001E962F495F07A990F4ED55ACCFEEF365DBAA76B6A048C0A200000007"
|
||||
}
|
||||
"TransactionType": "NFTokenCancelOffer",
|
||||
"Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"TokenIDs": "000100001E962F495F07A990F4ED55ACCFEEF365DBAA76B6A048C0A200000007"
|
||||
}
|
||||
```
|
||||
|
||||
## Permissions
|
||||
|
||||
An existing offer, represented by an `NFTokenOffer` object, can be cancelled by:
|
||||
|
||||
|
||||
|
||||
* The account that originally created the `NFTokenOffer`.
|
||||
* The account in the `Destination` field of the `NFTokenOffer`, if one is present.
|
||||
* The issuer of the token identified by the `TokenUID` field in the `NFTokenOffer` object, if the token has the `lsfIssuerCanCancelOffers` flag set.
|
||||
@@ -35,47 +34,10 @@ This transaction removes the listed `NFTokenOffer` object from the ledger, if pr
|
||||
|
||||
{% include '_snippets/tx-fields-intro.md' %}
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><strong>Field Name</strong>
|
||||
</td>
|
||||
<td><strong>Required?</strong>
|
||||
</td>
|
||||
<td><strong>JSON Type</strong>
|
||||
</td>
|
||||
<td><strong>Internal Type</strong>
|
||||
</td>
|
||||
<td><strong>Description</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>TransactionType</code>
|
||||
</td>
|
||||
<td>Yes
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
</td>
|
||||
<td><code>NFTokenCancelOffer</code> transaction type. The integer identifier is <code>28</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>TokenIDs</code>
|
||||
</td>
|
||||
<td>Yes
|
||||
</td>
|
||||
<td>array
|
||||
</td>
|
||||
<td>VECTOR256
|
||||
</td>
|
||||
<td>An array of <code>TokenID</code> objects, each identifying the <code>NFTokenOffer</code> object that should be cancelled by this transaction.
|
||||
<p>
|
||||
It is an error if an entry in this list points to an object that is not an <code>NFTokenOffer</code> object. It is not an error if an entry in this list points to an object that does not exist.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
| Field | JSON Type | [Internal Type][] | Description |
|
||||
|:----------------|:----------|:------------------|:---------------------------|
|
||||
| TransactionType | String | UInt16 | NFTokenCancelOffer transaction type. The integer identifier is 28. |
|
||||
| TokenIDs | Array | VECTOR256 | An array of TokenID objects, each identifying the NFTokenOffer object that should be cancelled by this transaction. It is an error if an entry in this list points to an object that is not an [NFTokenOffer object][]. It is not an error if an entry in this list points to an object that does not exist. |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2,13 +2,11 @@
|
||||
html: nftokencreateoffer.html
|
||||
parent: transaction-types.html
|
||||
blurb: Create an offer to buy or sell NFTs.
|
||||
filters:
|
||||
- include_code
|
||||
labels:
|
||||
- Non-fungible Tokens, NFTs
|
||||
status: not_enabled
|
||||
---
|
||||
# `NFTokenCreateOffer` transaction
|
||||
# NFTokenCreateOffer
|
||||
{% include '_snippets/nfts-disclaimer.md' %}
|
||||
|
||||
The `NFTokenCreateOffer` transaction creates either a new _Sell_ offer for an `NFToken` owned by the account executing the transaction, or a new _Buy_ offer for an `NFToken` owned by another account.
|
||||
@@ -19,12 +17,12 @@ Each offer costs one incremental reserve.
|
||||
|
||||
```json
|
||||
{
|
||||
"TransactionType": "NFTokenCreateOffer",
|
||||
"Account": "rs8jBmmfpwgmrSPgwMsh7CvKRmRt1JTVSX",
|
||||
"TokenID": "000100001E962F495F07A990F4ED55ACCFEEF365DBAA76B6A048C0A200000007",
|
||||
"Amount": "1000000",
|
||||
"Flags": 1
|
||||
}
|
||||
"TransactionType": "NFTokenCreateOffer",
|
||||
"Account": "rs8jBmmfpwgmrSPgwMsh7CvKRmRt1JTVSX",
|
||||
"TokenID": "000100001E962F495F07A990F4ED55ACCFEEF365DBAA76B6A048C0A200000007",
|
||||
"Amount": "1000000",
|
||||
"Flags": 1
|
||||
}
|
||||
```
|
||||
|
||||
## `NFTokenCreateOffer` Fields
|
||||
@@ -49,7 +47,7 @@ Each offer costs one incremental reserve.
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>UINT16
|
||||
<td>UInt16
|
||||
</td>
|
||||
<td>Indicates the new transaction type <code>NFTokenCreateOffer</code>. The integer identifier is <code>27</code>.
|
||||
</td>
|
||||
@@ -73,9 +71,9 @@ Each offer costs one incremental reserve.
|
||||
</td>
|
||||
<td>string
|
||||
</td>
|
||||
<td>Account ID
|
||||
<td>AccountID
|
||||
</td>
|
||||
<td>Indicates the <code>AccountID</code> of the account that owns the corresponding <code>NFToken</code>.
|
||||
<td>Who owns the corresponding <code>NFToken</code>.
|
||||
<ul>
|
||||
|
||||
<li>
|
||||
@@ -119,7 +117,7 @@ The amount must be non-zero, except where this is an offer to sell and the asset
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>Indicates the time after which the offer will no longer be valid. The value is the number of seconds since the <a href="https://xrpl.org/basic-data-types.html#specifying-time">Ripple Epoch</a>.
|
||||
</td>
|
||||
@@ -135,7 +133,7 @@ The amount must be non-zero, except where this is an offer to sell and the asset
|
||||
</td>
|
||||
<td>If present, indicates that this offer may only be accepted by the specified account. Attempts by other accounts to accept this offer MUST fail.
|
||||
<p>
|
||||
If succesful, <code>NFTokenCreateOffer</code> transaction results in the creation of <code>NFTokenOffer</code> object.
|
||||
If successful, the transaction creates a [NFTokenOffer object][].
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -145,7 +143,7 @@ If succesful, <code>NFTokenCreateOffer</code> transaction results in the creatio
|
||||
</td>
|
||||
<td>number
|
||||
</td>
|
||||
<td>UINT32
|
||||
<td>UInt32
|
||||
</td>
|
||||
<td>A set of flags that specifies options or controls the behavior of the transaction. The flag is defined in the table below.
|
||||
</td>
|
||||
|
||||
@@ -2,16 +2,14 @@
|
||||
html: nftokenmint.html
|
||||
parent: transaction-types.html
|
||||
blurb: Use TokenMint to issue new NFTs.
|
||||
filters:
|
||||
- include_code
|
||||
labels:
|
||||
- Non-fungible Tokens, NFTs
|
||||
- Non-fungible Tokens, NFTs
|
||||
status: not_enabled
|
||||
---
|
||||
# NFTokenMint
|
||||
{% include '_snippets/nfts-disclaimer.md' %}
|
||||
|
||||
The `NFTokenMint` transaction creates a `NFToken` object and adds it to the relevant `NFTokenPage` object of the `minter`. A required parameter to this transaction is the `Token` field specifying the actual token. This transaction is the only opportunity the `minter` has to specify any token fields that are defined as immutable (for example, the `TokenFlags`).
|
||||
The `NFTokenMint` transaction creates a [NFToken object][] and adds it to the relevant [NFTokenPage object][] of the `minter`. A required parameter to this transaction is the `Token` field specifying the actual token. This transaction is the only opportunity the `minter` has to specify any token fields that are defined as immutable (for example, the `TokenFlags`).
|
||||
|
||||
If the transaction is successful, the newly minted token is owned by the account (the `minter` account) that executed the transaction. If needed, the server creates a new `NFTokenPage` for the account and applies a reserve charge.
|
||||
|
||||
@@ -71,7 +69,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>string</code>
|
||||
</td>
|
||||
<td><code>UINT16</code>
|
||||
<td><code>UInt16</code>
|
||||
</td>
|
||||
<td>Indicates the new transaction type <code>NFTokenMint</code>. The integer value is <code>25</code>.
|
||||
</td>
|
||||
@@ -83,7 +81,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>string</code>
|
||||
</td>
|
||||
<td><code>ACCOUNT ID</code>
|
||||
<td><code>AccountID</code>
|
||||
</td>
|
||||
<td>Indicates the account that is minting the token. The account MUST <em>either</em>:
|
||||
<ul>
|
||||
@@ -102,7 +100,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>string</code>
|
||||
</td>
|
||||
<td><code>ACCOUNT ID</code>
|
||||
<td><code>AccountID</code>
|
||||
</td>
|
||||
<td>Indicates the account that issues the token. This value is <em>optional</em> and should only be specified if the account executing the transaction is not the <code>Issuer</code> of the <code>NFToken</code> object. If it is present, the <code>MintAccount</code> field in the <code>AccountRoot</code> of the <code>Issuer</code> field must match the <code>Account</code>. Otherwise, the transaction fails.
|
||||
</td>
|
||||
@@ -114,7 +112,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>number</code>
|
||||
</td>
|
||||
<td><code>UINT32</code>
|
||||
<td><code>UInt32</code>
|
||||
</td>
|
||||
<td>The taxon associated with the token. The taxon is generally a value chosen by the <code>minter</code> of the token. A given taxon can be used for multiple tokens. This implementation reserves all taxon identifiers greater than or equal to <code>0x80000000</code>; attempts to use mint tokens with such taxons should fail and a fee should be claimed.
|
||||
</td>
|
||||
@@ -126,7 +124,7 @@ In executing, this transaction examines the `MintedTokens` field in the account
|
||||
</td>
|
||||
<td><code>number</code>
|
||||
</td>
|
||||
<td><code>UINT16</code>
|
||||
<td><code>UInt16</code>
|
||||
</td>
|
||||
<td>The value specifies the fee charged by the issuer for secondary sales of the Token, if such sales are allowed. Valid values for this field are between 0 and 9999 inclusive, allowing transfer rates of between 0.00% and 99.99% in increments of 0.01.
|
||||
<p>
|
||||
@@ -152,7 +150,7 @@ The field MUST NOT be present if <code>tfTransferable</code> is not set. If it i
|
||||
</td>
|
||||
<td><code>number</code>
|
||||
</td>
|
||||
<td><code>UINT32</code>
|
||||
<td><code>UInt32</code>
|
||||
</td>
|
||||
<td>Specifies the flags used for the minting transaction. See the mint transaction flags in the following table.
|
||||
</td>
|
||||
|
||||
Reference in New Issue
Block a user