diff --git a/packages/fast-usdc/README.md b/packages/fast-usdc/README.md index 09810e873cd..fe1794a5872 100644 --- a/packages/fast-usdc/README.md +++ b/packages/fast-usdc/README.md @@ -56,3 +56,29 @@ sequenceDiagram A->>TF: notify(evidence) ``` + +# Status Manager + +### Contract state diagram + +*Transactions are qualified by the OCW and EventFeed before arriving to the Advancer.* + +```mermaid +stateDiagram-v2 + [*] --> Advanced: Advancer .advance() + Advanced --> Settled: Settler .settle() after fees + [*] --> Observed: Advancer .observed() + Observed --> Settled: Settler .settle() sans fees + Settled --> [*] +``` + +### Complete state diagram (starting from OCW) + +```mermaid +stateDiagram-v2 + Observed --> Qualified + Observed --> Unqualified + Qualified --> Advanced + Advanced --> Settled + Qualified --> Settled +``` diff --git a/packages/fast-usdc/src/exos/README.md b/packages/fast-usdc/src/exos/README.md deleted file mode 100644 index f65fb20a958..00000000000 --- a/packages/fast-usdc/src/exos/README.md +++ /dev/null @@ -1,26 +0,0 @@ -## **StatusManager** state diagram, showing different transitions - - -### Contract state diagram - -*Transactions are qualified by the OCW and EventFeed before arriving to the Advancer.* - -```mermaid -stateDiagram-v2 - [*] --> Advanced: Advancer .advance() - Advanced --> Settled: Settler .settle() after fees - [*] --> Observed: Advancer .observed() - Observed --> Settled: Settler .settle() sans fees - Settled --> [*] -``` - -### Complete state diagram (starting from OCW) - -```mermaid -stateDiagram-v2 - Observed --> Qualified - Observed --> Unqualified - Qualified --> Advanced - Advanced --> Settled - Qualified --> Settled -```