Copyright	© 2018-2020 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Cardano.Pool.Metadata

Contents

Fetch
Construct URLs
re-exports
Types

Description

HTTP-client(s) for fetching stake pool metadata from remote servers (directly from pool operators, or from smash).

Synopsis

fetchFromRemote :: Tracer IO StakePoolMetadataFetchLog -> [ UrlBuilder ] -> Manager -> PoolId -> StakePoolMetadataUrl -> StakePoolMetadataHash -> IO ( Maybe StakePoolMetadata )
data StakePoolMetadataFetchLog
fetchDelistedPools :: Tracer IO StakePoolMetadataFetchLog -> URI -> Manager -> IO ( Maybe [ PoolId ])
healthCheck :: Tracer IO StakePoolMetadataFetchLog -> URI -> Manager -> IO ( Maybe HealthStatusSMASH )
isHealthyStatus :: HealthStatusSMASH -> Bool
toHealthCheckSMASH :: Maybe HealthStatusSMASH -> HealthCheckSMASH
data HealthStatusSMASH = HealthStatusSMASH {
- status :: Text
- version :: Text
}
type UrlBuilder = PoolId -> StakePoolMetadataUrl -> StakePoolMetadataHash -> Either HttpException URI
identityUrlBuilder :: UrlBuilder
registryUrlBuilder :: URI -> UrlBuilder
data Manager
newManager :: MonadIO m => ManagerSettings -> m Manager
defaultManagerSettings :: ManagerSettings
newtype SMASHPoolId = SMASHPoolId {
- poolId :: Text
}

Fetch

fetchFromRemote :: Tracer IO StakePoolMetadataFetchLog -> [ UrlBuilder ] -> Manager -> PoolId -> StakePoolMetadataUrl -> StakePoolMetadataHash -> IO ( Maybe StakePoolMetadata ) Source #

data StakePoolMetadataFetchLog Source #

Constructors

MsgFetchPoolMetadata StakePoolMetadataHash URI
MsgFetchPoolMetadataSuccess StakePoolMetadataHash StakePoolMetadata
MsgFetchPoolMetadataFailure StakePoolMetadataHash String
MsgFetchPoolMetadataFallback URI Bool
MsgFetchSMASH URI
MsgFetchDelistedPoolsFailure String
MsgFetchDelistedPoolsSuccess [ PoolId ]
MsgFetchHealthCheckFailure String
MsgFetchHealthCheckSuccess HealthStatusSMASH

Instances

Instances details

Eq StakePoolMetadataFetchLog Source #
Instance details Defined in Cardano.Pool.Metadata Methods (==) :: StakePoolMetadataFetchLog -> StakePoolMetadataFetchLog -> Bool Source # (/=) :: StakePoolMetadataFetchLog -> StakePoolMetadataFetchLog -> Bool Source #
Show StakePoolMetadataFetchLog Source #
Instance details Defined in Cardano.Pool.Metadata Methods showsPrec :: Int -> StakePoolMetadataFetchLog -> ShowS Source # show :: StakePoolMetadataFetchLog -> String Source # showList :: [ StakePoolMetadataFetchLog ] -> ShowS Source #
ToText StakePoolMetadataFetchLog Source #
Instance details Defined in Cardano.Pool.Metadata Methods toText :: StakePoolMetadataFetchLog -> Text Source #
HasPrivacyAnnotation StakePoolMetadataFetchLog Source #
Instance details Defined in Cardano.Pool.Metadata Methods getPrivacyAnnotation :: StakePoolMetadataFetchLog -> PrivacyAnnotation
HasSeverityAnnotation StakePoolMetadataFetchLog Source #
Instance details Defined in Cardano.Pool.Metadata Methods getSeverityAnnotation :: StakePoolMetadataFetchLog -> Severity

fetchDelistedPools :: Tracer IO StakePoolMetadataFetchLog -> URI -> Manager -> IO ( Maybe [ PoolId ]) Source #

healthCheck :: Tracer IO StakePoolMetadataFetchLog -> URI -> Manager -> IO ( Maybe HealthStatusSMASH ) Source #

Gets the health status from the SMASH server. Returns Nothing if the server is unreachable.

isHealthyStatus :: HealthStatusSMASH -> Bool Source #

toHealthCheckSMASH :: Maybe HealthStatusSMASH -> HealthCheckSMASH Source #

Convert the result of healthCheck , which represents the server response to our own HealthCheckSMASH type, which is a superset of it.

data HealthStatusSMASH Source #

Parses the SMASH HealthCheck type from the SMASH API.

Constructors

HealthStatusSMASH
Fields status :: Text version :: Text

Instances

Instances details

