Skip to content

Commit a951aa3

Browse files
committed
update README
1 parent 1090131 commit a951aa3

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,43 @@
11
# NFT Storefront Contract Standard
22

3-
The version of the contracts in the `main` branch is the
4-
Cadence 1.0 version of the contracts and is not the same
5-
as the ones that are currently deployed to testnet and mainnet.
6-
See the `cadence-0.42` branch for the currently deployed versions.
7-
83
The NFT Storefront contract standard is a cornerstone of the Open Marketplace ecosystem on Flow. An open market ecosystem promotes the
94
free flow of NFT listings across the network, emitted as events and consumed by other marketplaces (or any other consumer). Marketplaces may filter
105
listings consumed based on commission rates they may receive. Listings may be created with variable commission, royalties or other fractional revenue, paying to multiple accounts. NFT listings are not NFTs, they are Resources which can be transacted with using the `purchase` [function](https://github.com/onflow/nft-storefront/blob/jp-update-structure/contracts/NFTStorefrontV2.cdc#L300) to obtain the token indicated by the listing.
116

12-
The NFTStorefront contract lets you create a non-custodial NFT marketplace to simplify integration with off-chain applications/UIs. The contract supports sellers who want to list and manage NFTs for sale simultaneously across any number of marketplaces. Listing expiry, orphaned and ghost listing cleanup are also of value for integrators to minimize overheads and ensure the best UX.
7+
The `NFTStorefrontV2` contract lets you create a non-custodial NFT marketplace to simplify integration with off-chain applications/UIs. The contract supports sellers who want to list and manage NFTs for sale simultaneously across any number of marketplaces. Listing expiry, orphaned and ghost listing cleanup are also of value for integrators to minimize overheads and ensure the best UX.
138

149
Marketplaces and sellers also benefit from the robust security guarantees of Flow's account model when trading NFTs. Through this standard a NFT trade takes place from peer-to-peer, directly from the Storefront Resource in the sellers account to the purchasers account. At the same time, the standard ensures that marketplaces or other recipients may receive royalties, fees or commissions with no risk to the seller.
1510

1611
Sellers or marketplaces can optionally configure their NFTStorefront to be limited or closed. However, those wishing to participate in the Open Marketplace ecosystem on Flow are required to use the NFTStorefront standard.
1712

1813
Detailed docs: [docs/documentation.md](docs/documentation.md)
14+
Flow.com docs: [NFT Storefront Standard](https://developers.flow.com/build/core-contracts/nft-storefront)
15+
16+
# Contract Addresses
17+
18+
|Name|Emulator|Testing Framework|Testnet|Previewnet|Mainnet|
19+
|----|----|------|-------|------|-------|
20+
|[NFTStorefront](contracts/NFTStorefront.cdc)|`0xf8d6e0586b0a20c7`|[0x94b06cfca1d8a476](https://flow-view-source.com/testnet/account/0x94b06cfca1d8a476/contract/NFTStorefront)|[0x6df5e52755433994](contracts/NFTStorefront.cdc)|[0x4eb8a10cb9f87357](https://flowscan.org/contract/A.4eb8a10cb9f87357.NFTStorefront)|
21+
|[NFTStorefrontV2 (recommended)](contracts/NFTStorefrontV2.cdc)|`0xf8d6e0586b0a20c7`|[0x2d55b98eb200daef](https://flow-view-source.com/testnet/account/0x2d55b98eb200daef/contract/NFTStorefrontV2)|[0x6df5e52755433994](contracts/NFTStorefrontV2.cdc)|[0x4eb8a10cb9f87357](https://flowscan.org/contract/A.4eb8a10cb9f87357.NFTStorefrontV2)|
22+
23+
# Usage
1924

20-
## Contract Addresses
25+
If you'd like to test with the `NFTStorefrontV2` Smart contract on the emulator,
26+
it is automatically deployed to `0xf8d6e0586b0a20c7` or `0x0000000000000001` in the Cadence Testing Framework.
2127

22-
|Name|Testnet|Previewnet|Mainnet|
23-
|----|-------|------|-------|
24-
|[NFTStorefront](contracts/NFTStorefront.cdc)|[0x94b06cfca1d8a476](https://flow-view-source.com/testnet/account/0x94b06cfca1d8a476/contract/NFTStorefront)|[0x6df5e52755433994](contracts/NFTStorefront.cdc)|[0x4eb8a10cb9f87357](https://flowscan.org/contract/A.4eb8a10cb9f87357.NFTStorefront)|
25-
|[NFTStorefrontV2 (recommended)](contracts/NFTStorefrontV2.cdc)|[0x2d55b98eb200daef](https://flow-view-source.com/testnet/account/0x2d55b98eb200daef/contract/NFTStorefrontV2)|[0x6df5e52755433994](contracts/NFTStorefrontV2.cdc)|[0x4eb8a10cb9f87357](https://flowscan.org/contract/A.4eb8a10cb9f87357.NFTStorefrontV2)|
28+
If you'd like to test with the `NFTStorefrontV2` Smart contract in your project,
29+
add it to your project by using the flow dependency manager:
2630

27-
## Usage
31+
```
32+
flow dependencies install mainnet://0x4eb8a10cb9f87357.NFTStorefrontV2
33+
```
34+
35+
Use the addresses mentioned above for the `emulator` and `testing` import addresses in your project's flow.json.
36+
37+
Detailed docs for how to manage listings are available on
38+
[the flow developer docs website](https://developers.flow.com/build/core-contracts/nft-storefront)
39+
40+
# Brief Overview
2841

2942
Each account that wants to offer NFTs for sale installs a `Storefront`,
3043
and then lists individual sales within that `Storefront` as `Listing` resources.
@@ -44,3 +57,5 @@ ID to see if they wish to buy the offered item.
4457

4558
Marketplaces and other aggregators can watch for `Listing` events
4659
and list items of interest.
60+
61+
See further docs and examples on [the developer docs site](https://developers.flow.com/build/core-contracts/nft-storefront).

0 commit comments

Comments
 (0)