Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.TUI.Model

Synopsis

data TUIEvent tx
- = NodeEvent (HydraEvent tx)
- | UTxOQueryResult (Map TxIn (TxOut CtxUTxO))
- | L1UTxORefresh (Map TxIn (TxOut CtxUTxO))
- | FuelUTxORefresh (Map TxIn (TxOut CtxUTxO))
- | TxBuildError Text
data RootState = RootState {
- nodeHost :: Host
- now :: UTCTime
- timeZone :: TimeZone
- connectedState :: ConnectedState
- logState :: LogState
- activeTab :: ActiveTab
- eventDetailRaw :: Bool
- eventHistoryList :: List Name LogMessage
- pendingAction :: Maybe Text
- l1UTxO :: Maybe (Map TxIn (TxOut CtxUTxO))
- fuelVk :: Maybe (VerificationKey PaymentKey)
- fuelUTxO :: Maybe (Map TxIn (TxOut CtxUTxO))
- previousTab :: ActiveTab
- theme :: Theme
- recoveryForm :: Maybe (TxIdRadioFieldForm (HydraEvent Tx) Name)
- fanoutSelectionForm :: Maybe (UTxOCheckboxForm (HydraEvent Tx) Name)
- eventHistoryFilter :: EventHistoryFilter
}
data ConnectedState
- = Disconnected
- | Connected {
  - connection :: Connection
  }
data IdentifiedState
- = Unidentified
- | Identified Party
data NetworkState
- = NetworkConnected
- | NetworkDisconnected
data ChainSyncedStatus
- = InSync
- | CatchingUp
data PeerStatus
- = PeerIsConnected
- | PeerIsDisconnected
- | PeerIsUnknown
data Connection = Connection {
- me :: IdentifiedState
- peers :: [(Host, PeerStatus)]
- networkState :: Maybe NetworkState
- chainSyncedStatus :: ChainSyncedStatus
- headState :: HeadState
}
type UTxOCheckboxForm e n = Form (Map TxIn (TxOut CtxUTxO, Bool)) e n
type UTxORadioFieldForm e n = Form (TxIn, TxOut CtxUTxO) e n
type TxIdRadioFieldForm e n = Form TxId e n
type ConfirmingRadioFieldForm e n = Form Bool e n
data OpenScreen
- = OpenHome
- | LoadingUTxOForIncrement
- | NoUTxOToIncrement
- | SelectingUTxO {
  - selectingUTxOForm :: UTxORadioFieldForm (HydraEvent Tx) Name
  }
- | SelectingUTxOToDecommit {
  - selectingUTxOToDecommitForm :: UTxORadioFieldForm (HydraEvent Tx) Name
  }
- | SelectingUTxOToIncrement {
  - selectingUTxOToIncrementForm :: UTxORadioFieldForm (HydraEvent Tx) Name
  }
- | EnteringAmount {
  - utxoSelected :: (TxIn, TxOut CtxUTxO)
  - enteringAmountForm :: Form Double (HydraEvent Tx) Name
  }
- | SelectingRecipient {
  - utxoSelected :: (TxIn, TxOut CtxUTxO)
  - amountEntered :: Double
  - selectingRecipientForm :: Form SelectAddressItem (HydraEvent Tx) Name
  }
- | EnteringRecipientAddress {
  - utxoSelected :: (TxIn, TxOut CtxUTxO)
  - amountEntered :: Double
  - enteringRecipientAddressForm :: Form AddressInEra (HydraEvent Tx) Name
  }
- | ConfirmingClose {
  - confirmingCloseForm :: ConfirmingRadioFieldForm (HydraEvent Tx) Name
  }
data SelectAddressItem
- = ManualEntry
- | SelectAddress AddressInEra
newtype ClosedState = ClosedState {
- contestationDeadline :: UTCTime
}
data HeadState
- = Idle
- | Active {
  - activeLink :: ActiveLink
  }
data PendingIncrementStatus
- = PendingDeposit
- | FinalizingDeposit
data PendingIncrement = PendingIncrement {
- utxoToCommit :: UTxO
- deposit :: TxId
- depositDeadline :: UTCTime
- status :: PendingIncrementStatus
}
data ActiveLink = ActiveLink {
- utxo :: UTxO
- pendingUTxOToDecommit :: UTxO
- pendingIncrements :: [PendingIncrement]
- parties :: [Party]
- headId :: HeadId
- activeHeadState :: ActiveHeadState
}
data ActiveHeadState
- = Open {
  - openState :: OpenScreen
  }
- | Closed {
  - closedState :: ClosedState
  }
- | FanoutPossible
- | FanningOut {
  - fanoutRemaining :: UTxO
  - fanoutMode :: FanoutProgressMode
  }
