Ctl.Internal.QueryM

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

type ListenerSet (request :: Type) (response :: Type) = { addMessageListener :: ListenerId -> (Either OgmiosDecodeError response -> Effect Unit) -> Effect Unit, addRequest :: ListenerId -> RequestBody /\ request -> Effect Unit, removeMessageListener :: ListenerId -> Effect Unit }

type OgmiosListeners = { acquireMempool :: ListenerSet Unit MempoolSnapshotAcquired, chainTip :: ListenerSet Unit ChainTipQR, currentEpoch :: ListenerSet Unit CurrentEpoch, delegationsAndRewards :: ListenerSet (Array String) DelegationsAndRewardsR, eraSummaries :: ListenerSet Unit OgmiosEraSummaries, evaluate :: ListenerSet (CborBytes /\ AdditionalUtxoSet) TxEvaluationR, getProtocolParameters :: ListenerSet Unit OgmiosProtocolParameters, mempoolHasTx :: ListenerSet TransactionHash HasTxR, mempoolNextTx :: ListenerSet Unit MaybeMempoolTransaction, mempoolSizeAndCapacity :: ListenerSet Unit MempoolSizeAndCapacity, releaseMempool :: ListenerSet Unit ReleasedMempool, stakePools :: ListenerSet StakePoolsQueryArgument PoolParametersR, submit :: SubmitTxListenerSet, systemStart :: ListenerSet Unit OgmiosSystemStart }

type OgmiosWebSocket = WebSocket OgmiosListeners

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

QueryConfig contains a complete specification on how to initialize a QueryM environment. It includes:

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

type QueryM = QueryMT Aff

type ParQueryM = QueryMT ParAff

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

Constructors

• QueryMT (ReaderT QueryEnv m a)

Instances

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

type QueryEnv = { config :: QueryConfig, runtime :: QueryRuntime }

QueryEnv contains everything needed for QueryM to run.

Instances

• MonadAsk QueryEnv (QueryMT Aff)
• MonadReader QueryEnv (QueryMT Aff)

type QueryRuntime = { ogmiosWs :: OgmiosWebSocket }

Reusable part of QueryRuntime that can be shared between many QueryM instances running in parallel.

Includes:

• WebSocket connections

type SubmitTxListenerSet = ListenerSet (TransactionHash /\ CborBytes) SubmitTxR

data WebSocket listeners

Constructors

• WebSocket JsWebSocket listeners

acquireMempoolSnapshot :: QueryM MempoolSnapshotAcquired

acquireMempoolSnapshotAff :: OgmiosWebSocket -> Logger -> Aff MempoolSnapshotAcquired

evaluateTxOgmios :: CborBytes -> AdditionalUtxoSet -> QueryM TxEvaluationR

getChainTip :: QueryM Tip

getLogger :: QueryM Logger

getProtocolParametersAff :: OgmiosWebSocket -> (LogLevel -> String -> Effect Unit) -> Aff OgmiosProtocolParameters

getSystemStartAff :: OgmiosWebSocket -> (LogLevel -> String -> Effect Unit) -> Aff SystemStart

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

listeners :: forall (listeners :: Type). WebSocket listeners -> listeners

postAeson :: Url -> Aeson -> Aff (Either Error (Response String))

mkListenerSet :: forall (request :: Type) (response :: Type). DecodeOgmios response => Dispatcher -> PendingRequests -> ListenerSet request response

defaultMessageListener :: Logger -> Array WebsocketDispatch -> String -> Effect Unit

mempoolSnapshotHasTx :: MempoolSnapshotAcquired -> TransactionHash -> QueryM Boolean

mempoolSnapshotHasTxAff :: OgmiosWebSocket -> Logger -> MempoolSnapshotAcquired -> TransactionHash -> Aff Boolean

mempoolSnapshotNextTx :: MempoolSnapshotAcquired -> QueryM (Maybe MempoolTransaction)

mempoolSnapshotNextTxAff :: OgmiosWebSocket -> Logger -> MempoolSnapshotAcquired -> Aff (Maybe MempoolTransaction)

mempoolSnapshotSizeAndCapacity :: MempoolSnapshotAcquired -> QueryM MempoolSizeAndCapacity

mempoolSnapshotSizeAndCapacityAff :: OgmiosWebSocket -> Logger -> MempoolSnapshotAcquired -> Aff MempoolSizeAndCapacity

mkOgmiosRequest :: forall (request :: Type) (response :: Type). JsonRpc2Call request response -> (OgmiosListeners -> ListenerSet request response) -> request -> QueryM response

Builds an Ogmios request action using QueryM

mkOgmiosRequestAff :: forall (request :: Type) (response :: Type). OgmiosWebSocket -> Logger -> JsonRpc2Call request response -> (OgmiosListeners -> ListenerSet request response) -> request -> Aff response

Builds an Ogmios request action using Aff

mkOgmiosWebSocketAff :: IsTxConfirmed -> Logger -> ServerConfig -> Aff OgmiosWebSocket

mkRequest :: forall (request :: Type) (response :: Type) (listeners :: Type). listeners -> JsWebSocket -> JsonRpc2Call request response -> (listeners -> ListenerSet request response) -> request -> QueryM response

mkRequestAff :: forall (request :: Type) (response :: Type) (listeners :: Type). listeners -> JsWebSocket -> Logger -> JsonRpc2Call request response -> (listeners -> ListenerSet request response) -> request -> Aff response

releaseMempool :: MempoolSnapshotAcquired -> QueryM Unit

releaseMempoolAff :: OgmiosWebSocket -> Logger -> MempoolSnapshotAcquired -> Aff ReleasedMempool

scriptToAeson :: PlutusScript -> Aeson

submitTxOgmios :: TransactionHash -> CborBytes -> QueryM SubmitTxR

underlyingWebSocket :: forall (a :: Type). WebSocket a -> JsWebSocket

type WebsocketDispatch = Aeson -> Effect (Either DispatchError (Effect Unit))

type RequestBody = String

type PendingSubmitTxRequests = GenericPendingRequests (RequestBody /\ TransactionHash)

type PendingRequests = GenericPendingRequests RequestBody

type GenericPendingRequests (requestData :: Type) = Ref (Map ListenerId requestData)

type Dispatcher = Ref (Map ListenerId (Aeson -> Effect Unit))

data DispatchError

Constructors

• JsonError JsonDecodeError
• FaultError Aeson
• ListenerCancelled ListenerId

Instances

• Show DispatchError

newPendingRequests :: forall (requestData :: Type). Effect (GenericPendingRequests requestData)

newDispatcher :: Effect Dispatcher

mkWebsocketDispatch :: Dispatcher -> WebsocketDispatch

dispatchErrorToError :: DispatchError -> Error

type ServerConfig = { host :: Host, path :: Maybe String, port :: UInt, secure :: Boolean }

type Host = String

mkWsUrl :: ServerConfig -> Url

mkServerUrl :: String -> ServerConfig -> Url

mkHttpUrl :: ServerConfig -> Url

defaultOgmiosWsConfig :: ServerConfig