atlas-cardano

Copyright	(c) 2025 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	None
Language	GHC2021

GeniusYield.Providers.Ogmios

Description

Synopsis

data OgmiosApiEnv
newOgmiosApiEnv :: String -> IO OgmiosApiEnv
data OgmiosProviderException
- = OgmiosApiError !Text !ClientError
- | OgmiosErrorResponse !Text !Value
- | OgmiosIncorrectEraHistoryLength ![EraSummary]
- | OgmiosTransactionDeserialisationError !String
- | OgmiosWebsocketDecodeError !String
ogmiosSubmitTx :: OgmiosApiEnv -> GYSubmitTx
ogmiosProtocolParameters :: OgmiosApiEnv -> IO ApiProtocolParameters
ogmiosGetSlotOfCurrentBlock :: OgmiosApiEnv -> IO GYSlot
ogmiosStakePools :: OgmiosApiEnv -> IO (Set PoolId)
ogmiosGetDRepsState :: OgmiosApiEnv -> Set (GYCredential 'GYKeyRoleDRep) -> IO (Map (GYCredential 'GYKeyRoleDRep) (Maybe GYDRepState))
ogmiosGetDRepState :: OgmiosApiEnv -> GYCredential 'GYKeyRoleDRep -> IO (Maybe GYDRepState)
ogmiosStakeAddressInfo :: OgmiosApiEnv -> GYStakeAddress -> IO (Maybe GYStakeAddressInfo)
ogmiosStartTime :: OgmiosApiEnv -> IO SystemStart
ogmiosEraSummaries :: OgmiosApiEnv -> IO EraHistory
ogmiosConstitution :: OgmiosApiEnv -> IO GYConstitution
ogmiosProposals :: OgmiosApiEnv -> Set GYGovActionId -> IO (Seq GYGovActionState)
ogmiosMempoolTxsWs :: OgmiosApiEnv -> IO [GYTx]

Documentation

data OgmiosApiEnv #

newOgmiosApiEnv :: String -> IO OgmiosApiEnv #

Returns a new OgmiosApiEnv given the base url to query from.

>>> env <- newOgmiosApiEnv "http://localhost:1337"

data OgmiosProviderException #

Exceptions.

Constructors

OgmiosApiError !Text !ClientError	Error from the Ogmios API.
OgmiosErrorResponse !Text !Value	Received error response.
OgmiosIncorrectEraHistoryLength ![EraSummary]	The API returned an unexpected number of era summaries.
OgmiosTransactionDeserialisationError	Unable to deserialise transaction returned by Ogmios.
Fields !String Transaction CBOR.
OgmiosWebsocketDecodeError	Unable to decode response given by Ogmios under Websocket connection.
Fields !String Received response.

Instances

Instances details

Exception OgmiosProviderException #
Instance details Defined in GeniusYield.Providers.Ogmios Methods toException :: OgmiosProviderException -> SomeException # fromException :: SomeException -> Maybe OgmiosProviderException # displayException :: OgmiosProviderException -> String # backtraceDesired :: OgmiosProviderException -> Bool #
Show OgmiosProviderException #
Instance details Defined in GeniusYield.Providers.Ogmios Methods showsPrec :: Int -> OgmiosProviderException -> ShowS # show :: OgmiosProviderException -> String # showList :: [OgmiosProviderException] -> ShowS #
Eq OgmiosProviderException #
Instance details Defined in GeniusYield.Providers.Ogmios Methods (==) :: OgmiosProviderException -> OgmiosProviderException -> Bool # (/=) :: OgmiosProviderException -> OgmiosProviderException -> Bool #

ogmiosSubmitTx :: OgmiosApiEnv -> GYSubmitTx #

Submit a transaction to the node via Ogmios.

ogmiosProtocolParameters :: OgmiosApiEnv -> IO ApiProtocolParameters #

Fetch protocol parameters.

ogmiosGetSlotOfCurrentBlock :: OgmiosApiEnv -> IO GYSlot #

Get slot of current block.

ogmiosStakePools :: OgmiosApiEnv -> IO (Set PoolId) #

ogmiosGetDRepsState :: OgmiosApiEnv -> Set (GYCredential 'GYKeyRoleDRep) -> IO (Map (GYCredential 'GYKeyRoleDRep) (Maybe GYDRepState)) #

ogmiosGetDRepState :: OgmiosApiEnv -> GYCredential 'GYKeyRoleDRep -> IO (Maybe GYDRepState) #

ogmiosStakeAddressInfo :: OgmiosApiEnv -> GYStakeAddress -> IO (Maybe GYStakeAddressInfo) #

ogmiosStartTime :: OgmiosApiEnv -> IO SystemStart #

ogmiosEraSummaries :: OgmiosApiEnv -> IO EraHistory #

ogmiosConstitution :: OgmiosApiEnv -> IO GYConstitution #

ogmiosProposals :: OgmiosApiEnv -> Set GYGovActionId -> IO (Seq GYGovActionState) #

ogmiosMempoolTxsWs :: OgmiosApiEnv -> IO [GYTx] #