Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 4.71 KB

README.md

File metadata and controls

101 lines (76 loc) · 4.71 KB
Raw

Cadence Cookbook Recipe: Withdrawing Tokens

What is this recipe about?

This is included in your smart contract when you would like to implement token withdrawls. Also useful for transferring tokens between accounts.

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
│   ├── 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

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,
};

License

This repository is licensed under the MIT License.