Skip to content

Commit a490447

Browse files
committed
fixes for some FIXME and TODO items
1 parent 2566d27 commit a490447

File tree

10 files changed

+28
-17
lines changed

10 files changed

+28
-17
lines changed

book.toml

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ create-missing = false # opt out of helper to create missing stub files, we want
1414
edition = "2021"
1515

1616
[output.html]
17-
site-url = "/book/" # needed for gh-pages, MUST match repo name on github!
18-
git-repository-url = "https://github.com/Polkadot-Blockchain-Academy/book"
19-
edit-url-template = "https://github.com/Polkadot-Blockchain-Academy/book/edit/main/{path}"
17+
site-url = "/pba-book/" # needed for gh-pages, MUST match repo name on github!
18+
git-repository-url = "https://github.com/Polkadot-Blockchain-Academy/pba-book"
19+
edit-url-template = "https://github.com/Polkadot-Blockchain-Academy/pba-book/edit/main/{path}"
2020

2121
[output.html.search]
2222
limit-results = 20

content/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ We suggest the [online](#hosted-online) version for general use, but cloning, in
88

99
### Hosted Online
1010

11-
The latest version is hosted at: <a target="_blank" href="https://polkadot-blockchain-academy.github.io/testing-only/">https://polkadot-blockchain-academy.github.io/testing-only/</a> FIXME
11+
The latest version is hosted at: <a target="_blank" href="https://polkadot-blockchain-academy.github.io/pba-book/">https://polkadot-blockchain-academy.github.io/pba-book/</a>
1212

1313
### Build Offline
1414

content/blockchain-contracts/bytecode/slides.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -663,7 +663,7 @@ Notes:
663663

664664
- `extern "C"`:
665665

666-
- > https://doc.rust-lang.org/std/keyword.extern.html>
666+
- <https://doc.rust-lang.org/std/keyword.extern.html>
667667
- <https://doc.rust-lang.org/book/ch19-01-unsafe-rust.html#using-extern-functions-to-call-external-code>
668668

669669
- Chapter 11 of this book is a great read: <https://nostarch.com/rust-rustaceans>

content/blockchain-contracts/infrastructure/slides.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Tomorrow and Thursday will dig in on how the blockchain and its P2P network work
123123

124124
## Blockchain Data structure
125125

126-
todo figure FIXME
126+
<img width="60%" src="../structure/img/forks.svg">
127127

128128
Notes:
129129

@@ -135,7 +135,7 @@ This one is forked which is when things get really interesting, and when you nee
135135

136136
## Blockchain Consensus
137137

138-
todo FIXME
138+
<img width="60%" src="../finality/img/byzantine-generals.png">
139139

140140
Notes:
141141

content/blockchain-contracts/ink-workshop/slides.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,8 @@ It contains the game metadata. You will need this in order to interact with the
218218

219219
Notes:
220220

221-
And it has 2 todo files. The first is some instructions on General setup and the second one is in order to build your player.
221+
And it has 2 `todo` files.
222+
The first is some instructions on General setup and the second one is in order to build your player.
222223

223224
---
224225

content/blockchain-contracts/light-clients-bridges/slides.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -445,8 +445,20 @@ Your app is only as quality as the lower of the blockspaces.
445445

446446
---v
447447

448-
## Example
448+
## Example: Depository Mint Model
449449

450-
Depository - Mint model - Full backing
450+
- Send tokens to a contract on source chain
451+
- Message is relayed to destination chain
452+
- Offchain relay and transaction
453+
- XCM
454+
- "Somehow"
455+
- New "wrapped" tokens are minted on the destination chain
451456

452-
TODO - complete slide
457+
<!-- TODO really needs a figure -->
458+
459+
Notes:
460+
461+
The same process works in reverse to get the original tokens back.
462+
This can get get complex when there are multiple bridges.
463+
Are their wrapped tokens interchangeable?
464+
What if one of the bridges gets hacked?
Loading

content/blockchain-contracts/services-as-state-machines/slides.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ If that is not possible, draw a partial LTS.
381381

382382
## Garage Door Lock
383383

384-
TODO figure of garage door opener
384+
<img rounded width="60%" src="./img/garage-door-keypad.jpg" />
385385

386386
Notes:
387387

@@ -392,9 +392,7 @@ If the user enters the correct 4 digits, the door opens (or closes if it was alr
392392
The thing is, you could enter some random digits before you enter the correct code, and it would still open after the correct code.
393393
As you sketch your states, be sure to handle that correctly.
394394

395-
This example is drawn from <https://eng.libretexts.org/Under_Construction/Book%3A_Discrete_Structures/09%3A_Finite-State_Automata/9.02%3A_State_Transition_Diagrams> which has many other excellent examples
396-
397-
TODO add this example to blockchain from scratch.
395+
This example is drawn from https://eng.libretexts.org/Under_Construction/Book%3A_Discrete_Structures/09%3A_Finite-State_Automata/9.02%3A_State_Transition_Diagrams which has many other excellent examples
398396

399397
---
400398

content/contribute/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ makers l
312312

313313
The checker uses the `.github/workflows/mlc_config.json` configuration, primarily used to _globally_ ignore specific common URLs that throw errors, in error 😛.
314314
_Notice that ignored links must be check from time to time manually!_
315-
_Thus don't use this unless explicitly needed, rather use a know good URL if at all possible, perhaps from the <https://web.archive.org/>_
315+
_Thus don't use this unless explicitly needed, rather use a know good URL if at all possible, perhaps from the <https://archive.org/web/>_
316316
The same tool is also run by our CI on all files for all pushes to all branches.
317317
See the `.github/workflows/link-check.yml` file in this repo for details.
318318

content/formal-methods/intro/slides.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Note:
143143

144144
Notes:
145145

146-
- [Great blog](https://web.archive.org/web/20230209000724/www.pl-enthusiast.net/2017/10/23/what-is-soundness-in-static-analysis/) that explains the trade-offs between soundness and tractability
146+
- [Great blog](https://web.archive.org/web/20230209000724/www.pl-enthusiast.net/2017/10/23/what-is-soundness-in-static-analysis/) that explains the trade-offs between soundness and tractability <!-- markdown-link-check-disable-line -->
147147

148148
---
149149

0 commit comments

Comments
 (0)