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

GeniusYield.Types.Providers

Contents

Lookup Datum
Submit Tx
Await Tx Confirmed
Get current slot
Get network parameters
Query UTxO
Logging
Providers

Description

Synopsis

type GYLookupDatum = GYDatumHash → IO (Maybe GYDatum)
type GYSubmitTx = GYTx → IO GYTxId
type GYAwaitTx = GYAwaitTxParameters → GYTxId → IO ()
data GYAwaitTxParameters = GYAwaitTxParameters {
- maxAttempts ∷ !Int
- checkInterval ∷ !Int
- confirmations ∷ !Word64
}
newtype GYAwaitTxException = GYAwaitTxException GYAwaitTxParameters
data GYSlotActions = GYSlotActions {
- gyGetSlotOfCurrentBlock' ∷ !(IO GYSlot)
- gyWaitForNextBlock' ∷ !(IO GYSlot)
- gyWaitUntilSlot' ∷ !(GYSlot → IO GYSlot)
}
gyGetSlotOfCurrentBlock ∷ GYProviders → IO GYSlot
gyWaitForNextBlock ∷ GYProviders → IO GYSlot
gyWaitForNextBlock_ ∷ GYProviders → IO ()
gyWaitForNextBlockDefault ∷ IO GYSlot → IO GYSlot
gyWaitUntilSlot ∷ GYProviders → GYSlot → IO GYSlot
gyWaitUntilSlotDefault ∷ IO GYSlot → GYSlot → IO GYSlot
makeSlotActions ∷ NominalDiffTime → IO GYSlot → IO GYSlotActions
data GYGetParameters = GYGetParameters {
- gyGetProtocolParameters' ∷ !(IO ProtocolParameters)
- gyGetSystemStart' ∷ !(IO SystemStart)
- gyGetEraHistory' ∷ !(IO (EraHistory CardanoMode))
- gyGetStakePools' ∷ !(IO (Set PoolId))
- gyGetSlotConfig' ∷ !(IO GYSlotConfig)
}
gyGetProtocolParameters ∷ GYProviders → IO ProtocolParameters
gyGetSystemStart ∷ GYProviders → IO SystemStart
gyGetEraHistory ∷ GYProviders → IO (EraHistory CardanoMode)
gyGetStakePools ∷ GYProviders → IO (Set PoolId)
gyGetSlotConfig ∷ GYProviders → IO GYSlotConfig
makeGetParameters ∷ IO GYSlot → IO ProtocolParameters → IO SystemStart → IO (EraHistory CardanoMode) → IO (Set PoolId) → IO GYGetParameters
gyQueryUtxosAtAddressWithDatumsDefault ∷ Monad m ⇒ (GYAddress → Maybe GYAssetClass → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → GYAddress → Maybe GYAssetClass → m [(GYUTxO, Maybe GYDatum)]
gyQueryUtxosAtAddressesWithDatumsDefault ∷ Monad m ⇒ ([GYAddress] → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → [GYAddress] → m [(GYUTxO, Maybe GYDatum)]
gyQueryUtxosAtPaymentCredsWithDatumsDefault ∷ Monad m ⇒ ([GYPaymentCredential] → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → [GYPaymentCredential] → m [(GYUTxO, Maybe GYDatum)]
gyQueryUtxosAtPaymentCredWithDatumsDefault ∷ Monad m ⇒ (GYPaymentCredential → Maybe GYAssetClass → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → GYPaymentCredential → Maybe GYAssetClass → m [(GYUTxO, Maybe GYDatum)]
gyQueryUtxosAtTxOutRefsWithDatumsDefault ∷ Monad m ⇒ ([GYTxOutRef] → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → [GYTxOutRef] → m [(GYUTxO, Maybe GYDatum)]
data GYQueryUTxO = GYQueryUTxO {
- gyQueryUtxosAtTxOutRefs' ∷ !([GYTxOutRef] → IO GYUTxOs)
- gyQueryUtxosAtTxOutRefsWithDatums' ∷ !(Maybe ([GYTxOutRef] → IO [(GYUTxO, Maybe GYDatum)]))
- gyQueryUtxoAtTxOutRef' ∷ !(GYTxOutRef → IO (Maybe GYUTxO))
- gyQueryUtxoRefsAtAddress' ∷ !(GYAddress → IO [GYTxOutRef])
- gyQueryUtxosAtAddress' ∷ !(GYAddress → Maybe GYAssetClass → IO GYUTxOs)
- gyQueryUtxosAtAddressWithDatums' ∷ !(Maybe (GYAddress → Maybe GYAssetClass → IO [(GYUTxO, Maybe GYDatum)]))
- gyQueryUtxosAtAddresses' ∷ !([GYAddress] → IO GYUTxOs)
- gyQueryUtxosAtAddressesWithDatums' ∷ !(Maybe ([GYAddress] → IO [(GYUTxO, Maybe GYDatum)]))
- gyQueryUtxosAtPaymentCredential' ∷ !(GYPaymentCredential → Maybe GYAssetClass → IO GYUTxOs)
- gyQueryUtxosAtPaymentCredWithDatums' ∷ !(Maybe (GYPaymentCredential → Maybe GYAssetClass → IO [(GYUTxO, Maybe GYDatum)]))
- gyQueryUtxosAtPaymentCredentials' ∷ !([GYPaymentCredential] → IO GYUTxOs)
- gyQueryUtxosAtPaymentCredsWithDatums' ∷ !(Maybe ([GYPaymentCredential] → IO [(GYUTxO, Maybe GYDatum)]))
}
gyQueryUtxosAtAddresses ∷ GYProviders → [GYAddress] → IO GYUTxOs
gyQueryUtxosAtAddressWithDatums ∷ GYProviders → GYAddress → Maybe GYAssetClass → IO [(GYUTxO, Maybe GYDatum)]
gyQueryUtxosAtAddressesWithDatums ∷ GYProviders → [GYAddress] → IO [(GYUTxO, Maybe GYDatum)]
gyQueryUtxosAtPaymentCredWithDatums ∷ GYProviders → GYPaymentCredential → Maybe GYAssetClass → IO [(GYUTxO, Maybe GYDatum)]
gyQueryUtxosAtPaymentCredsWithDatums ∷ GYProviders → [GYPaymentCredential] → IO [(GYUTxO, Maybe GYDatum)]
gyQueryUtxosAtAddress ∷ GYProviders → GYAddress → Maybe GYAssetClass → IO GYUTxOs
gyQueryUtxosAtPaymentCredential ∷ GYProviders → GYPaymentCredential → Maybe GYAssetClass → IO GYUTxOs
gyQueryUtxosAtPaymentCredentials ∷ GYProviders → [GYPaymentCredential] → IO GYUTxOs
gyQueryUtxosAtTxOutRefs ∷ GYProviders → [GYTxOutRef] → IO GYUTxOs
gyQueryUtxosAtTxOutRefsWithDatums ∷ GYProviders → [GYTxOutRef] → IO [(GYUTxO, Maybe GYDatum)]
gyQueryUtxoAtTxOutRef ∷ GYProviders → GYTxOutRef → IO (Maybe GYUTxO)
gyQueryUtxoRefsAtAddress ∷ GYProviders → GYAddress → IO [GYTxOutRef]
gyQueryUtxoRefsAtAddressDefault ∷ (GYAddress → Maybe GYAssetClass → IO GYUTxOs) → GYAddress → IO [GYTxOutRef]
gyQueryUtxoAtAddressesDefault ∷ (GYAddress → Maybe GYAssetClass → IO GYUTxOs) → [GYAddress] → IO GYUTxOs
gyQueryUtxoAtPaymentCredentialsDefault ∷ (GYPaymentCredential → Maybe GYAssetClass → IO GYUTxOs) → [GYPaymentCredential] → IO GYUTxOs
gyQueryUtxosAtTxOutRefsDefault ∷ (GYTxOutRef → IO (Maybe GYUTxO)) → [GYTxOutRef] → IO GYUTxOs
data GYLog = GYLog {
- logRun ∷ HasCallStack ⇒ GYLogNamespace → GYLogSeverity → String → IO ()
- logCleanUp ∷ IO ()
}
gyLog ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → GYLogSeverity → String → m ()
gyLogDebug ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → String → m ()
gyLogInfo ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → String → m ()
gyLogWarning ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → String → m ()
gyLogError ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → String → m ()
noLogging ∷ GYLog
simpleConsoleLogging ∷ (String → IO ()) → GYLog
data GYProviders = GYProviders {
- gyLookupDatum ∷ !GYLookupDatum
- gySubmitTx ∷ !GYSubmitTx
- gyAwaitTxConfirmed ∷ !GYAwaitTx
- gySlotActions ∷ !GYSlotActions
- gyGetParameters ∷ !GYGetParameters
- gyQueryUTxO ∷ !GYQueryUTxO
- gyLog' ∷ !GYLog
}

Lookup Datum

type GYLookupDatum = GYDatumHash → IO (Maybe GYDatum) #

How to query a datum by its hash?

Submit Tx

type GYSubmitTx = GYTx → IO GYTxId #

How to submit a transaction?

Await Tx Confirmed

type GYAwaitTx = GYAwaitTxParameters → GYTxId → IO () #

How to await for a transaction confirmation?

data GYAwaitTxParameters #

Await transaction parameters.

Constructors

GYAwaitTxParameters
Fields maxAttempts ∷ !Int Max number of attempts before give up. checkInterval ∷ !Int Wait time for each attempt (in microseconds). confirmations ∷ !Word64 Min number of block confirmation. NOTE: We might wait for more blocks than what is mentioned here but certainly not less.

Instances

Instances details

Show GYAwaitTxParameters #
Instance details Defined in GeniusYield.Types.Providers Methods showsPrec ∷ Int → GYAwaitTxParameters → ShowS Source # show ∷ GYAwaitTxParameters → String Source # showList ∷ [GYAwaitTxParameters] → ShowS Source #
Default GYAwaitTxParameters #
Instance details Defined in GeniusYield.Types.Providers Methods def ∷ GYAwaitTxParameters Source #

newtype GYAwaitTxException #

Constructors

GYAwaitTxException GYAwaitTxParameters

Instances

Instances details

Exception GYAwaitTxException #
Instance details Defined in GeniusYield.Types.Providers Methods toException ∷ GYAwaitTxException → SomeException Source # fromException ∷ SomeException → Maybe GYAwaitTxException Source # displayException ∷ GYAwaitTxException → String Source #
Show GYAwaitTxException #
Instance details Defined in GeniusYield.Types.Providers Methods showsPrec ∷ Int → GYAwaitTxException → ShowS Source # show ∷ GYAwaitTxException → String Source # showList ∷ [GYAwaitTxException] → ShowS Source #

Get current slot

data GYSlotActions #

How to get current slot?

Constructors

GYSlotActions
Fields gyGetSlotOfCurrentBlock' ∷ !(IO GYSlot) gyWaitForNextBlock' ∷ !(IO GYSlot) gyWaitUntilSlot' ∷ !(GYSlot → IO GYSlot)

gyGetSlotOfCurrentBlock ∷ GYProviders → IO GYSlot #

gyWaitForNextBlock ∷ GYProviders → IO GYSlot #

gyWaitForNextBlock_ ∷ GYProviders → IO () #

gyWaitForNextBlock variant which doesn't return current slot.

gyWaitForNextBlockDefault ∷ IO GYSlot → IO GYSlot #

Wait for the next block.

threadDelay until current slot getter returns another value.

gyWaitUntilSlot ∷ GYProviders → GYSlot → IO GYSlot #

gyWaitUntilSlotDefault ∷ IO GYSlot → GYSlot → IO GYSlot #

Wait until slot.

Returns the new current slot, which might be larger.

makeSlotActions #

Arguments

∷ NominalDiffTime	The time to cache current slots for.
→ IO GYSlot	Getting current slot directly from the provider
→ IO GYSlotActions

Construct efficient GYSlotActions methods by ensuring the supplied getSlotOfCurrentBlock is only made after a given duration of time has passed.

This uses IO to set up some mutable references used for caching.

Get network parameters

data GYGetParameters #

How to get protocol parameters? ... and other data to do balancing.

Constructors

GYGetParameters
Fields gyGetProtocolParameters' ∷ !(IO ProtocolParameters) gyGetSystemStart' ∷ !(IO SystemStart) gyGetEraHistory' ∷ !(IO (EraHistory CardanoMode)) gyGetStakePools' ∷ !(IO (Set PoolId)) gyGetSlotConfig' ∷ !(IO GYSlotConfig)

gyGetProtocolParameters ∷ GYProviders → IO ProtocolParameters #

gyGetSystemStart ∷ GYProviders → IO SystemStart #

gyGetEraHistory ∷ GYProviders → IO (EraHistory CardanoMode) #

gyGetStakePools ∷ GYProviders → IO (Set PoolId) #

gyGetSlotConfig ∷ GYProviders → IO GYSlotConfig #

makeGetParameters #

Arguments

∷ IO GYSlot	Getting current slot
→ IO ProtocolParameters	Getting protocol parameters
→ IO SystemStart	Getting system start
→ IO (EraHistory CardanoMode)	Getting era history
→ IO (Set PoolId)	Getting stake pools
→ IO GYGetParameters

Construct efficient GYGetParameters methods by ensuring the supplied IO queries are only made when necessary.

This uses IO to set up some mutable references used for caching.

Query UTxO

gyQueryUtxosAtAddressWithDatumsDefault ∷ Monad m ⇒ (GYAddress → Maybe GYAssetClass → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → GYAddress → Maybe GYAssetClass → m [(GYUTxO, Maybe GYDatum)] #

Lookup UTxOs at given GYAddress with their datums. This is a default implementation using utxosAtAddress and lookupDatum.

gyQueryUtxosAtAddressesWithDatumsDefault ∷ Monad m ⇒ ([GYAddress] → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → [GYAddress] → m [(GYUTxO, Maybe GYDatum)] #

Lookup UTxOs at zero or more GYAddress with their datums. This is a default implementation using utxosAtAddresses and lookupDatum.

gyQueryUtxosAtPaymentCredsWithDatumsDefault ∷ Monad m ⇒ ([GYPaymentCredential] → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → [GYPaymentCredential] → m [(GYUTxO, Maybe GYDatum)] #

Lookup UTxOs at zero or more GYPaymentCredential with their datums. This is a default implementation using utxosAtPaymentCredentials and lookupDatum.

gyQueryUtxosAtPaymentCredWithDatumsDefault ∷ Monad m ⇒ (GYPaymentCredential → Maybe GYAssetClass → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → GYPaymentCredential → Maybe GYAssetClass → m [(GYUTxO, Maybe GYDatum)] #

Lookup UTxOs at given GYPaymentCredential with their datums. This is a default implementation using utxosAtPaymentCredential and lookupDatum.

gyQueryUtxosAtTxOutRefsWithDatumsDefault ∷ Monad m ⇒ ([GYTxOutRef] → m GYUTxOs) → (GYDatumHash → m (Maybe GYDatum)) → [GYTxOutRef] → m [(GYUTxO, Maybe GYDatum)] #

Lookup UTxOs at zero or more GYTxOutRef with their datums. This is a default implementation using utxosAtTxOutRefs and lookupDatum.

data GYQueryUTxO #

How to query utxos?

Constructors

GYQueryUTxO

Fields

gyQueryUtxosAtTxOutRefs' ∷ !([GYTxOutRef] → IO GYUTxOs)
gyQueryUtxosAtTxOutRefsWithDatums' ∷ !(Maybe ([GYTxOutRef] → IO [(GYUTxO, Maybe GYDatum)]))
gyQueryUtxosAtTxOutRefsWithDatums` is as Maybe so that if an implementation is not given, a default one is used.
gyQueryUtxoAtTxOutRef' ∷ !(GYTxOutRef → IO (Maybe GYUTxO))
gyQueryUtxoRefsAtAddress' ∷ !(GYAddress → IO [GYTxOutRef])
gyQueryUtxosAtAddress' ∷ !(GYAddress → Maybe GYAssetClass → IO GYUTxOs)
gyQueryUtxosAtAddressWithDatums' ∷ !(Maybe (GYAddress → Maybe GYAssetClass → IO [(GYUTxO, Maybe GYDatum)]))
gyQueryUtxosAtAddresses' ∷ !([GYAddress] → IO GYUTxOs)
gyQueryUtxosAtAddressesWithDatums' ∷ !(Maybe ([GYAddress] → IO [(GYUTxO, Maybe GYDatum)]))
gyQueryUtxosAtAddressesWithDatums` is as Maybe so that if an implementation is not given, a default one is used.
gyQueryUtxosAtPaymentCredential' ∷ !(GYPaymentCredential → Maybe GYAssetClass → IO GYUTxOs)
gyQueryUtxosAtPaymentCredWithDatums' ∷ !(Maybe (GYPaymentCredential → Maybe GYAssetClass → IO [(GYUTxO, Maybe GYDatum)]))
gyQueryUtxosAtPaymentCredWithDatums` is as Maybe so that if an implementation is not given, a default one is used.
gyQueryUtxosAtPaymentCredentials' ∷ !([GYPaymentCredential] → IO GYUTxOs)
gyQueryUtxosAtPaymentCredsWithDatums' ∷ !(Maybe ([GYPaymentCredential] → IO [(GYUTxO, Maybe GYDatum)]))
gyQueryUtxosAtPaymentCredsWithDatums` is as Maybe so that if an implementation is not given, a default one is used.

gyQueryUtxosAtAddresses ∷ GYProviders → [GYAddress] → IO GYUTxOs #

gyQueryUtxosAtAddressWithDatums ∷ GYProviders → GYAddress → Maybe GYAssetClass → IO [(GYUTxO, Maybe GYDatum)] #

gyQueryUtxosAtAddressesWithDatums ∷ GYProviders → [GYAddress] → IO [(GYUTxO, Maybe GYDatum)] #

gyQueryUtxosAtPaymentCredWithDatums ∷ GYProviders → GYPaymentCredential → Maybe GYAssetClass → IO [(GYUTxO, Maybe GYDatum)] #

gyQueryUtxosAtPaymentCredsWithDatums ∷ GYProviders → [GYPaymentCredential] → IO [(GYUTxO, Maybe GYDatum)] #

gyQueryUtxosAtAddress ∷ GYProviders → GYAddress → Maybe GYAssetClass → IO GYUTxOs #

gyQueryUtxosAtPaymentCredential ∷ GYProviders → GYPaymentCredential → Maybe GYAssetClass → IO GYUTxOs #

gyQueryUtxosAtPaymentCredentials ∷ GYProviders → [GYPaymentCredential] → IO GYUTxOs #

gyQueryUtxosAtTxOutRefs ∷ GYProviders → [GYTxOutRef] → IO GYUTxOs #

gyQueryUtxosAtTxOutRefsWithDatums ∷ GYProviders → [GYTxOutRef] → IO [(GYUTxO, Maybe GYDatum)] #

gyQueryUtxoAtTxOutRef ∷ GYProviders → GYTxOutRef → IO (Maybe GYUTxO) #

gyQueryUtxoRefsAtAddress ∷ GYProviders → GYAddress → IO [GYTxOutRef] #

gyQueryUtxoRefsAtAddressDefault ∷ (GYAddress → Maybe GYAssetClass → IO GYUTxOs) → GYAddress → IO [GYTxOutRef] #

Query Utxo Refs at address (default implementation)

gyQueryUtxoAtAddressesDefault ∷ (GYAddress → Maybe GYAssetClass → IO GYUTxOs) → [GYAddress] → IO GYUTxOs #

Query Utxo for addresses (default implementation)

gyQueryUtxoAtPaymentCredentialsDefault ∷ (GYPaymentCredential → Maybe GYAssetClass → IO GYUTxOs) → [GYPaymentCredential] → IO GYUTxOs #

Query Utxo for payment credentials (default implementation)

gyQueryUtxosAtTxOutRefsDefault ∷ (GYTxOutRef → IO (Maybe GYUTxO)) → [GYTxOutRef] → IO GYUTxOs #

Query Utxos at output refs (default implementation).

Logging

data GYLog #

Constructors

GYLog
Fields logRun ∷ HasCallStack ⇒ GYLogNamespace → GYLogSeverity → String → IO () logCleanUp ∷ IO ()

gyLog ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → GYLogSeverity → String → m () #

gyLogDebug ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → String → m () #

gyLogInfo ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → String → m () #

gyLogWarning ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → String → m () #

gyLogError ∷ (HasCallStack, MonadIO m) ⇒ GYProviders → GYLogNamespace → String → m () #

noLogging ∷ GYLog #

simpleConsoleLogging #

Arguments

∷ (String → IO ())	putStrLn variant
→ GYLog

Providers

data GYProviders #

Constructors

GYProviders

Fields

gyLookupDatum ∷ !GYLookupDatum
gySubmitTx ∷ !GYSubmitTx
gyAwaitTxConfirmed ∷ !GYAwaitTx
This is a function to see whether the submitted transaction is successfully seen on chain. NOTE: Don't call gyAwaitTxConfirmed on transaction that has been submitted long ago as we determine presence of submitted transaction by looking for any UTxO generated by it. Though we maintain information for even spent UTxOs until the block which spent them is sufficiently deep (2160 blocks for mainnet).
gySlotActions ∷ !GYSlotActions
gyGetParameters ∷ !GYGetParameters
gyQueryUTxO ∷ !GYQueryUTxO
gyLog' ∷ !GYLog