implement hybrid custody

.github/workflows/ci.yml

@@ -6,21 +6,18 @@ on:
 
 jobs:
   build:
+    name: Flow CLI Tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: 'npm'
-          cache-dependency-path: lib/js/test/package-lock.json
-      - name: Install Flow CLI
-        run: sh -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/master/install.sh)"
-      - 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: make ci
+    - uses: actions/checkout@v3
+      with:
+        submodules: "true"
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.18
+    - name: Install Flow CLI
+      run: bash -ci "$(curl -fsSL https://raw.githubusercontent.com/onflow/flow-cli/master/install.sh)" -- v1.3.2
+    - name: Run tests
+      run: make ci
 

.gitignore

@@ -1,6 +1,7 @@
 .idea
 .DS_Store
 flowdb/
-lib/js/test/node_modules
 .vscode/
 .env
+coverage.json
+*.pkey

Makefile

@@ -1,7 +1,7 @@
 .PHONY: test
 test:
-	$(MAKE) test -C lib/js/test
+	set -e
+	flow test --cover ./test/*_tests.cdc
 
 .PHONY: ci
-ci:
-	$(MAKE) ci -C lib/js/test
+ci: test

README.md

@@ -213,12 +213,19 @@ To demo the functionality of this repo, clone it and follow the steps below by e
 
     - In one terminal window, run:
         ```sh
-        flow emulator start
+        flow emulator
         ```
 
-    - In another terminal window deploy the contracts with:
+    - In another terminal window, run the setup script creating our accounts & deploying contracts:
         ```sh
-        flow deploy
+        sh setup.sh
+        ```
+
+    - Lastly, a HybridCustody pre-requisite includes setting up a Capability `Filter` and Capability Factory `Manager`. These ensure that parent account access is scoped to just the Capabilities they need to interact with the assets we as the developer want them to access. For more info on `CapabilityFilter` & `CapabilityFactory`, read [these docs](https://developers.flow.com/concepts/hybrid-custody/guides/linking-accounts#pre-requisites).
+
+        ```sh
+        flow transactions send ./transactions/hybrid-custody/dev-setup/setup_filter_and_factory_manager.cdc \
+            f8d6e0586b0a20c7 GamePieceNFT f8d6e0586b0a20c7 TicketToken
         ```
 
 ## Walletless Demo Walkthrough

contracts/ArcadePrize.cdc

@@ -1,7 +1,7 @@
-import NonFungibleToken from "./utility/NonFungibleToken.cdc"
-import FungibleToken from "./utility/FungibleToken.cdc"
-import MetadataViews from "./utility/MetadataViews.cdc"
-import TicketToken from "./TicketToken.cdc"
+import "NonFungibleToken"
+import "FungibleToken"
+import "MetadataViews"
+import "TicketToken"
 
 pub contract ArcadePrize: NonFungibleToken {
 

contracts/DynamicNFT.cdc

@@ -1,4 +1,4 @@
-import MetadataViews from "./utility/MetadataViews.cdc"
+import "MetadataViews"
 
 /// DynamicNFT
 /// 

contracts/GamePieceNFT.cdc

@@ -1,8 +1,10 @@
-import FungibleToken from "./utility/FungibleToken.cdc"
-import NonFungibleToken from "./utility/NonFungibleToken.cdc"
-import MetadataViews from "./utility/MetadataViews.cdc"
-import GamingMetadataViews from "./GamingMetadataViews.cdc"
-import DynamicNFT from "./DynamicNFT.cdc"
+import "FungibleToken"
+import "NonFungibleToken"
+import "MetadataViews"
+import "ViewResolver"
+
+import "GamingMetadataViews"
+import "DynamicNFT"
 
 /// GamePieceNFT
 ///
@@ -11,7 +13,7 @@ import DynamicNFT from "./DynamicNFT.cdc"
 /// heavily modeled on MonsterMaker, using images from that NFT collection
 /// as well as many values & methods from that collection.
 ///
-pub contract GamePieceNFT: NonFungibleToken {
+pub contract GamePieceNFT: NonFungibleToken, ViewResolver {
 
     /// Counter to track total circulating supply
     pub var totalSupply: UInt64
@@ -217,45 +219,13 @@ pub contract GamePieceNFT: NonFungibleToken {
                         self.id
                     )
                 case Type<MetadataViews.ExternalURL>():
-                    return MetadataViews.ExternalURL("https://walletless-arcade-game.vercel.app/".concat(self.id.toString()))
-                // TODO: Confirm returned types
+                    return MetadataViews.ExternalURL("https://walletless-arcade-game.vercel.app/")
                 case Type<MetadataViews.NFTCollectionData>():
-                    return MetadataViews.NFTCollectionData(
-                        storagePath: GamePieceNFT.CollectionStoragePath,
-                        publicPath: GamePieceNFT.CollectionPublicPath,
-                        providerPath: GamePieceNFT.ProviderPrivatePath,
-                        publicCollection: Type<&GamePieceNFT.Collection{GamePieceNFT.GamePieceNFTCollectionPublic}>(),
-                        publicLinkedType: Type<&GamePieceNFT.Collection{GamePieceNFT.GamePieceNFTCollectionPublic, NonFungibleToken.CollectionPublic, NonFungibleToken.Receiver, MetadataViews.ResolverCollection}>(),
-                        providerLinkedType: Type<&GamePieceNFT.Collection{GamePieceNFT.GamePieceNFTCollectionPublic, NonFungibleToken.CollectionPublic, NonFungibleToken.Provider, MetadataViews.ResolverCollection}>(),
-                        createEmptyCollectionFunction: (fun (): @NonFungibleToken.Collection {
-                            return <-GamePieceNFT.createEmptyCollection()
-                        })
-                    )
+                    return GamePieceNFT.resolveView(view)
                 case Type<MetadataViews.NFTCollectionDisplay>():
-                    let media = MetadataViews.Media(
-                        file: MetadataViews.HTTPFile(
-                            url: "https://i.imgur.com/UMXsEjt.png"
-                        ),
-                        mediaType: "image/png"
-                    )
-
-                    let bannerMedia = MetadataViews.Media(
-                        file: MetadataViews.HTTPFile(
-                            url: "https://i.imgur.com/NzV9cyo.png"
-                        ),
-                        mediaType: "image/png"
-                    )
-                    return MetadataViews.NFTCollectionDisplay(
-                        name: "The MonsterMaker GamePieceNFT Collection",
-                        description: "This collection is used as an example to help you develop your next Flow NFT.",
-                        externalURL: MetadataViews.ExternalURL("https://walletless-arcade-game.vercel.app/"),
-                        squareImage: media,
-                        bannerImage: bannerMedia,
-                        socials: {}
-                    )
+                    return GamePieceNFT.resolveView(view)
                 case Type<MetadataViews.Traits>():
                     let traitsView = MetadataViews.dictToTraits(dict: self.metadata, excludedNames: [])
-
                     return traitsView
                 default:
                     return nil
@@ -559,6 +529,63 @@ pub contract GamePieceNFT: NonFungibleToken {
         )
     }
 
+    /// Function that resolves a metadata view for this contract.
+    ///
+    /// @param view: The Type of the desired view.
+    /// @return A structure representing the requested view.
+    ///
+    pub fun resolveView(_ view: Type): AnyStruct? {
+        switch view {
+            case Type<MetadataViews.NFTCollectionData>():
+                return MetadataViews.NFTCollectionData(
+                    storagePath: GamePieceNFT.CollectionStoragePath,
+                    publicPath: GamePieceNFT.CollectionPublicPath,
+                    providerPath: GamePieceNFT.ProviderPrivatePath,
+                    publicCollection: Type<&GamePieceNFT.Collection{GamePieceNFT.GamePieceNFTCollectionPublic}>(),
+                    publicLinkedType: Type<&GamePieceNFT.Collection{GamePieceNFT.GamePieceNFTCollectionPublic, NonFungibleToken.CollectionPublic, NonFungibleToken.Receiver, MetadataViews.ResolverCollection}>(),
+                    providerLinkedType: Type<&GamePieceNFT.Collection{GamePieceNFT.GamePieceNFTCollectionPublic, NonFungibleToken.CollectionPublic, NonFungibleToken.Provider, MetadataViews.ResolverCollection}>(),
+                    createEmptyCollectionFunction: (fun (): @NonFungibleToken.Collection {
+                        return <-GamePieceNFT.createEmptyCollection()
+                    })
+                )
+            case Type<MetadataViews.NFTCollectionDisplay>():
+                let media = MetadataViews.Media(
+                        file: MetadataViews.HTTPFile(
+                            url: "https://i.imgur.com/UMXsEjt.png"
+                        ),
+                        mediaType: "image/png"
+                    )
+
+                let bannerMedia = MetadataViews.Media(
+                        file: MetadataViews.HTTPFile(
+                            url: "https://i.imgur.com/NzV9cyo.png"
+                        ),
+                        mediaType: "image/png"
+                    )
+                return MetadataViews.NFTCollectionDisplay(
+                    name: "The MonsterMaker GamePieceNFT Collection",
+                    description: "This collection is used as an example to help you develop your next Flow NFT.",
+                    externalURL: MetadataViews.ExternalURL("https://walletless-arcade-game.vercel.app/"),
+                    squareImage: media,
+                    bannerImage: bannerMedia,
+                    socials: {}
+                )
+        }
+        return nil
+    }
+
+    /// Function that returns all the Metadata Views implemented by a Non Fungible Token
+    ///
+    /// @return An array of Types defining the implemented views. This value will be used by
+    ///         developers to know which parameter to pass to the resolveView() method.
+    ///
+    pub fun getViews(): [Type] {
+        return [
+            Type<MetadataViews.NFTCollectionData>(),
+            Type<MetadataViews.NFTCollectionDisplay>()
+        ]
+    }
+
     init() {
 
         self.totalSupply = 0

contracts/GamingMetadataViews.cdc

@@ -1,4 +1,4 @@
-import MetadataViews from "./utility/MetadataViews.cdc"
+import "MetadataViews"
 
 /// GamingMetadataViews
 ///