From b3be5c32ad15103d66a68758e0102c2ddda3deec Mon Sep 17 00:00:00 2001 From: yiannis Date: Mon, 19 Oct 2020 13:01:34 +0300 Subject: [PATCH 1/4] deletes outdated TODOs and diagrams and puts updated state diagram --- content/intro/arch.md | 42 +++++++++++++++++---------------- layouts/shortcodes/mermaid.html | 4 ++-- 2 files changed, 24 insertions(+), 22 deletions(-) diff --git a/content/intro/arch.md b/content/intro/arch.md index dd26bf702..965a17075 100644 --- a/content/intro/arch.md +++ b/content/intro/arch.md @@ -8,23 +8,25 @@ dashboardAudit: n/a # Architecture Diagrams -## Overview Diagram -{{< details title="TODO" >}} -- cleanup / reorganize - - this diagram is accurate, and helps lots to navigate, but it's still a bit confusing - - the arrows and lines make it a bit hard to follow. We should have a much cleaner version (maybe based on [C4](https://c4model.com)) -- reflect addition of Token system - - move data_transfers into Token -{{< /details >}} - -![Protocol Overview Diagram](diagrams/overview1/overview.dot) - -## Protocol Flow Diagram - -![Deals on Chain](diagrams/sequence/full-deals-on-chain.mmd) - -## Parameter Calculation Dependency Graph - -This is a diagram of the model for parameter calculation. This is made with [orient](https://github.com/filecoin-project/orient), our tool for modeling and solving for constraints. - -![Protocol Overview Diagram](diagrams/orient/filecoin.dot) \ No newline at end of file +Actor State Diagram + +{{< mermaid >}} +stateDiagram + Null --> Precommitted: PreCommitSectors + Precommitted --> Committed: CommitSectors + Precommitted --> Deleted: CronPreCommitExpiry (PCD) + Committed --> Active: SubmittedWindowPoSt + Committed --> Faulty: DeclareFault\nSubmitWindowPoSt (SP)\nProvingDeadline (SP) + Committed --> Terminated: TerminateSectors\n(TF) + Faulty --> Active: SubmittedWindowPoSt (FF) + Faulty --> Faulty: ProvingDeadline (FF) + Faulty --> Recovering: DeclareFaultRecovered + Faulty --> Terminated: EarlyExpiration (TF)\nTerminateSectors (TF) + Recovering --> Active: SubmittedWindowPoSt (FF) + Recovering --> Faulty: DeclareFault\nProvingDeadline (SP) + Recovering --> Terminated: TerminateSectors (TF) + Active --> Active: SubmittedWindowPoSt + Active --> Faulty: DeclareFault\nSubmitWindowPoSt (SP)\nProvingDeadline (SP) + Active --> Terminated: CronExpiration\nTerminateSectors (TF) + Terminated --> Deleted: CompactSectors +{{}} diff --git a/layouts/shortcodes/mermaid.html b/layouts/shortcodes/mermaid.html index 5960f84e0..417f87ecb 100644 --- a/layouts/shortcodes/mermaid.html +++ b/layouts/shortcodes/mermaid.html @@ -4,7 +4,7 @@ @@ -58,4 +58,4 @@ }; mermaid.render('temp-{{ $uuid }}', {{- .Inner -}}, insertSvg) -{{ end }} \ No newline at end of file +{{ end }} From d9724ea934d8a75d9fa17ced43c2f7824a01c7da Mon Sep 17 00:00:00 2001 From: yiannis Date: Mon, 19 Oct 2020 16:22:15 +0300 Subject: [PATCH 2/4] embeds mermaid diagram as an embedded file --- content/intro/arch.md | 21 +-------------------- content/intro/new-state-diagram.mmd | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 20 deletions(-) create mode 100644 content/intro/new-state-diagram.mmd diff --git a/content/intro/arch.md b/content/intro/arch.md index 965a17075..2d2c1a598 100644 --- a/content/intro/arch.md +++ b/content/intro/arch.md @@ -10,23 +10,4 @@ dashboardAudit: n/a Actor State Diagram -{{< mermaid >}} -stateDiagram - Null --> Precommitted: PreCommitSectors - Precommitted --> Committed: CommitSectors - Precommitted --> Deleted: CronPreCommitExpiry (PCD) - Committed --> Active: SubmittedWindowPoSt - Committed --> Faulty: DeclareFault\nSubmitWindowPoSt (SP)\nProvingDeadline (SP) - Committed --> Terminated: TerminateSectors\n(TF) - Faulty --> Active: SubmittedWindowPoSt (FF) - Faulty --> Faulty: ProvingDeadline (FF) - Faulty --> Recovering: DeclareFaultRecovered - Faulty --> Terminated: EarlyExpiration (TF)\nTerminateSectors (TF) - Recovering --> Active: SubmittedWindowPoSt (FF) - Recovering --> Faulty: DeclareFault\nProvingDeadline (SP) - Recovering --> Terminated: TerminateSectors (TF) - Active --> Active: SubmittedWindowPoSt - Active --> Faulty: DeclareFault\nSubmitWindowPoSt (SP)\nProvingDeadline (SP) - Active --> Terminated: CronExpiration\nTerminateSectors (TF) - Terminated --> Deleted: CompactSectors -{{}} +![Actor State Diagram](new-state-diagram.mmd) diff --git a/content/intro/new-state-diagram.mmd b/content/intro/new-state-diagram.mmd new file mode 100644 index 000000000..af2dff383 --- /dev/null +++ b/content/intro/new-state-diagram.mmd @@ -0,0 +1,18 @@ +stateDiagram + Null --> Precommitted: PreCommitSectors + Precommitted --> Committed: CommitSectors + Precommitted --> Deleted: CronPreCommitExpiry (PCD) + Committed --> Active: SubmittedWindowPoSt + Committed --> Faulty: DeclareFault\nSubmitWindowPoSt (SP)\nProvingDeadline (SP) + Committed --> Terminated: TerminateSectors\n(TF) + Faulty --> Active: SubmittedWindowPoSt (FF) + Faulty --> Faulty: ProvingDeadline (FF) + Faulty --> Recovering: DeclareFaultRecovered + Faulty --> Terminated: EarlyExpiration (TF)\nTerminateSectors (TF) + Recovering --> Active: SubmittedWindowPoSt (FF) + Recovering --> Faulty: DeclareFault\nProvingDeadline (SP) + Recovering --> Terminated: TerminateSectors (TF) + Active --> Active: SubmittedWindowPoSt + Active --> Faulty: DeclareFault\nSubmitWindowPoSt (SP)\nProvingDeadline (SP) + Active --> Terminated: CronExpiration\nTerminateSectors (TF) + Terminated --> Deleted: CompactSectors From f66f6970fd49729c3d226317e71aaa2436ef3964 Mon Sep 17 00:00:00 2001 From: yiannis Date: Mon, 19 Oct 2020 18:08:05 +0300 Subject: [PATCH 3/4] linking .mmd file path to be relative to the content folder --- content/intro/arch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/intro/arch.md b/content/intro/arch.md index 2d2c1a598..bdd4f89e8 100644 --- a/content/intro/arch.md +++ b/content/intro/arch.md @@ -10,4 +10,4 @@ dashboardAudit: n/a Actor State Diagram -![Actor State Diagram](new-state-diagram.mmd) +![Actor State Diagram](intro/new-state-diagram.mmd) From c88da2a5b08ebab6c117c9b1dcf7a27d31c6a947 Mon Sep 17 00:00:00 2001 From: yiannis Date: Mon, 19 Oct 2020 18:11:33 +0300 Subject: [PATCH 4/4] path typo --- content/intro/arch.md | 2 +- content/intro/new-state-diagram.mmd | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/content/intro/arch.md b/content/intro/arch.md index bdd4f89e8..273f270ac 100644 --- a/content/intro/arch.md +++ b/content/intro/arch.md @@ -10,4 +10,4 @@ dashboardAudit: n/a Actor State Diagram -![Actor State Diagram](intro/new-state-diagram.mmd) +![Actor State Diagram](/intro/new-state-diagram.mmd) diff --git a/content/intro/new-state-diagram.mmd b/content/intro/new-state-diagram.mmd index af2dff383..40033ada6 100644 --- a/content/intro/new-state-diagram.mmd +++ b/content/intro/new-state-diagram.mmd @@ -1,4 +1,5 @@ stateDiagram + Null --> Precommitted: PreCommitSectors Precommitted --> Committed: CommitSectors Precommitted --> Deleted: CronPreCommitExpiry (PCD)