Skip to content

Commit

Permalink
update the 1.0 version of the nft guide
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuahannan committed Mar 29, 2024
1 parent 928b51d commit 2090474
Showing 1 changed file with 28 additions and 4 deletions.
32 changes: 28 additions & 4 deletions versioned_docs/version-1.0/cadence_migration_guide/nft-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,14 @@ This guide is primarily for developers who have existing contracts
deployed to Flow mainnet that they need to update for Cadence 1.0.
If you don't have any contracts deployed yet, it is recommended that
you start an NFT contract from scratch by either copying the `ExampleNFT`
contract or the [`BasicNFT` contract](https://github.com/onflow/flow-nft/blob/standard-v2/contracts/BasicNFT.cdc)
contract or the [`BasicNFT` contract](https://github.com/onflow/flow-nft/blob/universal-collection/contracts/BasicNFT.cdc)
from the `standard-v2` branch of the flow-nft
github repo and wait to deploy it until Flow has been upgraded for Cadence 1.0.

## BasicNFT and UniversalCollection

As part of the improvements to the NFT standard, there is now a new NFT contract
example in the `flow-nft` github repo: [`BasicNFT`](https://github.com/onflow/flow-nft/blob/standard-v2/contracts/BasicNFT.cdc).
example in the `flow-nft` github repo: [`BasicNFT`](https://github.com/onflow/flow-nft/blob/universal-collection/contracts/BasicNFT.cdc).

`BasicNFT` defines a Cadence NFT in as few lines of code as possible, 137 at the moment!
This is possible because the contract basically only defines the NFT resource,
Expand All @@ -109,7 +109,7 @@ It doesn't have to define a collection! Most collection resources are 99% boiler
code, so it really doesn't make sense for most projects to have to define their own
collection.

Instead, `BasicNFT` uses [`UniversalCollection`](https://github.com/onflow/flow-nft/blob/standard-v2/contracts/UniversalCollection.cdc),
Instead, `BasicNFT` uses [`UniversalCollection`](https://github.com/onflow/flow-nft/blob/universal-collection/contracts/UniversalCollection.cdc),
a contract that defines a collection resource
that has all of the standard functionality that a collection needs and nothing else.
From now on, any project that doesn't want to do anything unique with their collection
Expand Down Expand Up @@ -237,6 +237,9 @@ access(all) contract ExampleNFT: NonFungibleToken {

This will ensure that your `NFT` resource has all the correct fields and functions.

As part of this upgrade, you should remove the `NonFungibleToken.INFT` implementation specification
from the declaration of your `NFT` because the `INFT` interface has been removed.

**Note for Custom Migrations:** All stored objects that currently use the concrete type
`NonFungibleToken.NFT` will be automatically migrated to use the interface type `{NonFungibleToken.NFT}`
as part of the Flow team's custom state migrations.
Expand All @@ -255,6 +258,17 @@ access(all) resource Collection: NonFungibleToken.Collection {
`NonFungibleToken.Collection` will be automatically migrated to use the interface type `{NonFungibleToken.Collection}`
as part of the Flow team's custom state migrations.

### Change the access specification of `ownedNFTs` to `access(contract)`

This one is EXTREMELY important. With the addition of entitlements and safe downcasting,
now anyone with a reference to your collection can downcast it to its concrete type
even if the reference is just of an interface type. This means that you have to be
very careful about which fields and functions are declared as public.

`ownedNFTs` used to be `access(all)`, but it should be changed to `access(contract)`
which means that only code from your contract can access it.
If this isn't done, then anyone would be able to access that field, which could be dangerous.

### Remove Project-Specific Events

Standard events are being added to the token standards! These are events
Expand Down Expand Up @@ -352,7 +366,7 @@ In the new standard examples, we often use UUID for NFT IDs. Many early Flow pro
used a project-specific ID system for their NFTs. It is important that you stick with
whatever ID system your project used from the beginning so NFT IDs don't get mixed up.

### AddcreateEmptyCollection() to NFT and Collection.
### Add createEmptyCollection() to NFT and Collection.

These function requirements were added to [`NFT`](https://github.com/onflow/flow-nft/pull/126/files#diff-0f42f974b7e6311f474d087fea60fbd57b5fda90294853811e492f965da21d36R58-R60)
and [`Collection`](https://github.com/onflow/flow-nft/pull/126/files#diff-0f42f974b7e6311f474d087fea60fbd57b5fda90294853811e492f965da21d36R203-R206)
Expand Down Expand Up @@ -565,6 +579,16 @@ The default view functions will be enforced by the token standard,
but if your project has any other getter functions that aren't in the standard
and don't modify any state, then you should add `view` to these functions.

Style Tip: The recommended style for view functions is to put the `view` keyword
after the access specification instead of before, like this:
```cadence
/// Recommended
access(all) view fun getIDs(): [UInt64] {
/// NOT Recommended
view access(all) fun getIDs(): [UInt64] {
```

### Remove Restricted Types

Cadence 1.0 makes it so restricted types
Expand Down

0 comments on commit 2090474

Please sign in to comment.