Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Chain.Direct.State

Contents

States & transitions
Constructing transactions
Helpers
Observing Transitions
Generators
- Warning zone
- Danger zone
Orphan instances

Description

Contains the a state-ful interface to transaction construction and observation.

It defines the 'ChainStateType tx' to be used in the Direct layer and it's constituents.

Synopsis

class HasKnownUTxO a where
- getKnownUTxO :: a -> UTxO
data ChainStateAt = ChainStateAt {
- spendableUTxO :: UTxO
- recordedAt :: Maybe ChainPoint
}
chainSlotFromPoint :: ChainPoint -> ChainSlot
data ChainTransition
- = Init
- | Abort
- | Commit
- | Collect
- | Increment
- | Decrement
- | Close
- | Contest
- | Fanout
data ChainState
- = Idle
- | Initial InitialState
- | Open OpenState
- | Closed ClosedState
initialChainState :: ChainStateType Tx
data ChainContext = ChainContext {
- networkId :: NetworkId
- ownVerificationKey :: VerificationKey PaymentKey
- ownParty :: Party
- scriptRegistry :: ScriptRegistry
}
data InitialState = InitialState {
- initialThreadOutput :: InitialThreadOutput
- initialInitials :: [(TxIn, TxOut CtxUTxO)]
- initialCommits :: [(TxIn, TxOut CtxUTxO)]
- headId :: HeadId
- seedTxIn :: TxIn
}
data OpenState = OpenState {
- openThreadOutput :: OpenThreadOutput
- headId :: HeadId
- seedTxIn :: TxIn
- openUtxoHash :: UTxOHash
}
data ClosedState = ClosedState {
- closedThreadOutput :: ClosedThreadOutput
- headId :: HeadId
- seedTxIn :: TxIn
}
initialize :: ChainContext -> TxIn -> [OnChainId] -> HeadParameters -> Tx
commit :: ChainContext -> HeadId -> UTxO -> UTxO -> Either (PostTxError Tx) Tx
commit' :: ChainContext -> HeadId -> UTxO -> CommitBlueprintTx Tx -> Either (PostTxError Tx) Tx
rejectByronAddress :: UTxO -> Either (PostTxError Tx) ()
rejectMoreThanMainnetLimit :: NetworkId -> UTxO -> Either (PostTxError Tx) ()
abort :: ChainContext -> TxIn -> UTxO -> UTxO -> Either AbortTxError Tx
data CollectTxError
- = InvalidHeadIdInCollect {
  - headId :: HeadId
  }
- | CannotFindHeadOutputToCollect
collect :: ChainContext -> HeadId -> HeadParameters -> UTxO -> UTxO -> Either CollectTxError Tx
data IncrementTxError
- = InvalidHeadIdInIncrement {
  - headId :: HeadId
  }
- | CannotFindHeadOutputInIncrement
- | CannotFindDepositOutputInIncrement {
  - depositTxId :: TxId
  }
- | SnapshotMissingIncrementUTxO
- | SnapshotIncrementUTxOIsNull
increment :: ChainContext -> UTxO -> HeadId -> HeadParameters -> ConfirmedSnapshot Tx -> TxId -> SlotNo -> Either IncrementTxError Tx
data DecrementTxError
- = InvalidHeadIdInDecrement {
  - headId :: HeadId
  }
- | CannotFindHeadOutputInDecrement
- | DecrementValueNegative
- | SnapshotDecrementUTxOIsNull
decrement :: ChainContext -> UTxO -> HeadId -> HeadParameters -> ConfirmedSnapshot Tx -> Either DecrementTxError Tx
data CloseTxError
- = InvalidHeadIdInClose {
  - headId :: HeadId
  }
- | CannotFindHeadOutputToClose
data RecoverTxError
- = InvalidHeadIdInRecover {
  - headId :: HeadId
  }
- | CannotFindDepositOutputToRecover {
  - depositTxId :: TxId
  }
- | CannotFindDepositedOutputToRecover {
  - depositedTxId :: TxId
  }
recover :: ChainContext -> HeadId -> TxId -> UTxO -> SlotNo -> Either RecoverTxError Tx
close :: ChainContext -> UTxO -> HeadId -> HeadParameters -> SnapshotVersion -> ConfirmedSnapshot Tx -> SlotNo -> PointInTime -> Either CloseTxError Tx
data ContestTxError
- = InvalidHeadIdInContest {
  - headId :: HeadId
  }