- | Final
type Name = Text
data ActiveTab
- = MainTab
- | FundsTab
- | EventHistoryTab
- | ModalTab
selectingUTxOToIncrementFormL :: Traversal' OpenScreen (UTxORadioFieldForm (HydraEvent Tx) Name)
selectingUTxOToDecommitFormL :: Traversal' OpenScreen (UTxORadioFieldForm (HydraEvent Tx) Name)
selectingUTxOFormL :: Traversal' OpenScreen (UTxORadioFieldForm (HydraEvent Tx) Name)
selectingRecipientFormL :: Traversal' OpenScreen (Form SelectAddressItem (HydraEvent Tx) Name)
enteringRecipientAddressFormL :: Traversal' OpenScreen (Form AddressInEra (HydraEvent Tx) Name)
enteringAmountFormL :: Traversal' OpenScreen (Form Double (HydraEvent Tx) Name)
confirmingCloseFormL :: Traversal' OpenScreen (ConfirmingRadioFieldForm (HydraEvent Tx) Name)
openStateL :: Traversal' ActiveHeadState OpenScreen
closedStateL :: Traversal' ActiveHeadState ClosedState
timeZoneL :: Lens' RootState TimeZone
themeL :: Lens' RootState Theme
recoveryFormL :: Lens' RootState (Maybe (TxIdRadioFieldForm (HydraEvent Tx) Name))
previousTabL :: Lens' RootState ActiveTab
pendingActionL :: Lens' RootState (Maybe Text)
nowL :: Lens' RootState UTCTime
logStateL :: Lens' RootState LogState
l1UTxOL :: Lens' RootState (Maybe (Map TxIn (TxOut CtxUTxO)))
fuelVkL :: Lens' RootState (Maybe (VerificationKey PaymentKey))
fuelUTxOL :: Lens' RootState (Maybe (Map TxIn (TxOut CtxUTxO)))
fanoutSelectionFormL :: Lens' RootState (Maybe (UTxOCheckboxForm (HydraEvent Tx) Name))
eventHistoryListL :: Lens' RootState (List Name LogMessage)
eventHistoryFilterL :: Lens' RootState EventHistoryFilter
eventDetailRawL :: Lens' RootState Bool
connectedStateL :: Lens' RootState ConnectedState
activeTabL :: Lens' RootState ActiveTab
connectionL :: Traversal' ConnectedState Connection
peersL :: Lens' Connection [(Host, PeerStatus)]
networkStateL :: Lens' Connection (Maybe NetworkState)
meL :: Lens' Connection IdentifiedState
headStateL :: Lens' Connection HeadState
chainSyncedStatusL :: Lens' Connection ChainSyncedStatus
activeLinkL :: Traversal' HeadState ActiveLink
utxoL :: Lens' ActiveLink UTxO
pendingUTxOToDecommitL :: Lens' ActiveLink UTxO
pendingIncrementsL :: Lens' ActiveLink [PendingIncrement]
activeHeadStateL :: Lens' ActiveLink ActiveHeadState
eventHistoryListName :: Name
mainUTxOViewportName :: Name
fundsL2ViewportName :: Name
fundsL1ViewportName :: Name
fundsFuelViewportName :: Name
fanoutSelectionViewportName :: Name
emptyEventHistoryList :: List Name LogMessage
emptyConnection :: Connection
newActiveLink :: [Party] -> HeadId -> ActiveLink
isModalOpen :: RootState -> Bool
recoverHeadState :: UTCTime -> HeadState -> NodeState Tx -> HeadState

Documentation

data TUIEvent tx Source #

TUI-local event wrapper so we can inject async results alongside Hydra node events.

Constructors

NodeEvent (HydraEvent tx)
UTxOQueryResult (Map TxIn (TxOut CtxUTxO))
L1UTxORefresh (Map TxIn (TxOut CtxUTxO))
FuelUTxORefresh (Map TxIn (TxOut CtxUTxO))
TxBuildError Text

data RootState Source #

Constructors

RootState

Fields

nodeHost :: Host
now :: UTCTime
timeZone :: TimeZone
connectedState :: ConnectedState
logState :: LogState
activeTab :: ActiveTab
eventDetailRaw :: Bool
eventHistoryList :: List Name LogMessage
pendingAction :: Maybe Text
l1UTxO :: Maybe (Map TxIn (TxOut CtxUTxO))
fuelVk :: Maybe (VerificationKey PaymentKey)
Verification key of the node's internal wallet, if a fuel key was configured. Used to derive the fuel address and highlight its outputs.
fuelUTxO :: Maybe (Map TxIn (TxOut CtxUTxO))
Last queried UTxO at the fuel address. Display-only; never committed.
previousTab :: ActiveTab
theme :: Theme
recoveryForm :: Maybe (TxIdRadioFieldForm (HydraEvent Tx) Name)
fanoutSelectionForm :: Maybe (UTxOCheckboxForm (HydraEvent Tx) Name)
When set, the operator is multi-selecting which UTxOs to fan out for a selective PartialFanout (a top-level modal flow, like $sel:recoveryForm:RootState). Available regardless of head state once fanout is possible.
eventHistoryFilter :: EventHistoryFilter

data ConnectedState Source #

Connection to the hydra node.

Constructors

Disconnected
Connected
Fields connection :: Connection

data IdentifiedState Source #

Constructors

Unidentified
Identified Party

data NetworkState Source #

