Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.TUI.Model

Synopsis

data RootState = RootState {
- nodeHost :: Host
- now :: UTCTime
- connectedState :: ConnectedState
- logState :: LogState
}
data ConnectedState
- = Disconnected
- | Connected {
  - connection :: Connection
  }
data IdentifiedState
- = Unidentified
- | Identified Party
data NetworkState
- = NetworkConnected
- | NetworkDisconnected
data Connection = Connection {
- me :: IdentifiedState
- peers :: [Host]
- networkState :: Maybe NetworkState
- 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, TxIn, TxOut CtxUTxO) e n
type ConfirmingRadioFieldForm e n = Form Bool e n
data InitializingState = InitializingState {
- remainingParties :: [Party]
- initializingScreen :: InitializingScreen
}
data InitializingScreen
- = InitializingHome
- | CommitMenu {
  - commitMenu :: UTxOCheckboxForm (HydraEvent Tx) Name
  }
- | ConfirmingAbort {
  - confirmingAbortForm :: ConfirmingRadioFieldForm (HydraEvent Tx) Name
  }
data OpenScreen
- = OpenHome
- | SelectingUTxO {
  - selectingUTxOForm :: UTxORadioFieldForm (HydraEvent Tx) Name
  }
- | SelectingUTxOToDecommit {
  - selectingUTxOToDecommitForm :: UTxORadioFieldForm (HydraEvent Tx) Name
  }
- | SelectingUTxOToIncrement {
  - selectingUTxOToIncrementForm :: UTxORadioFieldForm (HydraEvent Tx) Name
  }
- | SelectingDepositIdToRecover {
  - selectingDepositIdToRecoverForm :: TxIdRadioFieldForm (HydraEvent Tx) Name
  }
- | EnteringAmount {
  - utxoSelected :: (TxIn, TxOut CtxUTxO)
  - enteringAmountForm :: Form Integer (HydraEvent Tx) Name
  }
- | SelectingRecipient {
  - utxoSelected :: (TxIn, TxOut CtxUTxO)
  - amountEntered :: Integer
  - selectingRecipientForm :: Form SelectAddressItem (HydraEvent Tx) Name
  }
- | EnteringRecipientAddress {
  - utxoSelected :: (TxIn, TxOut CtxUTxO)
  - amountEntered :: Integer
  - 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
- = Initializing {
  - initializingState :: InitializingState
  }
- | Open {
  - openState :: OpenScreen
  }
- | Closed {
  - closedState :: ClosedState
  }
- | FanoutPossible
- | Final
type Name = Text
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)
selectingDepositIdToRecoverFormL :: Traversal' OpenScreen (TxIdRadioFieldForm (HydraEvent Tx) Name)
enteringRecipientAddressFormL :: Traversal' OpenScreen (Form AddressInEra (HydraEvent Tx) Name)
enteringAmountFormL :: Traversal' OpenScreen (Form Integer (HydraEvent Tx) Name)
confirmingCloseFormL :: Traversal' OpenScreen (ConfirmingRadioFieldForm (HydraEvent Tx) Name)
openStateL :: Traversal' ActiveHeadState OpenScreen
initializingStateL :: Traversal' ActiveHeadState InitializingState
closedStateL :: Traversal' ActiveHeadState ClosedState
nowL :: Lens' RootState UTCTime
nodeHostL :: Lens' RootState Host
logStateL :: Lens' RootState LogState
connectedStateL :: Lens' RootState ConnectedState
connectionL :: Traversal' ConnectedState Connection
confirmingAbortFormL :: Traversal' InitializingScreen (ConfirmingRadioFieldForm (HydraEvent Tx) Name)
commitMenuL :: Traversal' InitializingScreen (UTxOCheckboxForm (HydraEvent Tx) Name)
peersL :: Lens' Connection [Host]
networkStateL :: Lens' Connection (Maybe NetworkState)
meL :: Lens' Connection IdentifiedState
headStateL :: Lens' Connection HeadState
remainingPartiesL :: Lens' InitializingState [Party]
initializingScreenL :: Lens' InitializingState InitializingScreen
activeLinkL :: Traversal' HeadState ActiveLink
utxoL :: Lens' ActiveLink UTxO
pendingUTxOToDecommitL :: Lens' ActiveLink UTxO
pendingIncrementsL :: Lens' ActiveLink [PendingIncrement]
partiesL :: Lens' ActiveLink [Party]
headIdL :: Lens' ActiveLink HeadId
activeHeadStateL :: Lens' ActiveLink ActiveHeadState
fullFeedbackViewportName :: Name
shortFeedbackViewportName :: Name
emptyConnection :: Connection
newActiveLink :: [Party] -> HeadId -> ActiveLink
isModalOpen :: RootState -> Bool

Documentation

data RootState Source #

Constructors

RootState
Fields nodeHost :: Host now :: UTCTime connectedState :: ConnectedState logState :: LogState

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 Connection Source #

Constructors

Connection
Fields me :: IdentifiedState peers :: [Host] networkState :: Maybe NetworkState 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, TxIn, TxOut CtxUTxO) e n Source #

