mdBook generated from gitorial

Author: danielbui12

src/0/source/.gitattributes

@@ -1,23 +1,53 @@
-# Introduction to the Rust State Machine
+# Substrate Bitcoin-Like Blockchain Introduction
 
-Welcome to the Rust State Machine tutorial.
+This repository is derived from [Academy-PoW](https://github.com/Polkadot-Blockchain-Academy/Academy-PoW), originally designed as a learning resource. While implementing a Bitcoin-like blockchain, I faced several challenges that required updates and fixes to ensure smooth execution. Additionally, I transitioned the account model from an **Account-based** system to a **UTXO-based** approach. This implementation builds upon the foundational work from **[Building a UTXO Chain from Scratch | Substrate Seminar](https://www.youtube.com/watch?v=XuJmxMMHvDw)**. Inspired by this resource, I aimed to further enhance the project, incorporating my own insights and improvements.  
 
-This is a guided tutorial intended to teach readers the basics of Rust, Blockchain, and eventually the inner workings of the [Polkadot SDK](https://github.com/paritytech/polkadot-sdk).
+## Prerequisites  
 
-It has been my experience that the hardest part of building your first blockchain using the Polkadot SDK is navigating the advance Rust features used by [Substrate](https://github.com/paritytech/polkadot-sdk/tree/master/substrate), and understanding the underlying magic behind various macros which generate code for you.
+Before starting this interactive tutorial, you should have a basic understanding of **Substrate** and **FRAME development**. If you're new to these concepts, it's highly recommended to complete the introductory Substrate tutorials available in the official documentation. For example [Substrate Interactive Tutorial - Polkadot Study](https://polkadot.study/tutorials/interactive-substrate-tutorials-rusty-crewmates/).
 
-This tutorial tries to directly address this by having you build a completely vanilla Rust project which does all the same tricks as the Polkadot SDK, so you know first hand what is going on behind the scenes.
+## Useful Resources
 
-This tutorial does not assume the reader has much previous knowledge about Rust, Blockchain, or the Polkadot SDK, however, this tutorial does not replace a basic introduction of any of those topics.
+Here are some essential resources that will assist you throughout this tutorial:  
 
-It is strongly recommended that before you begin this tutorial, that you at least have read the first 11 chapters of the [Rust Book](https://doc.rust-lang.org/book/).
+- [Set Up Substrate Development Environment](https://docs.substrate.io/install/) – Choose your environment and complete the installation of required packages and Rust.  
+- [Polkadot SDK Documentation](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/index.html) – In-depth reference for the Polkadot SDK.  
+- [Simulating a Substrate Network](https://docs.substrate.io/tutorials/build-a-blockchain/simulate-network/) – Learn how to simulate a network in Substrate.  
+- [Unspent Transaction Output (UTXO)](https://github.com/danielbui12/substrate-bitcoin-like-blockchain/blob/main/docs/utxo/utxo.md) – Understanding UTXO account model.
+- [Proof of Work code breakdown](https://github.com/danielbui12/substrate-bitcoin-like-blockchain/blob/main/docs/pow/code-breakdown.md) – Learn how the Proof of Work code is implemented.
 
-You need not be an expert in all that you read, but it will help to have exposure to all the various topics like: ownership, basic data types, structures, enums, crates, error handling, traits, generic types, and tests.
+By following these resources, you’ll gain a solid foundation in Substrate development, enabling you to make the most of this tutorial. 🚀  
 
-The tutorial is broken into sections which cover specific learning goals for the reader, and can act as good pause points if you need them.
 
-All of the content of this tutorial is open source, free to access, and can be found [here](https://github.com/shawntabrizi/rust-state-machine).
+Overview of Bitcoin-like Blockchain in Substrate we will be building:
 
-If you have suggestions which can improve the tutorial, comments, issues and pull requests are welcome.
+```mermaid
+graph TD;
+    subgraph UTXO_Runtime
+        Timestamp -->|Time trait| Difficulty
+        Block_Author -->|BlockAuthor| UTXO
+        Bitcoin_Halving --> |Issuance| UTXO
+        FRAME_System
 
-Without further ado, enjoy and I hope you learn a ton!
+        subgraph Difficulty
+            Sha3_Difficulty
+            Keccak_Difficulty
+            Md5_Difficulty
+        end
+    end
+
+    subgraph UTXO_Node
+        subgraph Multi_PoW_Consensus
+            Sha3_Algorithm
+            Keccak_Algorithm
+            Md5_Algorithm
+        end
+
+        Tx_Pool
+    end
+
+    Difficulty --> Difficulty_API{{Difficulty API}}
+    Difficulty_API --> Multi_PoW_Consensus
+    UTXO --> Tx_Pool_API{{Tx Pool API}}
+    Tx_Pool_API --> Tx_Pool
+```

src/0/source/README.md

@@ -1,8 +0,0 @@
-diff --git a/.gitattributes b/.gitattributes
-new file mode 100644
-index 00000000..dfe07704
---- /dev/null
-+++ b/.gitattributes
-@@ -0,0 +1,2 @@
-+# Auto detect text files and perform LF normalization
-+* text=auto

src/0/source/changes.diff

@@ -16,7 +16,27 @@
 
 <div class="tab">
 <button class="subtab tablinks file-source file-added active" onclick="switchSubTab(event, 'Cargo.toml')" data-id="Cargo.toml">Cargo.toml</button>
-<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'src/main.rs')" data-id="src/main.rs">src/main.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'LICENSE')" data-id="LICENSE">LICENSE</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'multi-pow/Cargo.toml')" data-id="multi-pow/Cargo.toml">multi-pow/Cargo.toml</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'multi-pow/src/lib.rs')" data-id="multi-pow/src/lib.rs">multi-pow/src/lib.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'node/Cargo.toml')" data-id="node/Cargo.toml">node/Cargo.toml</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'node/build.rs')" data-id="node/build.rs">node/build.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'node/src/chain_spec.rs')" data-id="node/src/chain_spec.rs">node/src/chain_spec.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'node/src/cli.rs')" data-id="node/src/cli.rs">node/src/cli.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'node/src/command.rs')" data-id="node/src/command.rs">node/src/command.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'node/src/main.rs')" data-id="node/src/main.rs">node/src/main.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'node/src/rpc.rs')" data-id="node/src/rpc.rs">node/src/rpc.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'node/src/service.rs')" data-id="node/src/service.rs">node/src/service.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'runtime/Cargo.toml')" data-id="runtime/Cargo.toml">runtime/Cargo.toml</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'runtime/build.rs')" data-id="runtime/build.rs">runtime/build.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'runtime/src/block_author.rs')" data-id="runtime/src/block_author.rs">runtime/src/block_author.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'runtime/src/difficulty.rs')" data-id="runtime/src/difficulty.rs">runtime/src/difficulty.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'runtime/src/issuance.rs')" data-id="runtime/src/issuance.rs">runtime/src/issuance.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'runtime/src/lib.rs')" data-id="runtime/src/lib.rs">runtime/src/lib.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'runtime/src/utxo.rs')" data-id="runtime/src/utxo.rs">runtime/src/utxo.rs</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'rust-toolchain.toml')" data-id="rust-toolchain.toml">rust-toolchain.toml</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'rustfmt.toml')" data-id="rustfmt.toml">rustfmt.toml</button>
+<button class="subtab tablinks file-source file-added" onclick="switchSubTab(event, 'spec.json')" data-id="spec.json">spec.json</button>
 </div>
 <div id="source/Cargo.toml" class="subtab tabcontent active" data-id="Cargo.toml">
 
