Merge pull request #89 from onflow/stable-cadence-refactor

NFTStorefront v1 & v2 Cadence 1.0 Refactor

.github/workflows/ci.yml

@@ -9,39 +9,32 @@ jobs:
     name: NFTStorefront V2 Integration Tests
     timeout-minutes: 10
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        go: ["1.16"]
     steps:
     - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
       with:
-        node-version: 15.0.0
-        cache: 'npm'
-        cache-dependency-path: lib/js/test/package-lock.json
+        submodules: "true"
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.20
     - name: Install Flow CLI
-      run: sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/master/install.sh)" -- v0.33.1-sc-m5
-    - name: Flow cli Version
-      run: flow version
-    - name: Update PATH
-      run: echo "/root/.local/bin" >> $GITHUB_PATH
-    - name: Install dependencies
-      run: cd lib/js/test && npm ci
+      run: sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/feature/stable-cadence/install.sh)"
     - name: Run tests
-      run: cd lib/js/test && npm run test
-  V1-Integration-Tests:
+      run: flow test -f ./flow.testing.json --cover --covercode="contracts/NFTStorefrontV2.cdc" ./test/NFTStorefrontV2_test.cdc
+  V2-Integration-Tests:
     name: NFTStorefront V1 Integration Tests
+    timeout-minutes: 10
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-go@v2
-        with:
-          go-version: '1.16'
-      - uses: actions/cache@v1
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
-      - run: make ci
+    - uses: actions/checkout@v3
+      with:
+        submodules: "true"
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.20
+    - name: Install Flow CLI
+      run: sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/feature/stable-cadence/install.sh)"
+    - name: Run tests
+      run: flow test -f ./flow.testing.json --cover --covercode="contracts/NFTStorefront.cdc" ./test/NFTStorefrontV1_test.cdc
 

.gitignore

@@ -1 +1,3 @@
-lib/js/test/node_modules/*
+lib/js/test/node_modules/*
+.idea
+coverage.json

Makefile

@@ -1,15 +1,18 @@
+.PHONY: update-mainnet
+update-mainnet:
+	$(MAKE) flow accounts update-contract NFTStorefrontV2 ./contracts/NFTStorefrontV2.cdc --signer mainnet-account --network mainnet -f ./flow.mainnet.json
+
+.PHONY: update-testnet
+update-testnet:
+	$(MAKE) flow accounts update-contract NFTStorefrontV2 ./contracts/NFTStorefrontV2.cdc --signer testnet-account --network testnet -f ./flow.testnet.json
+
 .PHONY: test
 test:
+	$(MAKE) generate -C lib/go
 	$(MAKE) test -C lib/go
+	flow-c1 test --cover --covercode="contracts" tests/*.cdc
 
 .PHONY: ci
 ci:
 	$(MAKE) ci -C lib/go
-
-.PHONY: update-mainnet
-update-mainnet:
-	$(MAKE) flow accounts update-contract NFTStorefrontV2 ./contracts/NFTStorefrontV2.cdc --signer mainnet-account --network mainnet -f ./flow.mainnet.json
-
-.PHONY: update-testnet
-update-testnet:
-	$(MAKE) flow accounts update-contract NFTStorefrontV2 ./contracts/NFTStorefrontV2.cdc --signer testnet-account --network testnet -f ./flow.testnet.json
+	flow-c1 test --cover --covercode="contracts" tests/*.cdc

README.md

@@ -1,21 +1,23 @@
-# NFT Storefront
+# NFT Storefront Contract Standard
 
-The NFT storefront is a general-purpose Cadence 
-contract for trading NFTs on Flow.
+The NFT Storefront contract standard is a cornerstone of the Open Marketplace ecosystem on Flow. An open market ecosystem promotes the 
+free flow of NFT listings across the network, emitted as events and consumed by other marketplaces (or any other consumer). Marketplaces may filter 
+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. 
 
-`NFTStorefront` uses modern Cadence [run-time type](https://docs.onflow.org/cadence/language/run-time-types/)
-facilities to implement a marketplace that can take any currency in order to vend any token in a safe and secure way. 
-This means that only one instance of the contract is needed (see below for its address on Testnet and Mainnet), 
-and its resources, transactions, and scripts can be used by any account to create any marketplace.
+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. 
 
-> **_NOTE:_** New version of NFTStorefront,i.e. `NFTStorefrontV2` contract has been developed and deployed on testnet. Whoever wants to build upon NFTStorefront, it is recommended to use latest version of it,i.e `NFTStorefrontV2` and enjoy its latest offerings.
+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.
+
+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. 
+
+Detailed docs: [docs/documentation.md](docs/documentation.md)
 
 ## Contract Addresses 
 
-|Name|Testnet|Mainnet|
-|----|-------|-------|
-|[NFTStorefront](contracts/NFTStorefront.cdc)|[0x94b06cfca1d8a476](https://flow-view-source.com/testnet/account/0x94b06cfca1d8a476/contract/NFTStorefront)|[0x4eb8a10cb9f87357](https://flowscan.org/contract/A.4eb8a10cb9f87357.NFTStorefront)|
-|[NFTStorefrontV2](contracts/NFTStorefrontV2.cdc)|[0x2d55b98eb200daef](https://flow-view-source.com/testnet/account/0x2d55b98eb200daef/contract/NFTStorefrontV2)|[0x4eb8a10cb9f87357](https://flowscan.org/contract/A.4eb8a10cb9f87357.NFTStorefrontV2)|
+|Name|Testnet|Previewnet|Mainnet|
+|----|-------|------|-------|
+|[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)|
+|[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)|
 
 ## Usage