Merge pull request #1 from onflow/c1-migration

C1.0 migration

.github/workflows/cadence_lint.yml

@@ -0,0 +1,51 @@
+name: Run Cadence Contract Compilation, Deployment, Transaction Execution, and Lint
+on: push
+
+jobs:
+  run-cadence-lint:
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: 'true'
+
+      - name: Install Flow CLI
+        run: |
+          brew update
+          brew install flow-cli
+
+      - name: Initialize Flow
+        run: |
+          if [ ! -f flow.json ]; then
+            echo "Initializing Flow project..."
+            flow init
+          else
+            echo "Flow project already initialized."
+          fi
+          flow dependencies install
+
+      - name: Start Flow Emulator
+        run: |
+          echo "Starting Flow emulator in the background..."
+          nohup flow emulator start > emulator.log 2>&1 &
+          sleep 5 # Wait for the emulator to start
+          flow project deploy --network=emulator # Deploy the recipe contracts indicated in flow.json                           
+
+      - name: Run All Transactions
+        run: |
+          echo "Running all transactions in the transactions folder..."
+          for file in ./cadence/transactions/*.cdc; do
+            echo "Running transaction: $file"
+            TRANSACTION_OUTPUT=$(flow transactions send "$file" --signer emulator-account)
+            echo "$TRANSACTION_OUTPUT"
+            if echo "$TRANSACTION_OUTPUT" | grep -q "Transaction Error"; then
+              echo "Transaction Error detected in $file, failing the action..."
+              exit 1
+            fi
+          done
+
+      - name: Run Cadence Lint
+        run: |
+          echo "Running Cadence linter on .cdc files in the current repository"
+          flow cadence lint ./cadence/**/*.cdc

.github/workflows/cadence_tests.yml

@@ -0,0 +1,34 @@
+name: Run Cadence Tests
+on: push
+
+jobs:
+  run-cadence-tests:
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: 'true'
+
+      - name: Install Flow CLI
+        run: |
+          brew update
+          brew install flow-cli
+
+      - name: Initialize Flow
+        run: |
+          if [ ! -f flow.json ]; then
+            echo "Initializing Flow project..."
+            flow init
+          else
+            echo "Flow project already initialized."
+          fi
+
+      - name: Run Cadence Tests
+        run: |
+          if test -f "cadence/tests.cdc"; then
+            echo "Running Cadence tests in the current repository"
+            flow test cadence/tests.cdc
+          else
+            echo "No Cadence tests found. Skipping tests."
+          fi

.gitignore

@@ -1 +1,3 @@
-.DS_Store
+.DS_Store
+/imports/
+/.idea/

README.md

