Module

Ctl.Internal.QueryM.Ogmios

Provides types and instances to create Ogmios requests and decode its responses.

#ChainOrigin 

newtype ChainOrigin

The origin of the blockchain. It doesn't point to any existing slots, but

Constructors

Instances

#ChainPoint 

type ChainPoint = { id :: OgmiosBlockHeaderHash, slot :: Slot }

A point on the chain, identified by a slot and a block header hash

#ExecutionUnits 

type ExecutionUnits = { memory :: BigNum, steps :: BigNum }

#MempoolSizeAndCapacity 

newtype MempoolSizeAndCapacity

The acquired snapshot’s size (in bytes), number of transactions, and capacity (in bytes).

Constructors

Instances

#MempoolTransaction 

newtype MempoolTransaction

Constructors

Instances

#OgmiosAddress 

type OgmiosAddress = Bech32String

#OgmiosBlockHeaderHash 

newtype OgmiosBlockHeaderHash

A Blake2b 32-byte digest of an era-independent block header, serialized as

Constructors

Instances

#OgmiosTxOut 

type OgmiosTxOut = { address :: OgmiosAddress, datum :: Maybe String, datumHash :: Maybe String, script :: Maybe ScriptRef, value :: Value }

#OgmiosTxOutRef 

type OgmiosTxOutRef = { index :: UInt, txId :: String }

#PParamRational 

newtype PParamRational

A version of Rational with Aeson instance that decodes from x/y representation, instead of { numerator, denominator }

Constructors

Instances

#PoolParameters 

type PoolParameters = { cost :: BigNum, margin :: UnitInterval, pledge :: BigNum, poolMetadata :: Maybe PoolMetadata, poolOwners :: Array Ed25519KeyHash, relays :: Array Relay, rewardAccount :: RewardAddress, vrfKeyhash :: VRFKeyHash }

#RedeemerPointer 

type RedeemerPointer = { redeemerIndex :: UInt, redeemerTag :: RedeemerTag }

#OgmiosDatum 

type OgmiosDatum = String

#OgmiosScript 

type OgmiosScript = String

#OgmiosTxIn 

type OgmiosTxIn = { index :: Int, txId :: OgmiosTxId }

#OgmiosTxId 

type OgmiosTxId = String

#HasTxR 

newtype HasTxR

Constructors

Instances

#aesonArray 

aesonArray :: forall (a :: Type). (Array Aeson -> Either JsonDecodeError a) -> Aeson -> Either JsonDecodeError a

#aesonObject 

aesonObject :: forall (a :: Type). (Object Aeson -> Either JsonDecodeError a) -> Aeson -> Either JsonDecodeError a

#evaluateTxCall 

evaluateTxCall :: JsonRpc2Call (CborBytes /\ AdditionalUtxoSet) TxEvaluationR

Evaluates the execution units of scripts present in a given transaction, without actually submitting the transaction.

#queryStakePoolsCall 

queryStakePoolsCall :: JsonRpc2Call StakePoolsQueryArgument PoolParametersR

Queries Ogmios for pool parameters of all pools or of the provided pools.

#mkOgmiosCallType 

mkOgmiosCallType :: forall (a :: Type) (i :: Type) (o :: Type). EncodeAeson (JsonRpc2Request a) => DecodeOgmios o => { method :: String, params :: i -> a } -> JsonRpc2Call i o

#mkOgmiosCallTypeNoArgs 

mkOgmiosCallTypeNoArgs :: forall (o :: Type). DecodeOgmios o => String -> JsonRpc2Call Unit o

#queryChainTipCall 

queryChainTipCall :: JsonRpc2Call Unit ChainTipQR

Queries Ogmios for the chain’s current tip.

#queryCurrentEpochCall 

queryCurrentEpochCall :: JsonRpc2Call Unit CurrentEpoch

Queries Ogmios for the current epoch

#queryEraSummariesCall 

queryEraSummariesCall :: JsonRpc2Call Unit OgmiosEraSummaries

Queries Ogmios for an array of era summaries, used for Slot arithmetic.

#queryProtocolParametersCall 

queryProtocolParametersCall :: JsonRpc2Call Unit OgmiosProtocolParameters

Queries Ogmios for the current protocol parameters

#querySystemStartCall 

querySystemStartCall :: JsonRpc2Call Unit OgmiosSystemStart

Queries Ogmios for the system start Datetime

#submitTxCall 

submitTxCall :: JsonRpc2Call (TransactionHash /\ CborBytes) SubmitTxR

Sends a serialized signed transaction with its full witness through the Cardano network via Ogmios.

#submitSuccessPartialResp 

submitSuccessPartialResp :: TransactionHash -> { result :: { transaction :: { id :: TransactionHash } } }

#parseIpv6String 

parseIpv6String :: String -> Maybe Ipv6

#showRedeemerPointer 

showRedeemerPointer :: RedeemerPointer -> String

Modules