Safe Haskell	Safe-Inferred
Language	Haskell2010

Convex.Query

Contents

Tx balancing for operator
Wallet API queries

Description

Custom class to encapsulate the general purpose queries that we need for building transactions

Synopsis

class Monad m ⇒ MonadUtxoQuery m where
- utxosByPaymentCredentials ∷ Set PaymentCredential → m (UTxO BabbageEra)
utxosByPayment ∷ MonadUtxoQuery m ⇒ PaymentCredential → m (UTxO BabbageEra)
newtype BalancingError = BalancingError String
balanceTx ∷ (MonadBlockchain m, MonadUtxoQuery m) ⇒ PaymentCredential → TxOut CtxTx BabbageEra → TxBodyContent BuildTx BabbageEra → m (Either BalancingError (BalancedTxBody BabbageEra, BalanceChanges))
balanceAndSubmitOperator ∷ (MonadBlockchain m, MonadUtxoQuery m, MonadError BalanceAndSubmitError m) ⇒ Operator Signing → Maybe (TxOut CtxTx BabbageEra) → TxBodyContent BuildTx BabbageEra → m (Tx BabbageEra)
balanceOperator ∷ (MonadBlockchain m, MonadUtxoQuery m, MonadError BalanceAndSubmitError m) ⇒ PaymentCredential → Maybe (TxOut CtxTx BabbageEra) → TxBodyContent BuildTx BabbageEra → m (Tx BabbageEra)
signTxOperator ∷ Operator Signing → Tx BabbageEra → Tx BabbageEra
signAndSubmitOperator ∷ (MonadBlockchain m, MonadError BalanceAndSubmitError m) ⇒ Operator Signing → Tx BabbageEra → m (Tx BabbageEra)
operatorUtxos ∷ MonadUtxoQuery m ⇒ Operator k → m (UTxO BabbageEra)
selectOperatorUTxO ∷ MonadUtxoQuery m ⇒ Operator k → m (Maybe (TxIn, TxOut CtxUTxO BabbageEra))
data BalanceAndSubmitError
- = BalanceError BalancingError
- | SubmitError String
newtype WalletAPIQueryT m a = WalletAPIQueryT {
- runWalletAPIQueryT_ ∷ ReaderT ClientEnv m a
}
runWalletAPIQueryT ∷ ClientEnv → WalletAPIQueryT m a → m a

Documentation

class Monad m ⇒ MonadUtxoQuery m where Source #

Methods

utxosByPaymentCredentials ∷ Set PaymentCredential → m (UTxO BabbageEra) Source #

Instances

Instances details

