Add words from new features such as NFTs to the spell checker (#1615)

* Add words from new features such as NFTs to the spell checker

* Add more proper nouns and general purpose words

* Add more proper nouns and general purpose words

* Update to use backticks

* Update proper nouns and generic words

* Fix style for words based on style checker report

* Style/spelling fixes

* Fix links broken by style/spelling updates

* More edits for style

* Finish updates to get style checker to pass

Co-authored-by: mDuo13 <mduo13@gmail.com>
This commit is contained in:
Amarantha Kulkarni
2022-12-15 14:29:32 -08:00
committed by GitHub
parent 4c9ca0f219
commit 845422da7f
132 changed files with 618 additions and 981 deletions

View File

@@ -53,13 +53,14 @@ To mint a non-fungible token for another account:
1. Set the **Flags** field. For testing purposes, we recommend setting the value to _8_.
2. Enter the **NFToken URL**. This is a URI that points to the data or metadata associated with the NFToken object. You can use the sample URI provided if you do not have one of your own.
3. Enter the **Transfer Fee**, a percentage of the proceeds from future sales of the NFToken that will be returned to the original creator. This is a value of 0-50000 inclusive, allowing transfer rates between 0.000% and 50.000% in increments of 0.001%. If you do not set the **Flags** field to allow the NFToken to be transferrable, set this field to 0.
3. Enter the **Transfer Fee**, a percentage of the proceeds that the original creator receives from future sales of the NFToken. This is a value of 0-50000 inclusive, allowing transfer rates between 0.000% and 50.000% in increments of 0.001%. If you do not set the **Flags** field to allow the NFToken to be transferrable, set this field to 0.
4. Copy the **Standby Account** value.
5. Paste the **Standby Account** value in the Operational account **Issuer** field.
6. Click the Operational account **Mint Other** button.
[![Minted NFToken for Another Account](img/quickstart30.png)](img/quickstart30.png)
Once the item is minted, the authorized minter can sell the NFToken normally. The proceeds go to the authorized minter, less the transfer fee. The minter and the issuer can settle up on a division of the purchase price separately.
Once the item is minted, the authorized minter can sell the NFToken normally. The proceeds go to the authorized minter, less the transfer fee. The minter and the issuer can settle up on a division of the price separately.
## Create a Sell Offer
@@ -71,21 +72,21 @@ To create a NFToken sell offer:
4. Optionally, enter a number of days until **Expiration**.
5. Click **Create Sell Offer**.
The important piece of information in the response is the Token Offer Index, labeled as _nft_offer_index,_ which is used to accept the sell offer.
The important piece of information in the response is the NFToken Offer Index, labeled as `nft_offer_index`, which is used to accept the sell offer.
[![NFToken Sell Offer](img/quickstart31.png)](img/quickstart31.png)
## Accept Sell Offer
Once a sell offer is available, you can create a new account to accept the offer and purchase the NFToken.
Once a sell offer is available, you can create a new account to accept the offer and buy the NFToken.
To accept an available sell offer:
1. Click **Get New Standby Account**.
1. Enter the **NFToken Offer Index** (labeled as _nft_offer_index_ in the token offer results. This is not the same as the _nft_id_).
1. Enter the **NFToken Offer Index** (labeled as `nft_offer_index` in the NFToken offer results. This is different from the `nft_id`).
2. Click **Accept Sell Offer**.
When you examine the results field, you'll find that the Issuer account is credited 25 XRP. The Buyer account is debited the 100 XRP purchase price plus 12 drops as the transaction fee. The Seller (Authorized Minter) account is credited 75 XRP. the Issuer and the Seller can divide the proceeds per their agreement in a separate transaction.
The results show that the Issuer account has been credited 25 XRP. The Buyer account was debited the 100 XRP price plus 12 drops as the transaction cost. The Seller (Authorized Minter) account is credited 75 XRP. the Issuer and the Seller can divide the proceeds per their agreement in a separate transaction.
[![Transaction Results](img/quickstart32.png)](img/quickstart32.png)
# Code Walkthrough
@@ -104,7 +105,7 @@ This function sets the authorized minter for an account. Each account can have 0
async function setMinter(type) {
```
Connect to the ledger and get the account wallet.
Connect to the ledger and get the account.
```javascript
let net = getNet()
@@ -154,7 +155,7 @@ Prepare and send the transaction, then wait for results
const result = await client.submitAndWait(signed.tx_json)
```
If the transaction succeeds, stringify the results and report. If not, report that the transaction failed.
If the transaction succeeds, show the results. If not, report that the transaction failed.
```javascript
if (result.result.meta.TransactionResult == "tesSUCCESS") {
@@ -188,7 +189,7 @@ This revised mint function allows one account to mint for another issuer.
async function mintOther() {
```
Connect to the ledger and get the account wallet.
Connect to the ledger and get the account.
```javascript
results = 'Connecting to ' + getNet() + '....'
@@ -225,7 +226,8 @@ At a minimum, we recommend that you set the `tfTransferable` flag (8) to enable
"Flags": parseInt(standbyFlagsField.value),
```
Transfer fee is a value 0-50000 representing .001% of the purchase price for a resale to be returned to the original issuer. For example, _25000_ translates to 25% of the purchase price to be sent to the issuer on resale.
Transfer fee is a value 0-50000 representing .001% of the price for a resale to be returned to the original issuer. For example, _25000_ translates to 25% of the price to be sent to the issuer on resale.
```javascript
"TransferFee": parseInt(standbyTransferFeeField.value),
```
@@ -236,7 +238,7 @@ The **Issuer** is the original creator of the object represented by the NFToken.
"Issuer": standbyIssuerField.value,
```
The NFTokenTaxon is an optional number field the issuer can use for their own purposes. The same taxon can be used for multiple tokens. Set it to 0 if you have no use for it.
The `NFTokenTaxon` is an optional number field the issuer can use for their own purposes. The same taxon can be used for multiple tokens. Set it to 0 if you have no use for it.
```javascript
"NFTokenTaxon": 0 //Required, but if you have no use for it, set to zero.