From 77dfeb4bf2af1b4dc5345ead2b26da7a39579815 Mon Sep 17 00:00:00 2001
From: Tyler Goodlet <jgbt@protonmail.com>
Date: Fri, 16 Jun 2023 21:07:42 -0400
Subject: [PATCH] Update brokerd msgs with modern type annots, add a "closed"
 status

---
 piker/clearing/_messages.py | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

diff --git a/piker/clearing/_messages.py b/piker/clearing/_messages.py
index 126cd347..240c340b 100644
--- a/piker/clearing/_messages.py
+++ b/piker/clearing/_messages.py
@@ -23,7 +23,6 @@ Clearing sub-system message and protocols.
 #     deque,
 # )
 from typing import (
-    Optional,
     Literal,
 )
 
@@ -140,7 +139,7 @@ class Status(Struct):
 
     # this maps normally to the ``BrokerdOrder.reqid`` below, an id
     # normally allocated internally by the backend broker routing system
-    reqid: Optional[int | str] = None
+    reqid: int | str | None = None
 
     # the (last) source order/request msg if provided
     # (eg. the Order/Cancel which causes this msg) and
@@ -153,7 +152,7 @@ class Status(Struct):
     # event that wasn't originated by piker's emsd (eg. some external
     # trading system which does it's own order control but that you
     # might want to "track" using piker UIs/systems).
-    src: Optional[str] = None
+    src: str | None = None
 
     # set when a cancel request msg was set for this order flow dialog
     # but the brokerd dialog isn't yet in a cancelled state.
@@ -181,7 +180,7 @@ class BrokerdCancel(Struct):
     # for setting a unique order id then this value will be relayed back
     # on the emsd order request stream as the ``BrokerdOrderAck.reqid``
     # field
-    reqid: Optional[int | str] = None
+    reqid: int | str | None = None
     action: str = 'cancel'
 
 
@@ -205,7 +204,7 @@ class BrokerdOrder(Struct):
     # for setting a unique order id then this value will be relayed back
     # on the emsd order request stream as the ``BrokerdOrderAck.reqid``
     # field
-    reqid: Optional[int | str] = None
+    reqid: int | str | None = None
 
 
 # ---------------
@@ -233,14 +232,14 @@ class BrokerdOrderAck(Struct):
 
 class BrokerdStatus(Struct):
 
-    reqid: int | str
     time_ns: int
+    reqid: int | str
     status: Literal[
         'open',
         'canceled',
-        'fill',
         'pending',
         'error',
+        'closed',
     ]
 
     account: str
@@ -259,24 +258,24 @@ class BrokerdStatus(Struct):
 
 class BrokerdFill(Struct):
     '''
-    A single message indicating a "fill-details" event from the broker
-    if avaiable.
+    A single message indicating a "fill-details" event from the
+    broker if avaiable.
 
     '''
     # brokerd timestamp required for order mode arrow placement on x-axis
     # TODO: maybe int if we force ns?
     # we need to normalize this somehow since backends will use their
     # own format and likely across many disparate epoch clocks...
+    time_ns: int
     broker_time: float
     reqid: int | str
-    time_ns: int
 
     # order exeuction related
     size: float
     price: float
 
     name: str = 'fill'
-    action: Optional[str] = None
+    action: str | None = None
     broker_details: dict = {}  # meta-data (eg. commisions etc.)
 
 
@@ -293,7 +292,7 @@ class BrokerdError(Struct):
 
     # if no brokerd order request was actually submitted (eg. we errored
     # at the ``pikerd`` layer) then there will be ``reqid`` allocated.
-    reqid: Optional[int | str] = None
+    reqid: int | str | None = None
 
     name: str = 'error'
     broker_details: dict = {}