Skip to content

Commit 840aabd

Browse files
mergify[bot]clmyy
andauthored
docs: fix several typos in the document (backport #22052) (#22061)
Co-authored-by: clmyy <[email protected]>
1 parent e9486fc commit 840aabd

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/architecture/adr-043-nft-module.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ This ADR defines the `x/nft` module which is a generic implementation of NFTs, r
1717

1818
* `MsgNewClass` - Receive the user's request to create a class, and call the `NewClass` of the `x/nft` module.
1919
* `MsgUpdateClass` - Receive the user's request to update a class, and call the `UpdateClass` of the `x/nft` module.
20-
* `MsgMintNFT` - Receive the user's request to mint a nft, and call the `MintNFT` of the `x/nft` module.
21-
* `BurnNFT` - Receive the user's request to burn a nft, and call the `BurnNFT` of the `x/nft` module.
22-
* `UpdateNFT` - Receive the user's request to update a nft, and call the `UpdateNFT` of the `x/nft` module.
20+
* `MsgMintNFT` - Receive the user's request to mint an NFT, and call the `MintNFT` of the `x/nft` module.
21+
* `BurnNFT` - Receive the user's request to burn an NFT, and call the `BurnNFT` of the `x/nft` module.
22+
* `UpdateNFT` - Receive the user's request to update an NFT, and call the `UpdateNFT` of the `x/nft` module.
2323

2424
## Context
2525

@@ -48,7 +48,7 @@ We create a `x/nft` module, which contains the following functionality:
4848
* Expose external `Message` interface for users to transfer ownership of their NFTs.
4949
* Query NFTs and their supply information.
5050

51-
The proposed module is a base module for NFT app logic. It's goal it to provide a common layer for storage, basic transfer functionality and IBC. The module should not be used as a standalone.
51+
The proposed module is a base module for NFT app logic. Its goal is to provide a common layer for storage, basic transfer functionality and IBC. The module should not be used as a standalone.
5252
Instead an app should create a specialized module to handle app specific logic (eg: NFT ID construction, royalty), user level minting and burning. Moreover an app specialized module should handle auxiliary data to support the app logic (eg indexes, ORM, business data).
5353

5454
All data carried over IBC must be part of the `NFT` or `Class` type described below. The app specific NFT data should be encoded in `NFT.data` for cross-chain integrity. Other objects related to NFT, which are not important for integrity can be part of the app specific module.
@@ -58,7 +58,7 @@ All data carried over IBC must be part of the `NFT` or `Class` type described be
5858
We propose two main types:
5959

6060
* `Class` -- describes NFT class. We can think about it as a smart contract address.
61-
* `NFT` -- object representing unique, non fungible asset. Each NFT is associated with a Class.
61+
* `NFT` -- object representing unique, non-fungible asset. Each NFT is associated with a class.
6262

6363
#### Class
6464

@@ -81,7 +81,7 @@ message Class {
8181
* `symbol` is the symbol usually shown on exchanges for the NFT class; _optional_
8282
* `description` is a detailed description of the NFT class; _optional_
8383
* `uri` is a URI for the class metadata stored off chain. It should be a JSON file that contains metadata about the NFT class and NFT data schema ([OpenSea example](https://docs.opensea.io/docs/contract-level-metadata)); _optional_
84-
* `uri_hash` is a hash of the document pointed by uri; _optional_
84+
* `uri_hash` is a hash of the document pointed by URI; _optional_
8585
* `data` is app specific metadata of the class; _optional_
8686

8787
#### NFT
@@ -107,7 +107,7 @@ message NFT {
107107

108108
* `uri` is a URI for the NFT metadata stored off chain. Should point to a JSON file that contains metadata about this NFT (Ref: [ERC721 standard and OpenSea extension](https://docs.opensea.io/docs/metadata-standards)); _required_
109109
* `uri_hash` is a hash of the document pointed by uri; _optional_
110-
* `data` is an app specific data of the NFT. CAN be used by composing modules to specify additional properties of the NFT; _optional_
110+
* `data` is an app specific data of the NFT. Can be used by composing modules to specify additional properties of the NFT; _optional_
111111

112112
This ADR doesn't specify values that `data` can take; however, best practices recommend upper-level NFT modules clearly specify their contents. Although the value of this field doesn't provide the additional context required to manage NFT records, which means that the field can technically be removed from the specification, the field's existence allows basic informational/UI functionality.
113113

0 commit comments

Comments
 (0)