atlas-cardano
Copyright(c) 2023 GYELD GMBH
LicenseApache 2.0
Maintainer[email protected]
Stabilitydevelop
Safe HaskellNone
LanguageGHC2021

GeniusYield.GYConfig

Description

 
Synopsis

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

newtype Confidential a #

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

Constructors

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

GYOgmiosKupo 

Fields

GYMaestro 
GYBlockfrost