MonadUtxoQuery m ⇒ MonadUtxoQuery (MonadLogIgnoreT m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → MonadLogIgnoreT m (UTxO BabbageEra) Source #
MonadIO m ⇒ MonadUtxoQuery (WalletAPIQueryT m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → WalletAPIQueryT m (UTxO BabbageEra) Source #
Monad m ⇒ MonadUtxoQuery (MockchainT m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → MockchainT m (UTxO BabbageEra) Source #
MonadUtxoQuery m ⇒ MonadUtxoQuery (MonadBlockchainWaitingT m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → MonadBlockchainWaitingT m (UTxO BabbageEra) Source #
MonadUtxoQuery m ⇒ MonadUtxoQuery (ResultT m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → ResultT m (UTxO BabbageEra) Source #
MonadUtxoQuery m ⇒ MonadUtxoQuery (MonadBlockchainCardanoNodeT e m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → MonadBlockchainCardanoNodeT e m (UTxO BabbageEra) Source #
MonadUtxoQuery m ⇒ MonadUtxoQuery (ExceptT e m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → ExceptT e m (UTxO BabbageEra) Source #
MonadUtxoQuery m ⇒ MonadUtxoQuery (ReaderT e m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → ReaderT e m (UTxO BabbageEra) Source #
MonadUtxoQuery m ⇒ MonadUtxoQuery (StateT s m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → StateT s m (UTxO BabbageEra) Source #
MonadUtxoQuery m ⇒ MonadUtxoQuery (StateT s m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → StateT s m (UTxO BabbageEra) Source #

utxosByPayment ∷ MonadUtxoQuery m ⇒ PaymentCredential → m (UTxO BabbageEra) Source #

newtype BalancingError Source #

Constructors

BalancingError String

Instances

Instances details

Show BalancingError Source #
Instance details Defined in Convex.Query Methods showsPrec ∷ Int → BalancingError → ShowS Source # show ∷ BalancingError → String Source # showList ∷ [BalancingError] → ShowS Source #
Eq BalancingError Source #
Instance details Defined in Convex.Query Methods (==) ∷ BalancingError → BalancingError → Bool Source # (/=) ∷ BalancingError → BalancingError → Bool Source #
Ord BalancingError Source #
Instance details Defined in Convex.Query Methods compare ∷ BalancingError → BalancingError → Ordering Source # (<) ∷ BalancingError → BalancingError → Bool Source # (<=) ∷ BalancingError → BalancingError → Bool Source # (>) ∷ BalancingError → BalancingError → Bool Source # (>=) ∷ BalancingError → BalancingError → Bool Source # max ∷ BalancingError → BalancingError → BalancingError Source # min ∷ BalancingError → BalancingError → BalancingError Source #

balanceTx ∷ (MonadBlockchain m, MonadUtxoQuery m) ⇒ PaymentCredential → TxOut CtxTx BabbageEra → TxBodyContent BuildTx BabbageEra → m (Either BalancingError (BalancedTxBody BabbageEra, BalanceChanges)) Source #

Balance the transaction body using the UTxOs locked by the payment credential, and returning any unused funds to the given payment credential and stake credential |

Tx balancing for operator

balanceAndSubmitOperator ∷ (MonadBlockchain m, MonadUtxoQuery m, MonadError BalanceAndSubmitError m) ⇒ Operator Signing → Maybe (TxOut CtxTx BabbageEra) → TxBodyContent BuildTx BabbageEra → m (Tx BabbageEra) Source #

Balance a transaction body, sign it with the operator's key, and submit it to the network.

balanceOperator ∷ (MonadBlockchain m, MonadUtxoQuery m, MonadError BalanceAndSubmitError m) ⇒ PaymentCredential → Maybe (TxOut CtxTx BabbageEra) → TxBodyContent BuildTx BabbageEra → m (Tx BabbageEra) Source #

Balance a transaction body using the funds locked by the payment credential

signTxOperator ∷ Operator Signing → Tx BabbageEra → Tx BabbageEra Source #

Add a signature to the transaction

signAndSubmitOperator ∷ (MonadBlockchain m, MonadError BalanceAndSubmitError m) ⇒ Operator Signing → Tx BabbageEra → m (Tx BabbageEra) Source #

Add the operator's signature to the transaction and send it to the blockchain

operatorUtxos ∷ MonadUtxoQuery m ⇒ Operator k → m (UTxO BabbageEra) Source #

UTxOs that are locked by the operator's payment credential |

selectOperatorUTxO ∷ MonadUtxoQuery m ⇒ Operator k → m (Maybe (TxIn, TxOut CtxUTxO BabbageEra)) Source #

Select a single UTxO that is controlled by the operator. |

data BalanceAndSubmitError Source #

Failures during txn balancing and submission

Constructors

BalanceError BalancingError
SubmitError String

Instances

Instances details

Show BalanceAndSubmitError Source #
Instance details Defined in Convex.Query Methods showsPrec ∷ Int → BalanceAndSubmitError → ShowS Source # show ∷ BalanceAndSubmitError → String Source # showList ∷ [BalanceAndSubmitError] → ShowS Source #

Wallet API queries

newtype WalletAPIQueryT m a Source #

Constructors

WalletAPIQueryT
Fields runWalletAPIQueryT_ ∷ ReaderT ClientEnv m a

Instances

Instances details

MonadError e m ⇒ MonadError e (WalletAPIQueryT m) Source #
Instance details Defined in Convex.Query Methods throwError ∷ e → WalletAPIQueryT m a Source # catchError ∷ WalletAPIQueryT m a → (e → WalletAPIQueryT m a) → WalletAPIQueryT m a Source #
MonadIO m ⇒ MonadIO (WalletAPIQueryT m) Source #
Instance details Defined in Convex.Query Methods liftIO ∷ IO a → WalletAPIQueryT m a Source #
Applicative m ⇒ Applicative (WalletAPIQueryT m) Source #
Instance details Defined in Convex.Query Methods pure ∷ a → WalletAPIQueryT m a Source # (<>) ∷ WalletAPIQueryT m (a → b) → WalletAPIQueryT m a → WalletAPIQueryT m b Source # liftA2 ∷ (a → b → c) → WalletAPIQueryT m a → WalletAPIQueryT m b → WalletAPIQueryT m c Source # (>) ∷ WalletAPIQueryT m a → WalletAPIQueryT m b → WalletAPIQueryT m b Source # (<*) ∷ WalletAPIQueryT m a → WalletAPIQueryT m b → WalletAPIQueryT m a Source #
Functor m ⇒ Functor (WalletAPIQueryT m) Source #
Instance details Defined in Convex.Query Methods fmap ∷ (a → b) → WalletAPIQueryT m a → WalletAPIQueryT m b Source # (<$) ∷ a → WalletAPIQueryT m b → WalletAPIQueryT m a Source #
Monad m ⇒ Monad (WalletAPIQueryT m) Source #
Instance details Defined in Convex.Query Methods (>>=) ∷ WalletAPIQueryT m a → (a → WalletAPIQueryT m b) → WalletAPIQueryT m b Source # (>>) ∷ WalletAPIQueryT m a → WalletAPIQueryT m b → WalletAPIQueryT m b Source # return ∷ a → WalletAPIQueryT m a Source #
MonadBlockchain m ⇒ MonadBlockchain (WalletAPIQueryT m) Source #
Instance details Defined in Convex.Query Methods sendTx ∷ Tx BabbageEra → WalletAPIQueryT m TxId Source # utxoByTxIn ∷ Set TxIn → WalletAPIQueryT m (UTxO BabbageEra) Source # queryProtocolParameters ∷ WalletAPIQueryT m (BundledProtocolParameters BabbageEra) Source # queryStakePools ∷ WalletAPIQueryT m (Set PoolId) Source # querySystemStart ∷ WalletAPIQueryT m SystemStart Source # queryEraHistory ∷ WalletAPIQueryT m (EraHistory CardanoMode) Source # querySlotNo ∷ WalletAPIQueryT m (SlotNo, SlotLength, UTCTime) Source # networkId ∷ WalletAPIQueryT m NetworkId Source #
MonadLog m ⇒ MonadLog (WalletAPIQueryT m) Source #
Instance details Defined in Convex.Query Methods logInfo' ∷ Doc Void → WalletAPIQueryT m () Source # logWarn' ∷ Doc Void → WalletAPIQueryT m () Source # logDebug' ∷ Doc Void → WalletAPIQueryT m () Source #
MonadIO m ⇒ MonadUtxoQuery (WalletAPIQueryT m) Source #
Instance details Defined in Convex.Query Methods utxosByPaymentCredentials ∷ Set PaymentCredential → WalletAPIQueryT m (UTxO BabbageEra) Source #

runWalletAPIQueryT ∷ ClientEnv → WalletAPIQueryT m a → m a Source #