rusty-crewmates / substrate-tutorials Goto Github PK

View Code? Open in Web Editor NEW

131.0 3.0 107.0 241 KB

A collection of exercices to teach yourself Substrate

License: Apache License 2.0

Rust 99.51% Dockerfile 0.49%

substrate tutorials blockchain rust

substrate-tutorials's Introduction

Exercises to learn substrate

Who is this tutorial for?

This tutorial is for developers willing to learn the basics of Substrate development and broaden their skillsets through real-world use cases.

You will need a solid grasp of the Rust programming language before you start to learn Substrate.

Some good entry points to learning Rust 📚

As officially referred to here, the best paths to get started with Rust are:

The Rust Book (aka "The Book"): the official manual, which is very well written and approachable.
The Rustlings git repository: a thorough series of exercises.
The Rust by examples documentation.

And of course, you should always challenge yourself with a side project or two.

What is Substrate?

Substrate can be described as a blockchain framework — specifically, a framework for building customized blockchains. It is built on the Rust programming language, which makes use of novel design patterns to enable the development of code that is safe and fast.

To give some context, Polkadot is a layer-0 protocol and multichain network laying the foundation for the future of Web3. Substrate is the primary blockchain SDK used by developers to create the parachains that make up the Polkadot network.

How to train?

fork this repository
clone it on your machine
code until all tests pass

If you want to run your pallet in a real runtime, you can easily edit the substrate-node-template and add your pallet to its runtime.

What's in those exercises?

We designed the exercises to teach you:

how to use the numerous features of Substrate
some good Substrate practices
some blockchain core principles

If you are stuck, you can always check the solution branch. It's not cheating, just learning 🧑‍🎓

Thanks to our sponsors

This tutorial is made possible thanks to a grant from the Web3 Foundation. Thanks a lot to them!

substrate-tutorials's People

Contributors

Stargazers

Watchers

Forkers

22388o bbenzikry nihadsopaj sbdiarra gdnathan voidwizid andropixels mahmudsudo p00pcvm realnimish lopeselio knzeng-e phonbopit herou jakerumbles ical10 martinloesethjensen mrisholukamba bmacer tracysalander nampc1 ydebaz rogerjbos nadongjun bmorphism sha888 dinhthor gflow33 haider-ali-ds haideralicode roduquen atlaspilotpuppy asiniscalchi teke-pixel asofyan andreymgn bredamatt lrazovic vvandenb cuteolaf w3f-grants-archive 0xti4n nzt48 dkamenetsky tlacloc oyelowo bloppan gfox1 hgminerva taylor-shift oleksandr-code ivanproskuryakov arthur-cw a-moreira happyhackerbird thea-leake palozano raj-rr1 noormohammedb crackthecode016 davidesilva ftupas mr-abims makluganteng dbejarano820 tekkac ame1ma godspower-eze yvchen223 tomaszwaszczyk aksaray68686868 cekingx yogalholic dungnguyen-art lilyanb tidus91 aniketpr01 juul-mc-goa ramandabhijana akhiln28 harryobas ratimon zuko-firelord gangov pangan21 xdrkush doug-c markxueyuan m-bln srivasd96 gerson2102 ronnie-ahmed fabrobles92 cbiniamow vpin09 psyfercom awaisshah228 francom564 kartikkanugo ltfschoen

substrate-tutorials's Issues

Add these tutorials to Polkadot.Study

To make these tutorials more visible, it would be neat to have them included in polkadot.study.

Cc @niklasp / [email protected]

Informations and comments

Maybe add instructions, at least a little, not giving solution but lead of what to do.

Update solution branch with code from milestone-commits

Commits to cherry-pick (might have conflict to resolve, we should only keep documentation update, and test updates):

91a63bb

Build fails due to old substrate-node-template version

machine: aarch64-darwin

Just forked and cloned the repo and tried to the run the tests:

$ cargo t
...
   Compiling k256 v0.10.4
   Compiling num-rational v0.4.1
   Compiling num-complex v0.4.2
   Compiling approx v0.5.1
   Compiling rawpointer v0.2.1
   Compiling frame-support-procedural-tools v4.0.0-dev (https://github.com/paritytech/substrate.git?branch=polkadot-v0.9.22#616d33ea)
   Compiling matrixmultiply v0.3.2
   Compiling nalgebra-macros v0.1.0
   Compiling primitive-types v0.11.1
error[E0603]: module `group` is private
   --> /Users/afm/.cargo/git/checkouts/substrate-7e08433d4c370a21/616d33e/frame/support/procedural/tools/src/syn_ext.rs:50:53
    |
50  |                 let syn::group::$name { token, content } = syn::group::$parse(input)?;
    |                                                                 ^^^^^ private module
    |
note: the module `group` is defined here
   --> /Users/afm/.cargo/registry/src/github.com-1ecc6299db9ec823/syn-1.0.107/src/lib.rs:308:1
    |
308 | mod group;
    | ^^^^^^^^^

error[E0603]: module `group` is private
   --> /Users/afm/.cargo/git/checkouts/substrate-7e08433d4c370a21/616d33e/frame/support/procedural/tools/src/syn_ext.rs:50:14
    |
50  |                 let syn::group::$name { token, content } = syn::group::$parse(input)?;
    |                          ^^^^^ private module
    |
note: the module `group` is defined here
   --> /Users/afm/.cargo/registry/src/github.com-1ecc6299db9ec823/syn-1.0.107/src/lib.rs:308:1
    |
308 | mod group;
    | ^^^^^^^^^

For more information about this error, try `rustc --explain E0603`.
error: could not compile `frame-support-procedural-tools` due to 2 previous errors
warning: build failed, waiting for other jobs to finish...

I've seen this error before when building older versions of Substrate.
I can fix this by upgrading version to polkadot-v0.9.28 in the exercises.

Renaming storage type

The storage Account, is confusing as it is an amount of type u128 that is stored and binded to an AccountId.

Code improvement as per FRAME v3

This code in exercise-0 needs to be changed as per FRAME v3.

File (code referenced): https://github.com/rusty-crewmates/substrate-tutorials/blob/main/exercises/ex00-testing/flipper/src/lib.rs#L18-20

Before:

After:

Exercises ideas

Here is a list of ideas for new exercises.

Genesis config
Runtime benchmark and weight: we need to teach how to write and run the runtime benchmarks along with all the different way a weight can be calculated for an extrinsic
Offchain workers
Imbalances

404 Links in Exercises 0 and 7

Hey 👋 It seems that some links in Exercises 0 and 7 are pointing to some 404 pages.

Exercise 0:

Exercise 7:

Mint not check if added to account in ex03

Hi in the exercice 03 nft, there is no check in mint if tokens are added to account

New Substrate doc links needed (maybe)

Hey @gdnathan and others: substrate-developer-hub/substrate-docs#1132

all older links now are likely useless redirects, please scan & update 🙏 happy to help if you can't find something you need, please open an issue on the docs themselves for a missing/broken link

Originally posted by @nukemandan in #12 (comment)

Unable to test individual exercises via script on non-aarch64 machines

Sending build context to Docker daemon  2.121GB
Step 1/3 : FROM tdelabro/rusty-crewmates-substrate-tutorials:latest
 ---> 23262fd19c33
Step 2/3 : ADD ./exercises/ex00-writing-tests/  /home/substrate-tutorials/./exercises/ex00-writing-tests/
 ---> Using cache
 ---> 12d2b8623cde
Step 3/3 : CMD ["cargo", "test", "--manifest-path", "/home/substrate-tutorials/Cargo.toml"]
 ---> Using cache
 ---> de7d38fc8bcb
Successfully built de7d38fc8bcb
Successfully tagged substrate-test-exercise:latest
WARNING: The requested image's platform (linux/arm64/v8) does not match the detected host platform (linux/amd64) and no specific platform was requested
docker: Error response from daemon: failed to create endpoint sharp_meitner on network bridge: failed to add the host (vethbfda3cd) <=> sandbox (veth9f069ae) pair interfaces: operation not supported.

I've tried different altering the run_one_excersice_tests.sh script with different --platform switches but no avail...I guess this script was only intended for people with M1 Macs? 0.0

Fix links

It appears maybe due to the substrate docs update, some of the links in https://github.com/rusty-crewmates/substrate-tutorials/tree/main/exercises/ex00-writing-tests are not working properly. I'll like to go through the effort of replacing the links to the proper location.