@@ -9,6 +9,7 @@ Using the TopShot contract, this is how you would create a Play to start adding
 - [Description](#description)
 - [What is included in this repository?](#what-is-included-in-this-repository)
 - [Supported Recipe Data](#recipe-data)
+- [Deploying Recipe Contracts and Running Transactions Locally (Flow Emulator)](#deploying-recipe-contracts-and-running-transactions-locally-flow-emulator)
 - [License](#license)
 
 ## Description
@@ -19,7 +20,6 @@ The Cadence Cookbook is a collection of code examples, recipes, and tutorials de
 
 Each recipe in the Cadence Cookbook is a practical coding example that showcases a specific aspect of Cadence or use-case on Flow, including smart contract development, interaction, and best practices. By following these recipes, you can gain hands-on experience and learn how to leverage Cadence for your blockchain projects.
 
-
 ### Contributing to the Cadence Cookbook
 
 Learn more about the contribution process [here](https://github.com/onflow/cadence-cookbook/blob/main/contribute.md).
@@ -34,17 +34,17 @@ Recipe metadata, such as title, author, and category labels, is stored in `index
 
 ```
 recipe-name/
-├── cadence/              # Cadence files for recipe examples
-│   ├── contract.cdc          # Contract code
-│   ├── transaction.cdc          # Transaction code
-│   ├── tests.cdc          # Tests code
-├── explanations/         # Explanation files for recipe examples
-│   ├── contract.txt          # Contract code explanation
-│    ├── transaction.txt          # Transaction code explanation
-│    ├── tests.txt         # Tests code explanation
-├── index.js        # Root file for storing recipe metadata
-├── README.md             # This README file
-└── LICENSE               # License information
+├── cadence/                          # Cadence files for recipe examples
+│   ├── contracts/Recipe.cdc          # Contract code
+│   ├── transactions/create_play.cdc   # Transaction code
+│   ├── tests/Recipe_test.cdc           # Tests code
+├── explanations/           # Explanation files for recipe examples
+│   ├── contract.txt        # Contract code explanation
+│   ├── transaction.txt     # Transaction code explanation
+│   ├── tests.txt           # Tests code explanation
+├── index.js                # Root file for storing recipe metadata
+├── README.md               # This README file
+└── LICENSE                 # License information
 ```
 
 ## Supported Recipe Data
@@ -95,6 +95,43 @@ export const sampleRecipe= {
   transactionExplanation: transactionExplanationPath,
 };
 ```
+## Deploying Recipe Contracts and Running Transactions Locally (Flow Emulator)
+
+This section explains how to deploy the recipe's contracts to the Flow emulator, run the associated transaction with sample arguments, and verify the results.
+
+### Prerequisites
+
+Before deploying and running the recipe:
+
+1. Install the Flow CLI. You can find installation instructions [here](https://docs.onflow.org/flow-cli/install/).
+2. Ensure the Flow emulator is installed and ready to use with `flow version`.
+
+### Step 1: Start the Flow Emulator
+
+Start the Flow emulator to simulate the blockchain environment locally
+
+```bash
+flow emulator start
+```
+
+### Step 2: Install Dependencies and Deploy Project Contracts
+
+Deploy contracts to the emulator. This will deploy all the contracts specified in the _deployments_ section of `flow.json` whether project contracts or dependencies.
+
+```bash
+flow dependencies install
+flow project deploy --network=emulator                                  
+```
+
+### Step 3: Run the Transaction
+
+Transactions associated with the recipe are located in `./cadence/transactions`. To run a transaction, execute the following command:
+
+```bash
+flow transactions send cadence/transactions/TRANSACTION_NAME.cdc --signer emulator-account
+```
+
+To verify the transaction's execution, check the emulator logs printed during the transaction for confirmation messages. You can add the `--log-level debug` flag to your Flow CLI command for more detailed output during contract deployment or transaction execution.
 
 ## License
 

cadence/contract.cdc

@@ -0,0 +1 @@
+./cadence/contracts/Recipe.cdc

cadence/contracts/Recipe.cdc

@@ -0,0 +1,70 @@
+import "TopShot"
+
+access(all) contract Recipe {
+    // This is a snippet extracting the relevant logic from the TopShot contract for demonstration purposes
+    // TopShot Contract Code Above
+
+    access(all) var playDatas: {UInt32: Recipe.Play}
+    access(all) var nextPlayID: UInt32
+
+    access(all) event PlayCreated(id: UInt32, metadata: {String: String})
+
+    init() {
+        self.playDatas = {}
+        self.nextPlayID = 0
+    }
+
+    // Play is a Struct that holds metadata associated 
+    // with a specific NBA play, like the legendary moment when 
+    // Ray Allen hit the 3 to tie the Heat and Spurs in the 2013 finals game 6
+    // or when Lance Stephenson blew in the ear of Lebron James.
+    //
+    // Moment NFTs will all reference a single play as the owner of
+    // its metadata. The plays are publicly accessible, so anyone can
+    // read the metadata associated with a specific play ID
+    //
+    access(all) struct Play {
+        // The unique ID for the Play
+        access(all) let playID: UInt32
+
+        // Stores all the metadata about the play as a string mapping
+        // This is not the long-term way NFT metadata will be stored.
+        access(all) let metadata: {String: String}
+
+        init(metadata: {String: String}) {
+            pre {
+                metadata.length != 0: "New Play metadata cannot be empty"
+            }
+            self.playID = TopShot.nextPlayID
+            self.metadata = metadata
+        }
+    }
+
+    access(all)
+    resource Admin {
+
+        // createPlay creates a new Play struct 
+        // and stores it in the Plays dictionary in the TopShot smart contract
+        //
+        // Parameters: metadata: A dictionary mapping metadata titles to their data
+        // Returns: the ID of the new Play object
+        access(all)
+        fun createPlay(metadata: {String: String}): UInt32 {
+            // Create the new Play
+            let newPlay = Play(metadata: metadata)
+            let newID = newPlay.playID
+
+            // Increment the ID so that it isn't used again
+            Recipe.nextPlayID = Recipe.nextPlayID + UInt32(1)
+
+            emit PlayCreated(id: newPlay.playID, metadata: metadata)
+
+            // Store it in the contract storage
+            Recipe.playDatas[newID] = newPlay
+
+            return newID
+        }
+    }
+
+    // Rest of TopShot contract below
+}

cadence/tests/Recipe_test.cdc

@@ -0,0 +1,18 @@
+import Test
+
+access(all)
+fun setup() {
+
+    let err = Test.deployContract(
+        name: "Recipe",
+        path: "../contracts/Recipe.cdc",
+        arguments: [],
+    )
+
+    Test.expect(err, Test.beNil())
+}
+
+access(all) fun testExample() {
+    let array = [1, 2, 3]
+    Test.expect(array.length, Test.equal(3))
+}

cadence/transaction.cdc

@@ -0,0 +1 @@
+./cadence/transactions/create_play.cdc

cadence/transactions/create_play.cdc

@@ -0,0 +1,18 @@
+import "TopShot"
+
+transaction {
+    let admin: &TopShot.Admin
+
+    prepare(signer: auth(Storage) &Account) {
+        // Borrow the Admin resource from the specified storage path
+        self.admin = signer.storage.borrow<&TopShot.Admin>(from: /storage/TopShotAdmin)
+            ?? panic("Cannot borrow admin resource")
+    }
+
+    execute {
+        // Create plays using the admin resource
+        self.admin.createPlay(metadata: {"Rookie": "2004", "Player Name": "Dwight Howard"})
+        self.admin.createPlay(metadata: {"Rookie": "2003", "Player Name": "Dwayne Wade"})
+        log("Play created")
+    }
+}

emulator-account.pkey

@@ -0,0 +1 @@
+0xdc07d83a937644ff362b279501b7f7a3735ac91a0f3647147acf649dda804e28