Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Tx.Snapshot

Contents

SnapshotNumber and SnapshotVersion
Snapshot
ConfirmedSnapshot

Synopsis

newtype SnapshotNumber = UnsafeSnapshotNumber Natural
fromChainSnapshotNumber :: SnapshotNumber -> SnapshotNumber
newtype SnapshotVersion = UnsafeSnapshotVersion Natural
fromChainSnapshotVersion :: SnapshotVersion -> SnapshotVersion
data Snapshot tx = Snapshot {
- headId :: HeadId
- version :: SnapshotVersion
- number :: SnapshotNumber
- confirmed :: [tx]
- utxo :: UTxOType tx
- utxoToCommit :: Maybe (UTxOType tx)
- utxoToDecommit :: Maybe (UTxOType tx)
}
data ConfirmedSnapshot tx
- = InitialSnapshot {
  - headId :: HeadId
  - initialUTxO :: UTxOType tx
  }
- | ConfirmedSnapshot {
  - snapshot :: Snapshot tx
  - signatures :: MultiSignature (Snapshot tx)
  }
getSnapshot :: ConfirmedSnapshot tx -> Snapshot tx
genConfirmedSnapshot :: IsTx tx => HeadId -> SnapshotVersion -> SnapshotNumber -> UTxOType tx -> Maybe (UTxOType tx) -> Maybe (UTxOType tx) -> [SigningKey HydraKey] -> Gen (ConfirmedSnapshot tx)

SnapshotNumber and SnapshotVersion

newtype SnapshotNumber Source #

Constructors

UnsafeSnapshotNumber Natural

Instances

Instances details

