Release 12/2024

.github/workflows/cadence.yml

@@ -32,16 +32,61 @@ jobs:
           submodules: 'true'
        - name: Install Flow CLI
          run: |
-           if test -f ${{ env.RECIPE_REPO }}/cadence/tests.cdc; then
-             brew update
-             brew install flow-cli
-             flow init --reset
-           fi
-       - name: Trigger recipe test
+           cd ${{ env.RECIPE_REPO }}
+           brew update
+           brew install flow-cli
+
+       - name: Start Flow Emulator
+         run: |
+          cd ${{ env.RECIPE_REPO }}
+          if test -f "flow.json"; then
+            flow dependencies install
+            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  
+          else
+            echo "No flow.json found."
+          fi 
+
+       - name: Run Cadence Lint
          run: |
-          if test -f ${{ env.RECIPE_REPO }}/cadence/tests.cdc; then
-            flow test ${{ env.RECIPE_REPO }}/cadence/tests.cdc
+          cd ${{ env.RECIPE_REPO }}
+          if test -f "flow.json"; then
+           echo "Running Cadence linter on .cdc files in the current repository"
+           flow cadence lint ./cadence/**/*.cdc    
+          else
+           echo "No flow.json found."
           fi 
 
+       - name: Run All Transactions
+         run: |
+          cd ${{ env.RECIPE_REPO }}
+          if test -f "flow.json"; then
+           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
+          else
+           echo "No flow.json found."
+          fi 
+
+
+       - name: Trigger recipe tests
+         run: |
+          cd ${{ env.RECIPE_REPO }}
+          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
 
 
+
+

.gitmodules

@@ -1,6 +1,3 @@
-[submodule "src/data/recipes/add-a-play-to-topshot-set"]
-	path = src/data/recipes/add-a-play-to-topshot-set
-	url = https://github.com/lealobanov/add-a-play-to-topshot-set
 [submodule "src/data/recipes/mint-nft"]
 	path = src/data/recipes/mint-nft
 	url = https://github.com/lealobanov/mint-nft
@@ -46,15 +43,6 @@
 [submodule "src/data/recipes/add-admin-resource-to-account"]
 	path = src/data/recipes/add-admin-resource-to-account
 	url = https://github.com/lealobanov/add-admin-resource-to-account
-[submodule "src/data/recipes/create-a-topshot-play"]
-	path = src/data/recipes/create-a-topshot-play
-	url = https://github.com/lealobanov/create-a-topshot-play
-[submodule "src/data/recipes/create-a-topshot-set"]
-	path = src/data/recipes/create-a-topshot-set
-	url = https://github.com/lealobanov/create-a-topshot-set
-[submodule "src/data/recipes/minting-a-moment-in-topshot-set"]
-	path = src/data/recipes/minting-a-moment-in-topshot-set
-	url = https://github.com/lealobanov/minting-a-moment-in-topshot-set
 [submodule "src/data/recipes/create-a-marketplace"]
 	path = src/data/recipes/create-a-marketplace
 	url = https://github.com/lealobanov/create-a-marketplace

src/data/recipeUtils.js

@@ -1,47 +1,132 @@
 import * as fs from "node:fs";
 import { recipes } from "./recipes";