Connectivity of the hydra node to the hydra network.

Constructors

NetworkConnected
NetworkDisconnected

data ChainSyncedStatus Source #

Synchronization status of the hydra node to the cardano chain.

Constructors

InSync
CatchingUp

data PeerStatus Source #

Constructors

PeerIsConnected
PeerIsDisconnected
PeerIsUnknown

data Connection Source #

Constructors

Connection
Fields me :: IdentifiedState peers :: [(Host, PeerStatus)] networkState :: Maybe NetworkState chainSyncedStatus :: ChainSyncedStatus headState :: HeadState

type UTxOCheckboxForm e n = Form (Map TxIn (TxOut CtxUTxO, Bool)) e n Source #

type UTxORadioFieldForm e n = Form (TxIn, TxOut CtxUTxO) e n Source #

type TxIdRadioFieldForm e n = Form TxId e n Source #

type ConfirmingRadioFieldForm e n = Form Bool e n Source #

data OpenScreen Source #

Constructors

OpenHome
LoadingUTxOForIncrement
NoUTxOToIncrement
SelectingUTxO
Fields selectingUTxOForm :: UTxORadioFieldForm (HydraEvent Tx) Name
SelectingUTxOToDecommit
Fields selectingUTxOToDecommitForm :: UTxORadioFieldForm (HydraEvent Tx) Name
SelectingUTxOToIncrement
Fields selectingUTxOToIncrementForm :: UTxORadioFieldForm (HydraEvent Tx) Name
EnteringAmount
Fields utxoSelected :: (TxIn, TxOut CtxUTxO) enteringAmountForm :: Form Double (HydraEvent Tx) Name
SelectingRecipient
Fields utxoSelected :: (TxIn, TxOut CtxUTxO) amountEntered :: Double selectingRecipientForm :: Form SelectAddressItem (HydraEvent Tx) Name
EnteringRecipientAddress
Fields utxoSelected :: (TxIn, TxOut CtxUTxO) amountEntered :: Double enteringRecipientAddressForm :: Form AddressInEra (HydraEvent Tx) Name
ConfirmingClose
Fields confirmingCloseForm :: ConfirmingRadioFieldForm (HydraEvent Tx) Name

data SelectAddressItem Source #

Constructors

ManualEntry
SelectAddress AddressInEra

Instances

Instances details

Show SelectAddressItem Source #
Instance details Defined in Hydra.TUI.Model Methods showsPrec :: Int -> SelectAddressItem -> ShowS Source # show :: SelectAddressItem -> String Source # showList :: [SelectAddressItem] -> ShowS Source #
Eq SelectAddressItem Source #
Instance details Defined in Hydra.TUI.Model Methods (==) :: SelectAddressItem -> SelectAddressItem -> Bool Source # (/=) :: SelectAddressItem -> SelectAddressItem -> Bool Source #
Pretty SelectAddressItem Source #
Instance details Defined in Hydra.TUI.Model Methods pretty :: SelectAddressItem -> Doc ann prettyList :: [SelectAddressItem] -> Doc ann

newtype ClosedState Source #

Constructors

ClosedState
Fields contestationDeadline :: UTCTime

data HeadState Source #

Constructors

Idle
Active
Fields activeLink :: ActiveLink

data PendingIncrementStatus Source #

Constructors

PendingDeposit
FinalizingDeposit

Instances

Instances details

Show PendingIncrementStatus Source #
Instance details Defined in Hydra.TUI.Model Methods showsPrec :: Int -> PendingIncrementStatus -> ShowS Source # show :: PendingIncrementStatus -> String Source # showList :: [PendingIncrementStatus] -> ShowS Source #

data PendingIncrement Source #

Constructors

PendingIncrement
Fields utxoToCommit :: UTxO deposit :: TxId depositDeadline :: UTCTime status :: PendingIncrementStatus

data ActiveLink Source #

Constructors

ActiveLink
Fields utxo :: UTxO pendingUTxOToDecommit :: UTxO pendingIncrements :: [PendingIncrement] parties :: [Party] headId :: HeadId activeHeadState :: ActiveHeadState

data ActiveHeadState Source #

Constructors

Open
Fields openState :: OpenScreen
Closed
Fields closedState :: ClosedState
FanoutPossible
FanningOut	A selective partial fanout is in progress (on-chain `FanoutProgress`): some UTxO has been distributed and `$sel:fanoutRemaining:Open` is still in the head. Only further partial fanouts are accepted (no full `Fanout`). `$sel:fanoutMode:Open` (reported by the node) says whether it keeps draining on its own or awaits the next selection, driving what the UI offers.
Fields fanoutRemaining :: UTxO fanoutMode :: FanoutProgressMode
Final

type Name = Text Source #

data ActiveTab Source #

Constructors

MainTab
FundsTab
EventHistoryTab
ModalTab

Instances

Instances details

Eq ActiveTab Source #
Instance details Defined in Hydra.TUI.Model Methods (==) :: ActiveTab -> ActiveTab -> Bool Source # (/=) :: ActiveTab -> ActiveTab -> Bool Source #