Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Ledger

Synopsis

nextChainSlot :: ChainSlot -> ChainSlot
newtype Ledger tx = Ledger {
- applyTransactions :: ChainSlot -> UTxOType tx -> [tx] -> Either (tx, ValidationError) (UTxOType tx)
}
collectTransactions :: Ledger tx -> ChainSlot -> UTxOType tx -> [tx] -> ([tx], UTxOType tx)
data ValidationResult
- = Valid
- | Invalid ValidationError
newtype ValidationError = ValidationError {
- reason :: Text
}

Documentation

nextChainSlot :: ChainSlot -> ChainSlot Source #

Get the next chain slot. Use this instead of giving Enum or Num instances to ChainSlot.

newtype Ledger tx Source #

An abstract interface for a Ledger. Allows to define mock / simpler implementation for testing as well as limiting feature-envy from the business logic by forcing a closed interface.

Constructors

Ledger
Fields applyTransactions :: ChainSlot -> UTxOType tx -> [tx] -> Either (tx, ValidationError) (UTxOType tx) Apply a set of transaction to a given UTxO set. Returns the new UTxO or validation failures returned from the ledger. TODO: `ValidationError` should also include the UTxO, which is not necessarily the same as the given UTxO after some transactions

collectTransactions :: Ledger tx -> ChainSlot -> UTxOType tx -> [tx] -> ([tx], UTxOType tx) Source #

Collect applicable transactions and resulting UTxO. In contrast to $sel:applyTransactions:Ledger, this functions continues on validation errors.

data ValidationResult Source #

Either valid or an error which we get from the ledger-specs tx validation.

Constructors

Valid
Invalid ValidationError

Instances

Instances details

Generic ValidationResult Source #
Instance details Defined in Hydra.Ledger Associated Types type Rep ValidationResult :: Type -> Type Source # Methods from :: ValidationResult -> Rep ValidationResult x Source # to :: Rep ValidationResult x -> ValidationResult Source #
Show ValidationResult Source #
Instance details Defined in Hydra.Ledger Methods showsPrec :: Int -> ValidationResult -> ShowS Source # show :: ValidationResult -> String Source # showList :: [ValidationResult] -> ShowS Source #
Eq ValidationResult Source #
Instance details Defined in Hydra.Ledger Methods (==) :: ValidationResult -> ValidationResult -> Bool Source # (/=) :: ValidationResult -> ValidationResult -> Bool Source #
type Rep ValidationResult Source #
Instance details Defined in Hydra.Ledger type Rep ValidationResult = D1 ('MetaData "ValidationResult" "Hydra.Ledger" "hydra-node-0.21.0-4ibc00B6CCmF4EmjGjxvGm" 'False) (C1 ('MetaCons "Valid" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Invalid" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ValidationError)))

newtype ValidationError Source #

Constructors

ValidationError
Fields reason :: Text

Instances

Instances details

Arbitrary ValidationError Source #
Instance details Defined in Hydra.Ledger Methods arbitrary :: Gen ValidationError shrink :: ValidationError -> [ValidationError]
FromJSON ValidationError Source #
Instance details Defined in Hydra.Ledger Methods parseJSON :: Value -> Parser ValidationError parseJSONList :: Value -> Parser [ValidationError] omittedField :: Maybe ValidationError
ToJSON ValidationError Source #
Instance details Defined in Hydra.Ledger Methods toJSON :: ValidationError -> Value toEncoding :: ValidationError -> Encoding toJSONList :: [ValidationError] -> Value toEncodingList :: [ValidationError] -> Encoding omitField :: ValidationError -> Bool
Generic ValidationError Source #
Instance details Defined in Hydra.Ledger Associated Types type Rep ValidationError :: Type -> Type Source # Methods from :: ValidationError -> Rep ValidationError x Source # to :: Rep ValidationError x -> ValidationError Source #
Show ValidationError Source #
Instance details Defined in Hydra.Ledger Methods showsPrec :: Int -> ValidationError -> ShowS Source # show :: ValidationError -> String Source # showList :: [ValidationError] -> ShowS Source #
Eq ValidationError Source #
Instance details Defined in Hydra.Ledger Methods (==) :: ValidationError -> ValidationError -> Bool Source # (/=) :: ValidationError -> ValidationError -> Bool Source #
type Rep ValidationError Source #
Instance details Defined in Hydra.Ledger type Rep ValidationError = D1 ('MetaData "ValidationError" "Hydra.Ledger" "hydra-node-0.21.0-4ibc00B6CCmF4EmjGjxvGm" 'True) (C1 ('MetaCons "ValidationError" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))