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

GeniusYield.GYConfig

Description

Synopsis

data GYCoreConfig = GYCoreConfig {
- cfgCoreProvider ∷ !GYCoreProviderInfo
- cfgNetworkId ∷ !GYNetworkId
- cfgLogging ∷ ![GYLogScribeConfig]
- cfgLogTiming ∷ !(Maybe Bool)
}
newtype Confidential a = Confidential a
data GYCoreProviderInfo
- = GYNodeKupo {
  - cpiSocketPath ∷ !FilePath
  - cpiKupoUrl ∷ !Text
  - cpiMempoolCache ∷ !(Maybe MempoolCacheSettings)
  - cpiLocalTxSubmissionCache ∷ !(Maybe LocalTxSubmissionCacheSettings)
  }
- | GYOgmiosKupo {
  - cpiOgmiosUrl ∷ !Text
  - cpiKupoUrl ∷ !Text
  - cpiMempoolCache ∷ !(Maybe MempoolCacheSettings)
  - cpiLocalTxSubmissionCache ∷ !(Maybe LocalTxSubmissionCacheSettings)
  }
- | GYMaestro {
  - cpiMaestroToken ∷ !(Confidential Text)
  - cpiTurboSubmit ∷ !(Maybe Bool)
  }
- | GYBlockfrost {
  - cpiBlockfrostKey ∷ !(Confidential Text)
  }
withCfgProviders ∷ GYCoreConfig → GYLogNamespace → (GYProviders → IO a) → IO a
coreConfigIO ∷ FilePath → IO GYCoreConfig
coreProviderIO ∷ FilePath → IO GYCoreProviderInfo
findMaestroTokenAndNetId ∷ [GYCoreConfig] → IO (Text, GYNetworkId)
isNodeKupo ∷ GYCoreProviderInfo → Bool
isOgmiosKupo ∷ GYCoreProviderInfo → Bool
isMaestro ∷ GYCoreProviderInfo → Bool
isBlockfrost ∷ GYCoreProviderInfo → Bool

Documentation

data GYCoreConfig #

The config to initialize the GY framework with. Should include information on the providers to use, as well as the network id.

In JSON format, this essentially corresponds to:

{ coreProvider: GYCoreProviderInfo, networkId: NetworkId, logging: [GYLogScribeConfig], utxoCacheEnable: boolean }

Constructors

GYCoreConfig
Fields cfgCoreProvider ∷ !GYCoreProviderInfo cfgNetworkId ∷ !GYNetworkId cfgLogging ∷ ![GYLogScribeConfig] List of scribes to register. cfgLogTiming ∷ !(Maybe Bool) Optional switch to enable timing and logging of requests sent to provider.

Instances

Instances details

FromJSON GYCoreConfig #
Instance details Defined in GeniusYield.GYConfig Methods parseJSON ∷ Value → Parser GYCoreConfig # parseJSONList ∷ Value → Parser [GYCoreConfig] # omittedField ∷ Maybe GYCoreConfig #
Show GYCoreConfig #
Instance details Defined in GeniusYield.GYConfig Methods showsPrec ∷ Int → GYCoreConfig → ShowS # show ∷ GYCoreConfig → String # showList ∷ [GYCoreConfig] → ShowS #

newtype Confidential a #

Newtype with a custom show instance that prevents showing the contained data.

Constructors

Confidential a

Instances

Instances details