type ConfirmingRadioFieldForm e n = Form Bool e n Source #

data InitializingState Source #

Constructors

InitializingState
Fields remainingParties :: [Party] initializingScreen :: InitializingScreen

data InitializingScreen Source #

Constructors

InitializingHome
CommitMenu
Fields commitMenu :: UTxOCheckboxForm (HydraEvent Tx) Name
ConfirmingAbort
Fields confirmingAbortForm :: ConfirmingRadioFieldForm (HydraEvent Tx) Name

data OpenScreen Source #

Constructors

OpenHome
SelectingUTxO
Fields selectingUTxOForm :: UTxORadioFieldForm (HydraEvent Tx) Name
SelectingUTxOToDecommit
Fields selectingUTxOToDecommitForm :: UTxORadioFieldForm (HydraEvent Tx) Name
SelectingUTxOToIncrement
Fields selectingUTxOToIncrementForm :: UTxORadioFieldForm (HydraEvent Tx) Name
SelectingDepositIdToRecover
Fields selectingDepositIdToRecoverForm :: TxIdRadioFieldForm (HydraEvent Tx) Name
EnteringAmount
Fields utxoSelected :: (TxIn, TxOut CtxUTxO) enteringAmountForm :: Form Integer (HydraEvent Tx) Name
SelectingRecipient
Fields utxoSelected :: (TxIn, TxOut CtxUTxO) amountEntered :: Integer selectingRecipientForm :: Form SelectAddressItem (HydraEvent Tx) Name
EnteringRecipientAddress
Fields utxoSelected :: (TxIn, TxOut CtxUTxO) amountEntered :: Integer 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

Initializing
Fields initializingState :: InitializingState
Open
Fields openState :: OpenScreen
Closed
Fields closedState :: ClosedState
FanoutPossible
Final

type Name = Text Source #

selectingUTxOToIncrementFormL :: Traversal' OpenScreen (UTxORadioFieldForm (HydraEvent Tx) Name) Source #

selectingUTxOToDecommitFormL :: Traversal' OpenScreen (UTxORadioFieldForm (HydraEvent Tx) Name) Source #

selectingUTxOFormL :: Traversal' OpenScreen (UTxORadioFieldForm (HydraEvent Tx) Name) Source #

selectingRecipientFormL :: Traversal' OpenScreen (Form SelectAddressItem (HydraEvent Tx) Name) Source #

selectingDepositIdToRecoverFormL :: Traversal' OpenScreen (TxIdRadioFieldForm (HydraEvent Tx) Name) Source #

enteringRecipientAddressFormL :: Traversal' OpenScreen (Form AddressInEra (HydraEvent Tx) Name) Source #

enteringAmountFormL :: Traversal' OpenScreen (Form Integer (HydraEvent Tx) Name) Source #

confirmingCloseFormL :: Traversal' OpenScreen (ConfirmingRadioFieldForm (HydraEvent Tx) Name) Source #

openStateL :: Traversal' ActiveHeadState OpenScreen Source #

initializingStateL :: Traversal' ActiveHeadState InitializingState Source #

closedStateL :: Traversal' ActiveHeadState ClosedState Source #

nowL :: Lens' RootState UTCTime Source #

nodeHostL :: Lens' RootState Host Source #

logStateL :: Lens' RootState LogState Source #

connectedStateL :: Lens' RootState ConnectedState Source #

connectionL :: Traversal' ConnectedState Connection Source #

confirmingAbortFormL :: Traversal' InitializingScreen (ConfirmingRadioFieldForm (HydraEvent Tx) Name) Source #

commitMenuL :: Traversal' InitializingScreen (UTxOCheckboxForm (HydraEvent Tx) Name) Source #

peersL :: Lens' Connection [Host] Source #

networkStateL :: Lens' Connection (Maybe NetworkState) Source #

meL :: Lens' Connection IdentifiedState Source #

headStateL :: Lens' Connection HeadState Source #

remainingPartiesL :: Lens' InitializingState [Party] Source #

initializingScreenL :: Lens' InitializingState InitializingScreen Source #

activeLinkL :: Traversal' HeadState ActiveLink Source #

utxoL :: Lens' ActiveLink UTxO Source #

pendingUTxOToDecommitL :: Lens' ActiveLink UTxO Source #

pendingIncrementsL :: Lens' ActiveLink [PendingIncrement] Source #

partiesL :: Lens' ActiveLink [Party] Source #

headIdL :: Lens' ActiveLink HeadId Source #

activeHeadStateL :: Lens' ActiveLink ActiveHeadState Source #

fullFeedbackViewportName :: Name Source #

shortFeedbackViewportName :: Name Source #

emptyConnection :: Connection Source #

newActiveLink :: [Party] -> HeadId -> ActiveLink Source #

isModalOpen :: RootState -> Bool Source #

Key	Shortcut
s	Open this search box
esc	Close this search box
↓,ctrl + j	Move down in search results
↑,ctrl + k	Move up in search results
↵	Go to active search result