Eq HealthStatusSMASH Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods (==) :: HealthStatusSMASH -> HealthStatusSMASH -> Bool Source # (/=) :: HealthStatusSMASH -> HealthStatusSMASH -> Bool Source #
Ord HealthStatusSMASH Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods compare :: HealthStatusSMASH -> HealthStatusSMASH -> Ordering Source # (<) :: HealthStatusSMASH -> HealthStatusSMASH -> Bool Source # (<=) :: HealthStatusSMASH -> HealthStatusSMASH -> Bool Source # (>) :: HealthStatusSMASH -> HealthStatusSMASH -> Bool Source # (>=) :: HealthStatusSMASH -> HealthStatusSMASH -> Bool Source # max :: HealthStatusSMASH -> HealthStatusSMASH -> HealthStatusSMASH Source # min :: HealthStatusSMASH -> HealthStatusSMASH -> HealthStatusSMASH Source #
Show HealthStatusSMASH Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods showsPrec :: Int -> HealthStatusSMASH -> ShowS Source # show :: HealthStatusSMASH -> String Source # showList :: [ HealthStatusSMASH ] -> ShowS Source #
Generic HealthStatusSMASH Source #
Instance details Defined in Cardano.Wallet.Api.Types Associated Types type Rep HealthStatusSMASH :: Type -> Type Source # Methods from :: HealthStatusSMASH -> Rep HealthStatusSMASH x Source # to :: Rep HealthStatusSMASH x -> HealthStatusSMASH Source #
ToJSON HealthStatusSMASH Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods toJSON :: HealthStatusSMASH -> Value Source # toEncoding :: HealthStatusSMASH -> Encoding Source # toJSONList :: [ HealthStatusSMASH ] -> Value Source # toEncodingList :: [ HealthStatusSMASH ] -> Encoding Source #
FromJSON HealthStatusSMASH Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods parseJSON :: Value -> Parser HealthStatusSMASH Source # parseJSONList :: Value -> Parser [ HealthStatusSMASH ] Source #
type Rep HealthStatusSMASH Source #
Instance details Defined in Cardano.Wallet.Api.Types type Rep HealthStatusSMASH = D1 (' MetaData "HealthStatusSMASH" "Cardano.Wallet.Api.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "HealthStatusSMASH" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "status") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text ) :*: S1 (' MetaSel (' Just "version") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text )))

Construct URLs

type UrlBuilder = PoolId -> StakePoolMetadataUrl -> StakePoolMetadataHash -> Either HttpException URI Source #

A type-alias to ease signatures

identityUrlBuilder :: UrlBuilder Source #

Simply return a pool metadata url, unchanged

registryUrlBuilder :: URI -> UrlBuilder Source #

Build a URL from a metadata hash compatible with an aggregation registry

re-exports

data Manager Source #

Keeps track of open connections for keep-alive.

If possible, you should share a single Manager between multiple threads and requests.

Since 0.1.0

Instances

Instances details

HasHttpManager Manager
Instance details Defined in Network.HTTP.Client.Types Methods getHttpManager :: Manager -> Manager Source #

newManager :: MonadIO m => ManagerSettings -> m Manager Source #

Create a connection manager that supports TLS connections.

defaultManagerSettings :: ManagerSettings Source #

Some default settings, overriding some of the library's default with stricter values.

Types

newtype SMASHPoolId Source #

TODO: import SMASH types

Constructors

SMASHPoolId
Fields poolId :: Text

Instances

Instances details

Eq SMASHPoolId Source #
Instance details Defined in Cardano.Pool.Metadata Methods (==) :: SMASHPoolId -> SMASHPoolId -> Bool Source # (/=) :: SMASHPoolId -> SMASHPoolId -> Bool Source #
Ord SMASHPoolId Source #
Instance details Defined in Cardano.Pool.Metadata Methods compare :: SMASHPoolId -> SMASHPoolId -> Ordering Source # (<) :: SMASHPoolId -> SMASHPoolId -> Bool Source # (<=) :: SMASHPoolId -> SMASHPoolId -> Bool Source # (>) :: SMASHPoolId -> SMASHPoolId -> Bool Source # (>=) :: SMASHPoolId -> SMASHPoolId -> Bool Source # max :: SMASHPoolId -> SMASHPoolId -> SMASHPoolId Source # min :: SMASHPoolId -> SMASHPoolId -> SMASHPoolId Source #
Show SMASHPoolId Source #
Instance details Defined in Cardano.Pool.Metadata Methods showsPrec :: Int -> SMASHPoolId -> ShowS Source # show :: SMASHPoolId -> String Source # showList :: [ SMASHPoolId ] -> ShowS Source #
Generic SMASHPoolId Source #
Instance details Defined in Cardano.Pool.Metadata Associated Types type Rep SMASHPoolId :: Type -> Type Source # Methods from :: SMASHPoolId -> Rep SMASHPoolId x Source # to :: Rep SMASHPoolId x -> SMASHPoolId Source #
ToJSON SMASHPoolId Source #
Instance details Defined in Cardano.Pool.Metadata Methods toJSON :: SMASHPoolId -> Value Source # toEncoding :: SMASHPoolId -> Encoding Source # toJSONList :: [ SMASHPoolId ] -> Value Source # toEncodingList :: [ SMASHPoolId ] -> Encoding Source #
FromJSON SMASHPoolId Source #
Instance details Defined in Cardano.Pool.Metadata Methods parseJSON :: Value -> Parser SMASHPoolId Source # parseJSONList :: Value -> Parser [ SMASHPoolId ] Source #
type Rep SMASHPoolId Source #
Instance details Defined in Cardano.Pool.Metadata type Rep SMASHPoolId = D1 (' MetaData "SMASHPoolId" "Cardano.Pool.Metadata" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "SMASHPoolId" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "poolId") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text )))