Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.YTxP.SDK.ControlParameters

Contents

Types

Description

Deprecated: Use Ply instead.

This module is consider deprecated. Use Ply instead.

Synopsis

data YieldingScripts = YieldingScripts {
- yieldingMintingPolicies :: [HexStringScript "YieldingMP"]
- yieldingValidator :: HexStringScript "YieldingValidator"
- yieldingStakingValidators :: [HexStringScript "YieldingSV"]
}
data ControlParameters = ControlParameters {
- yieldingScripts :: YieldingScripts
- sdkParameters :: SdkParameters
}
newtype HexStringScript (scriptLabel :: Symbol) = HexStringScript ShortByteString
sbsToHexText :: ShortByteString -> Text
hexTextToSbs :: MonadFail m => Text -> m ShortByteString

Types

data YieldingScripts Source #

Scripts that yield to transaction families identified by reference scripts which carry a state thread token

Constructors

YieldingScripts
Fields yieldingMintingPolicies :: [HexStringScript "YieldingMP"] Since: 0.1.0 yieldingValidator :: HexStringScript "YieldingValidator" Since: 0.1.0 yieldingStakingValidators :: [HexStringScript "YieldingSV"] Since: 0.1.0

Instances

Instances details

FromJSON YieldingScripts Source #	Since: 0.1.0
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods parseJSON :: Value -> Parser YieldingScripts parseJSONList :: Value -> Parser [YieldingScripts] omittedField :: Maybe YieldingScripts
ToJSON YieldingScripts Source #	Since: 0.1.0
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods toJSON :: YieldingScripts -> Value toEncoding :: YieldingScripts -> Encoding toJSONList :: [YieldingScripts] -> Value toEncodingList :: [YieldingScripts] -> Encoding omitField :: YieldingScripts -> Bool
Show YieldingScripts Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods showsPrec :: Int -> YieldingScripts -> ShowS Source # show :: YieldingScripts -> String Source # showList :: [YieldingScripts] -> ShowS Source #
Eq YieldingScripts Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods (==) :: YieldingScripts -> YieldingScripts -> Bool Source # (/=) :: YieldingScripts -> YieldingScripts -> Bool Source #
Pretty YieldingScripts Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods pretty :: YieldingScripts -> Doc ann prettyList :: [YieldingScripts] -> Doc ann

data ControlParameters Source #

Contains the compiled scripts along with the parameters they were compiled against. This is useful for _library consumers_ and should contain all of the information needed to work with the library.

Constructors

ControlParameters
Fields yieldingScripts :: YieldingScripts Since: 0.1.0 sdkParameters :: SdkParameters Since: 0.1.0

Instances

Instances details

FromJSON ControlParameters Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods parseJSON :: Value -> Parser ControlParameters parseJSONList :: Value -> Parser [ControlParameters] omittedField :: Maybe ControlParameters
ToJSON ControlParameters Source #	Since: 0.1.0
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods toJSON :: ControlParameters -> Value toEncoding :: ControlParameters -> Encoding toJSONList :: [ControlParameters] -> Value toEncodingList :: [ControlParameters] -> Encoding omitField :: ControlParameters -> Bool
Show ControlParameters Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods showsPrec :: Int -> ControlParameters -> ShowS Source # show :: ControlParameters -> String Source # showList :: [ControlParameters] -> ShowS Source #
Eq ControlParameters Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods (==) :: ControlParameters -> ControlParameters -> Bool Source # (/=) :: ControlParameters -> ControlParameters -> Bool Source #
Pretty ControlParameters Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods pretty :: ControlParameters -> Doc ann prettyList :: [ControlParameters] -> Doc ann

newtype HexStringScript (scriptLabel :: Symbol) Source #

A helper newtype to ensure that any Scripts we use are serialized (and deserialized), consistently. We also have a 'tag' for a more specific type name or label when using a via derivation with this, or as part of a larger type.

See JSON.md for an explanation of our policy. TODO: update json policy

Constructors

HexStringScript ShortByteString

Instances

Instances details

KnownSymbol scriptLabel => FromJSON (HexStringScript scriptLabel) Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods parseJSON :: Value -> Parser (HexStringScript scriptLabel) parseJSONList :: Value -> Parser [HexStringScript scriptLabel] omittedField :: Maybe (HexStringScript scriptLabel)
ToJSON (HexStringScript scriptLabel) Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods toJSON :: HexStringScript scriptLabel -> Value toEncoding :: HexStringScript scriptLabel -> Encoding toJSONList :: [HexStringScript scriptLabel] -> Value toEncodingList :: [HexStringScript scriptLabel] -> Encoding omitField :: HexStringScript scriptLabel -> Bool
KnownSymbol scriptLabel => Show (HexStringScript scriptLabel) Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods showsPrec :: Int -> HexStringScript scriptLabel -> ShowS Source # show :: HexStringScript scriptLabel -> String Source # showList :: [HexStringScript scriptLabel] -> ShowS Source #
Eq (HexStringScript scriptLabel) Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods (==) :: HexStringScript scriptLabel -> HexStringScript scriptLabel -> Bool Source # (/=) :: HexStringScript scriptLabel -> HexStringScript scriptLabel -> Bool Source #
Pretty (HexStringScript scriptLabel) Source #
Instance details Defined in Cardano.YTxP.SDK.ControlParameters Methods pretty :: HexStringScript scriptLabel -> Doc ann prettyList :: [HexStringScript scriptLabel] -> Doc ann

sbsToHexText :: ShortByteString -> Text Source #

Converts a ShortByteString into a textual representation in hex.

hexTextToSbs :: MonadFail m => Text -> m ShortByteString Source #

Attempts to parse the given Text into the ShortByteString that would have produced it via sbsToHexText, indicating parse failures with fail.