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

#86dtu93ty - Include how to write nft contracts (NEP-11) to the docum… #1270

Merged
merged 2 commits into from
Jun 19, 2024
Merged

#86dtu93ty - Include how to write nft contracts (NEP-11) to the docum… #1270

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95f470e
#86dtu93ty - Include how to write nft contracts (NEP-11) to the docum…
jplippi Jun 19, 2024
0a6ece6
#86dtu93ty - Include how to write nft contracts (NEP-11) to the docum…
jplippi Jun 19, 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
26 changes: 26 additions & 0 deletions docs/source/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,32 @@ And must also implement and trigger a `Transfer` event whenever tokens are trans
Here's a [simple example](https://github.com/CityOfZion/neo3-boa/blob/development/boa3_test/examples/simple_nep17.py) of a Token contract following the NEP-17 standard.
>Note: The NEP-17 standard also has requirements on how each method must be implemented. Be sure to check the [full documentation](https://docs.neo.org/docs/en-us/develop/write/nep17.html) on the NEP-17 standard to ensure the implementation is correct.

### How to make a Non-Fungible (NFT) Token smart contract
Just like the fungible token, for a contract to be a non-fungible token (NFT) in the Neo blockchain, it needs to adhere to the [NEP-11](https://docs.neo.org/docs/en-us/develop/write/nep11.html) standard by implementing a few methods and events:
- `symbol` - Returns the symbol of the token.
- `decimals` - Returns the number of decimals used by the token.
- `totalSupply` - Returns the total supply of the token.
- `tokensOf` = Returns the IDs of all NFTs owned by the specified account.

In addition, an NFT contract may be either *non-divisible* or *divisible*.

For **non-divisible** NFT contracts, the following method is also required:
- `balanceOf` - Returns the total amount of NFTs of the specified account.
- `transfer` - Transfers tokens to a specified account.
- `ownerOf` - Returns the address of the owner of a specified NFT ID.

For **divisible** NFT contracts, the following methods are also required:
- `balanceOf` - Returns the amount of NFTs of the specified NFT ID for the specified account.
- `transfer` - Transfers tokens to from a specified account to another.
- `ownerOf` - Returns the addresses of all co-owners of a specified NFT ID.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the method names are the same for each case, it should need to explain before this that the signatures are different, not only what each method returns


In both cases, the contract must also implement and trigger a `Transfer` event whenever tokens are transferred.

>Note: Although many methods and events have the same name as the NEP-17 standard, their implementation and parameters may differ.

Here's a [full example](https://github.com/CityOfZion/neo3-boa/blob/development/boa3_test/examples/nep11_non_divisible.py) of a non-divisible token contract following the NEP-11 standard.
>Note: The example above is rather complete and contains more than just the basic implementation of a NEP-11 contract. Once again, be sure to check the [full documentation](https://docs.neo.org/docs/en-us/develop/write/nep11.html) on the NEP-11 standard to ensure the implementation is correct.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just saw that you pasted the direct link to development branch, can you change it to relative path, so when it's merged to staging and master it links to the respective versions?
Same for the nep17 example


## Compiling your Smart Contract

### Using CLI
Expand Down
Loading