Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Ledger

Synopsis

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

Documentation

data 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
reapplyTransactions :: ChainSlot -> UTxOType tx -> [tx] -> Either (tx, ValidationError) (UTxOType tx)
Like $sel:applyTransactions:Ledger, but only for transactions that were already accepted by $sel:applyTransactions:Ledger earlier (possibly against a different UTxO). It skips the expensive *static* checks — Plutus script evaluation and witness cryptography — while still running the state-dependent checks (inputs present, value preserved), so it fails exactly like $sel:applyTransactions:Ledger when a transaction no longer applies.
Callers MUST only pass previously-validated transactions; passing an unvalidated transaction is unsound (its scripts/signatures are not checked).

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-2.3.0-1cgalYNmLJQC1YXlYVq7mp" 'False) (C1 ('MetaCons "Valid" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Invalid" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ValidationError)))

newtype ValidationError Source #

Constructors

ValidationError
Fields reason :: Text

Instances

Instances details

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 #
FromCBOR ValidationError Source #
Instance details Defined in Hydra.Ledger Methods fromCBOR :: Decoder s ValidationError label :: Proxy ValidationError -> Text
ToCBOR ValidationError Source #
Instance details Defined in Hydra.Ledger Methods toCBOR :: ValidationError -> Encoding encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy ValidationError -> Size encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ValidationError] -> Size
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-2.3.0-1cgalYNmLJQC1YXlYVq7mp" 'True) (C1 ('MetaCons "ValidationError" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))