Skip to main content

Course Capstone Project

The purpose of this capstone project is to bring something both engaging and informative to the student. You, the student, should be able to build a Substrate pallet in the Substrate Node Template, run it, and modify and view its state in real time.

An honorable mention and inspiration behind this project is Substrate Kitties by Shawn Tabrizi.

Required Functionality - What You Will Build

  • Create an essential foundation for a Sybil-resistant social network with only profiles. The user must meet a set of prerequisites (balance) to join.
  • Teach how to count for Sybil attacks using other pallets.
  • Generating random profile pictures in the runtime.
  • Storing and managing user metadata and unique usernames. All handles are unique - no two usernames can be the same.
  • Learn only bound-constrained metadata for an account. Allow for a person to assign information about themselves, but limit how much information

Project Components

The following will be created as a result of this project:

  1. A runtime pallet, which the student can publish and modify as they will.
  2. An instance of the node template with this pallet integrated.
  3. A simple front end to display all profiles on a network. (optional)

Student Objectives

Note: the project should compile even without these!

  • Fill in a new event
  • Fill in a new dispatchable function
    • Interact with a storage map; both get a value, then set a new one.
    • Use ensure
  • Fill in a new error
  • Write a simple unit test to cover the new event
  • Show but not implement the use of Balances pallet

Substrate Topics Covered

The following Substrate topics and nuances will be covered as a result of this project:

  • Creating a FRAME pallet, adding it to the runtime, and configuring it for the runtime.
  • Learning how different pallet macros operate and work (dispatch, errors, events, storage).
  • Using the dev_mode macro to mitigate fees, but the concept of weight in Substrate will be discussed.
  • Going over the Rust language for each pallet concept.
  • Creating any storage mappings or associations for storing data in the chain
  • Learn how to utilize BoundedVec and the importance of bounded data in general in blockchain development.
  • Learning safe math via the Like or Dislike mechanism to prevent integer overflows. Explain the importance of safe math in the runtime.
  • Creating events for each action taken by a user
  • Learning the importance of error handling and not panicking within a FRAME pallet
  • Interact with pallet_balance through its associated trait, Currency, to check the balance and lock it if needed. Explain the use of BalanceOf<T> and how it works regarding Rust.
  • Loose vs. tight coupling, with loose coupling being used and prioritized.
  • Think through a realistic, real-world scenario of theory to a pallet.