From 5f0fcddb1f4e10de6e6344c35c8cc89181f19a52 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:28:40 +0200 Subject: [PATCH 1/7] fix typos --- content/overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/overview.md b/content/overview.md index 743f695..c36e256 100644 --- a/content/overview.md +++ b/content/overview.md @@ -3,7 +3,7 @@ This book contains a set of course materials covering both the conceptual underpinnings and hands-on experience in developing blockchain and web3 technologies. Students will be introduced to core concepts in economic, cryptographic, and computer science fields that lay the foundation for approaching web3 development, as well as hands-on experience developing web3 systems in Rust, primarily utilizing the ecosystem of tooling provided by Polkadot and Substrate. -> 🙋 This book is designed specifically for use in an a **_in-person course_**. +> 🙋 This book is designed specifically for use in an **_in-person course_**. > This provides _far more value_ from these materials than an online only, self-guided experience could provide. > > ✅ The Academy encourages everyone to [apply to the program](https://dot.li/pba-github) @@ -49,7 +49,7 @@ The course is segmented into **modules**, with the granular **lessons** intended | [⛓️ Blockchains and Smart Contracts](./blockchain-contracts/) | Blockchain and applications built on them covered in depth conceptually and hands-on operation and construction. | | [🧬 Substrate](./substrate/) | The blockchain framework canonical to Polkadot and Parachains covered in depth, at a lower level. | | [🧱 FRAME](./frame/) | The primary Substrate runtime framework used for parachain development. | -| [🟣 Polkadot](./polkadot/) | The Polkadot blockchain covered in depth, focus on high-level design and practically how to utilize it's blockspace. | +| [🟣 Polkadot](./polkadot/) | The Polkadot blockchain covered in depth, focus on high-level design and practically how to utilize its blockspace. | | [💱 XCM](./xcm/) | The cross consensus messaging format covered from first principals to use in protocols. | From 654ffc045fffd32d2829ba18ff6a590c20eb64f7 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:31:16 +0200 Subject: [PATCH 2/7] fix typos --- content/substrate/code/slides.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/substrate/code/slides.md b/content/substrate/code/slides.md index 4ad57ec..4d809d5 100644 --- a/content/substrate/code/slides.md +++ b/content/substrate/code/slides.md @@ -10,7 +10,7 @@ duration: 60 minutes ## Substrate; Show Me The Code 👨‍💻 -Previous lecture was all abut high level information; now we want to bridge that to real code. +Previous lecture was all about high level information; now we want to bridge that to real code. --- @@ -131,7 +131,7 @@ Notes: all commands: all args to a typical run command -Bute then each node can decide which subset of these it chooses, and how it implements it. +But then each node can decide which subset of these it chooses, and how it implements it. @@ -180,7 +180,7 @@ trait Config { Notes: -Especially in FRAME, often times you have to parameterize your pallets with a pattern like above. +Especially in FRAME, oftentimes you have to parameterize your pallets with a pattern like above. Simply search the trait in the rust-docs, and find the implementors! --- From 91bfbbacc9cc86c356644e2ce5f40cdd854f5b93 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:32:09 +0200 Subject: [PATCH 3/7] fix typo --- content/substrate/interact/slides.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/substrate/interact/slides.md b/content/substrate/interact/slides.md index 6ec723f..94056b4 100644 --- a/content/substrate/interact/slides.md +++ b/content/substrate/interact/slides.md @@ -227,7 +227,7 @@ const provider = new WsProvider("wss://rpc.polkadot.io"); const api = await ApiPromise.create({ provider }); api.stats; api.isConnected; - // where doe this come from? + // where does this come from? api.runtimeVersion; // where does this come from? api.registry.chainDecimals; From 4bbeb89e35d90209baa65ca2b661a18eda36651c Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:35:37 +0200 Subject: [PATCH 4/7] fix typos --- content/substrate/intro/slides.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/substrate/intro/slides.md b/content/substrate/intro/slides.md index 58ff0fe..bc2f9aa 100644 --- a/content/substrate/intro/slides.md +++ b/content/substrate/intro/slides.md @@ -103,8 +103,8 @@ Notes: Bitcoin block size has never been and is an ongoing debate. -I am not against L2s per se, but it is truth that they mostly exist because the underlying protocol -is too hard/slow to upgrade itself. ETH Gas prices is also shows that the underlying protocol cannot +I am not against L2s per se, but it is true that they mostly exist because the underlying protocol +is too hard/slow to upgrade itself. ETH Gas prices also show that the underlying protocol cannot meet the demands of today. @@ -558,7 +558,7 @@ Wasm's instruction set is deterministic, so all good. Notes: -howe can we guarantee that neither enter an infinite loop, or try to access the filesystem? +how can we guarantee that neither enter an infinite loop, or try to access the filesystem? ---v @@ -616,7 +616,7 @@ Notes: - Can be slower than native, depending on the executor/execution method. - Limited access to the host host env, all needs to be done through syscalls. -Less state-transition diversification, because the runtime is the same for all clients. If there a +Less state-transition diversification, because the runtime is the same for all clients. If there is a bug in it, everyone is affected. --- @@ -656,7 +656,7 @@ the next episode to air actually will be. Notes: -state is sometimes called "storage" asd well. +state is sometimes called "storage" as well. --- @@ -681,7 +681,7 @@ state is sometimes called "storage" asd well. ## The Client: Database 🤔 -- The database, from the client's PoV, is a _untyped_, key-value storage. +- The database, from the client's PoV, is an _untyped_, key-value storage. - The runtime knows which key/value means what. --- @@ -965,7 +965,7 @@ hardcoded, but the protocol itself is flexible. Notes: -We are aware that the module is highly skewed in terms of lecture time, but is is intentional and we +We are aware that the module is highly skewed in terms of lecture time, but it is intentional and we want to see how it works. This allows you to kickstart with your assignment earlier. ---v From 8e425fb956b6204d9bfe67eaf7742866c3e821f3 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:39:31 +0200 Subject: [PATCH 5/7] fix typos --- content/substrate/storage/slides.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/substrate/storage/slides.md b/content/substrate/storage/slides.md index 46b2f43..dab3543 100644 --- a/content/substrate/storage/slides.md +++ b/content/substrate/storage/slides.md @@ -413,7 +413,7 @@ When proof is being sent, there is no IO. First glance, the radix-8 seems better: you will typically have less DB access to reach a key. For example, with binary, with 3 IO, we can reach only 8 items, but with radix-8 512. -So why should not chose a very wide tree? +So why should not choose a very wide tree? Because the wider you make the tree, the bigger each node gets, because it has to store more hashes. At some point, this start to screw with both the proof size and the cost of reading/writing/encoding/decoding all these nodes. @@ -524,7 +524,7 @@ One can assume that the green node is like any other node in the trie. Notes: -in other words, one should one care too much about updating a "trie" and all of its hashing details while the block is still being executed? all of that can be delayed. +in other words, one should care too much about updating a "trie" and all of its hashing details while the block is still being executed? all of that can be delayed. --- @@ -597,7 +597,7 @@ Notes: ### Overlay -- The overlay is also able to spawn child-overlays, know as "_storage layer_". +- The overlay is also able to spawn child-overlays, known as "_storage layer_". - Useful for having a _transactional_ block of code. ```rust @@ -664,7 +664,7 @@ with_storage_layer(|| { Notes: NO! -overlay works on the level on key-values, ot knows nothing of trie nodes, and to compute the root we have to go to the trie layer and pull a whole lot of data back from the disk and build all the nodes etc. etc. +overlay works on the level on key-values, ot knows nothing of trie nodes, and to compute the root we have to go to the trie layer and pull a whole lot of data back from the disk and build all the nodes etc. ---v @@ -858,4 +858,4 @@ Notes: Double check the narrative and example of the `BIG_STUFF` node. An example/exercise of some sort would be great, where students call a bunch of `sp_io` functions, visualize the trie, and invoke -proof recorder, and see which pars of the trie is exactly part of the proof. +proof recorder, and see which parts of the trie is exactly part of the proof. From 1079521437e5db24207dae7c0559148854cbe76c Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:41:24 +0200 Subject: [PATCH 6/7] fix typos --- content/substrate/tips-tricks/slides.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/substrate/tips-tricks/slides.md b/content/substrate/tips-tricks/slides.md index c376fb0..c1efbad 100644 --- a/content/substrate/tips-tricks/slides.md +++ b/content/substrate/tips-tricks/slides.md @@ -386,7 +386,7 @@ log::debug!(target: "bar", "hello world! ({})", 10u32); ### Logging And Prints In The Runtime. -- But `log` crate doesn't doo much in itself! it needs two additional steps to work: +- But `log` crate doesn't do much in itself! it needs two additional steps to work: 1. `// $ RUST_LOG=foo=debug,bar=trace cargo run` 2. `sp_tracing::try_init_simple()` @@ -441,7 +441,7 @@ If the interface is built with `disable-logging`, it omits all log messages. > false ``` -- Google "weird float behavior" fro more entertainment around this. +- Google "weird float behavior" for more entertainment around this. ---v From 276b52a21d359ddd8dbd3076d911b73289276534 Mon Sep 17 00:00:00 2001 From: Nuke Date: Tue, 26 Sep 2023 08:52:49 -0600 Subject: [PATCH 7/7] Apply suggestions from code review --- content/substrate/intro/slides.md | 13 ++++++------- content/substrate/storage/slides.md | 5 +++-- content/substrate/tips-tricks/slides.md | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/content/substrate/intro/slides.md b/content/substrate/intro/slides.md index bc2f9aa..7e27513 100644 --- a/content/substrate/intro/slides.md +++ b/content/substrate/intro/slides.md @@ -103,9 +103,8 @@ Notes: Bitcoin block size has never been and is an ongoing debate. -I am not against L2s per se, but it is true that they mostly exist because the underlying protocol -is too hard/slow to upgrade itself. ETH Gas prices also show that the underlying protocol cannot -meet the demands of today. +I am not against L2s per se, but it is true that they mostly exist because the underlying protocol is too hard/slow to upgrade itself. +ETH Gas prices also show that the underlying protocol cannot meet the demands of today. @@ -558,7 +557,7 @@ Wasm's instruction set is deterministic, so all good. Notes: -how can we guarantee that neither enter an infinite loop, or try to access the filesystem? +How can we guarantee that neither enter an infinite loop, or try to access the filesystem? ---v @@ -616,8 +615,8 @@ Notes: - Can be slower than native, depending on the executor/execution method. - Limited access to the host host env, all needs to be done through syscalls. -Less state-transition diversification, because the runtime is the same for all clients. If there is a -bug in it, everyone is affected. +Less state-transition diversification, because the runtime is the same for all clients. +If there is a bug in it, everyone is affected. --- @@ -656,7 +655,7 @@ the next episode to air actually will be. Notes: -state is sometimes called "storage" as well. +State is sometimes called "storage" as well. --- diff --git a/content/substrate/storage/slides.md b/content/substrate/storage/slides.md index dab3543..cb899bf 100644 --- a/content/substrate/storage/slides.md +++ b/content/substrate/storage/slides.md @@ -524,7 +524,8 @@ One can assume that the green node is like any other node in the trie. Notes: -in other words, one should care too much about updating a "trie" and all of its hashing details while the block is still being executed? all of that can be delayed. +In other words, one should care too much about updating a "trie" and all of its hashing details while the block is still being executed? +All of that can be delayed. --- @@ -664,7 +665,7 @@ with_storage_layer(|| { Notes: NO! -overlay works on the level on key-values, ot knows nothing of trie nodes, and to compute the root we have to go to the trie layer and pull a whole lot of data back from the disk and build all the nodes etc. +The overlay works on the level on key-values, it knows nothing of trie nodes, and to compute the root we have to go to the trie layer and pull a whole lot of data back from the disk and build all the nodes etc. ---v diff --git a/content/substrate/tips-tricks/slides.md b/content/substrate/tips-tricks/slides.md index c1efbad..c15b44c 100644 --- a/content/substrate/tips-tricks/slides.md +++ b/content/substrate/tips-tricks/slides.md @@ -441,7 +441,7 @@ If the interface is built with `disable-logging`, it omits all log messages. > false ``` -- Google "weird float behavior" for more entertainment around this. +- Search "weird float behavior" for more entertainment around this. ---v