Skip to content

Latest commit

 

History

History
137 lines (99 loc) · 6.31 KB

README.md

File metadata and controls

137 lines (99 loc) · 6.31 KB
Raw

Cadence Cookbook Recipe: Add a Play to TopShot Set

What is this recipe about?

Once you have a set created and some plays, you can use this to add a play to a TopShot Set that can later be minted.

Table of Contents

Description

What is the Cadence Cookbook?

The Cadence Cookbook is a collection of code examples, recipes, and tutorials designed to help developers learn and understand the Cadence programming language. Cadence is the smart contract programming language used on the Flow blockchain. Whether you are new to Flow or an experienced blockchain developer, the Cadence Cookbook serves as a valuable resource to explore various aspects of Cadence and its applications in building dApps on the Flow blockchain.

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.

What is included in this repository?

Each recipe repository is subdivided into 2 main sections, Cadence code files (.cdc) under the /cadence directory, and explanation files (.txt) under the /explanations directory.

The Cadence Cookbook supports Cadence code and explanations for the contract, transaction, and testing elements of each recipe.

Recipe metadata, such as title, author, and category labels, is stored in index.js. Each recipe also includes a link to a live, runnable example of the corresponding code in the Flow Playground.

recipe-name/
├── cadence/                          # Cadence files for recipe examples
│   ├── contracts/Recipe.cdc          # Contract code
│   ├── transactions/create_plays.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

  • const recipe: defines a unique identifier (slug) for the recipe
  • title: indicates the title of the recipe
  • featuredText(optional): a subheading for the recipe title
  • coverUrl (optional): path to a featured cover image for the recipe
  • createdAt: date on which recipe was added to the Cadence Cookbook
  • author: contributor of the recipe
  • playgroundLink: a link to Flow Playground containing the deployed recipe code
  • excerpt: a brief description of the recipe contents
  • smartContractCode: path to location of Cadence smart contract code example
  • smartContractExplanation: path to location of smart contract code explanation
  • transactionCode: path to location of Cadence transaction code example
  • transactionExplanation: path to location of transaction code explanation
  • testsPath: path to location of Cadence test cases code example
  • testsExplanationPath: path to location of test cases code explanation
  • filters: the filters object is used to perform filtering on recipes in the cookbook
    • difficulty: the difficulty filter supports one of ['beginner', 'intermediate', 'advanced']
// Pass the repo name
const recipe = "sample-recipe-name";

//Generate paths of each code file to render
const contractPath = `${recipe}/cadence/contract.cdc`;
const transactionPath = `${recipe}/cadence/transaction.cdc`;
const testsPath = `${recipe}/cadence/tests.cdc`;

//Generate paths of each explanation file to render
const smartContractExplanationPath = `${recipe}/explanations/contract.txt`;
const transactionExplanationPath = `${recipe}/explanations/transaction.txt`;
const testsExplanationPath = `${recipe}/explanations/tests.txt`;

export const sampleRecipe= {
  slug: recipe,
  title: "",
  featuredText: "",
  createdAt: Date(2022, 3, 1),
  author: "",
  playgroundLink: "",
  excerpt: "",
  smartContractCode: contractPath,
  smartContractExplanation: smartContractExplanationPath,
  transactionCode: transactionPath,
  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.
  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

flow emulator start

Step 2: 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

flow project deploy --network=emulator

Step 3: Run the Transaction

The transaction file is located in ./cadence/transactions/create_plays.cdc. To run the transaction, execute the following command:

flow transactions send cadence/transactions/create_plays.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

This repository is licensed under the MIT License.