Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Contract.HeadState

Synopsis

type SnapshotNumber = Integer
type SnapshotVersion = Integer
type Hash = BuiltinByteString
type Signature = BuiltinByteString
data OpenDatum = OpenDatum {
- headId :: CurrencySymbol
- parties :: [Party]
- contestationPeriod :: ContestationPeriod
- version :: SnapshotVersion
- utxoHash :: Hash
}
data ClosedDatum = ClosedDatum {
- headId :: CurrencySymbol
- parties :: [Party]
- contestationPeriod :: ContestationPeriod
- version :: SnapshotVersion
- snapshotNumber :: SnapshotNumber
- utxoHash :: Hash
- deltaUTxOHash :: Hash
- contesters :: [PubKeyHash]
- contestationDeadline :: POSIXTime
}
data State
- = Initial {
  - contestationPeriod :: ContestationPeriod
  - parties :: [Party]
  - headId :: CurrencySymbol
  - seed :: TxOutRef
  }
- | Open OpenDatum
- | Closed ClosedDatum
- | Final
data CloseRedeemer
- = CloseInitial
- | CloseUnused {
  - signature :: [Signature]
  }
- | CloseUsed {
  - signature :: [Signature]
  - alreadyDecommittedUTxOHash :: Hash
  }
data ContestRedeemer
- = ContestCurrent {
  - signature :: [Signature]
  }
- | ContestOutdated {
  - signature :: [Signature]
  - alreadyDecommittedUTxOHash :: Hash
  }
data IncrementRedeemer = IncrementRedeemer
data DecrementRedeemer = DecrementRedeemer {
- signature :: [Signature]
- snapshotNumber :: SnapshotNumber
- numberOfDecommitOutputs :: Integer
}
data Input
- = CollectCom
- | Increment IncrementRedeemer
- | Decrement DecrementRedeemer
- | Close CloseRedeemer
- | Contest ContestRedeemer
- | Abort
- | Fanout {
  - numberOfFanoutOutputs :: Integer
  - numberOfDecommitOutputs :: Integer
  }

Documentation

type SnapshotNumber = Integer Source #

type SnapshotVersion = Integer Source #

type Hash = BuiltinByteString Source #

type Signature = BuiltinByteString Source #

data OpenDatum Source #

Sub-type for the open state-machine state.

Constructors

OpenDatum
Fields headId :: CurrencySymbol Spec: cid parties :: [Party] Spec: kH contestationPeriod :: ContestationPeriod Spec: T version :: SnapshotVersion Spec: v utxoHash :: Hash Spec: η

Instances

Instances details

