The goal of this quest is to practice interactive with smart contracts on Flow. In this quest we will be interacting with the Yearbook contract. The theory behind this contract (as well as some introductory Cadence concepts) are covered in THEORY.md.
This README contains a practical quest. Anyone who completes this quest will receive a Soulbound Proof-of-Knowledge NFT.
- Create a Testnet Account
- Interact with a smart contract
-
- Sign transactions (mutate the chain)
-
- Execute scripts (query the chain)
- Learn how to use Flow CLI, an essential tool as a Flow developer
- Create a testnet account on Flow
- Send a transactions, such as signing the 'Flow Yearbook'!
All quest completionists will receive a super exclusive soulbound proof-of-knowledge NFT. Aside from bragging rights, this special NFT will grant access to completion-gated channels in the official Flow Discord.
Note: The NFT type we are using (FLOATs) is supported by Instagram, so if the feature has been rolled out to your account, you’ll be able to share your accomplishment with your friends, family and colleagues.
Everyone! You don't need any pre-requisites :) Jump right in!
Assuming you know the basics of a command line, it will take approximately 15 minutes!
Install/Update the Flow CLI: you will need the Flow CLI to complete this quest. Visit the Flow CLI Installation documentation and follow the instructions. You simply need to run a single command in your terminal to install it. If you already have it installed, make sure it’s the latest version (check that page for updating instructions).
Clone this repo (optional): This repo already provides the completed transactions and scripts in order to complete the quest. The recommended way to follow along is to clone the repo. Alternatively, you can download the repo or follow along by creating the necessary files manually. You can clone the repo by using this command:
git clone https://github.com/onflow/flow-101-quest
cd flow-101-questOnce you are in your working directory, we'll initialize the Flow CLI and configure it in order to query Testnet.
flow init
You should see something like this:
Configuration initialized
Service account: 0xf8d6e0586b0a20c7
Start emulator by running: 'flow emulator'
Reset configuration using: 'flow init --reset'
Before we can sign the yearbook, we'll need our own account! Luckily for us, we just need to run a simple command with the Flow CLI.
flow accounts create
Here's what the process looks like:
Name your new account hero and hit Enter. Follow the rest of the instructions on screen.
Enter an account name: hero
💡 You can pick any name, we are trying to keep the instructions in line with your experience. If you would decide to name your account differently, please use that name everywhere we refer to
heroaccount and address.
Scroll down once to select Flow Testnet, then hit Enter
Use the arrow keys to navigate: ↓ ↑ → ←
? Choose a network:
Local Emulator
▸ Flow Testnet
Flow Mainnet
You'll then get presented with a confirmation step. Type y and hit Enter.
✔ Flow Testnet
❗ This command will perform the following:
- Generate a new ECDSA P-256 public and private key pair.
- Save the private key to hero.private.json and add it to .gitignore.
- Create a new account on Flow Testnet paired with the public key.
- Save the newly-created account to flow.json.
? Do you want to continue? [y/N] y
Please complete the following steps in a web browser:
1. Complete the captcha challenge.
2. Click the 'Create Account' button.
3. Return to this window.
✔ Press <ENTER> to open in your browser...: █
Once you press Enter, your browser will be automatically directed to the Flow Testnet Faucet with your account information pre-populated.
The only actions that is required are:
Please complete the following steps in a web browser:
1. Complete the captcha challenge.
2. Click the 'Create Account' button.
3. Return to this window.
You can also navigate to the link manually: https://testnet-faucet.onflow.org/?key=<key_that_is_pre_populated>
Waiting for your account to be created, please finish all the steps in the browser...
🎉 New account created with address 0xebeb17c521a0d375 and name hero.
Here’s a summary of all the actions that were taken:
- Added the new account to flow.json.
- Saved the private key to hero.private.json.
- Added hero.private.json to .gitignore.
After you finish all the steps, you will notice that 2 new files are now present in the directory:
flow.jsonhero.private.json
The Flow CLI automatically created a configuration file for us (flow.json) that references the second file hero.private.json. This file contains our private key from our newly created testnet account. This file is automatically added to the .gitignore so you don't accidentally leak any credentials!
If you inspect the files, you should see the address and private key for your freshly minted account 👍!
The official Flow Yearbook contract is already deployed to Testnet, so in this quest we'll simply be interacting with it from the command line, via the Flow CLI. You can view it on Flow View Source (one of Flow's contract explorers). Click here to view the contract. Alternatively, check the THEORY.md file for context on how the contract works.
In this quest, we'll be skipping the theory and showing you how to interact with scripts and transactions via the Flow CLI. Let's go!
First let's take a look at our first transaction. If you cloned the repo, you'll find it in cadence/transactions/init-account.cdc. Otherwise, just create a file called init-account.cdc and paste the content with following Cadence code:
import YearbookMinter from 0x63ffd70144f80d07
transaction {
prepare(signer: AuthAccount) {
// checks if we have a yearbook resource in our account
let yearbookExists = signer.getCapability(YearbookMinter.publicPath)
.check<&YearbookMinter.Yearbook>()
// if it doesn't find one, let's create a new one.
if(!yearbookExists){
let book <- YearbookMinter.createYearbook(ownerAddress: signer.address)
signer.save(<-book, to: YearbookMinter.storagePath)
signer.link<&YearbookMinter.Yearbook>(YearbookMinter.publicPath, target: YearbookMinter.storagePath)
}
}
}Now we will use the Flow CLI to send this transaction and sign it with our hero account
flow transactions send ./cadence/transactions/init-account.cdc --signer=hero --network=testnet
NOTE: This command will only work if you cloned the repo, since the file
./init-account.cdcis located in./cadence/transactions/. Based on where you are in the directory, update the path in the command above accordingly. For example, if you created the file in the home directory of the repo, you should use./init-account.cdcinstead in the command above.
Let's dissect this script:
--signer flag will tell the CLI to use your hero profile as a signer
--network flag will specify which network we are interacting with - in this case we are using Testnet
This step initiates your account and creates a Yearbook resource if it doesn't exist yet.
Pro Tip 👉 every time you run a transaction, the Flow CLI will poll until the transaction status is sealed, which means it is fully committed to the chain. So once a transaction finished, make sure to check the outcome of command by scrolling up and checking that it says "Status ✅ SEALED" and no other errors.
To keep things civil, we limited the messages that people can leave on each others' yearbooks. You'll need to specify a message key instead of a custom message. Let’s get a list of available keys and corresponding messages.
If you cloned the repo, you'll find the next file in cadence/scripts/get-message-keys.cdc. If you're creating them from scratch, create a file called get-message-keys.cdc and paste the following Cadence code:
import YearbookMinter from 0x63ffd70144f80d07
pub fun main(): {String: String} {
return YearbookMinter.allowedMessages
}Execute the script with the following Flow CLI command:
flow scripts execute ./cadence/scripts/get-message-keys.cdc --network=testnet
NOTE: This command will only work if you cloned the repo, since the file
./init-account.cdcis located in./cadence/scripts/. Based on where you are in the directory, update the path in the command above accordingly. For example, if you created the file in the home directory of the repo, you should use./get-message-keys.cdcinstead in the command above.
This will give you a list of keys:
"hello": "Hello",
"bff": "You are the best friend anyone could ask for!",
"cya": "See you around",
"gator": "Later, aligator!",
"fun": "You make my life fun!"Pick your favorite, and now let's leave a message in the main Flow Yearbook!
In order to sign the Flow Yearbook, you will need to submit a transaction.
- Flow Yearbook Testnet Address:
0x63ffd70144f80d07
To sign the yearbook, we'll be executing the code below. If you cloned the repo, you'll find the file in cadence/transactions/sign-yearbook.cdc. If you're creating them from scratch, create a file called sign-yearbook.cdc and paste the following Cadence code:
import YearbookMinter from 0x63ffd70144f80d07
transaction(yearbookOwner: Address, messageKey: String){
prepare(signer: AuthAccount){
// borrow the public reference & capability to the Yearbook at the address specified
let yearbookReference = getAccount(yearbookOwner)
.getCapability(YearbookMinter.publicPath)
.borrow<&YearbookMinter.Yearbook>()
?? panic(YearbookMinter.errNoYearbook)
// sign the yearbook
yearbookReference.leaveMessage(signer: signer.address, messageKey: messageKey)
}
}This transaction takes two arguments:
yearbookOwner- the address of the Yearbook owner we are trying to modifymessageKey- the message key we’ve just discussed
To run this transaction, use the following command. We are using the fun message key as an example, feel free to choose your favorite from the list in the previous section.
flow transactions send ./cadence/transactions/sign-yearbook.cdc 0x63ffd70144f80d07 fun --signer=hero --network=testnet
NOTE: This command will only work if you cloned the repo, since the file
sign-yearbook.cdcis located in./cadence/transactions/. Based on where you are in the directory, update the path in the command above accordingly. For example, if you created the file in the home directory of the repo, you should use./sign-yearbook.cdcinstead in the command above.
Additionally you can also read all previous messages left by other heroes - both from your and others' accounts.
To do this, we'll use the get-messages.cdc script file, which you will find in cadence/scripts/. Otherwise create it from scratch and paste in the following Cadence code:
import YearbookMinter from 0x63ffd70144f80d07
pub fun main(owner: Address): {Address: String}{
// get a reference to the yearbook
let yearbookReference = getAccount(owner)
.getCapability(YearbookMinter.publicPath)
.borrow<&YearbookMinter.Yearbook>()
?? panic(YearbookMinter.errNoYearbook)
// return its messages
return yearbookReference.messages
}Let’s check our Yearbook and see who left messages there:
flow scripts execute ./cadence/scripts/get-messages.cdc 0x63ffd70144f80d07 --network=testnet NOTE: This command will only work if you cloned the repo, since the file
get-messages.cdcis located in./cadence/scripts/. Based on where you are in the directory, update the path in the command above accordingly. For example, if you created the file in the home directory of the repo, you should use./get-messages.cdcinstead in the command above.
You should be able to see a list of addresses and corresponding messages, they have left in our Yearbook.
You can also update that 0x63ffd70144f80d07 to your own address - which can be found within hero.private.json file and check who left messages in your Yearbook. If you don't have any messages, you can create another testnet account and try leaving one, or share this with a friend and get them to leave a message! :)
In order for us to deliver your Soulbound proof-of-knowledge NFT (FLOAT), you will need to send us your Mainnet account address. The easiest way is via Float City webpage - which will also help to initialize your account with FLOAT Collection.
- Visit https://floats.city
- Click on “Connect Wallet”
- Login with the wallet of your choice (choose wisely! This is where you will receive your FLOAT! If you want to show this off on Instagram, choose Dapper)
- Click on the address in the top right
- Copy the Address from the “Account” tab (this is your mainnet account!)
- Important: On the "Account" tab, make sure to click on "Setup Account" if this is your first time receiving/using FLOATs.
Congratulations on sending your first transactions on Testnet and utilizing Flow CLI commands! You're well on your way to becoming a proficient developer on Flow. In order to receive your soulbound Proof-of-Knowledge NFT, please fill out the form with the following information:
- Testnet Account Address (to verify your work - you'll find this in your
hero.private.jsonfile) - Mainnet Account Address (to receive the FLOAT)
- Email Address (so we can reach out for SWAG!)
Verification process will be automatically processed every week and you can expect to see your FLOAT in your account within a week's time of your form submission
You've completed the quest. Now what? Well, something you should attempt doing is building a dapp around the Yearbook. Wondering how to do that? Here's a list of resources you should explore as next steps:
- Emerald Academy - Hello World Dapp Challenge
- Emerald Academy - Simple NFT Dapp Challenge
- Emerald Academy - Simple Fungible Token Challenge
- Buildspace - Flow Track
- LearnWeb3 - Flow Track
Be sure to reach out if you have any questions!