Hello Starknet community, This repository is not updated with the latest Cairo syntax and hence, we do not recommend to attempt this tutorial as of today. If you are interested in contributing to the repository to update the tutorial, please comment on the below issue to pick up a task. You can find more details about the issue and exercises breakdown here: #61
You can also ping me(@gyanlakshmi) or Omar(@omarespejel) on Telegram to tag you on the right tasks.
- A Simplified Chinese version is available here.
- A Spanish version is available here.
- (not updated) A Portuguese version is available here.
- (not updated) A Korean version is available here.
Welcome!
This tutorial is made for developers who are interested in learning how to read Cairo 1 code and Starknet smart contracts. By following it, you'll be able to get started in no time. Have fun!
Welcome to Starknet, a general-purpose Validity Rollup on top of Ethereum mainnet. Starknet is a layer 2 scaling solution that lets developers build decentralised applications without compromising on security, scalability and decentralization.
This workshop is designed to help you read Cairo 1 code and Starknet smart contracts, and understand their syntax. Don't worry, you don't need to code or install anything on your machine to follow and complete it. You can do it all from your browser.
The exercises are a set of smart contracts deployed on Starknet Alpha on testnet. Each smart contract is an exercise/puzzle that outlines a feature of the Cairo Smart contract language.
Completing the exercises will earn you points in the form of an ERC20 token. The token does not have any monetary value, but it's a fun way to track your learning progresses.
We hope you have fun participating in this workshop!
- How to read Cairo 1 code
- How to read Starknet smart contracts
- How to interact with Starknet smart contracts using a browser wallet and a block explorer.
Don’t expect any benefit from using this other than learning some cool stuff about Starknet, the first general-purpose Validity Rollup on the Ethereum mainnet.
To complete the tutorial, you need to collect points. You will own these points through your Starknet wallet.
- The easiest way to set one up is to use Argent X (download the chrome extension or check their repo) or Braavos (download the chrome extension). These wallet solutions are for Starknet what Metamask is for Ethereum. They allow users to initiate transactions and interact with applications on Starknet.
- Follow the instructions in your wallet app to install the extension. It may take approximately 5 minutes for the account to be deployed. Note that in Starknet, there is only one type of account: smart contract accounts. To create a new wallet, you need to send a transaction that publishes your smart contract wallet to the network.
- Make sure you are on the Goerli testnet network.
- The tutorial’s points are held in contract
0x044f65adbdb59bf1db71e8b69efb7c9d0b810db94c1730a05fa5751b02d396de(Starkscan link, Voyager link). Click "Add Token" in your installed wallet and add the tutorial contract address so that your points balance appears there. A new token calledSC101(starknet-cairo-101) will appear in your wallet. - To execute transactions on the Goerli Starknet testnet, you will need testnet ETH to pay for gas. You have two options:
To finish this workshop, you have to interact with the exercises/smart contracts through a block explorer.
You can use either Starkscan or Voyager. These are for Starknet what Etherscan is for Ethereum. They allow you to browse the state of the blockchain and view all transactions and their status.
By connecting your wallet to the block explorer, you will be able to send your transactions to the network and interact with the exercises in the tutorial.
When looking for a contract/transaction, always ensure you are on the Goerli version of the Block Explorer. To solve the exercises, access the contract’s functions by using the read/write tab in the explorer.
Each exercise is a separate smart contract. It contains code that, when executed correctly, will distribute points to your address.
To solve an exercise, follow the link below to read its code. Read the comments, and follow the instructions to understand the code. Your goal is to get each exercise to call successfully the function distribute_points(), which will send you ERC20 points.
During validation, exercises often also call validate_exercise(), which records that you completed an exercise and prohibit you from collecting points various times.
Each exercise is deployed on the Goerli testnet, and you will need to interact with them through a Block Explorer. You can find the addresses of the contracts in the table below.
| Topic | Contract code | Contract on Starkscan | Contract on Voyager |
|---|---|---|---|
| General syntax | Ex01 | Link | Link |
| Storage variables, getters, asserts | Ex02 | Link | Link |
| Reading and writing storage variables | Ex03 | Link | Link |
| Mappings | Ex04 | Link | Link |
| Variable visibility | Ex05 | Link | Link |
| Functions visibility | Ex06 | Link | Link |
| Comparing values | Ex07 | Link | Link |
| Recursions level 1 | Ex08 | Link | Link |
| Recursions level 2 | Ex09 | Link | Link |
| Composability | Ex10 | Link | Link |
| Importing functions | Ex11 | Link | Link |
| Events | Ex12 | Link | Link |
| Privacy on Starknet | Ex13 | Link | Link |
| Multicall | Ex14 | Link | Link |
Your points will be credited to your wallet, though this may take some time. If you want to monitor your points count in real-time, you can also check your balance in a block explorer!
- Go to the ERC20 counter on Voyager or Starkscan in the "read contract" tab.
- Enter your address in the
balanceOffunction.
Enjoy the workshop! If you have any questions, feel free to contact us on Discord. We are happy to help!
This project can be made better and will evolve. Your contributions are welcome! Go to the CONTRIBUTING file for more information on how to setup your environment and contribute to the project.
Here are some things that you can do to help:
- Create a branch with a translation to your language
- Correct bugs if you find some
- Add an explanation in the comments of the exercise if you feel it needs more explanation
- Add exercises showcasing your favorite Cairo feature
- Add a new tutorial to the series
This workshop is the first in a series aimed at teaching how to build on Starknet. Checkout out other workshops in the series:
| Topic | GitHub repo |
|---|---|
| Learn how to read Cairo code (you are here) | Cairo 101 |
| Deploy and customize an ERC721 NFT | Starknet ERC721 |
| Deploy and customize an ERC20 token | Starknet ERC20 |
| Build a cross-layer application | Starknet messaging bridge |
| Debug your Cairo contracts easily | Starknet debug |
| Design your own account contract | Starknet account abstraction |
Once you are done working on this tutorial, your feedback will be greatly appreciated!
Please fill out this form to let us know what we can do to make it better.
And if you struggle to move forward, do let us know! This workshop is meant to be as accessible as possible; we want to see if it’s not the case. Do you have a question? Join our Discord server, register, and join channel #tutorials-support.
Are you interested in attending online workshops about dev on Starknet? Subscribe here