Arbitrary SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods arbitrary :: Gen SnapshotNumber shrink :: SnapshotNumber -> [SnapshotNumber]
FromJSON SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods parseJSON :: Value -> Parser SnapshotNumber parseJSONList :: Value -> Parser [SnapshotNumber] omittedField :: Maybe SnapshotNumber
ToJSON SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods toJSON :: SnapshotNumber -> Value toEncoding :: SnapshotNumber -> Encoding toJSONList :: [SnapshotNumber] -> Value toEncodingList :: [SnapshotNumber] -> Encoding omitField :: SnapshotNumber -> Bool
Enum SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods succ :: SnapshotNumber -> SnapshotNumber Source # pred :: SnapshotNumber -> SnapshotNumber Source # toEnum :: Int -> SnapshotNumber Source # fromEnum :: SnapshotNumber -> Int Source # enumFrom :: SnapshotNumber -> [SnapshotNumber] Source # enumFromThen :: SnapshotNumber -> SnapshotNumber -> [SnapshotNumber] Source # enumFromTo :: SnapshotNumber -> SnapshotNumber -> [SnapshotNumber] Source # enumFromThenTo :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber -> [SnapshotNumber] Source #
Generic SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Associated Types type Rep SnapshotNumber :: Type -> Type Source # Methods from :: SnapshotNumber -> Rep SnapshotNumber x Source # to :: Rep SnapshotNumber x -> SnapshotNumber Source #
Num SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods (+) :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber Source # (-) :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber Source # (*) :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber Source # negate :: SnapshotNumber -> SnapshotNumber Source # abs :: SnapshotNumber -> SnapshotNumber Source # signum :: SnapshotNumber -> SnapshotNumber Source # fromInteger :: Integer -> SnapshotNumber Source #
Integral SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods quot :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber Source # rem :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber Source # div :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber Source # mod :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber Source # quotRem :: SnapshotNumber -> SnapshotNumber -> (SnapshotNumber, SnapshotNumber) Source # divMod :: SnapshotNumber -> SnapshotNumber -> (SnapshotNumber, SnapshotNumber) Source # toInteger :: SnapshotNumber -> Integer Source #
Real SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods toRational :: SnapshotNumber -> Rational Source #
Show SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods showsPrec :: Int -> SnapshotNumber -> ShowS Source # show :: SnapshotNumber -> String Source # showList :: [SnapshotNumber] -> ShowS Source #
FromCBOR SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods fromCBOR :: Decoder s SnapshotNumber label :: Proxy SnapshotNumber -> Text
ToCBOR SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods toCBOR :: SnapshotNumber -> Encoding encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy SnapshotNumber -> Size encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SnapshotNumber] -> Size
Eq SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods (==) :: SnapshotNumber -> SnapshotNumber -> Bool Source # (/=) :: SnapshotNumber -> SnapshotNumber -> Bool Source #
Ord SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot Methods compare :: SnapshotNumber -> SnapshotNumber -> Ordering Source # (<) :: SnapshotNumber -> SnapshotNumber -> Bool Source # (<=) :: SnapshotNumber -> SnapshotNumber -> Bool Source # (>) :: SnapshotNumber -> SnapshotNumber -> Bool Source # (>=) :: SnapshotNumber -> SnapshotNumber -> Bool Source # max :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber Source # min :: SnapshotNumber -> SnapshotNumber -> SnapshotNumber Source #
type Rep SnapshotNumber Source #
Instance details Defined in Hydra.Tx.Snapshot type Rep SnapshotNumber = D1 ('MetaData "SnapshotNumber" "Hydra.Tx.Snapshot" "hydra-tx-0.19.0-48ZeHxZ5xZTA1LWQfKBQCQ" 'True) (C1 ('MetaCons "UnsafeSnapshotNumber" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

fromChainSnapshotNumber :: SnapshotNumber -> SnapshotNumber Source #

newtype SnapshotVersion Source #

Constructors

UnsafeSnapshotVersion Natural

Instances

Instances details

Arbitrary SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods arbitrary :: Gen SnapshotVersion shrink :: SnapshotVersion -> [SnapshotVersion]
FromJSON SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods parseJSON :: Value -> Parser SnapshotVersion parseJSONList :: Value -> Parser [SnapshotVersion] omittedField :: Maybe SnapshotVersion
ToJSON SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods toJSON :: SnapshotVersion -> Value toEncoding :: SnapshotVersion -> Encoding toJSONList :: [SnapshotVersion] -> Value toEncodingList :: [SnapshotVersion] -> Encoding omitField :: SnapshotVersion -> Bool
Enum SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods succ :: SnapshotVersion -> SnapshotVersion Source # pred :: SnapshotVersion -> SnapshotVersion Source # toEnum :: Int -> SnapshotVersion Source # fromEnum :: SnapshotVersion -> Int Source # enumFrom :: SnapshotVersion -> [SnapshotVersion] Source # enumFromThen :: SnapshotVersion -> SnapshotVersion -> [SnapshotVersion] Source # enumFromTo :: SnapshotVersion -> SnapshotVersion -> [SnapshotVersion] Source # enumFromThenTo :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion -> [SnapshotVersion] Source #
Generic SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Associated Types type Rep SnapshotVersion :: Type -> Type Source # Methods from :: SnapshotVersion -> Rep SnapshotVersion x Source # to :: Rep SnapshotVersion x -> SnapshotVersion Source #
Num SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods (+) :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion Source # (-) :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion Source # (*) :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion Source # negate :: SnapshotVersion -> SnapshotVersion Source # abs :: SnapshotVersion -> SnapshotVersion Source # signum :: SnapshotVersion -> SnapshotVersion Source # fromInteger :: Integer -> SnapshotVersion Source #
Integral SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods quot :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion Source # rem :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion Source # div :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion Source # mod :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion Source # quotRem :: SnapshotVersion -> SnapshotVersion -> (SnapshotVersion, SnapshotVersion) Source # divMod :: SnapshotVersion -> SnapshotVersion -> (SnapshotVersion, SnapshotVersion) Source # toInteger :: SnapshotVersion -> Integer Source #
Real SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods toRational :: SnapshotVersion -> Rational Source #
Show SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods showsPrec :: Int -> SnapshotVersion -> ShowS Source # show :: SnapshotVersion -> String Source # showList :: [SnapshotVersion] -> ShowS Source #
FromCBOR SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods fromCBOR :: Decoder s SnapshotVersion label :: Proxy SnapshotVersion -> Text
ToCBOR SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods toCBOR :: SnapshotVersion -> Encoding encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy SnapshotVersion -> Size encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SnapshotVersion] -> Size
Eq SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods (==) :: SnapshotVersion -> SnapshotVersion -> Bool Source # (/=) :: SnapshotVersion -> SnapshotVersion -> Bool Source #
Ord SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot Methods compare :: SnapshotVersion -> SnapshotVersion -> Ordering Source # (<) :: SnapshotVersion -> SnapshotVersion -> Bool Source # (<=) :: SnapshotVersion -> SnapshotVersion -> Bool Source # (>) :: SnapshotVersion -> SnapshotVersion -> Bool Source # (>=) :: SnapshotVersion -> SnapshotVersion -> Bool Source # max :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion Source # min :: SnapshotVersion -> SnapshotVersion -> SnapshotVersion Source #
type Rep SnapshotVersion Source #
Instance details Defined in Hydra.Tx.Snapshot type Rep SnapshotVersion = D1 ('MetaData "SnapshotVersion" "Hydra.Tx.Snapshot" "hydra-tx-0.19.0-48ZeHxZ5xZTA1LWQfKBQCQ" 'True) (C1 ('MetaCons "UnsafeSnapshotVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

fromChainSnapshotVersion :: SnapshotVersion -> SnapshotVersion Source #

Snapshot

data Snapshot tx Source #

Constructors

Snapshot

Fields

headId :: HeadId
version :: SnapshotVersion
Open state version this snapshot is based on. Spec: v
number :: SnapshotNumber
Monotonically increasing snapshot number. Spec: s
confirmed :: [tx]
The set of transactions that lead to $sel:utxo:Snapshot. Spec: T
utxo :: UTxOType tx
Snaspshotted UTxO set. Spec: U
utxoToCommit :: Maybe (UTxOType tx)
UTxO to be committed. Spec: Uα
utxoToDecommit :: Maybe (UTxOType tx)
UTxO to be decommitted. Spec: Uω

Instances

Instances details

(Arbitrary tx, Arbitrary (UTxOType tx)) => Arbitrary (Snapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods arbitrary :: Gen (Snapshot tx) shrink :: Snapshot tx -> [Snapshot tx]
IsTx tx => FromJSON (Snapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods parseJSON :: Value -> Parser (Snapshot tx) parseJSONList :: Value -> Parser [Snapshot tx] omittedField :: Maybe (Snapshot tx)
IsTx tx => ToJSON (Snapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods toJSON :: Snapshot tx -> Value toEncoding :: Snapshot tx -> Encoding toJSONList :: [Snapshot tx] -> Value toEncodingList :: [Snapshot tx] -> Encoding omitField :: Snapshot tx -> Bool
Generic (Snapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Associated Types type Rep (Snapshot tx) :: Type -> Type Source # Methods from :: Snapshot tx -> Rep (Snapshot tx) x Source # to :: Rep (Snapshot tx) x -> Snapshot tx Source #
IsTx tx => Show (Snapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods showsPrec :: Int -> Snapshot tx -> ShowS Source # show :: Snapshot tx -> String Source # showList :: [Snapshot tx] -> ShowS Source #
IsTx tx => SignableRepresentation (Snapshot tx) Source #	Binary representation of snapshot signatures. That is, concatenated CBOR for `Snapshot`, `$sel:version:Snapshot`, `$sel:number:Snapshot`, `utxoHash` and `utxoToDecommitHash` according to CDDL schemata: headId = bytes .size 16 version = uint number = uint utxoHash = bytes utxoToCommitHash = bytes utxoToDecommitHash = bytes where hashes are the result of applying `hashUTxO`.
Instance details Defined in Hydra.Tx.Snapshot Methods getSignableRepresentation :: Snapshot tx -> ByteString
IsTx tx => Eq (Snapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods (==) :: Snapshot tx -> Snapshot tx -> Bool Source # (/=) :: Snapshot tx -> Snapshot tx -> Bool Source #
type Rep (Snapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot type Rep (Snapshot tx) = D1 ('MetaData "Snapshot" "Hydra.Tx.Snapshot" "hydra-tx-0.19.0-48ZeHxZ5xZTA1LWQfKBQCQ" 'False) (C1 ('MetaCons "Snapshot" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SnapshotVersion) :: S1 ('MetaSel ('Just "number") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SnapshotNumber))) :: ((S1 ('MetaSel ('Just "confirmed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [tx]) :: S1 ('MetaSel ('Just "utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))) :: (S1 ('MetaSel ('Just "utxoToCommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (UTxOType tx))) :: S1 ('MetaSel ('Just "utxoToDecommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (UTxOType tx)))))))

ConfirmedSnapshot

data ConfirmedSnapshot tx Source #

A snapshot that can be used to close a head with. Either the initial one, or when it was signed by all parties, i.e. it is confirmed.

Constructors

InitialSnapshot
Fields headId :: HeadId initialUTxO :: UTxOType tx
ConfirmedSnapshot
Fields snapshot :: Snapshot tx signatures :: MultiSignature (Snapshot tx)

Instances

Instances details

(Arbitrary tx, Arbitrary (UTxOType tx), IsTx tx) => Arbitrary (ConfirmedSnapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods arbitrary :: Gen (ConfirmedSnapshot tx) shrink :: ConfirmedSnapshot tx -> [ConfirmedSnapshot tx]
IsTx tx => FromJSON (ConfirmedSnapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods parseJSON :: Value -> Parser (ConfirmedSnapshot tx) parseJSONList :: Value -> Parser [ConfirmedSnapshot tx] omittedField :: Maybe (ConfirmedSnapshot tx)
IsTx tx => ToJSON (ConfirmedSnapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods toJSON :: ConfirmedSnapshot tx -> Value toEncoding :: ConfirmedSnapshot tx -> Encoding toJSONList :: [ConfirmedSnapshot tx] -> Value toEncodingList :: [ConfirmedSnapshot tx] -> Encoding omitField :: ConfirmedSnapshot tx -> Bool
Generic (ConfirmedSnapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Associated Types type Rep (ConfirmedSnapshot tx) :: Type -> Type Source # Methods from :: ConfirmedSnapshot tx -> Rep (ConfirmedSnapshot tx) x Source # to :: Rep (ConfirmedSnapshot tx) x -> ConfirmedSnapshot tx Source #
IsTx tx => Show (ConfirmedSnapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods showsPrec :: Int -> ConfirmedSnapshot tx -> ShowS Source # show :: ConfirmedSnapshot tx -> String Source # showList :: [ConfirmedSnapshot tx] -> ShowS Source #
IsTx tx => Eq (ConfirmedSnapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot Methods (==) :: ConfirmedSnapshot tx -> ConfirmedSnapshot tx -> Bool Source # (/=) :: ConfirmedSnapshot tx -> ConfirmedSnapshot tx -> Bool Source #
type Rep (ConfirmedSnapshot tx) Source #
Instance details Defined in Hydra.Tx.Snapshot type Rep (ConfirmedSnapshot tx) = D1 ('MetaData "ConfirmedSnapshot" "Hydra.Tx.Snapshot" "hydra-tx-0.19.0-48ZeHxZ5xZTA1LWQfKBQCQ" 'False) (C1 ('MetaCons "InitialSnapshot" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "initialUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))) :+: C1 ('MetaCons "ConfirmedSnapshot" 'PrefixI 'True) (S1 ('MetaSel ('Just "snapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Snapshot tx)) :: S1 ('MetaSel ('Just "signatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MultiSignature (Snapshot tx)))))

getSnapshot :: ConfirmedSnapshot tx -> Snapshot tx Source #

Safely get a Snapshot from a confirmed snapshot.

NOTE: While we could use $sel:snapshot:InitialSnapshot directly, this is a record-field accessor which may become partial (and lead to unnoticed runtime errors) if we ever add a new branch to the sumtype. So, we explicitely define a getter which will force us into thinking about changing the signature properly if this happens.

genConfirmedSnapshot Source #

Arguments

:: IsTx tx
=> HeadId
-> SnapshotVersion	Exact snapshot version to generate.
-> SnapshotNumber	The lower bound on snapshot number to generate. If this is 0, then we can generate an `InitialSnapshot` or a `ConfirmedSnapshot`. Otherwise we generate only `ConfirmedSnapshot` with a number strictly superior to this lower bound.
-> UTxOType tx
-> Maybe (UTxOType tx)
-> Maybe (UTxOType tx)
-> [SigningKey HydraKey]
-> Gen (ConfirmedSnapshot tx)