Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Generator

Contents

Helpers

Synopsis

networkId :: NetworkId
data Dataset = Dataset {
- fundingTransaction :: Tx
- hydraNodeKeys :: [SigningKey PaymentKey]
- clientDatasets :: [ClientDataset]
- title :: Maybe Text
- description :: Maybe Text
}
data ClientDataset = ClientDataset {
- paymentKey :: SigningKey PaymentKey
- initialUTxO :: UTxO
- txSequence :: [Tx]
}
generateConstantUTxODataset :: SigningKey PaymentKey -> Int -> Int -> Gen Dataset
generateDemoUTxODataset :: NetworkId -> SocketPath -> SigningKey PaymentKey -> Int -> Int -> IO Dataset
withInitialUTxO :: SigningKey PaymentKey -> Tx -> UTxO
genClientFunds :: [SigningKey PaymentKey] -> Integer -> Gen [(VerificationKey PaymentKey, Coin)]
generateClientDataset :: NetworkId -> Tx -> Int -> SigningKey PaymentKey -> Gen ClientDataset

Documentation

networkId :: NetworkId Source #

data Dataset Source #

A Dataset that can be run for testing purpose. Each Dataset represents a complete scenario where several ClientDataset are run concurrently against one or more HydraNodes. A dataset can optionally have a title and description which will be used to report results.

Constructors

Dataset
Fields fundingTransaction :: Tx hydraNodeKeys :: [SigningKey PaymentKey] Cardano signing keys that will hold fuel. clientDatasets :: [ClientDataset] title :: Maybe Text description :: Maybe Text

Instances

Instances details

Arbitrary Dataset Source #
Instance details Defined in Hydra.Generator Methods arbitrary :: Gen Dataset shrink :: Dataset -> [Dataset]
FromJSON Dataset Source #
Instance details Defined in Hydra.Generator Methods parseJSON :: Value -> Parser Dataset parseJSONList :: Value -> Parser [Dataset] omittedField :: Maybe Dataset
ToJSON Dataset Source #
Instance details Defined in Hydra.Generator Methods toJSON :: Dataset -> Value toEncoding :: Dataset -> Encoding toJSONList :: [Dataset] -> Value toEncodingList :: [Dataset] -> Encoding omitField :: Dataset -> Bool
Generic Dataset Source #
Instance details Defined in Hydra.Generator Associated Types type Rep Dataset :: Type -> Type Source # Methods from :: Dataset -> Rep Dataset x Source # to :: Rep Dataset x -> Dataset Source #
Show Dataset Source #
Instance details Defined in Hydra.Generator Methods showsPrec :: Int -> Dataset -> ShowS Source # show :: Dataset -> String Source # showList :: [Dataset] -> ShowS Source #
type Rep Dataset Source #
Instance details Defined in Hydra.Generator type Rep Dataset = D1 ('MetaData "Dataset" "Hydra.Generator" "hydra-cluster-0.21.0-6NMRzcL0VsPAI40lpMjPzt" 'False) (C1 ('MetaCons "Dataset" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fundingTransaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tx) :: S1 ('MetaSel ('Just "hydraNodeKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SigningKey PaymentKey])) :: (S1 ('MetaSel ('Just "clientDatasets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ClientDataset]) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

data ClientDataset Source #

Constructors

ClientDataset
Fields paymentKey :: SigningKey PaymentKey initialUTxO :: UTxO txSequence :: [Tx]

Instances

Instances details

FromJSON ClientDataset Source #
Instance details Defined in Hydra.Generator Methods parseJSON :: Value -> Parser ClientDataset parseJSONList :: Value -> Parser [ClientDataset] omittedField :: Maybe ClientDataset
ToJSON ClientDataset Source #
Instance details Defined in Hydra.Generator Methods toJSON :: ClientDataset -> Value toEncoding :: ClientDataset -> Encoding toJSONList :: [ClientDataset] -> Value toEncodingList :: [ClientDataset] -> Encoding omitField :: ClientDataset -> Bool
Generic ClientDataset Source #
Instance details Defined in Hydra.Generator Associated Types type Rep ClientDataset :: Type -> Type Source # Methods from :: ClientDataset -> Rep ClientDataset x Source # to :: Rep ClientDataset x -> ClientDataset Source #
Show ClientDataset Source #
Instance details Defined in Hydra.Generator Methods showsPrec :: Int -> ClientDataset -> ShowS Source # show :: ClientDataset -> String Source # showList :: [ClientDataset] -> ShowS Source #
type Rep ClientDataset Source #
Instance details Defined in Hydra.Generator type Rep ClientDataset = D1 ('MetaData "ClientDataset" "Hydra.Generator" "hydra-cluster-0.21.0-6NMRzcL0VsPAI40lpMjPzt" 'False) (C1 ('MetaCons "ClientDataset" 'PrefixI 'True) (S1 ('MetaSel ('Just "paymentKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SigningKey PaymentKey)) :: (S1 ('MetaSel ('Just "initialUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTxO) :: S1 ('MetaSel ('Just "txSequence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tx]))))

generateConstantUTxODataset Source #

Arguments

:: SigningKey PaymentKey	Faucet signing key
-> Int	Number of clients
-> Int	Number of transactions
-> Gen Dataset

Generate a Dataset which does not grow the per-client UTXO set over time. This version provided faucet key owns funds on the initial funds of the devnet (See availableInitialFunds and 'genesis-shelley.json'). Then for a given number of clients a number of transactions are generated.

generateDemoUTxODataset Source #

Arguments

:: NetworkId
-> SocketPath
-> SigningKey PaymentKey	Faucet signing key
-> Int	Number of clients.
-> Int	Number of transactions
-> IO Dataset

Generate a Dataset from an already running network by quering available funds of the well-known 'faucet.sk' and assuming the hydra-nodes we connect to have fuel available. Then for a given number of clients a number of transactions are generated.

Helpers

withInitialUTxO :: SigningKey PaymentKey -> Tx -> UTxO Source #

genClientFunds :: [SigningKey PaymentKey] -> Integer -> Gen [(VerificationKey PaymentKey, Coin)] Source #

generateClientDataset :: NetworkId -> Tx -> Int -> SigningKey PaymentKey -> Gen ClientDataset Source #