Copyright | (c) 2023 GYELD GMBH |
---|---|
License | Apache 2.0 |
Maintainer | [email protected] |
Stability | develop |
Safe Haskell | None |
Language | Haskell2010 |
GeniusYield.GYConfig
Description
Synopsis
- data GYCoreConfig = GYCoreConfig {}
- data GYCoreProviderInfo
- = GYNodeChainIx {
- cpiSocketPath ∷ !FilePath
- cpiMaestroToken ∷ !(Confidential Text)
- | GYDbSync {
- cpiCardanoDbSync ∷ !PQConnInf
- cpiCardanoSubmitApiUrl ∷ !String
- | GYMaestro {
- cpiMaestroToken ∷ !(Confidential Text)
- | GYBlockfrost {
- cpiBlockfrostKey ∷ !(Confidential Text)
- = GYNodeChainIx {
- withCfgProviders ∷ GYCoreConfig → GYLogNamespace → (GYProviders → IO a) → IO a
- coreConfigIO ∷ FilePath → IO GYCoreConfig
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 |
Instances
Show GYCoreConfig # | |
Defined in GeniusYield.GYConfig Methods showsPrec ∷ Int → GYCoreConfig → ShowS # show ∷ GYCoreConfig → String # showList ∷ [GYCoreConfig] → ShowS # | |
FromJSON GYCoreConfig # | |
Defined in GeniusYield.GYConfig |
data GYCoreProviderInfo #
The supported providers. The options are:
- Local node.socket and a maestro API key
- Cardano db sync alongside cardano submit api
- Maestro blockchain API, provided its API token.
In JSON format, this essentially corresponds to:
{ socketPath: FilePath, maestroToken: string }
| { cardanoDbSync: PQ.ConnectInfo, cardanoSubmitApiUrl: string } | { maestroToken: string } | { blockfrostKey: string }
The constructor tags don't need to appear in the JSON.
Constructors
GYNodeChainIx | |
Fields
| |
GYDbSync | |
Fields
| |
GYMaestro | |
Fields
| |
GYBlockfrost | |
Fields
|
Instances
Show GYCoreProviderInfo # | |
Defined in GeniusYield.GYConfig Methods showsPrec ∷ Int → GYCoreProviderInfo → ShowS # show ∷ GYCoreProviderInfo → String # showList ∷ [GYCoreProviderInfo] → ShowS # | |
FromJSON GYCoreProviderInfo # | |
Defined in GeniusYield.GYConfig Methods parseJSON ∷ Value → Parser GYCoreProviderInfo # parseJSONList ∷ Value → Parser [GYCoreProviderInfo] # |
withCfgProviders ∷ GYCoreConfig → GYLogNamespace → (GYProviders → IO a) → IO a #