Cardano.Kupmios

type ParKupmiosM = KupmiosMT ParAff

newtype KupmiosMT :: (Type -> Type) -> Type -> Typenewtype KupmiosMT (m :: Type -> Type) (a :: Type)

Constructors

• KupmiosMT (ReaderT KupmiosEnv m a)

Instances

• Newtype (KupmiosMT m a) _
• (Functor m) => Functor (KupmiosMT m)
• (Apply m) => Apply (KupmiosMT m)
• (Applicative m) => Applicative (KupmiosMT m)
• (Bind m) => Bind (KupmiosMT m)
• (Alt m) => Alt (KupmiosMT m)
• (Plus m) => Plus (KupmiosMT m)
• (Alternative m) => Alternative (KupmiosMT m)
• Monad (KupmiosMT Aff)
• MonadEffect (KupmiosMT Aff)
• MonadAff (KupmiosMT Aff)
• (Semigroup a, Apply m) => Semigroup (KupmiosMT m a)
• (Monoid a, Applicative m) => Monoid (KupmiosMT m a)
• MonadThrow Error (KupmiosMT Aff)
• MonadError Error (KupmiosMT Aff)
• MonadRec (KupmiosMT Aff)
• MonadAsk KupmiosEnv (KupmiosMT Aff)
• MonadReader KupmiosEnv (KupmiosMT Aff)
• MonadLogger (KupmiosMT Aff)
• Parallel (KupmiosMT ParAff) (KupmiosMT Aff)

type KupmiosM = KupmiosMT Aff

type KupmiosEnv = { config :: KupmiosConfig }

KupmiosEnv contains everything needed for KupmiosM to run.

Instances

• MonadAsk KupmiosEnv (KupmiosMT Aff)
• MonadReader KupmiosEnv (KupmiosMT Aff)

type KupmiosConfig = { customLogger :: Maybe (LogLevel -> Message -> Aff Unit), kupoConfig :: ServerConfig, logLevel :: LogLevel, ogmiosConfig :: ServerConfig, suppressLogs :: Boolean }

KupmiosConfig contains a complete specification on how to initialize a KupmiosM environment. It includes:

• server parameters for all the services
• network ID
• logging level
• optional custom logger

type ClusterSetup = { keys :: { payment :: PrivatePaymentKey, stake :: Maybe PrivateStakeKey }, kupoConfig :: ServerConfig, ogmiosConfig :: ServerConfig }

Cluster setup contains everything that is needed to run a Contract on a local cluster: paramters to connect to the services and private keys that are pre-funded with Ada on that cluster

handleAffjaxResponse :: forall (result :: Type). DecodeAeson result => Either Error (Response String) -> Either ClientError result

utxosAt :: Address -> KupmiosM (Either ClientError UtxoMap)

isTxConfirmedAff :: ServerConfig -> TransactionHash -> Aff (Either ClientError (Maybe Slot))

isTxConfirmed :: TransactionHash -> KupmiosM (Either ClientError (Maybe Slot))

getUtxoByOref :: TransactionInput -> KupmiosM (Either ClientError (Maybe TransactionOutput))

getTxAuxiliaryData :: TransactionHash -> KupmiosM (Either GetTxMetadataError AuxiliaryData)

getScriptByHash :: ScriptHash -> KupmiosM (Either ClientError (Maybe ScriptRef))

getOutputAddressesByTxHash :: TransactionHash -> KupmiosM (Either ClientError (Array Address))

Specialized function to get addresses only, without resolving script references. Used internally.

getDatumByHash :: DataHash -> KupmiosM (Either ClientError (Maybe PlutusData))

type Logger = LogLevel -> String -> Effect Unit

mkLogger :: LogLevel -> Maybe (LogLevel -> Message -> Aff Unit) -> Logger

logTrace' :: forall (m :: Type -> Type). MonadLogger m => String -> m Unit

submitTxOgmios :: TransactionHash -> CborBytes -> KupmiosM SubmitTxR

poolParameters :: StakePoolsQueryArgument -> KupmiosM (Either OgmiosDecodeError PoolParametersR)

getSystemStartTime :: KupmiosM (Either OgmiosDecodeError OgmiosSystemStart)

getProtocolParameters :: KupmiosM (Either OgmiosDecodeError OgmiosProtocolParameters)

getChainTip :: KupmiosM Tip

evaluateTxOgmios :: CborBytes -> AdditionalUtxoSet -> KupmiosM TxEvaluationR

eraSummaries :: KupmiosM (Either OgmiosDecodeError OgmiosEraSummaries)

delegationsAndRewards :: Array String -> KupmiosM (Either OgmiosDecodeError DelegationsAndRewardsR)

currentEpoch :: KupmiosM (Either OgmiosDecodeError CurrentEpoch)

getCurrentEpoch :: KupmiosM CurrentEpoch

Get the current Epoch. Details can be found https://ogmios.dev/api/ under "currentEpoch" query

getEraSummaries :: KupmiosM EraSummaries

Get EraSummaries as used for Slot arithemetic. Details can be found https://ogmios.dev/api/ under "eraSummaries" query

sysStartToOgmiosTimestamp :: SystemStart -> String

sysStartFromOgmiosTimestampUnsafe :: String -> SystemStart

sysStartFromOgmiosTimestamp :: String -> Either String SystemStart

Attempts to parse SystemStart from Ogmios timestamp string.

getValidatorHashDelegationsAndRewards :: StakeValidatorHash -> KupmiosM (Maybe DelegationsAndRewards)

getPubKeyHashDelegationsAndRewards :: StakePubKeyHash -> KupmiosM (Maybe DelegationsAndRewards)

getPoolsParameters :: Array PoolPubKeyHash -> KupmiosM (Map PoolPubKeyHash PoolParams)

getPoolParameters :: PoolPubKeyHash -> KupmiosM PoolParams

getPoolIds :: KupmiosM (Array PoolPubKeyHash)