Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 5.38 KB

README.md

File metadata and controls

69 lines (41 loc) · 5.38 KB
Raw

Rust State Machine

This repository is the basis for a tutorial teaching how to develop a simple state machine using Rust.

Goal

The goal of this tutorial is to teach by experience various entry level concepts around Rust and blockchain development.

This tutorial is opinionated, and heavily influenced by the Polkadot SDK, Substrate, and FRAME. However, everything in this tutorial is written from scratch and built without using these libraries.

The tutorial is designed with the hope that readers who complete it will have a better understanding of what is happening behind FRAME and will feel more capable of using the Polkadot-SDK successfully.

This tutorial will teach and review many Rust concepts, however it is not a replacement for a primary Rust education course. It is recommended, before you even start this tutorial, that you are already familiar with the concepts taught in the first 11 chapters of the Rust Book.

How To Use

This repository is not meant to be used directly, but as the source for generating an interactive tutorial using the source code and readme files included at each commit.

This repository manages 3 branches, each with its own history and purpose:

  • master: This is an expanded version of each step and file of the tutorial. Each step has its own full source code and README which is used for that step in the tutorial.
  • gitorial: This branch repackages all the steps of the tutorial into a single Git history. You can actually take a look at the history of the gitorial branch, and see how each steps evolves using the Git diff.
  • mdbook: This is a special repackaging of the tutorial for generating an mdBook that can be directly used by students.

If you have small changes that need to be made to a single step, feel free to open an issue or make a PR against the master branch. However, for more complex changes which may affect multiple steps, consider learning more about the gitorial format.

More about Gitorial

The heart of this tutorial is the Gitorial format.

If you browse the commit history of the gitorial branch, you will see that each commit is designed to be a single step in the tutorial.

All commits are prefixed with one of:

  • section: This denotes the beginning of a new set of steps which will have a specific goal. These commits will only have changes to the README.md file which can be used to introduce the new section of the tutorial.
  • template: This is the commit has a README.md that teaches the reader any information needed to complete the step. It will also include files with TODO comments, telling the user what specifically needs to be done. A template will always be followed by a solution.
  • solution: These commits will always come after a template commit. These commits will have the final state of all files in the project at the end of a step. Commits prefixed with solution should always compile, run and test successfully (compiler warning are okay). The template and solution commits should be presented together so reads can compare their work to a working solution. These commits can also be used to generate a diff of the step. The README.md file in this commit does not need to be presented to the user.
  • action: This denotes a step in the tutorial where the user needs to complete some action, not necessarily write any code. For example, the user might need to import a new crate. In this case, it does not make sense to have a template and solution, but just the final outcome after the action was taken. The previous commit can be used for generating a diff. The README.md file should contain any information the user needs to complete the action successfully.
  • readme: This is only applied to the last commit in this repo, and denotes that this commit was specifically for make a README.md for users that browse this repository on github. This step should not be used in the tutorial generation.

You can use Git to make changes to the history of the repo, and then use git merge to propagate those changes cleanly into the rest of your repo.

Maintenance

Maintaining the repo means keeping all three of the main branches in sync.

For this, you can use the gitorial-cli.

Once you have made changes to the appropriate branch, you can use these commands to get all branches in order:

  • Convert master to an up to date gitorial branch:

    gitorial-cli repack -p /path/to/rust-state-machine -i master -s steps -o gitorial2

    Then check your work, and git reset --hard the gitorial branch with gitorial2.

  • Convert gitorial to an up to date mdbook branch:

     gitorial-cli mdbook -p /path/to/rust-state-machine -i gitorial -o mdbook

  • Convert gitorial to an up to date master branch:

     gitorial-cli unpack -p /path/to/rust-state-machine -i gitorial -o master -s steps