Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Cluster.Faucet

Synopsis

data FaucetException
- = FaucetHasNotEnoughFunds {
  - faucetUTxO :: UTxO
  }
- | FaucetFailedToBuildTx {
  - reason :: TxBodyErrorAutoBalance Era
  }
data FaucetLog
- = TraceResourceExhaustedHandled Text
- | ReturnedFunds {
  - actor :: String
  - returnAmount :: Coin
  }
seedFromFaucet :: RunningNode -> VerificationKey PaymentKey -> Coin -> Tracer IO FaucetLog -> IO UTxO
findFaucetUTxO :: RunningNode -> Coin -> IO UTxO
seedFromFaucet_ :: RunningNode -> VerificationKey PaymentKey -> Coin -> Tracer IO FaucetLog -> IO ()
returnFundsToFaucet :: Tracer IO FaucetLog -> RunningNode -> Actor -> IO ()
returnFundsToFaucet' :: Tracer IO FaucetLog -> RunningNode -> SigningKey PaymentKey -> IO Coin
createOutputAtAddress :: RunningNode -> AddressInEra -> TxOutDatum CtxTx -> IO (TxIn, TxOut CtxUTxO)
calculateTxFee :: RunningNode -> SigningKey PaymentKey -> UTxO -> AddressInEra -> Coin -> IO Coin
retryOnExceptions :: (MonadCatch m, MonadDelay m) => Tracer m FaucetLog -> m a -> m a
publishHydraScriptsAs :: RunningNode -> Actor -> IO TxId

Documentation

data FaucetException Source #

Constructors

FaucetHasNotEnoughFunds
Fields faucetUTxO :: UTxO
FaucetFailedToBuildTx
Fields reason :: TxBodyErrorAutoBalance Era

Instances

Instances details

Exception FaucetException Source #
Instance details Defined in Hydra.Cluster.Faucet Methods toException :: FaucetException -> SomeException Source # fromException :: SomeException -> Maybe FaucetException Source # displayException :: FaucetException -> String Source #
Show FaucetException Source #
Instance details Defined in Hydra.Cluster.Faucet Methods showsPrec :: Int -> FaucetException -> ShowS Source # show :: FaucetException -> String Source # showList :: [FaucetException] -> ShowS Source #

data FaucetLog Source #

Constructors

TraceResourceExhaustedHandled Text
ReturnedFunds
Fields actor :: String returnAmount :: Coin

Instances

Instances details

FromJSON FaucetLog Source #
Instance details Defined in Hydra.Cluster.Faucet Methods parseJSON :: Value -> Parser FaucetLog parseJSONList :: Value -> Parser [FaucetLog] omittedField :: Maybe FaucetLog
ToJSON FaucetLog Source #
Instance details Defined in Hydra.Cluster.Faucet Methods toJSON :: FaucetLog -> Value toEncoding :: FaucetLog -> Encoding toJSONList :: [FaucetLog] -> Value toEncodingList :: [FaucetLog] -> Encoding omitField :: FaucetLog -> Bool
Generic FaucetLog Source #
Instance details Defined in Hydra.Cluster.Faucet Associated Types type Rep FaucetLog :: Type -> Type Source # Methods from :: FaucetLog -> Rep FaucetLog x Source # to :: Rep FaucetLog x -> FaucetLog Source #
Show FaucetLog Source #
Instance details Defined in Hydra.Cluster.Faucet Methods showsPrec :: Int -> FaucetLog -> ShowS Source # show :: FaucetLog -> String Source # showList :: [FaucetLog] -> ShowS Source #
Eq FaucetLog Source #
Instance details Defined in Hydra.Cluster.Faucet Methods (==) :: FaucetLog -> FaucetLog -> Bool Source # (/=) :: FaucetLog -> FaucetLog -> Bool Source #
type Rep FaucetLog Source #
Instance details Defined in Hydra.Cluster.Faucet type Rep FaucetLog = D1 ('MetaData "FaucetLog" "Hydra.Cluster.Faucet" "hydra-cluster-0.19.0-FdS6WpgbrGm8HrOQAHMkj7" 'False) (C1 ('MetaCons "TraceResourceExhaustedHandled" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "ReturnedFunds" 'PrefixI 'True) (S1 ('MetaSel ('Just "actor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "returnAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Coin)))

seedFromFaucet Source #

Arguments

:: RunningNode
-> VerificationKey PaymentKey	Recipient of the funds
-> Coin	Amount to get from faucet
-> Tracer IO FaucetLog
-> IO UTxO

Create a specially marked "seed" UTXO containing requested Lovelace by redeeming funds available to the well-known faucet.

findFaucetUTxO :: RunningNode -> Coin -> IO UTxO Source #

seedFromFaucet_ Source #

Arguments

:: RunningNode
-> VerificationKey PaymentKey	Recipient of the funds
-> Coin	Amount to get from faucet
-> Tracer IO FaucetLog
-> IO ()

Like seedFromFaucet, but without returning the seeded UTxO'.

returnFundsToFaucet :: Tracer IO FaucetLog -> RunningNode -> Actor -> IO () Source #

Return the remaining funds to the faucet

returnFundsToFaucet' :: Tracer IO FaucetLog -> RunningNode -> SigningKey PaymentKey -> IO Coin Source #

createOutputAtAddress :: RunningNode -> AddressInEra -> TxOutDatum CtxTx -> IO (TxIn, TxOut CtxUTxO) Source #

calculateTxFee :: RunningNode -> SigningKey PaymentKey -> UTxO -> AddressInEra -> Coin -> IO Coin Source #

Build and sign tx and return the calculated fee. - Signing key should be the key of a sender - Address is used as a change address. - Lovelace amount should be one we are trying to send.

retryOnExceptions :: (MonadCatch m, MonadDelay m) => Tracer m FaucetLog -> m a -> m a Source #

Try to submit tx and retry when some caught exception/s take place.

publishHydraScriptsAs :: RunningNode -> Actor -> IO TxId Source #

Publish current Hydra scripts as scripts outputs for later referencing them.

The key of the given Actor is used to pay for fees in required transactions, it is expected to have sufficient funds.