engineering/make_post_sell
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases 2 Packages Wiki Activity Actions

Update state machine documentation to use dash-separated naming

Browse source 
- Convert all state names from underscore to dash format in markdown documentation
- Ensures consistency across all documentation formats (dot, svg, markdown)
- All payment states now use dashes: confirmed-complete, underpaid-refunded, etc.
- Maintains consistency with the source dot file which is the canonical reference

This completes the documentation naming convention standardization.
This commit is contained in:
Russell Ballestrini 2025-10-04 13:02:07 -04:00
parent fde7e2b2d0
commit 3fedfeb849
4 changed files with 405 additions and 387 deletions
Download patch file Download diff file Expand all files Collapse all files

90
docs/state-machine.dot
View file

@ -4,61 +4,61 @@ digraph G {
edge [penwidth=1.5, fontsize=10, fontname="Arial"];
"[*]" [shape=circle, label="", width=0.2, fillcolor=black, style=filled];
"pending" [fillcolor="#e7f3ff", fontcolor="#0056b3", color="#0056b3", fontsize=12];
"doublepay_refunded" [fillcolor="#e7f3ff", fontcolor="#0056b3", color="#0056b3", fontsize=12];
"latepay_refunded" [fillcolor="#e7f3ff", fontcolor="#0056b3", color="#0056b3", fontsize=12];
"doublepay-refunded" [fillcolor="#e7f3ff", fontcolor="#0056b3", color="#0056b3", fontsize=12];
"latepay-refunded" [fillcolor="#e7f3ff", fontcolor="#0056b3", color="#0056b3", fontsize=12];
"received" [fillcolor="#cce5ff", fontcolor="#004085", color="#004085", fontsize=12];
"expired" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"cancelled" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"confirmed" [fillcolor="#d4edda", fontcolor="#155724", color="#155724", fontsize=12];
"confirmed_complete" [fillcolor="#d4edda", fontcolor="#155724", color="#155724", fontsize=12];
"confirmed_overpay" [fillcolor="#cce5ff", fontcolor="#004085", color="#004085", fontsize=12];
"underpaid_refunded" [fillcolor="#fff3cd", fontcolor="#856404", color="#856404", fontsize=12];
"out_of_stock_refunded" [fillcolor="#fff3cd", fontcolor="#856404", color="#856404", fontsize=12];
"confirmed_overpay_refunded" [fillcolor="#fff3cd", fontcolor="#856404", color="#856404", fontsize=12];
"confirmed_overpay_refunded_complete" [fillcolor="#d4edda", fontcolor="#155724", color="#155724", fontsize=12];
"confirmed_overpay_not_refunded" [fillcolor="#d4edda", fontcolor="#155724", color="#155724", fontsize=12];
"latepay_refunded_complete" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"latepay_not_refunded" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"underpaid_refunded_complete" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"underpaid_not_refunded" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"out_of_stock_refunded_complete" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"out_of_stock_not_refunded" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"doublepay_refunded_complete" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"doublepay_not_refunded" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"confirmed-complete" [fillcolor="#d4edda", fontcolor="#155724", color="#155724", fontsize=12];
"confirmed-overpay" [fillcolor="#cce5ff", fontcolor="#004085", color="#004085", fontsize=12];
"underpaid-refunded" [fillcolor="#fff3cd", fontcolor="#856404", color="#856404", fontsize=12];
"out-of-stock-refunded" [fillcolor="#fff3cd", fontcolor="#856404", color="#856404", fontsize=12];
"confirmed-overpay-refunded" [fillcolor="#fff3cd", fontcolor="#856404", color="#856404", fontsize=12];
"confirmed-overpay-refunded-complete" [fillcolor="#d4edda", fontcolor="#155724", color="#155724", fontsize=12];
"confirmed-overpay-not-refunded" [fillcolor="#d4edda", fontcolor="#155724", color="#155724", fontsize=12];
"latepay-refunded-complete" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"latepay-not-refunded" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"underpaid-refunded-complete" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"underpaid-not-refunded" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"out-of-stock-refunded-complete" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"out-of-stock-not-refunded" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"doublepay-refunded-complete" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"doublepay-not-refunded" [fillcolor="#f8d7da", fontcolor="#721c24", color="#721c24", fontsize=12];
"terminated" [shape=doubleoctagon, fillcolor="#e0e0e0", fontcolor="#333333", color="#333333", fontsize=12];
"[*]" -> "pending";
"[*]" -> "doublepay_refunded" [label="Duplicate payment detected"];
"[*]" -> "latepay_refunded" [label="Late payment detected"];
"[*]" -> "doublepay-refunded" [label="Duplicate payment detected"];
"[*]" -> "latepay-refunded" [label="Late payment detected"];
"pending" -> "received" [label="Payment detected in mempool"];
"pending" -> "expired" [label="Payment timeout (never received)"];
"pending" -> "cancelled" [label="User cancellation"];
"received" -> "confirmed" [label="Sufficient payment + confirmations"];
"received" -> "confirmed_overpay" [label="Overpayment detected"];
"received" -> "underpaid_refunded" [label="Underpayment detected"];
"received" -> "out_of_stock_refunded" [label="Product unavailable"];
"confirmed" -> "confirmed_complete" [label="Swept to cold storage"];
"confirmed_complete" -> "terminated" [label="✓ Terminal Success"];
"confirmed_overpay" -> "confirmed_overpay_refunded" [label="Initiate refund"];
"confirmed_overpay_refunded" -> "confirmed_overpay_refunded_complete" [label="Refund confirmed"];
"confirmed_overpay_refunded" -> "confirmed_overpay_not_refunded" [label="No refund wallet configured"];
"confirmed_overpay_refunded_complete" -> "terminated" [label="✓ Terminal Success"];
"confirmed_overpay_not_refunded" -> "terminated" [label="✓ Terminal Success (Not Refunded)"];
"received" -> "confirmed-overpay" [label="Overpayment detected"];
"received" -> "underpaid-refunded" [label="Underpayment detected"];
"received" -> "out-of-stock-refunded" [label="Product unavailable"];
"confirmed" -> "confirmed-complete" [label="Swept to cold storage"];
"confirmed-complete" -> "terminated" [label="✓ Terminal Success"];
"confirmed-overpay" -> "confirmed-overpay-refunded" [label="Initiate refund"];
"confirmed-overpay-refunded" -> "confirmed-overpay-refunded-complete" [label="Refund confirmed"];
"confirmed-overpay-refunded" -> "confirmed-overpay-not-refunded" [label="No refund wallet configured"];
"confirmed-overpay-refunded-complete" -> "terminated" [label="✓ Terminal Success"];
"confirmed-overpay-not-refunded" -> "terminated" [label="✓ Terminal Success (Not Refunded)"];
"expired" -> "terminated" [label="✓ Terminal Failed (Expired)"];
"latepay_refunded" -> "latepay_refunded_complete" [label="Refund confirmed"];
"latepay_refunded" -> "latepay_not_refunded" [label="No refund wallet configured"];
"latepay_refunded_complete" -> "terminated" [label="✓ Terminal Failed (Refund Complete)"];
"latepay_not_refunded" -> "terminated" [label="✓ Terminal Failed (Not Refunded)"];
"underpaid_refunded" -> "underpaid_refunded_complete" [label="Refund confirmed"];
"underpaid_refunded" -> "underpaid_not_refunded" [label="No refund wallet configured"];
"underpaid_refunded_complete" -> "terminated" [label="✓ Terminal Failed (Refund Complete)"];
"underpaid_not_refunded" -> "terminated" [label="✓ Terminal Failed (Not Refunded)"];
"out_of_stock_refunded" -> "out_of_stock_refunded_complete" [label="Refund confirmed"];
"out_of_stock_refunded" -> "out_of_stock_not_refunded" [label="No refund wallet configured"];
"out_of_stock_refunded_complete" -> "terminated" [label="✓ Terminal Failed (Refund Complete)"];
"out_of_stock_not_refunded" -> "terminated" [label="✓ Terminal Failed (Not Refunded)"];
"doublepay_refunded" -> "doublepay_refunded_complete" [label="Refund confirmed"];
"doublepay_refunded" -> "doublepay_not_refunded" [label="No refund wallet configured"];
"doublepay_refunded_complete" -> "terminated" [label="✓ Terminal Failed (Refund Complete)"];
"doublepay_not_refunded" -> "terminated" [label="✓ Terminal Failed (Not Refunded)"];
"latepay-refunded" -> "latepay-refunded-complete" [label="Refund confirmed"];
"latepay-refunded" -> "latepay-not-refunded" [label="No refund wallet configured"];
"latepay-refunded-complete" -> "terminated" [label="✓ Terminal Failed (Refund Complete)"];
"latepay-not-refunded" -> "terminated" [label="✓ Terminal Failed (Not Refunded)"];
"underpaid-refunded" -> "underpaid-refunded-complete" [label="Refund confirmed"];
"underpaid-refunded" -> "underpaid-not-refunded" [label="No refund wallet configured"];
"underpaid-refunded-complete" -> "terminated" [label="✓ Terminal Failed (Refund Complete)"];
"underpaid-not-refunded" -> "terminated" [label="✓ Terminal Failed (Not Refunded)"];
"out-of-stock-refunded" -> "out-of-stock-refunded-complete" [label="Refund confirmed"];
"out-of-stock-refunded" -> "out-of-stock-not-refunded" [label="No refund wallet configured"];
"out-of-stock-refunded-complete" -> "terminated" [label="✓ Terminal Failed (Refund Complete)"];
"out-of-stock-not-refunded" -> "terminated" [label="✓ Terminal Failed (Not Refunded)"];
"doublepay-refunded" -> "doublepay-refunded-complete" [label="Refund confirmed"];
"doublepay-refunded" -> "doublepay-not-refunded" [label="No refund wallet configured"];
"doublepay-refunded-complete" -> "terminated" [label="✓ Terminal Failed (Refund Complete)"];
"doublepay-not-refunded" -> "terminated" [label="✓ Terminal Failed (Not Refunded)"];
"cancelled" -> "terminated" [label="✓ Terminal Failed (Cancelled)"];
}