cardano-api-8.36.1.1: The cardano api

Safe Haskell	None
Language	Haskell2010

Cardano.Api.Convenience.Query

Contents

Simplest query related

Description

Convenience query functions

Synopsis

data QueryConvenienceError
- = AcqFailure AcquiringFailure
- | QueryEraMismatch EraMismatch
- | ByronEraNotSupported
- | QceUnsupportedNtcVersion !UnsupportedNtcVersionError
determineEra :: LocalNodeConnectInfo -> IO (Either AcquiringFailure AnyCardanoEra)
executeQueryCardanoMode :: SocketPath -> NetworkId -> QueryInMode (Either EraMismatch result) -> IO (Either QueryConvenienceError result)
executeQueryAnyMode :: forall result. LocalNodeConnectInfo -> QueryInMode (Either EraMismatch result) -> IO (Either QueryConvenienceError result)
queryStateForBalancedTx :: CardanoEra era -> [TxIn] -> [Certificate era] -> LocalStateQueryExpr block point QueryInMode r IO (Either QueryConvenienceError (UTxO era, LedgerProtocolParameters era, EraHistory, SystemStart, Set PoolId, Map StakeCredential Lovelace, Map (Credential DRepRole StandardCrypto) Lovelace))
renderQueryConvenienceError :: QueryConvenienceError -> Text

Documentation

data QueryConvenienceError Source #

Constructors

AcqFailure AcquiringFailure
QueryEraMismatch EraMismatch
ByronEraNotSupported
QceUnsupportedNtcVersion !UnsupportedNtcVersionError

Instances

Instances details

Show QueryConvenienceError Source #
Instance details Defined in Cardano.Api.Convenience.Query Methods showsPrec :: Int -> QueryConvenienceError -> ShowS Source # show :: QueryConvenienceError -> String Source # showList :: [QueryConvenienceError] -> ShowS Source #

determineEra :: LocalNodeConnectInfo -> IO (Either AcquiringFailure AnyCardanoEra) Source #

Query the node to determine which era it is in.

Simplest query related

executeQueryCardanoMode :: SocketPath -> NetworkId -> QueryInMode (Either EraMismatch result) -> IO (Either QueryConvenienceError result) Source #

Execute a query against the local node. The local node must be in CardanoMode.

executeQueryAnyMode :: forall result. LocalNodeConnectInfo -> QueryInMode (Either EraMismatch result) -> IO (Either QueryConvenienceError result) Source #

Execute a query against the local node in any mode.

queryStateForBalancedTx :: CardanoEra era -> [TxIn] -> [Certificate era] -> LocalStateQueryExpr block point QueryInMode r IO (Either QueryConvenienceError (UTxO era, LedgerProtocolParameters era, EraHistory, SystemStart, Set PoolId, Map StakeCredential Lovelace, Map (Credential DRepRole StandardCrypto) Lovelace)) Source #

A convenience function to query the relevant information, from the local node, for Cardano.Api.Convenience.Construction.constructBalancedTx

renderQueryConvenienceError :: QueryConvenienceError -> Text Source #