Skip to content

Commit

Permalink
mdBook generated from gitorial
Browse files Browse the repository at this point in the history
  • Loading branch information
shawntabrizi committed Aug 3, 2024
1 parent 5394c0e commit 1349a13
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
8 changes: 4 additions & 4 deletions src/0/source/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Welcome to the new Substrate Collectables Workshop.

The goal of this tutorial is to **teach by experience** various entry level concepts around Polkadot Pallet development.
The goal of this tutorial is to **teach by experience** various entry level concepts around developing on [Polkadot](https://polkadot.network/).

Before we get started writing code, we will need to cover some basics.

Expand Down Expand Up @@ -43,11 +43,11 @@ cd substrate-collectables-workshop

Or access the template directly here:

https://github.com/shawntabrizi/substrate-collectables-workshop/releases/tag/starting-template
[https://github.com/shawntabrizi/substrate-collectables-workshop/releases/tag/starting-template](https://github.com/shawntabrizi/substrate-collectables-workshop/releases/tag/starting-template)

We will go over the starting template in detail throughout this section, but don't be afraid to peek around yourself.
The starting template includes a `README` with instructions to setup your working environment. Follow those instructions.

Make sure your checks pass on this initial template without warning or errors:
Make sure you are able to run the following checks on this starting template without warnings or errors:

```bash
cargo +nightly fmt
Expand Down
22 changes: 20 additions & 2 deletions src/1/source/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,28 @@ Our starting template for this tutorial uses the [Polkadot SDK](https://github.c

This is the same technology stack used to build and power the [Polkadot Network](https://polkadot.network/).

To better understand what you will be doing in this tutorial, we need to give you a high level overview of the blockchain ecosystem to make sure we are all on the same page.
To better understand what you will be doing in this tutorial, we need to start with a high level overview of blockchains.

## Blockchain

Blockchains are the foundation of building Web3 technologies.

Web3 is a promise toward a world with less trust, and more truth.

Through blockchains, people are able to develop and deploy software that are decentralized, open, permissionless, censorship resistant, and independently verifiable.
Through blockchain technology, we are able to develop and deploy software that are decentralized, open, permissionless, censorship resistant, and independently verifiable.

The main purpose of a blockchain node is to come to consensus with other nodes on the decentralized network.

<details>

<summary>Deep Dive</summary>

If you want to learn more about blockchains, check out the following video from the Polkadot Blockchain Academy:

<iframe width="560" height="315" src="https://www.youtube.com/embed/8UvdfFGYFiE?si=5PIyppVBZ91vUtjf" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

</details>

## Runtime

At the heart of a blockchain is a [state transition function](https://en.wikipedia.org/wiki/Finite-state_machine) (STF).
Expand All @@ -30,10 +36,16 @@ In the `polkadot-sdk` we refer to this logic as the blockchain's runtime.

All nodes on a blockchain network have and use the same runtime, allowing them to come to consensus about changes to a blockchain.

<details>

<summary>Deep Dive</summary>

To learn more about the runtime, and its role inside of the `polkadot-sdk`, check out this video from the Polkadot Blockchain Academy:

<iframe width="560" height="315" src="https://www.youtube.com/embed/-ttmm8gYS04?si=ZH_g83CVtguENoK7" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

</details>

## Pallets

The `polkadot-sdk` provides a developer framework called FRAME.
Expand All @@ -52,10 +64,16 @@ You can think of different Pallets as different applications or functions that y

You can also think of Pallets very similar to traditional blockchain smart contracts, however Pallets are more powerful and execute much faster than smart contracts.

<details>

<summary>Deep Dive</summary>

To learn more about FRAME and Pallets, check out this video from the Polkadot Blockchain Academy:

<iframe width="560" height="315" src="https://www.youtube.com/embed/ghMloMzEEsA?si=3DtsmrYOapbnR2oy" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

</details>

## NFTs

Non-Fungible Tokens (NFTs) are a type of token which can be created and traded on a blockchain.
Expand Down

0 comments on commit 1349a13

Please sign in to comment.