Cardano.Ogmios.Mempool

acquireMempoolSnapshot :: MempoolM MempoolSnapshotAcquired

mempoolSnapshotHasTx :: MempoolSnapshotAcquired -> TransactionHash -> MempoolM Boolean

mempoolSnapshotNextTx :: MempoolSnapshotAcquired -> MempoolM (Maybe Transaction)

fetchMempoolTxs :: MempoolSnapshotAcquired -> MempoolM (Array Transaction)

Recursively request the next TX in the mempool until Ogmios does not respond with a new TX.

mempoolSnapshotSizeAndCapacity :: MempoolSnapshotAcquired -> MempoolM MempoolSizeAndCapacity

releaseMempool :: MempoolSnapshotAcquired -> MempoolM Unit

withMempoolSnapshot :: forall a. (MempoolSnapshotAcquired -> MempoolM a) -> MempoolM a

A bracket-style function for working with mempool snapshots - ensures release in the presence of exceptions

type MempoolEnv = { customLogger :: Maybe (LogLevel -> Message -> Aff Unit), logLevel :: LogLevel, ogmiosWs :: OgmiosWebSocket, suppressLogs :: Boolean }

Instances

• MonadAsk MempoolEnv (MempoolMT Aff)

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

Constructors

• MempoolMT (ReaderT MempoolEnv m a)

Instances

• Newtype (MempoolMT m a) _
• (Functor m) => Functor (MempoolMT m)
• (Apply m) => Apply (MempoolMT m)
• (Applicative m) => Applicative (MempoolMT m)
• (Bind m) => Bind (MempoolMT m)
• Monad (MempoolMT Aff)
• MonadEffect (MempoolMT Aff)
• MonadAff (MempoolMT Aff)
• MonadThrow Error (MempoolMT Aff)
• MonadError Error (MempoolMT Aff)
• MonadAsk MempoolEnv (MempoolMT Aff)

type MempoolM = MempoolMT Aff

data WebSocket listeners

Constructors

• WebSocket JsWebSocket listeners

data ReleasedMempool

Constructors

• ReleasedMempool

Instances

• Generic ReleasedMempool _
• Show ReleasedMempool
• DecodeAeson ReleasedMempool
• DecodeOgmios ReleasedMempool

type OgmiosWebSocket = WebSocket OgmiosListeners

type OgmiosListeners = { acquireMempool :: ListenerSet Unit MempoolSnapshotAcquired, mempoolHasTx :: ListenerSet TransactionHash HasTxR, mempoolNextTx :: ListenerSet Unit MaybeMempoolTransaction, mempoolSizeAndCapacity :: ListenerSet Unit MempoolSizeAndCapacity, releaseMempool :: ListenerSet Unit ReleasedMempool }

newtype MempoolTransaction

Constructors

• MempoolTransaction { id :: OgmiosTxId, raw :: String }

Instances

• Generic MempoolTransaction _
• Newtype MempoolTransaction _

newtype MempoolSnapshotAcquired

Instances

• Show MempoolSnapshotAcquired
• DecodeAeson MempoolSnapshotAcquired
• DecodeOgmios MempoolSnapshotAcquired

newtype MempoolSizeAndCapacity

The acquired snapshot’s size (in bytes), number of transactions, and capacity (in bytes).

Constructors

• MempoolSizeAndCapacity { capacity :: Int, currentSize :: Int, numberOfTxs :: Int }

Instances

• Generic MempoolSizeAndCapacity _
• Newtype MempoolSizeAndCapacity _
• Show MempoolSizeAndCapacity
• DecodeAeson MempoolSizeAndCapacity
• DecodeOgmios MempoolSizeAndCapacity

newtype MaybeMempoolTransaction

Constructors

• MaybeMempoolTransaction (Maybe MempoolTransaction)

Instances

• DecodeAeson MaybeMempoolTransaction
• Newtype MaybeMempoolTransaction _
• DecodeOgmios MaybeMempoolTransaction

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

type ListenerId = String

newtype HasTxR

Constructors

• HasTxR Boolean

Instances

• Newtype HasTxR _
• DecodeOgmios HasTxR

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

releaseMempoolCall :: MempoolSnapshotAcquired -> JsonRpc2Call Unit ReleasedMempool

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

mkOgmiosWebSocketAff :: Logger -> String -> Aff OgmiosWebSocket

mkOgmiosCallType :: forall (a :: Type) (i :: Type) (o :: Type). EncodeAeson (JsonRpc2Request a) => DecodeOgmios o => { method :: String, params :: i -> a } -> JsonRpc2Call i o

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

mempoolSnapshotSizeAndCapacityCall :: MempoolSnapshotAcquired -> JsonRpc2Call Unit MempoolSizeAndCapacity

mempoolSnapshotNextTxCall :: MempoolSnapshotAcquired -> JsonRpc2Call Unit MaybeMempoolTransaction

mempoolSnapshotHasTxCall :: MempoolSnapshotAcquired -> JsonRpc2Call TransactionHash HasTxR

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

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

acquireMempoolSnapshotCall :: JsonRpc2Call Unit MempoolSnapshotAcquired