Skip to content

Latest commit

 

History

History
220 lines (190 loc) · 11.8 KB

README.adoc

File metadata and controls

220 lines (190 loc) · 11.8 KB

The Starknet Book

Work in Progress and Community Contributions

Important
The Starknet Book is a work in progress, and its content is rapidly evolving as the community contributes to its development. As a result, some sections may be incomplete or contain information that is still green. We highly encourage readers to contribute by suggesting improvements, providing feedback, or submitting new content to help us expand and refine the book. Your contributions are invaluable in making The Starknet Book a comprehensive and reliable resource for the community.

Welcome

Welcome to the Starknet Book!

The Starknet Book is a curriculum created to teach the Cairo programming language and Starknet development. It is divided by Chapters and built by the Starknet community (you!). Finish the resume and you will conquer the Ethereum world.

Contents

Chapter

Goal

1: Getting Started

Learn how to deploy and interact with smart contracts using the CLI.

2: Smart Contracts in Cairo

Write a Cairo smart contracts.

3: Tooling

Set up a development environment and perform complex deployments.

4: Testing

Test smart contracts in a local environment, and write unit and integration tests.

5: Frontend

Integrate Starknet with a React frontend using starknet.js.

6: Running a Node

Set up and run a Starknet node and indexer.

7: Account Abstraction

Understand user accounts and create custom accounts.

8: Starknet Architecture

Explore transaction lifecycle, fees calculation, Prover and Verifier interaction, and more.

9: Cairo Architecture

Dive into the Cairo virtual machine, memory model, opcodes, and compiler.

10: STARKs

Understanding STARKs and how they connect with other aspects of Starknet.

Where to Start?

Depending on your goals and interests, you can choose different paths through the Starknet Book. Here are some recommendations based on various objectives:

  • If you’re a complete beginner and want to start learning about Cairo and Starknet from scratch, follow the book in its entirety, starting with Chapter 1: Getting Started.

  • If you’re an experienced developer looking to quickly dive into writing scalable and decentralized smart contracts, focus on Chapters 1 and 2.

  • If you’re a frontend developer wanting to integrate Starknet with a React frontend, prioritize Chapter 5: Frontend after covering the basics in Chapters 1 and 2.

  • If you’re a DevOps engineer or node operator interested in running a Starknet node and indexer, head straight to Chapter 6: Running a Node.

  • If you’re a security researcher or smart contract auditor wanting to learn about the Account Abstraction feature and its implications, go for Chapter 7: Account Abstraction.

  • If you’re a blockchain enthusiast curious about the underlying architecture and mechanics of Starknet and Cairo, explore Chapters 8 and 9.

  • If you’re a cryptography expert or researcher eager to understand the fundamentals of STARKs and their connection to the Starknet ecosystem, delve into Chapter 10: STARKs.

Feel free to mix and match these paths based on your unique interests and requirements.

Your Contributions Matter

We’re thrilled to have you join us on this incredible journey to create the ultimate resource for Cairo and Starknet development. By contributing to the Starknet Book, you’re not only sharing your knowledge and expertise with the world, but you’re also helping shape the future of decentralized technology. Together, we’ll build a comprehensive, accessible, and engaging curriculum that will empower developers everywhere to harness the full potential of Starknet.

As a contributor, you’ll be part of a vibrant and growing community dedicated to pushing the boundaries of what’s possible with decentralized technology. You’ll have the opportunity to collaborate with like-minded individuals from around the globe, share your unique insights, and learn from one another. Your contributions will not only enrich the Starknet community but also leave a lasting impact on the broader field of blockchain technology.

So, are you ready to embark on this epic adventure? Let’s dive in and explore the vast and exciting world of Starknet together. Here’s to the countless discoveries, breakthroughs, and innovations that await us!

Please refer to the existing Contributors Guide for detailed instructions on how to contribute. Remember, every contribution, no matter how small, makes a difference. Your expertise and passion are invaluable in helping us create a truly exceptional resource for the Starknet community. Let’s make history together!

Here are things you can do to help:

  • In most sections there is a message for builders who want to collaborate with content.

  • Empty section in a Chapter? Go for it!

  • Do you think the Starknet Book needs an additional section? Propose it.

  • Can a section be improved? Feel free to modify it.

  • Do you want to add an alternative programming language for the examples? Yes please.

  • Correct the bugs if you find any.

  • Please add an explanation in the exercise comments if you feel they need them.

  • Add exercises that show your favorite feature of Cairo.

Additional Key Educational Resources

We’ve compiled a list of valuable educational resources that will help deepen your understanding and enhance your skills in coding with Cairo and staying abreast with Starknet developments:

  1. Starklings: A resource specifically designed to guide you through learning Cairo programming, ensuring that you reach a proficient level. You can access it here.

  2. Starknet Community Forum: An online platform where you can engage in discussions about the latest developments in Starknet. Join the conversation here.

  3. Starknet Documentation: You can browse through the documentation here.

  4. Cairo Documentation: Explore it here.

  5. Starknet Developer Telegram (English): A community for English-speaking Starknet developers. This is a great platform for networking, sharing ideas, and troubleshooting together. Join us on Telegram here.

Starknet Book Authors ✨

We extend our sincere gratitude to these exceptional individuals who have made invaluable contributions to the Starknet Book:

4755430?v=4&s=100

Omar Espejel

113911244?v=4&s=100

James Stark

16685321?v=4&s=100

Dr Spaceman

27683905?v=4&s=100

Gyan

22731646?v=4&s=100

Henri

2279046?v=4&s=100

David Barreto

30735581?v=4&s=100

Remedcu

73983677?v=4&s=100

Omahs

70894690?v=4&s=100

Lucas @ Starkware

33158502?v=4&s=100

Qd-Qd

12909374?v=4&s=100

Oboulant

63842643?v=4&s=100

Code Whizperer

2437994?v=4&s=100

Avi Mak

36516516?v=4&s=100

Robert Kodra

49245208?v=4&s=100

Manmit Singh

85268534?v=4&s=100

Lvis Wang

98833290?v=4&s=100

Leablock

113949669?v=4&s=100

Carlos Lira

21693926?v=4&s=100

Artur Vargas

126797224?v=4&s=100

Lorcan-codes

117481421?v=4&s=100

Devnet0x

2848732?v=4&s=100

Ivan Pavičić

67330943?v=4&s=100

Raphael Ndonga

114395459?v=4&s=100

Asten

35219743?v=4&s=100

Trangnv

102651969?v=4&s=100

0xKubitus

12902455?v=4&s=100

Evolve Art

112663528?v=4&s=100

Nadai

30095502?v=4&s=100

Prince Anuragi

876976?v=4&s=100

Ccolorado

95504156?v=4&s=100

Diego Hermida

105909776?v=4&s=100

0x180db

11048263?v=4&s=100

Shramee Srivastav

31094102?v=4&s=100

Santala

13951843?v=4&s=100

Satyam Bansal

25623039?v=4&s=100

Zé Diogo

106890011?v=4&s=100

Pikkuherkko

2940022?v=4&s=100

Davide Silva

22482966?v=4&s=100

Leapalazzolo

65915812?v=4&s=100

Keivin

87354252?v=4&s=100

lambda-0x

22297601?v=4&s=100

David Lange