+const path = require("path");
 import { randomIntFromInterval } from "../utils/random_interval";
 
 const recipesByModule = recipes;
 
 export function fetchExternalRecipe(recipe) {
-  const contractPath = recipe.smartContractCode;
-  const transactionPath = recipe.transactionCode;
-  const testPath = recipe.testCasesCode;
-
-  const contractExplanationPath = recipe.smartContractExplanation;
-  const transactionExplanationPath = recipe.transactionExplanation;
-  const testExplanationPath = recipe.testCasesExplanation;
-
-  const contractCode =
-    contractPath !== undefined && contractPath !== null
-      ? fs.readFileSync(`./src/data/recipes/${contractPath}`, "utf8")
-      : null;
-  const transactionCode =
-    transactionPath !== undefined && transactionPath !== null
-      ? fs.readFileSync(`./src/data/recipes/${transactionPath}`, "utf8")
-      : null;
-  const testCasesCode =
-    testPath !== undefined && testPath !== null
-      ? fs.readFileSync(`./src/data/recipes/${testPath}`, "utf8")
-      : null;
-
-  const contractExplanation =
-    contractExplanationPath !== undefined && contractExplanationPath !== null
-      ? fs.readFileSync(`./src/data/recipes/${contractExplanationPath}`, "utf8")
-      : null;
-  const transactionExplanation =
-    transactionExplanationPath !== undefined &&
-    transactionExplanationPath !== null
-      ? fs.readFileSync(
-          `./src/data/recipes/${transactionExplanationPath}`,
+  const contractFolder = `./src/data/recipes/${recipe.slug}/cadence/contracts`;
+  const transactionFolder = `./src/data/recipes/${recipe.slug}/cadence/transactions`;
+  const testFolder = `./src/data/recipes/${recipe.slug}/cadence/tests`;
+
+  // Dynamically find Recipe.cdc in the contracts folder
+  const contractCode = (() => {
+    try {
+      const files = fs.readdirSync(contractFolder);
+      const recipeContract = files.find((file) => file === "Recipe.cdc");
+      if (recipeContract) {
+        return fs.readFileSync(
+          path.join(contractFolder, recipeContract),
           "utf8"
-        )
-      : null;
-  const testCasesExplanation =
-    testExplanationPath !== undefined && testExplanationPath !== null
-      ? fs.readFileSync(`./src/data/recipes/${testExplanationPath}`, "utf8")
-      : null;
+        );
+      } else {
+        return null;
+      }
+    } catch (err) {
+      // Check if the recipe still follows old structure
+      const oldContractPath = `./src/data/recipes/${recipe.slug}/cadence/contract.cdc`;
+      try {
+        if (fs.existsSync(oldContractPath)) {
+          console.log("Using /cadence/contract.cdc configuration for: " + oldContractPath)
+          return fs.readFileSync(oldContractPath, "utf8");
+        } else {
+          return null;
+        }
+      } catch (oldErr) {
+        return null;
+      }
+    }
+  })();
+
+  // Dynamically find any transaction file in the transactions folder
+  const transactionCode = (() => {
+    try {
+      const files = fs.readdirSync(transactionFolder);
+      const transactionFile = files.length > 0 ? files[0] : null; // Pick the first file
+      if (transactionFile) {
+        return fs.readFileSync(
+          path.join(transactionFolder, transactionFile),
+          "utf8"
+        );
+      } else {
+        return null;
+      }
+    } catch (err) {
+      // Check if the recipe still follows old structure
+      const oldTransactionPath = `./src/data/recipes/${recipe.slug}/cadence/transaction.cdc`;
+      try {
+        if (fs.existsSync(oldTransactionPath)) {
+          return fs.readFileSync(oldTransactionPath, "utf8");
+        } else {
+          return null;
+        }
+      } catch (oldErr) {
+        return null;
+      }
+    }
+  })();
+
+  // Dynamically find Recipe.cdc in the contracts folder
+  const testCasesCode = (() => {
+    try {
+      const files = fs.readdirSync(testFolder);
+      const recipeContractTests = files.find(
+        (file) => file === "Recipe_test.cdc"
+      );
+      if (recipeContractTests) {
+        return fs.readFileSync(
+          path.join(testFolder, recipeContractTests),
+          "utf8"
+        );
+      } else {
+        return null;
+      }
+    } catch (err) {
+      return null
+    }
+  })();
+
+
+  const contractExplanation = (() => {
+    const explanationPath = `./src/data/recipes/${recipe.slug}/explanations/contract.txt`;
+    try {
+      if (fs.existsSync(explanationPath)) {
+        return fs.readFileSync(explanationPath, "utf8");
+      } else {
+        return null;
+      }
+    } catch (err) {
+      return null;
+    }
+  })();
+
+  const transactionExplanation = (() => {
+    const explanationPath = `./src/data/recipes/${recipe.slug}/explanations/transaction.txt`;
+    try {
+      if (fs.existsSync(explanationPath)) {
+        return fs.readFileSync(explanationPath, "utf8");
+      } else {
+        return null;
+      }
+    } catch (err) {
+      return null;
+    }
+  })();
+
+  const testCasesExplanation = (() => {
+    const explanationPath = `./src/data/recipes/${recipe.slug}/explanations/tests.txt`;
+    try {
+      if (fs.existsSync(explanationPath)) {
+        return fs.readFileSync(explanationPath, "utf8");
+      } else {
+        return null;
+      }
+    } catch (err) {
+      return null;
+    }
+  })();
+
 
   const setCoverUrl =
     recipe.coverUrl === undefined