Safe Haskell	Safe-Inferred
Language	Haskell2010

Hydra.Ledger

Synopsis

class (Eq tx, Show tx, Typeable tx, Arbitrary tx, FromCBOR tx, ToCBOR tx, FromJSON tx, ToJSON tx, Eq (TxIdType tx), Ord (TxIdType tx), Show (TxIdType tx), Typeable (TxIdType tx), Arbitrary (TxIdType tx), FromJSON (TxIdType tx), ToJSON (TxIdType tx), FromCBOR (TxIdType tx), ToCBOR (TxIdType tx), FromJSONKey (TxIdType tx), ToJSONKey (TxIdType tx), Eq (UTxOType tx), Show (UTxOType tx), Arbitrary (UTxOType tx), FromJSON (UTxOType tx), Monoid (UTxOType tx), ToJSON (UTxOType tx), FromCBOR (UTxOType tx), ToCBOR (UTxOType tx)) => IsTx tx where
- type UTxOType tx
- type TxIdType tx
- type ValueType tx
- txId :: tx -> TxIdType tx
- balance :: UTxOType tx -> ValueType tx
- hashUTxO :: UTxOType tx -> ByteString
newtype ChainSlot = ChainSlot Natural
nextChainSlot :: ChainSlot -> ChainSlot
data Ledger tx = Ledger {
- applyTransactions :: ChainSlot -> UTxOType tx -> [tx] -> Either (tx, ValidationError) (UTxOType tx)
- initUTxO :: UTxOType tx
}
canApply :: Ledger tx -> ChainSlot -> UTxOType tx -> tx -> ValidationResult
data ValidationResult
- = Valid
- | Invalid ValidationError
newtype ValidationError = ValidationError {
- reason :: Text
}

Documentation

class (Eq tx, Show tx, Typeable tx, Arbitrary tx, FromCBOR tx, ToCBOR tx, FromJSON tx, ToJSON tx, Eq (TxIdType tx), Ord (TxIdType tx), Show (TxIdType tx), Typeable (TxIdType tx), Arbitrary (TxIdType tx), FromJSON (TxIdType tx), ToJSON (TxIdType tx), FromCBOR (TxIdType tx), ToCBOR (TxIdType tx), FromJSONKey (TxIdType tx), ToJSONKey (TxIdType tx), Eq (UTxOType tx), Show (UTxOType tx), Arbitrary (UTxOType tx), FromJSON (UTxOType tx), Monoid (UTxOType tx), ToJSON (UTxOType tx), FromCBOR (UTxOType tx), ToCBOR (UTxOType tx)) => IsTx tx where Source #

Associated Types

type UTxOType tx Source #

type TxIdType tx Source #

type ValueType tx Source #

Methods

txId :: tx -> TxIdType tx Source #

balance :: UTxOType tx -> ValueType tx Source #

hashUTxO :: UTxOType tx -> ByteString Source #

Hash a utxo set to be able to sign (off-chain) and verify it (on-chain).

Instances

Instances details

IsTx Tx Source #
Instance details Defined in Hydra.Ledger.Cardano Associated Types type UTxOType Tx Source # type TxIdType Tx Source # type ValueType Tx Source # Methods txId :: Tx -> TxIdType Tx Source # balance :: UTxOType Tx -> ValueType Tx Source # hashUTxO :: UTxOType Tx -> ByteString Source #
IsTx SimpleTx Source #
Instance details Defined in Hydra.Ledger.Simple Associated Types type UTxOType SimpleTx Source # type TxIdType SimpleTx Source # type ValueType SimpleTx Source # Methods txId :: SimpleTx -> TxIdType SimpleTx Source # balance :: UTxOType SimpleTx -> ValueType SimpleTx Source # hashUTxO :: UTxOType SimpleTx -> ByteString Source #

newtype ChainSlot Source #

A generic description for a chain slot all implementions need to use.

Constructors

ChainSlot Natural

Instances

Instances details

Arbitrary ChainSlot Source #
Instance details Defined in Hydra.Ledger Methods arbitrary :: Gen ChainSlot shrink :: ChainSlot -> [ChainSlot]
FromJSON ChainSlot Source #
Instance details Defined in Hydra.Ledger Methods parseJSON :: Value -> Parser ChainSlot parseJSONList :: Value -> Parser [ChainSlot]
ToJSON ChainSlot Source #
Instance details Defined in Hydra.Ledger Methods toJSON :: ChainSlot -> Value toEncoding :: ChainSlot -> Encoding toJSONList :: [ChainSlot] -> Value toEncodingList :: [ChainSlot] -> Encoding
Generic ChainSlot Source #
Instance details Defined in Hydra.Ledger Associated Types type Rep ChainSlot :: Type -> Type Source # Methods from :: ChainSlot -> Rep ChainSlot x Source # to :: Rep ChainSlot x -> ChainSlot Source #
Show ChainSlot Source #
Instance details Defined in Hydra.Ledger Methods showsPrec :: Int -> ChainSlot -> ShowS Source # show :: ChainSlot -> String Source # showList :: [ChainSlot] -> ShowS Source #
Eq ChainSlot Source #
Instance details Defined in Hydra.Ledger Methods (==) :: ChainSlot -> ChainSlot -> Bool Source # (/=) :: ChainSlot -> ChainSlot -> Bool Source #
Ord ChainSlot Source #
Instance details Defined in Hydra.Ledger Methods compare :: ChainSlot -> ChainSlot -> Ordering Source # (<) :: ChainSlot -> ChainSlot -> Bool Source # (<=) :: ChainSlot -> ChainSlot -> Bool Source # (>) :: ChainSlot -> ChainSlot -> Bool Source # (>=) :: ChainSlot -> ChainSlot -> Bool Source # max :: ChainSlot -> ChainSlot -> ChainSlot Source # min :: ChainSlot -> ChainSlot -> ChainSlot Source #
type Rep ChainSlot Source #
Instance details Defined in Hydra.Ledger type Rep ChainSlot = D1 ('MetaData "ChainSlot" "Hydra.Ledger" "hydra-node-0.13.0-HKlbaPrFKjs2dhEMwn7ono" 'True) (C1 ('MetaCons "ChainSlot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

nextChainSlot :: ChainSlot -> ChainSlot Source #

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

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
initUTxO :: UTxOType tx
Generates an initial UTXO set. This is only temporary as it does not allow to initialize the UTXO.
TODO: This seems redundant with the `Monoid (UTxOType tx)` constraints coming with IsTx. We probably want to dry this out.

canApply :: Ledger tx -> ChainSlot -> UTxOType tx -> tx -> ValidationResult Source #

data ValidationResult Source #

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

Constructors

Valid
Invalid ValidationError

Instances

Instances details

FromJSON ValidationResult Source #
Instance details Defined in Hydra.Ledger Methods parseJSON :: Value -> Parser ValidationResult parseJSONList :: Value -> Parser [ValidationResult]
ToJSON ValidationResult Source #
Instance details Defined in Hydra.Ledger Methods toJSON :: ValidationResult -> Value toEncoding :: ValidationResult -> Encoding toJSONList :: [ValidationResult] -> Value toEncodingList :: [ValidationResult] -> Encoding
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.13.0-HKlbaPrFKjs2dhEMwn7ono" '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]
ToJSON ValidationError Source #
Instance details Defined in Hydra.Ledger Methods toJSON :: ValidationError -> Value toEncoding :: ValidationError -> Encoding toJSONList :: [ValidationError] -> Value toEncodingList :: [ValidationError] -> Encoding
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.13.0-HKlbaPrFKjs2dhEMwn7ono" 'True) (C1 ('MetaCons "ValidationError" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))