@@ -26,10 +46,170 @@
 
 </div>
 
-<div id="source/src/main.rs" class="subtab tabcontent" data-id="src/main.rs">
+<div id="source/LICENSE" class="subtab tabcontent" data-id="LICENSE">
+
+```text
+{{#include ./source/LICENSE}}
+```
+
+</div>
+
+<div id="source/multi-pow/Cargo.toml" class="subtab tabcontent" data-id="multi-pow/Cargo.toml">
+
+```toml
+{{#include ./source/multi-pow/Cargo.toml}}
+```
+
+</div>
+
+<div id="source/multi-pow/src/lib.rs" class="subtab tabcontent" data-id="multi-pow/src/lib.rs">
+
+```rust
+{{#include ./source/multi-pow/src/lib.rs}}
+```
+
+</div>
+
+<div id="source/node/Cargo.toml" class="subtab tabcontent" data-id="node/Cargo.toml">
+
+```toml
+{{#include ./source/node/Cargo.toml}}
+```
+
+</div>
+
+<div id="source/node/build.rs" class="subtab tabcontent" data-id="node/build.rs">
+
+```rust
+{{#include ./source/node/build.rs}}
+```
+
+</div>
+
+<div id="source/node/src/chain_spec.rs" class="subtab tabcontent" data-id="node/src/chain_spec.rs">
+
+```rust
+{{#include ./source/node/src/chain_spec.rs}}
+```
+
+</div>
+
+<div id="source/node/src/cli.rs" class="subtab tabcontent" data-id="node/src/cli.rs">
+
+```rust
+{{#include ./source/node/src/cli.rs}}
+```
+
+</div>
+
+<div id="source/node/src/command.rs" class="subtab tabcontent" data-id="node/src/command.rs">
+
+```rust
+{{#include ./source/node/src/command.rs}}
+```
+
+</div>
+
+<div id="source/node/src/main.rs" class="subtab tabcontent" data-id="node/src/main.rs">
+
+```rust
+{{#include ./source/node/src/main.rs}}
+```
+
+</div>
+
+<div id="source/node/src/rpc.rs" class="subtab tabcontent" data-id="node/src/rpc.rs">
+
+```rust
+{{#include ./source/node/src/rpc.rs}}
+```
+
+</div>
+
+<div id="source/node/src/service.rs" class="subtab tabcontent" data-id="node/src/service.rs">
 
 ```rust
-{{#include ./source/src/main.rs}}
+{{#include ./source/node/src/service.rs}}
+```
+
+</div>
+
+<div id="source/runtime/Cargo.toml" class="subtab tabcontent" data-id="runtime/Cargo.toml">
+
+```toml
+{{#include ./source/runtime/Cargo.toml}}
+```
+
+</div>
+
+<div id="source/runtime/build.rs" class="subtab tabcontent" data-id="runtime/build.rs">
+
+```rust
+{{#include ./source/runtime/build.rs}}
+```
+
+</div>
+
+<div id="source/runtime/src/block_author.rs" class="subtab tabcontent" data-id="runtime/src/block_author.rs">
+
+```rust
+{{#include ./source/runtime/src/block_author.rs}}
+```
+
+</div>
+
+<div id="source/runtime/src/difficulty.rs" class="subtab tabcontent" data-id="runtime/src/difficulty.rs">
+
+```rust
+{{#include ./source/runtime/src/difficulty.rs}}
+```
+
+</div>
+
+<div id="source/runtime/src/issuance.rs" class="subtab tabcontent" data-id="runtime/src/issuance.rs">
+
+```rust
+{{#include ./source/runtime/src/issuance.rs}}
+```
+
+</div>
+
+<div id="source/runtime/src/lib.rs" class="subtab tabcontent" data-id="runtime/src/lib.rs">
+
+```rust
+{{#include ./source/runtime/src/lib.rs}}
+```
+
+</div>
+
+<div id="source/runtime/src/utxo.rs" class="subtab tabcontent" data-id="runtime/src/utxo.rs">
+
+```rust
+{{#include ./source/runtime/src/utxo.rs}}
+```
+
+</div>
+
+<div id="source/rust-toolchain.toml" class="subtab tabcontent" data-id="rust-toolchain.toml">
+
+```toml
+{{#include ./source/rust-toolchain.toml}}
+```
+
+</div>
+
+<div id="source/rustfmt.toml" class="subtab tabcontent" data-id="rustfmt.toml">
+
+```toml
+{{#include ./source/rustfmt.toml}}
+```
+
+</div>
+
+<div id="source/spec.json" class="subtab tabcontent" data-id="spec.json">
+
+```json
+{{#include ./source/spec.json}}
 ```
 
 </div>

src/1/README.md

@@ -0,0 +1,35 @@
+root = true
+[*]
+indent_style=tab
+indent_size=tab
+tab_width=4
+end_of_line=lf
+charset=utf-8
+trim_trailing_whitespace=true
+max_line_length=100
+insert_final_newline=true
+
+[*.yml]
+indent_style=space
+indent_size=2
+tab_width=8
+end_of_line=lf
+
+[*.sh]
+indent_style=space
+indent_size=2
+tab_width=8
+end_of_line=lf
+
+[*.js]
+indent_style=space
+indent_size=4
+
+
+[*.jsx]
+indent_style=space
+indent_size=4
+
+[Dockerfile]
+indent_style=space
+indent_size=2

src/1/source/.editorconfig

@@ -1,2 +1,5 @@
+**/*.rs.bk
 **/target/
-.DS_Store
+addresses.json
+
+validators