- | CannotFindHeadOutputToContest
- | MissingHeadDatumInContest
- | MissingHeadRedeemerInContest
- | WrongDatumInContest
- | FailedToConvertFromScriptDataInContest
contest :: ChainContext -> UTxO -> HeadId -> ContestationPeriod -> SnapshotVersion -> ConfirmedSnapshot Tx -> PointInTime -> Either ContestTxError Tx
data FanoutTxError
- = CannotFindHeadOutputToFanout
- | MissingHeadDatumInFanout
- | WrongDatumInFanout
- | FailedToConvertFromScriptDataInFanout
fanout :: ChainContext -> UTxO -> TxIn -> UTxO -> Maybe UTxO -> SlotNo -> Either FanoutTxError Tx
utxoOfThisHead :: PolicyId -> UTxO -> UTxO
observeInit :: ChainContext -> [VerificationKey PaymentKey] -> Tx -> Either NotAnInitReason (OnChainTx Tx, InitialState)
observeCommit :: ChainContext -> InitialState -> Tx -> Maybe (OnChainTx Tx, InitialState)
observeCollect :: InitialState -> Tx -> Maybe (OnChainTx Tx, OpenState)
observeClose :: OpenState -> Tx -> Maybe (OnChainTx Tx, ClosedState)
maxGenParties :: Int
maxGenAssets :: Int
genChainState :: Gen ChainState
genChainStateWithTx :: Gen (ChainContext, ChainState, UTxO, Tx, ChainTransition)
data HydraContext = HydraContext {
- ctxVerificationKeys :: [VerificationKey PaymentKey]
- ctxHydraSigningKeys :: [SigningKey HydraKey]
- ctxNetworkId :: NetworkId
- ctxContestationPeriod :: ContestationPeriod
- ctxScriptRegistry :: ScriptRegistry
}
ctxParties :: HydraContext -> [Party]
ctxParticipants :: HydraContext -> [OnChainId]
ctxHeadParameters :: HydraContext -> HeadParameters
genHydraContext :: Int -> Gen HydraContext
genHydraContextFor :: Int -> Gen HydraContext
deriveChainContexts :: HydraContext -> Gen [ChainContext]
pickChainContext :: HydraContext -> Gen ChainContext
genStInitial :: HydraContext -> Gen (ChainContext, InitialState)
genInitTx :: HydraContext -> Gen Tx
genCommits :: HydraContext -> Tx -> Gen [Tx]
genCommits' :: Gen UTxO -> HydraContext -> Tx -> Gen [Tx]
genCommitFor :: VerificationKey PaymentKey -> Gen UTxO
genCommit :: Gen UTxO
genCollectComTx :: Gen (ChainContext, [UTxO], InitialState, UTxO, Tx)
genDepositTx :: Gen (UTxO, Tx)
genRecoverTx :: Gen (UTxO, Tx)
genIncrementTx :: Int -> Gen (ChainContext, [TxOut CtxUTxO], OpenState, UTxO, Tx)
genDecrementTx :: Int -> Gen (ChainContext, [TxOut CtxUTxO], OpenState, UTxO, Tx)
genCloseTx :: Int -> Gen (ChainContext, OpenState, UTxO, Tx, ConfirmedSnapshot Tx)
genContestTx :: Gen (HydraContext, PointInTime, ClosedState, UTxO, Tx)
genFanoutTx :: Int -> Int -> Gen (HydraContext, ClosedState, UTxO, Tx)
getContestationDeadline :: ClosedState -> UTCTime
genStOpen :: HydraContext -> Gen (UTxO, OpenState)
genStClosed :: HydraContext -> UTxO -> Maybe UTxO -> Gen (SnapshotNumber, UTxO, Maybe UTxO, ClosedState)
unsafeCommit :: HasCallStack => ChainContext -> HeadId -> UTxO -> UTxO -> Tx
unsafeAbort :: HasCallStack => ChainContext -> TxIn -> UTxO -> UTxO -> Tx
unsafeIncrement :: HasCallStack => ChainContext -> UTxO -> HeadId -> HeadParameters -> ConfirmedSnapshot Tx -> TxId -> SlotNo -> Tx
unsafeDecrement :: HasCallStack => ChainContext -> UTxO -> HeadId -> HeadParameters -> ConfirmedSnapshot Tx -> Tx
unsafeClose :: HasCallStack => ChainContext -> UTxO -> HeadId -> HeadParameters -> SnapshotVersion -> ConfirmedSnapshot Tx -> SlotNo -> PointInTime -> Tx
unsafeCollect :: ChainContext -> HeadId -> HeadParameters -> UTxO -> UTxO -> Tx
unsafeContest :: HasCallStack => ChainContext -> UTxO -> HeadId -> ContestationPeriod -> SnapshotVersion -> ConfirmedSnapshot Tx -> PointInTime -> Tx
unsafeFanout :: HasCallStack => ChainContext -> UTxO -> TxIn -> UTxO -> Maybe UTxO -> SlotNo -> Tx
unsafeObserveInit :: HasCallStack => ChainContext -> [VerificationKey PaymentKey] -> Tx -> InitialState
unsafeObserveInitAndCommits :: HasCallStack => ChainContext -> [VerificationKey PaymentKey] -> Tx -> [Tx] -> ([UTxO], InitialState)

Documentation

class HasKnownUTxO a where Source #

A class for accessing the known UTxO' set in a type. This is useful to get all the relevant UTxO for resolving transaction inputs.

Methods

getKnownUTxO :: a -> UTxO Source #

Instances

Instances details