FromJSON a ⇒ FromJSON (Confidential a) #
Instance details Defined in GeniusYield.GYConfig Methods parseJSON ∷ Value → Parser (Confidential a) # parseJSONList ∷ Value → Parser [Confidential a] # omittedField ∷ Maybe (Confidential a) #
ToJSON a ⇒ ToJSON (Confidential a) #
Instance details Defined in GeniusYield.GYConfig Methods toJSON ∷ Confidential a → Value # toEncoding ∷ Confidential a → Encoding # toJSONList ∷ [Confidential a] → Value # toEncodingList ∷ [Confidential a] → Encoding # omitField ∷ Confidential a → Bool #
Show (Confidential a) #
Instance details Defined in GeniusYield.GYConfig Methods showsPrec ∷ Int → Confidential a → ShowS # show ∷ Confidential a → String # showList ∷ [Confidential a] → ShowS #
Eq a ⇒ Eq (Confidential a) #
Instance details Defined in GeniusYield.GYConfig Methods (==) ∷ Confidential a → Confidential a → Bool # (/=) ∷ Confidential a → Confidential a → Bool #
Ord a ⇒ Ord (Confidential a) #
Instance details Defined in GeniusYield.GYConfig Methods compare ∷ Confidential a → Confidential a → Ordering # (<) ∷ Confidential a → Confidential a → Bool # (<=) ∷ Confidential a → Confidential a → Bool # (>) ∷ Confidential a → Confidential a → Bool # (>=) ∷ Confidential a → Confidential a → Bool # max ∷ Confidential a → Confidential a → Confidential a # min ∷ Confidential a → Confidential a → Confidential a #

data GYCoreProviderInfo #

The supported providers. The options are:

Local node.socket along with Kupo
Ogmios node instance along with Kupo
Maestro blockchain API, provided its API token.
Blockfrost API, provided its API key.

In JSON format, this essentially corresponds to:

{ socketPath: FilePath, kupoUrl: string, mempoolCache: { cacheInterval: number }, localTxSubmissionCache: { cacheInterval: number } }

| { ogmiosUrl: string, kupoUrl: string, mempoolCache: { cacheInterval: number }, localTxSubmissionCache: { cacheInterval: number } } | { maestroToken: string, turboSubmit: boolean } | { blockfrostKey: string }

The constructor tags don't need to appear in the JSON.

Constructors

GYNodeKupo
Fields cpiSocketPath ∷ !FilePath cpiKupoUrl ∷ !Text cpiMempoolCache ∷ !(Maybe MempoolCacheSettings) cpiLocalTxSubmissionCache ∷ !(Maybe LocalTxSubmissionCacheSettings)
GYOgmiosKupo
Fields cpiOgmiosUrl ∷ !Text cpiKupoUrl ∷ !Text cpiMempoolCache ∷ !(Maybe MempoolCacheSettings) cpiLocalTxSubmissionCache ∷ !(Maybe LocalTxSubmissionCacheSettings)
GYMaestro
Fields cpiMaestroToken ∷ !(Confidential Text) cpiTurboSubmit ∷ !(Maybe Bool)
GYBlockfrost
Fields cpiBlockfrostKey ∷ !(Confidential Text)

Instances

Instances details

FromJSON GYCoreProviderInfo #
Instance details Defined in GeniusYield.GYConfig Methods parseJSON ∷ Value → Parser GYCoreProviderInfo # parseJSONList ∷ Value → Parser [GYCoreProviderInfo] # omittedField ∷ Maybe GYCoreProviderInfo #
Show GYCoreProviderInfo #
Instance details Defined in GeniusYield.GYConfig Methods showsPrec ∷ Int → GYCoreProviderInfo → ShowS # show ∷ GYCoreProviderInfo → String # showList ∷ [GYCoreProviderInfo] → ShowS #

withCfgProviders ∷ GYCoreConfig → GYLogNamespace → (GYProviders → IO a) → IO a #

coreConfigIO ∷ FilePath → IO GYCoreConfig #

coreProviderIO ∷ FilePath → IO GYCoreProviderInfo #

findMaestroTokenAndNetId ∷ [GYCoreConfig] → IO (Text, GYNetworkId) #

isNodeKupo ∷ GYCoreProviderInfo → Bool #

isOgmiosKupo ∷ GYCoreProviderInfo → Bool #

isMaestro ∷ GYCoreProviderInfo → Bool #

isBlockfrost ∷ GYCoreProviderInfo → Bool #