atlas-cardano-0.6.2: Application backend for Plutus smart contracts on Cardano
Copyright(c) 2023 GYELD GMBH
LicenseApache 2.0
Maintainer[email protected]
Stabilitydevelop
Safe HaskellSafe-Inferred
LanguageGHC2021

GeniusYield.Types.Providers

Description

 
Synopsis

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 #

show ∷ GYAwaitTxParameters → String #

showList ∷ [GYAwaitTxParameters] → ShowS #

Default GYAwaitTxParameters # 
Instance details

Defined in GeniusYield.Types.Providers

Methods

def ∷ GYAwaitTxParameters #

newtype GYAwaitTxException #

Constructors

GYAwaitTxException GYAwaitTxParameters 

Instances

Instances details
Exception GYAwaitTxException # 
Instance details

Defined in GeniusYield.Types.Providers

Methods

toException ∷ GYAwaitTxException → SomeException #

fromException ∷ SomeException → Maybe GYAwaitTxException #

displayException ∷ GYAwaitTxException → String #

Show GYAwaitTxException # 
Instance details

Defined in GeniusYield.Types.Providers

Methods

showsPrec ∷ Int → GYAwaitTxException → ShowS #

show ∷ GYAwaitTxException → String #

showList ∷ [GYAwaitTxException] → ShowS #

Get current slot

data GYSlotActions #

How to get current slot?

Constructors

GYSlotActions 

Fields

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 ∷ GYProviders → IO ApiProtocolParameters #

gyGetSystemStart ∷ GYProviders → IO SystemStart #

gyGetEraHistory ∷ GYProviders → IO EraHistory #

gyGetStakePools ∷ GYProviders → IO (Set PoolId) #

gyGetSlotConfig ∷ GYProviders → IO GYSlotConfig #

makeGetParameters #

Arguments

∷ IO ApiProtocolParameters

Getting protocol parameters

→ IO SystemStart

Getting system start

→ IO EraHistory

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

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

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 ∷ GYLogConfiguration #

simpleLogging ∷ GYLogSeverity → (Text → IO ()) → GYLogConfiguration #

Logging messages using the given severity filter with given IO action.

Providers

data GYProviders #

Constructors

GYProviders 

Fields