HasKnownUTxO ChainContext Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: ChainContext -> UTxO Source #
HasKnownUTxO ChainState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: ChainState -> UTxO Source #
HasKnownUTxO ClosedState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: ClosedState -> UTxO Source #
HasKnownUTxO InitialState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: InitialState -> UTxO Source #
HasKnownUTxO OpenState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: OpenState -> UTxO Source #

States & transitions

data ChainStateAt Source #

The chain state used by the Hydra.Chain.Direct implementation. It records the actual ChainState paired with a ChainSlot (used to know up to which point to rewind on rollbacks).

Constructors

ChainStateAt
Fields spendableUTxO :: UTxO recordedAt :: Maybe ChainPoint

Instances

Instances details

Arbitrary ChainStateAt Source #
Instance details Defined in Hydra.Chain.Direct.State Methods arbitrary :: Gen ChainStateAt shrink :: ChainStateAt -> [ChainStateAt]
FromJSON ChainStateAt Source #
Instance details Defined in Hydra.Chain.Direct.State Methods parseJSON :: Value -> Parser ChainStateAt parseJSONList :: Value -> Parser [ChainStateAt] omittedField :: Maybe ChainStateAt
ToJSON ChainStateAt Source #
Instance details Defined in Hydra.Chain.Direct.State Methods toJSON :: ChainStateAt -> Value toEncoding :: ChainStateAt -> Encoding toJSONList :: [ChainStateAt] -> Value toEncodingList :: [ChainStateAt] -> Encoding omitField :: ChainStateAt -> Bool
Generic ChainStateAt Source #
Instance details Defined in Hydra.Chain.Direct.State Associated Types type Rep ChainStateAt :: Type -> Type Source # Methods from :: ChainStateAt -> Rep ChainStateAt x Source # to :: Rep ChainStateAt x -> ChainStateAt Source #
Show ChainStateAt Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> ChainStateAt -> ShowS Source # show :: ChainStateAt -> String Source # showList :: [ChainStateAt] -> ShowS Source #
Eq ChainStateAt Source #
Instance details Defined in Hydra.Chain.Direct.State Methods (==) :: ChainStateAt -> ChainStateAt -> Bool Source # (/=) :: ChainStateAt -> ChainStateAt -> Bool Source #
type Rep ChainStateAt Source #
Instance details Defined in Hydra.Chain.Direct.State type Rep ChainStateAt = D1 ('MetaData "ChainStateAt" "Hydra.Chain.Direct.State" "hydra-node-0.20.0-GJlHI5giGamBfggh7PdYBV" 'False) (C1 ('MetaCons "ChainStateAt" 'PrefixI 'True) (S1 ('MetaSel ('Just "spendableUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTxO) :*: S1 ('MetaSel ('Just "recordedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChainPoint))))

chainSlotFromPoint :: ChainPoint -> ChainSlot Source #

Get a generic ChainSlot from a Cardano ChainPoint. Slot 0 is used for the genesis point.

data ChainTransition Source #

A definition of all transitions between ChainStates. Enumerable and bounded to be used as labels for checking coverage.

Constructors

Init
Abort
Commit
Collect
Increment
Decrement
Close
Contest
Fanout

Instances

Instances details

Bounded ChainTransition Source #
Instance details Defined in Hydra.Chain.Direct.State Methods minBound :: ChainTransition Source # maxBound :: ChainTransition Source #
Enum ChainTransition Source #
Instance details Defined in Hydra.Chain.Direct.State Methods succ :: ChainTransition -> ChainTransition Source # pred :: ChainTransition -> ChainTransition Source # toEnum :: Int -> ChainTransition Source # fromEnum :: ChainTransition -> Int Source # enumFrom :: ChainTransition -> [ChainTransition] Source # enumFromThen :: ChainTransition -> ChainTransition -> [ChainTransition] Source # enumFromTo :: ChainTransition -> ChainTransition -> [ChainTransition] Source # enumFromThenTo :: ChainTransition -> ChainTransition -> ChainTransition -> [ChainTransition] Source #
Show ChainTransition Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> ChainTransition -> ShowS Source # show :: ChainTransition -> String Source # showList :: [ChainTransition] -> ShowS Source #
Eq ChainTransition Source #
Instance details Defined in Hydra.Chain.Direct.State Methods (==) :: ChainTransition -> ChainTransition -> Bool Source # (/=) :: ChainTransition -> ChainTransition -> Bool Source #

data ChainState Source #

An enumeration of all possible on-chain states of a Hydra Head, where each case stores the relevant information to construct & observe transactions to other states.

Constructors

Idle	The idle state does not contain any head-specific information and exists to be used as a starting and terminal state.
Initial InitialState
Open OpenState
Closed ClosedState

Instances

Instances details

Arbitrary ChainState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods arbitrary :: Gen ChainState shrink :: ChainState -> [ChainState]
FromJSON ChainState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods parseJSON :: Value -> Parser ChainState parseJSONList :: Value -> Parser [ChainState] omittedField :: Maybe ChainState
ToJSON ChainState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods toJSON :: ChainState -> Value toEncoding :: ChainState -> Encoding toJSONList :: [ChainState] -> Value toEncodingList :: [ChainState] -> Encoding omitField :: ChainState -> Bool
Generic ChainState Source #
Instance details Defined in Hydra.Chain.Direct.State Associated Types type Rep ChainState :: Type -> Type Source # Methods from :: ChainState -> Rep ChainState x Source # to :: Rep ChainState x -> ChainState Source #
Show ChainState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> ChainState -> ShowS Source # show :: ChainState -> String Source # showList :: [ChainState] -> ShowS Source #
Eq ChainState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods (==) :: ChainState -> ChainState -> Bool Source # (/=) :: ChainState -> ChainState -> Bool Source #
HasKnownUTxO ChainState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: ChainState -> UTxO Source #
type Rep ChainState Source #
Instance details Defined in Hydra.Chain.Direct.State type Rep ChainState = D1 ('MetaData "ChainState" "Hydra.Chain.Direct.State" "hydra-node-0.20.0-GJlHI5giGamBfggh7PdYBV" 'False) ((C1 ('MetaCons "Idle" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Initial" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InitialState))) :+: (C1 ('MetaCons "Open" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OpenState)) :+: C1 ('MetaCons "Closed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ClosedState))))

initialChainState :: ChainStateType Tx Source #

Defines the starting state of the direct chain layer.

data ChainContext Source #

Read-only chain-specific data. This is different to HydraContext as it only contains data known to single peer.

Constructors

ChainContext
Fields networkId :: NetworkId ownVerificationKey :: VerificationKey PaymentKey ownParty :: Party scriptRegistry :: ScriptRegistry

Instances

Instances details

Arbitrary ChainContext Source #
Instance details Defined in Hydra.Chain.Direct.State Methods arbitrary :: Gen ChainContext shrink :: ChainContext -> [ChainContext]
FromJSON ChainContext Source #
Instance details Defined in Hydra.Chain.Direct.State Methods parseJSON :: Value -> Parser ChainContext parseJSONList :: Value -> Parser [ChainContext] omittedField :: Maybe ChainContext
ToJSON ChainContext Source #
Instance details Defined in Hydra.Chain.Direct.State Methods toJSON :: ChainContext -> Value toEncoding :: ChainContext -> Encoding toJSONList :: [ChainContext] -> Value toEncodingList :: [ChainContext] -> Encoding omitField :: ChainContext -> Bool
Generic ChainContext Source #
Instance details Defined in Hydra.Chain.Direct.State Associated Types type Rep ChainContext :: Type -> Type Source # Methods from :: ChainContext -> Rep ChainContext x Source # to :: Rep ChainContext x -> ChainContext Source #
Show ChainContext Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> ChainContext -> ShowS Source # show :: ChainContext -> String Source # showList :: [ChainContext] -> ShowS Source #
Eq ChainContext Source #
Instance details Defined in Hydra.Chain.Direct.State Methods (==) :: ChainContext -> ChainContext -> Bool Source # (/=) :: ChainContext -> ChainContext -> Bool Source #
HasKnownUTxO ChainContext Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: ChainContext -> UTxO Source #
type Rep ChainContext Source #
Instance details Defined in Hydra.Chain.Direct.State type Rep ChainContext = D1 ('MetaData "ChainContext" "Hydra.Chain.Direct.State" "hydra-node-0.20.0-GJlHI5giGamBfggh7PdYBV" 'False) (C1 ('MetaCons "ChainContext" 'PrefixI 'True) ((S1 ('MetaSel ('Just "networkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NetworkId) :: S1 ('MetaSel ('Just "ownVerificationKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VerificationKey PaymentKey))) :: (S1 ('MetaSel ('Just "ownParty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Party) :*: S1 ('MetaSel ('Just "scriptRegistry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScriptRegistry))))

data InitialState Source #

Constructors

InitialState
Fields initialThreadOutput :: InitialThreadOutput initialInitials :: [(TxIn, TxOut CtxUTxO)] initialCommits :: [(TxIn, TxOut CtxUTxO)] headId :: HeadId seedTxIn :: TxIn

Instances

Instances details

Arbitrary InitialState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods arbitrary :: Gen InitialState shrink :: InitialState -> [InitialState]
FromJSON InitialState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods parseJSON :: Value -> Parser InitialState parseJSONList :: Value -> Parser [InitialState] omittedField :: Maybe InitialState
ToJSON InitialState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods toJSON :: InitialState -> Value toEncoding :: InitialState -> Encoding toJSONList :: [InitialState] -> Value toEncodingList :: [InitialState] -> Encoding omitField :: InitialState -> Bool
Generic InitialState Source #
Instance details Defined in Hydra.Chain.Direct.State Associated Types type Rep InitialState :: Type -> Type Source # Methods from :: InitialState -> Rep InitialState x Source # to :: Rep InitialState x -> InitialState Source #
Show InitialState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> InitialState -> ShowS Source # show :: InitialState -> String Source # showList :: [InitialState] -> ShowS Source #
Eq InitialState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods (==) :: InitialState -> InitialState -> Bool Source # (/=) :: InitialState -> InitialState -> Bool Source #
HasKnownUTxO InitialState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: InitialState -> UTxO Source #
type Rep InitialState Source #
Instance details Defined in Hydra.Chain.Direct.State type Rep InitialState = D1 ('MetaData "InitialState" "Hydra.Chain.Direct.State" "hydra-node-0.20.0-GJlHI5giGamBfggh7PdYBV" 'False) (C1 ('MetaCons "InitialState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "initialThreadOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InitialThreadOutput) :: S1 ('MetaSel ('Just "initialInitials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(TxIn, TxOut CtxUTxO)])) :: (S1 ('MetaSel ('Just "initialCommits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(TxIn, TxOut CtxUTxO)]) :: (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "seedTxIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxIn)))))

data OpenState Source #

Constructors

OpenState
Fields openThreadOutput :: OpenThreadOutput headId :: HeadId seedTxIn :: TxIn openUtxoHash :: UTxOHash

Instances

Instances details

Arbitrary OpenState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods arbitrary :: Gen OpenState shrink :: OpenState -> [OpenState]
FromJSON OpenState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods parseJSON :: Value -> Parser OpenState parseJSONList :: Value -> Parser [OpenState] omittedField :: Maybe OpenState
ToJSON OpenState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods toJSON :: OpenState -> Value toEncoding :: OpenState -> Encoding toJSONList :: [OpenState] -> Value toEncodingList :: [OpenState] -> Encoding omitField :: OpenState -> Bool
Generic OpenState Source #
Instance details Defined in Hydra.Chain.Direct.State Associated Types type Rep OpenState :: Type -> Type Source # Methods from :: OpenState -> Rep OpenState x Source # to :: Rep OpenState x -> OpenState Source #
Show OpenState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> OpenState -> ShowS Source # show :: OpenState -> String Source # showList :: [OpenState] -> ShowS Source #
Eq OpenState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods (==) :: OpenState -> OpenState -> Bool Source # (/=) :: OpenState -> OpenState -> Bool Source #
HasKnownUTxO OpenState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: OpenState -> UTxO Source #
type Rep OpenState Source #
Instance details Defined in Hydra.Chain.Direct.State type Rep OpenState = D1 ('MetaData "OpenState" "Hydra.Chain.Direct.State" "hydra-node-0.20.0-GJlHI5giGamBfggh7PdYBV" 'False) (C1 ('MetaCons "OpenState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "openThreadOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OpenThreadOutput) :: S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId)) :: (S1 ('MetaSel ('Just "seedTxIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxIn) :*: S1 ('MetaSel ('Just "openUtxoHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTxOHash))))

data ClosedState Source #

Constructors

ClosedState
Fields closedThreadOutput :: ClosedThreadOutput headId :: HeadId seedTxIn :: TxIn

Instances

Instances details

Arbitrary ClosedState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods arbitrary :: Gen ClosedState shrink :: ClosedState -> [ClosedState]
FromJSON ClosedState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods parseJSON :: Value -> Parser ClosedState parseJSONList :: Value -> Parser [ClosedState] omittedField :: Maybe ClosedState
ToJSON ClosedState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods toJSON :: ClosedState -> Value toEncoding :: ClosedState -> Encoding toJSONList :: [ClosedState] -> Value toEncodingList :: [ClosedState] -> Encoding omitField :: ClosedState -> Bool
Generic ClosedState Source #
Instance details Defined in Hydra.Chain.Direct.State Associated Types type Rep ClosedState :: Type -> Type Source # Methods from :: ClosedState -> Rep ClosedState x Source # to :: Rep ClosedState x -> ClosedState Source #
Show ClosedState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> ClosedState -> ShowS Source # show :: ClosedState -> String Source # showList :: [ClosedState] -> ShowS Source #
Eq ClosedState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods (==) :: ClosedState -> ClosedState -> Bool Source # (/=) :: ClosedState -> ClosedState -> Bool Source #
HasKnownUTxO ClosedState Source #
Instance details Defined in Hydra.Chain.Direct.State Methods getKnownUTxO :: ClosedState -> UTxO Source #
type Rep ClosedState Source #
Instance details Defined in Hydra.Chain.Direct.State type Rep ClosedState = D1 ('MetaData "ClosedState" "Hydra.Chain.Direct.State" "hydra-node-0.20.0-GJlHI5giGamBfggh7PdYBV" 'False) (C1 ('MetaCons "ClosedState" 'PrefixI 'True) (S1 ('MetaSel ('Just "closedThreadOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ClosedThreadOutput) :: (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "seedTxIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxIn))))

Constructing transactions

initialize Source #

Arguments

:: ChainContext
-> TxIn	Seed input.
-> [OnChainId]	Verification key hashes of all participants.
-> HeadParameters
-> Tx

Construct an init transaction given some general ChainContext, the HeadParameters and a seed TxIn which will be spent.

commit Source #

Arguments

:: ChainContext
-> HeadId
-> UTxO	Spendable `UTxO'`
-> UTxO	`UTxO'` to commit. All outputs are assumed to be owned by public keys
-> Either (PostTxError Tx) Tx

Construct a commit transaction based on known, spendable UTxO and some arbitrary UTxOs to commit. This does look for "our initial output" to spend and check the given UTxO' to be compatible. Hence, this function does fail if already committed or if the head is not initializing.

NOTE: This version of commit does only commit outputs which are held by payment keys. For a variant which supports committing scripts, see commit'.

commit' Source #

Arguments

:: ChainContext
-> HeadId
-> UTxO	Spendable `UTxO'`
-> CommitBlueprintTx Tx
-> Either (PostTxError Tx) Tx

Construct a commit transaction based on known, spendable UTxO and some user UTxO inputs to commit. This does look for "our initial output" to spend and check the given UTxO' to be compatible. Hence, this function does fail if already committed or if the head is not initializing.

NOTE: A simpler variant only supporting pubkey outputs is commit.

rejectByronAddress :: UTxO -> Either (PostTxError Tx) () Source #

rejectMoreThanMainnetLimit :: NetworkId -> UTxO -> Either (PostTxError Tx) () Source #

abort Source #

Arguments

:: ChainContext
-> TxIn	Seed TxIn
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> UTxO	Committed UTxOs to reimburse.
-> Either AbortTxError Tx

Construct a abort transaction based on known, spendable UTxO. This function looks for head, initial and commit outputs to spend and it will fail if we can't find the head output.

data CollectTxError Source #

Constructors

InvalidHeadIdInCollect
Fields headId :: HeadId
CannotFindHeadOutputToCollect

Instances

Instances details

Show CollectTxError Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> CollectTxError -> ShowS Source # show :: CollectTxError -> String Source # showList :: [CollectTxError] -> ShowS Source #

collect Source #

Arguments

:: ChainContext
-> HeadId
-> HeadParameters
-> UTxO	UTxO to be used to collect. Should match whatever is recorded in the commit inputs.
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> Either CollectTxError Tx

Construct a collect transaction based on known, spendable UTxO. This function looks for head output and commit outputs to spend and it will fail if we can't find the head output.

data IncrementTxError Source #

Constructors

InvalidHeadIdInIncrement
Fields headId :: HeadId
CannotFindHeadOutputInIncrement
CannotFindDepositOutputInIncrement
Fields depositTxId :: TxId
SnapshotMissingIncrementUTxO
SnapshotIncrementUTxOIsNull

Instances

Instances details

Show IncrementTxError Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> IncrementTxError -> ShowS Source # show :: IncrementTxError -> String Source # showList :: [IncrementTxError] -> ShowS Source #

increment Source #

Arguments

:: ChainContext
-> UTxO	Spendable UTxO containing head and deposit outputs
-> HeadId
-> HeadParameters
-> ConfirmedSnapshot Tx	Snapshot to increment with.
-> TxId	Deposited TxId
-> SlotNo
-> Either IncrementTxError Tx

Construct a increment transaction spending the head and deposit outputs in given UTxO', and producing single head output for pending $sel:utxoToCommit:Snapshot of given Snapshot.

data DecrementTxError Source #

Possible errors when trying to construct decrement tx

Constructors

InvalidHeadIdInDecrement
Fields headId :: HeadId
CannotFindHeadOutputInDecrement
DecrementValueNegative
SnapshotDecrementUTxOIsNull

Instances

Instances details

Show DecrementTxError Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> DecrementTxError -> ShowS Source # show :: DecrementTxError -> String Source # showList :: [DecrementTxError] -> ShowS Source #

decrement Source #

Arguments

:: ChainContext
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> HeadId
-> HeadParameters
-> ConfirmedSnapshot Tx	Snapshot to decrement with.
-> Either DecrementTxError Tx

Construct a decrement transaction spending the head output in given UTxO', and producing outputs for all pending $sel:utxoToDecommit:Snapshot of given Snapshot.

data CloseTxError Source #

Constructors

InvalidHeadIdInClose
Fields headId :: HeadId
CannotFindHeadOutputToClose

Instances

Instances details

Show CloseTxError Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> CloseTxError -> ShowS Source # show :: CloseTxError -> String Source # showList :: [CloseTxError] -> ShowS Source #

data RecoverTxError Source #

Constructors

InvalidHeadIdInRecover
Fields headId :: HeadId
CannotFindDepositOutputToRecover
Fields depositTxId :: TxId
CannotFindDepositedOutputToRecover
Fields depositedTxId :: TxId

Instances

Instances details

Show RecoverTxError Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> RecoverTxError -> ShowS Source # show :: RecoverTxError -> String Source # showList :: [RecoverTxError] -> ShowS Source #

recover Source #

Arguments

:: ChainContext
-> HeadId
-> TxId	Deposit TxId
-> UTxO	Spendable UTxO
-> SlotNo
-> Either RecoverTxError Tx

Construct a recover transaction spending the deposit output and producing outputs the user initially deposited.

close Source #

Arguments

:: ChainContext
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> HeadId	Head id to close.
-> HeadParameters	Parameters of the head to close.
-> SnapshotVersion	Last known version of the open head. NOTE: We deliberately require a `SnapshotVersion` to be passed in, even though it could be extracted from the open head output in the spendable UTxO, to stay consistent with the way parameters are handled.
-> ConfirmedSnapshot Tx	Snapshot to close with.
-> SlotNo	`Tx` validity lower bound
-> PointInTime	`Tx` validity upper bound
-> Either CloseTxError Tx

Construct a close transaction spending the head output in given UTxO', head parameters, and a confirmed snapshot. NOTE: Lower and upper bound slot difference should not exceed contestation period.

data ContestTxError Source #

Constructors

InvalidHeadIdInContest
Fields headId :: HeadId
CannotFindHeadOutputToContest
MissingHeadDatumInContest
MissingHeadRedeemerInContest
WrongDatumInContest
FailedToConvertFromScriptDataInContest

Instances

Instances details

Show ContestTxError Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> ContestTxError -> ShowS Source # show :: ContestTxError -> String Source # showList :: [ContestTxError] -> ShowS Source #

contest Source #

Arguments

:: ChainContext
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> HeadId
-> ContestationPeriod
-> SnapshotVersion	Last known version of the open head. NOTE: We deliberately require a `SnapshotVersion` to be passed in, even though it could be extracted from the open head output in the spendable UTxO, to stay consistent with the way parameters are handled.
-> ConfirmedSnapshot Tx	Snapshot to contest with.
-> PointInTime	Current slot and posix time to be used as the contestation time.
-> Either ContestTxError Tx

Construct a contest transaction based on the ClosedState and a confirmed snapshot. The given PointInTime will be used as an upper validity bound and needs to be before the deadline.

data FanoutTxError Source #

Constructors

CannotFindHeadOutputToFanout
MissingHeadDatumInFanout
WrongDatumInFanout
FailedToConvertFromScriptDataInFanout

Instances

Instances details

Show FanoutTxError Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> FanoutTxError -> ShowS Source # show :: FanoutTxError -> String Source # showList :: [FanoutTxError] -> ShowS Source #

fanout Source #

Arguments

:: ChainContext
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> TxIn	Seed TxIn
-> UTxO	Snapshot UTxO to fanout
-> Maybe UTxO	Snapshot UTxO to decommit to fanout
-> SlotNo	Contestation deadline as SlotNo, used to set lower tx validity bound.
-> Either FanoutTxError Tx

Construct a fanout transaction based on the ClosedState and off-chain agreed UTxO' set to fan out.

Helpers

utxoOfThisHead :: PolicyId -> UTxO -> UTxO Source #

Observing Transitions

IdleState transitions

observeInit :: ChainContext -> [VerificationKey PaymentKey] -> Tx -> Either NotAnInitReason (OnChainTx Tx, InitialState) Source #

Observe an init transition using a InitialState and observeInitTx.

InitialState transitions

observeCommit :: ChainContext -> InitialState -> Tx -> Maybe (OnChainTx Tx, InitialState) Source #

Observe an commit transition using a InitialState and observeCommitTx.

observeCollect :: InitialState -> Tx -> Maybe (OnChainTx Tx, OpenState) Source #

Observe an collect transition using a InitialState and observeCollectComTx. This function checks the head id and ignores if not relevant.

OpenState transitions

observeClose :: OpenState -> Tx -> Maybe (OnChainTx Tx, ClosedState) Source #

Observe a close transition using a OpenState and observeCloseTx. This function checks the head id and ignores if not relevant.

Generators

maxGenParties :: Int Source #

Maximum number of parties used in the generators.

maxGenAssets :: Int Source #

Maximum number of assets (ADA or other tokens) used in the generators.

genChainState :: Gen ChainState Source #

Generate a ChainState within known limits above.

genChainStateWithTx :: Gen (ChainContext, ChainState, UTxO, Tx, ChainTransition) Source #

Generate a ChainContext and ChainState within the known limits above, along with a transaction that results in a transition away from it.

Warning zone

data HydraContext Source #

Define some global context from which generators can pick values for generation. This allows to write fairly independent generators which however still make sense with one another within the context of a head.

For example, one can generate a head's _party_ from that global list, whereas other functions may rely on all parties and thus, we need both generation to be coherent.

Do not use this in production code, but only for generating test data.

Constructors

HydraContext
Fields ctxVerificationKeys :: [VerificationKey PaymentKey] ctxHydraSigningKeys :: [SigningKey HydraKey] ctxNetworkId :: NetworkId ctxContestationPeriod :: ContestationPeriod ctxScriptRegistry :: ScriptRegistry

Instances

Instances details

Show HydraContext Source #
Instance details Defined in Hydra.Chain.Direct.State Methods showsPrec :: Int -> HydraContext -> ShowS Source # show :: HydraContext -> String Source # showList :: [HydraContext] -> ShowS Source #

ctxParties :: HydraContext -> [Party] Source #

ctxParticipants :: HydraContext -> [OnChainId] Source #

ctxHeadParameters :: HydraContext -> HeadParameters Source #

genHydraContext :: Int -> Gen HydraContext Source #

Generate a HydraContext for a arbitrary number of parties, bounded by given maximum.

genHydraContextFor :: Int -> Gen HydraContext Source #

Generate a HydraContext for a given number of parties.

deriveChainContexts :: HydraContext -> Gen [ChainContext] Source #

Get all peer-specific ChainContexts from a HydraContext. NOTE: This assumes that HydraContext has same length $sel:ctxVerificationKeys:HydraContext and $sel:ctxHydraSigningKeys:HydraContext. XXX: This is actually a non-monadic function.

pickChainContext :: HydraContext -> Gen ChainContext Source #

Pick one of the participants and derive the peer-specific ChainContext from a HydraContext. NOTE: This assumes that HydraContext has same length $sel:ctxVerificationKeys:HydraContext and $sel:ctxHydraSigningKeys:HydraContext.

genStInitial :: HydraContext -> Gen (ChainContext, InitialState) Source #

genInitTx :: HydraContext -> Gen Tx Source #

genCommits :: HydraContext -> Tx -> Gen [Tx] Source #

genCommits' :: Gen UTxO -> HydraContext -> Tx -> Gen [Tx] Source #

genCommitFor :: VerificationKey PaymentKey -> Gen UTxO Source #

genCommit :: Gen UTxO Source #

genCollectComTx :: Gen (ChainContext, [UTxO], InitialState, UTxO, Tx) Source #

genDepositTx :: Gen (UTxO, Tx) Source #

genRecoverTx :: Gen (UTxO, Tx) Source #

genIncrementTx :: Int -> Gen (ChainContext, [TxOut CtxUTxO], OpenState, UTxO, Tx) Source #

genDecrementTx :: Int -> Gen (ChainContext, [TxOut CtxUTxO], OpenState, UTxO, Tx) Source #

genCloseTx :: Int -> Gen (ChainContext, OpenState, UTxO, Tx, ConfirmedSnapshot Tx) Source #

genContestTx :: Gen (HydraContext, PointInTime, ClosedState, UTxO, Tx) Source #

genFanoutTx :: Int -> Int -> Gen (HydraContext, ClosedState, UTxO, Tx) Source #

getContestationDeadline :: ClosedState -> UTCTime Source #

genStOpen :: HydraContext -> Gen (UTxO, OpenState) Source #

genStClosed :: HydraContext -> UTxO -> Maybe UTxO -> Gen (SnapshotNumber, UTxO, Maybe UTxO, ClosedState) Source #

Danger zone

unsafeCommit Source #

Arguments

:: HasCallStack
=> ChainContext
-> HeadId
-> UTxO	Spendable `UTxO'`
-> UTxO	`UTxO'` to commit. All outputs are assumed to be owned by public keys.
-> Tx

unsafeAbort Source #

Arguments

:: HasCallStack
=> ChainContext
-> TxIn	Seed TxIn
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> UTxO	Committed UTxOs to reimburse.
-> Tx

unsafeIncrement Source #

Arguments

:: HasCallStack
=> ChainContext
-> UTxO	Spendable `UTxO'`
-> HeadId
-> HeadParameters
-> ConfirmedSnapshot Tx
-> TxId
-> SlotNo
-> Tx

unsafeDecrement Source #

Arguments

:: HasCallStack
=> ChainContext
-> UTxO	Spendable `UTxO'`
-> HeadId
-> HeadParameters
-> ConfirmedSnapshot Tx
-> Tx

unsafeClose Source #

Arguments

:: HasCallStack
=> ChainContext
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> HeadId
-> HeadParameters
-> SnapshotVersion
-> ConfirmedSnapshot Tx
-> SlotNo
-> PointInTime
-> Tx

Unsafe version of close that throws an error if the transaction fails to build.

unsafeCollect Source #

Arguments

:: ChainContext
-> HeadId
-> HeadParameters
-> UTxO	UTxO to be used to collect. Should match whatever is recorded in the commit inputs.
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> Tx

unsafeContest Source #

Arguments

:: HasCallStack
=> ChainContext
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> HeadId
-> ContestationPeriod
-> SnapshotVersion
-> ConfirmedSnapshot Tx
-> PointInTime
-> Tx

Unsafe version of contest that throws an error if the transaction fails to build.

unsafeFanout Source #

Arguments

:: HasCallStack
=> ChainContext
-> UTxO	Spendable UTxO containing head, initial and commit outputs
-> TxIn	Seed TxIn
-> UTxO	Snapshot UTxO to fanout
-> Maybe UTxO	Snapshot decommit UTxO to fanout
-> SlotNo	Contestation deadline as SlotNo, used to set lower tx validity bound.
-> Tx

unsafeObserveInit :: HasCallStack => ChainContext -> [VerificationKey PaymentKey] -> Tx -> InitialState Source #

unsafeObserveInitAndCommits :: HasCallStack => ChainContext -> [VerificationKey PaymentKey] -> Tx -> [Tx] -> ([UTxO], InitialState) Source #

Orphan instances

IsChainState Tx Source #
Instance details Associated Types type ChainStateType Tx = (c :: Type) Methods chainStateSlot :: ChainStateType Tx -> ChainSlot