GeniusYield.GYConfig

Description

Synopsis

Documentation

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 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 with a custom show instance that prevents showing the contained data.

Constructors

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 #

The supported providers. The options are:

In JSON format, this essentially corresponds to:

| { maestroToken: string, turboSubmit: boolean } | { blockfrostKey: string }

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

Constructors

GYNodeKupo
Fields cpiSocketPath ∷ !FilePath cpiKupoUrl ∷ !Text
GYMaestro
Fields cpiMaestroToken ∷ !(Confidential Text) cpiTurboSubmit ∷ !(Maybe Bool)
GYBlockfrost
Fields cpiBlockfrostKey ∷ !(Confidential Text)

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 #