Generic OpenDatum Source #
Instance details Defined in Hydra.Contract.HeadState Associated Types type Rep OpenDatum :: Type -> Type Source # Methods from :: OpenDatum -> Rep OpenDatum x Source # to :: Rep OpenDatum x -> OpenDatum Source #
Show OpenDatum Source #
Instance details Defined in Hydra.Contract.HeadState Methods showsPrec :: Int -> OpenDatum -> ShowS Source # show :: OpenDatum -> String Source # showList :: [OpenDatum] -> ShowS Source #
FromData OpenDatum Source #
Instance details Defined in Hydra.Contract.HeadState Methods fromBuiltinData :: BuiltinData -> Maybe OpenDatum
ToData OpenDatum Source #
Instance details Defined in Hydra.Contract.HeadState Methods toBuiltinData :: OpenDatum -> BuiltinData
UnsafeFromData OpenDatum Source #
Instance details Defined in Hydra.Contract.HeadState Methods unsafeFromBuiltinData :: BuiltinData -> OpenDatum
type Rep OpenDatum Source #
Instance details Defined in Hydra.Contract.HeadState type Rep OpenDatum = D1 ('MetaData "OpenDatum" "Hydra.Contract.HeadState" "hydra-plutus-0.20.0-LbBW0QYa4oSFBvNyDrDbFg" 'False) (C1 ('MetaCons "OpenDatum" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CurrencySymbol) :: S1 ('MetaSel ('Just "parties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Party])) :: (S1 ('MetaSel ('Just "contestationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContestationPeriod) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SnapshotVersion) :: S1 ('MetaSel ('Just "utxoHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hash)))))

data ClosedDatum Source #

Sub-type for the closed state-machine state.

Constructors

ClosedDatum

Fields

headId :: CurrencySymbol
Spec: cid
parties :: [Party]
Spec: kH
contestationPeriod :: ContestationPeriod
Spec: T
version :: SnapshotVersion
Spec: v
snapshotNumber :: SnapshotNumber
Spec: s
utxoHash :: Hash
Spec: η. Digest of snapshotted UTxO
deltaUTxOHash :: Hash
Spec: ηΔ. Digest of UTxO still to be distributed
contesters :: [PubKeyHash]
Spec: C
contestationDeadline :: POSIXTime
Spec: tfinal

Instances

Instances details

Generic ClosedDatum Source #
Instance details Defined in Hydra.Contract.HeadState Associated Types type Rep ClosedDatum :: Type -> Type Source # Methods from :: ClosedDatum -> Rep ClosedDatum x Source # to :: Rep ClosedDatum x -> ClosedDatum Source #
Show ClosedDatum Source #
Instance details Defined in Hydra.Contract.HeadState Methods showsPrec :: Int -> ClosedDatum -> ShowS Source # show :: ClosedDatum -> String Source # showList :: [ClosedDatum] -> ShowS Source #
FromData ClosedDatum Source #
Instance details Defined in Hydra.Contract.HeadState Methods fromBuiltinData :: BuiltinData -> Maybe ClosedDatum
ToData ClosedDatum Source #
Instance details Defined in Hydra.Contract.HeadState Methods toBuiltinData :: ClosedDatum -> BuiltinData
UnsafeFromData ClosedDatum Source #
Instance details Defined in Hydra.Contract.HeadState Methods unsafeFromBuiltinData :: BuiltinData -> ClosedDatum
type Rep ClosedDatum Source #
Instance details Defined in Hydra.Contract.HeadState type Rep ClosedDatum = D1 ('MetaData "ClosedDatum" "Hydra.Contract.HeadState" "hydra-plutus-0.20.0-LbBW0QYa4oSFBvNyDrDbFg" 'False) (C1 ('MetaCons "ClosedDatum" 'PrefixI 'True) (((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CurrencySymbol) :: S1 ('MetaSel ('Just "parties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Party])) :: (S1 ('MetaSel ('Just "contestationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContestationPeriod) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SnapshotVersion))) :: ((S1 ('MetaSel ('Just "snapshotNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SnapshotNumber) :: S1 ('MetaSel ('Just "utxoHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hash)) :: (S1 ('MetaSel ('Just "deltaUTxOHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hash) :: (S1 ('MetaSel ('Just "contesters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PubKeyHash]) :: S1 ('MetaSel ('Just "contestationDeadline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))))))

data State Source #

Constructors

Initial
Fields contestationPeriod :: ContestationPeriod parties :: [Party] headId :: CurrencySymbol seed :: TxOutRef
Open OpenDatum
Closed ClosedDatum
Final

Instances

Instances details

Generic State Source #
Instance details Defined in Hydra.Contract.HeadState Associated Types type Rep State :: Type -> Type Source # Methods from :: State -> Rep State x Source # to :: Rep State x -> State Source #
Show State Source #
Instance details Defined in Hydra.Contract.HeadState Methods showsPrec :: Int -> State -> ShowS Source # show :: State -> String Source # showList :: [State] -> ShowS Source #
FromData State Source #
Instance details Defined in Hydra.Contract.HeadState Methods fromBuiltinData :: BuiltinData -> Maybe State
ToData State Source #
Instance details Defined in Hydra.Contract.HeadState Methods toBuiltinData :: State -> BuiltinData
UnsafeFromData State Source #
Instance details Defined in Hydra.Contract.HeadState Methods unsafeFromBuiltinData :: BuiltinData -> State
type Rep State Source #
Instance details Defined in Hydra.Contract.HeadState type Rep State = D1 ('MetaData "State" "Hydra.Contract.HeadState" "hydra-plutus-0.20.0-LbBW0QYa4oSFBvNyDrDbFg" 'False) ((C1 ('MetaCons "Initial" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contestationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContestationPeriod) :: S1 ('MetaSel ('Just "parties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Party])) :: (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CurrencySymbol) :*: S1 ('MetaSel ('Just "seed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxOutRef))) :+: C1 ('MetaCons "Open" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OpenDatum))) :+: (C1 ('MetaCons "Closed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ClosedDatum)) :+: C1 ('MetaCons "Final" 'PrefixI 'False) (U1 :: Type -> Type)))

data CloseRedeemer Source #

Sub-type for close transition with auxiliary data as needed.

Constructors

CloseInitial	Intial snapshot is used to close.
CloseUnused	Closing snapshot refers to the current state version
Fields signature :: [Signature] Multi-signature of a snapshot ξ
CloseUsed	Closing snapshot refers to the previous state version
Fields signature :: [Signature] Multi-signature of a snapshot ξ alreadyDecommittedUTxOHash :: Hash UTxO which was already decommitted ηω

Instances

Instances details

Generic CloseRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Associated Types type Rep CloseRedeemer :: Type -> Type Source # Methods from :: CloseRedeemer -> Rep CloseRedeemer x Source # to :: Rep CloseRedeemer x -> CloseRedeemer Source #
Show CloseRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods showsPrec :: Int -> CloseRedeemer -> ShowS Source # show :: CloseRedeemer -> String Source # showList :: [CloseRedeemer] -> ShowS Source #
FromData CloseRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods fromBuiltinData :: BuiltinData -> Maybe CloseRedeemer
ToData CloseRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods toBuiltinData :: CloseRedeemer -> BuiltinData
UnsafeFromData CloseRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods unsafeFromBuiltinData :: BuiltinData -> CloseRedeemer
type Rep CloseRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState type Rep CloseRedeemer = D1 ('MetaData "CloseRedeemer" "Hydra.Contract.HeadState" "hydra-plutus-0.20.0-LbBW0QYa4oSFBvNyDrDbFg" 'False) (C1 ('MetaCons "CloseInitial" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CloseUnused" 'PrefixI 'True) (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Signature])) :+: C1 ('MetaCons "CloseUsed" 'PrefixI 'True) (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Signature]) :*: S1 ('MetaSel ('Just "alreadyDecommittedUTxOHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hash))))

data ContestRedeemer Source #

Sub-type for contest transition with auxiliary data as needed.

Constructors

ContestCurrent	Contesting snapshot refers to the current state version
Fields signature :: [Signature] Multi-signature of a snapshot ξ
ContestOutdated	Contesting snapshot refers to the previous state version
Fields signature :: [Signature] Multi-signature of a snapshot ξ alreadyDecommittedUTxOHash :: Hash UTxO which was already decommitted ηω

Instances

Instances details

Generic ContestRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Associated Types type Rep ContestRedeemer :: Type -> Type Source # Methods from :: ContestRedeemer -> Rep ContestRedeemer x Source # to :: Rep ContestRedeemer x -> ContestRedeemer Source #
Show ContestRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods showsPrec :: Int -> ContestRedeemer -> ShowS Source # show :: ContestRedeemer -> String Source # showList :: [ContestRedeemer] -> ShowS Source #
FromData ContestRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods fromBuiltinData :: BuiltinData -> Maybe ContestRedeemer
ToData ContestRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods toBuiltinData :: ContestRedeemer -> BuiltinData
UnsafeFromData ContestRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods unsafeFromBuiltinData :: BuiltinData -> ContestRedeemer
type Rep ContestRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState type Rep ContestRedeemer = D1 ('MetaData "ContestRedeemer" "Hydra.Contract.HeadState" "hydra-plutus-0.20.0-LbBW0QYa4oSFBvNyDrDbFg" 'False) (C1 ('MetaCons "ContestCurrent" 'PrefixI 'True) (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Signature])) :+: C1 ('MetaCons "ContestOutdated" 'PrefixI 'True) (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Signature]) :*: S1 ('MetaSel ('Just "alreadyDecommittedUTxOHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hash)))

data IncrementRedeemer Source #

Sub-type for increment transition TODO: add more fields as needed.

Constructors

IncrementRedeemer

Instances

Instances details

Generic IncrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Associated Types type Rep IncrementRedeemer :: Type -> Type Source # Methods from :: IncrementRedeemer -> Rep IncrementRedeemer x Source # to :: Rep IncrementRedeemer x -> IncrementRedeemer Source #
Show IncrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods showsPrec :: Int -> IncrementRedeemer -> ShowS Source # show :: IncrementRedeemer -> String Source # showList :: [IncrementRedeemer] -> ShowS Source #
FromData IncrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods fromBuiltinData :: BuiltinData -> Maybe IncrementRedeemer
ToData IncrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods toBuiltinData :: IncrementRedeemer -> BuiltinData
UnsafeFromData IncrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods unsafeFromBuiltinData :: BuiltinData -> IncrementRedeemer
type Rep IncrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState type Rep IncrementRedeemer = D1 ('MetaData "IncrementRedeemer" "Hydra.Contract.HeadState" "hydra-plutus-0.20.0-LbBW0QYa4oSFBvNyDrDbFg" 'False) (C1 ('MetaCons "IncrementRedeemer" 'PrefixI 'False) (U1 :: Type -> Type))

data DecrementRedeemer Source #

Sub-type for decrement transition with auxiliary data as needed.

Constructors

DecrementRedeemer
Fields signature :: [Signature] Spec: ξ snapshotNumber :: SnapshotNumber Spec: s numberOfDecommitOutputs :: Integer Spec: m

Instances

Instances details

Generic DecrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Associated Types type Rep DecrementRedeemer :: Type -> Type Source # Methods from :: DecrementRedeemer -> Rep DecrementRedeemer x Source # to :: Rep DecrementRedeemer x -> DecrementRedeemer Source #
Show DecrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods showsPrec :: Int -> DecrementRedeemer -> ShowS Source # show :: DecrementRedeemer -> String Source # showList :: [DecrementRedeemer] -> ShowS Source #
FromData DecrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods fromBuiltinData :: BuiltinData -> Maybe DecrementRedeemer
ToData DecrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods toBuiltinData :: DecrementRedeemer -> BuiltinData
UnsafeFromData DecrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState Methods unsafeFromBuiltinData :: BuiltinData -> DecrementRedeemer
type Rep DecrementRedeemer Source #
Instance details Defined in Hydra.Contract.HeadState type Rep DecrementRedeemer = D1 ('MetaData "DecrementRedeemer" "Hydra.Contract.HeadState" "hydra-plutus-0.20.0-LbBW0QYa4oSFBvNyDrDbFg" 'False) (C1 ('MetaCons "DecrementRedeemer" 'PrefixI 'True) (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Signature]) :: (S1 ('MetaSel ('Just "snapshotNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SnapshotNumber) :: S1 ('MetaSel ('Just "numberOfDecommitOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer))))

data Input Source #

Constructors

CollectCom
Increment IncrementRedeemer
Decrement DecrementRedeemer
Close CloseRedeemer
Contest ContestRedeemer
Abort
Fanout
Fields numberOfFanoutOutputs :: Integer Spec: m numberOfDecommitOutputs :: Integer Spec: n

Instances

Instances details

Generic Input Source #
Instance details Defined in Hydra.Contract.HeadState Associated Types type Rep Input :: Type -> Type Source # Methods from :: Input -> Rep Input x Source # to :: Rep Input x -> Input Source #
Show Input Source #
Instance details Defined in Hydra.Contract.HeadState Methods showsPrec :: Int -> Input -> ShowS Source # show :: Input -> String Source # showList :: [Input] -> ShowS Source #
FromData Input Source #
Instance details Defined in Hydra.Contract.HeadState Methods fromBuiltinData :: BuiltinData -> Maybe Input
ToData Input Source #
Instance details Defined in Hydra.Contract.HeadState Methods toBuiltinData :: Input -> BuiltinData
UnsafeFromData Input Source #
Instance details Defined in Hydra.Contract.HeadState Methods unsafeFromBuiltinData :: BuiltinData -> Input
type Rep Input Source #
Instance details Defined in Hydra.Contract.HeadState type Rep Input = D1 ('MetaData "Input" "Hydra.Contract.HeadState" "hydra-plutus-0.20.0-LbBW0QYa4oSFBvNyDrDbFg" 'False) ((C1 ('MetaCons "CollectCom" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Increment" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IncrementRedeemer)) :+: C1 ('MetaCons "Decrement" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DecrementRedeemer)))) :+: ((C1 ('MetaCons "Close" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CloseRedeemer)) :+: C1 ('MetaCons "Contest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContestRedeemer))) :+: (C1 ('MetaCons "Abort" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Fanout" 'PrefixI 'True) (S1 ('MetaSel ('Just "numberOfFanoutOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "numberOfDecommitOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))))