Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update nft docs #22060

Merged
merged 3 commits into from
Oct 3, 2024
Merged

docs: Update nft docs #22060

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
074e08b
Update nft readme
lucaslopezf Oct 3, 2024
278937f
delete unnecessary module
lucaslopezf Oct 3, 2024
29144bd
delete unnecessary module
lucaslopezf Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion x/nft/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ sidebar_position: 1
* [Messages](#messages)
* [MsgSend](#msgsend)
* [Events](#events)
* [Queries](#queries)
* [Keeper Functions](#keeper-functions)

## Concepts

Expand Down Expand Up @@ -86,4 +88,30 @@ The message handling should fail if:

## Events

The nft module emits proto events defined in [the Protobuf reference](https://buf.build/cosmos/cosmos-sdk/docs/main:cosmos.nft.v1beta1).
The NFT module emits proto events defined in [the Protobuf reference](https://buf.build/cosmos/cosmos-sdk/docs/main:cosmos.nft.v1beta1).

## Queries

The `x/nft` module provides several queries to retrieve information about NFTs and classes:

* `Balance`: Returns the number of NFTs of a given class owned by the owner.
* `Owner`: Returns the owner of an NFT based on its class and ID.
* `Supply`: Returns the number of NFTs from the given class.
* `NFTs`: Queries all NFTs of a given class or owner.
* `NFT`: Returns an NFT based on its class and ID.
* `Class`: Returns an NFT class based on its ID.
* `Classes`: Returns all NFT classes.

## Keeper Functions

The Keeper of the `x/nft` module provides several functions to manage NFTs:

* `Mint`: Mints a new NFT.
* `Burn`: Burns an existing NFT.
* `Update`: Updates an existing NFT.
* `Transfer`: Transfers an NFT from one owner to another.
* `GetNFT`: Retrieves information about a specific NFT.
* `GetNFTsOfClass`: Retrieves all NFTs of a specific class.
* `GetNFTsOfClassByOwner`: Retrieves all NFTs of a specific class belonging to an owner.
* `GetBalance`: Retrieves the balance of NFTs of a specific class for an owner.
* `GetTotalSupply`: Retrieves the total supply of NFTs of a specific class.
Loading