Ctl.Internal.QueryM.Ogmios

newtype ChainOrigin

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

Constructors

• ChainOrigin String

Instances

• Eq ChainOrigin
• DecodeAeson ChainOrigin
• HasRuntimeType ChainOrigin
• Generic ChainOrigin _
• Show ChainOrigin

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

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

data ChainTipQR

Constructors

• CtChainOrigin ChainOrigin
• CtChainPoint ChainPoint

Instances

• Generic ChainTipQR _
• Show ChainTipQR
• DecodeAeson ChainTipQR
• DecodeOgmios ChainTipQR

newtype CurrentEpoch

Constructors

• CurrentEpoch BigNum

Instances

• Generic CurrentEpoch _
• Newtype CurrentEpoch _
• DecodeAeson CurrentEpoch
• EncodeAeson CurrentEpoch
• Eq CurrentEpoch
• Ord CurrentEpoch
• Show CurrentEpoch
• DecodeOgmios CurrentEpoch

newtype DelegationsAndRewardsR

Constructors

• DelegationsAndRewardsR (Map String { delegate :: Maybe PoolPubKeyHash, rewards :: Maybe Coin })

Instances

• Generic DelegationsAndRewardsR _
• Newtype DelegationsAndRewardsR _
• DecodeAeson DelegationsAndRewardsR
• DecodeOgmios DelegationsAndRewardsR

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

newtype MempoolSizeAndCapacity

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

Constructors

• MempoolSizeAndCapacity { capacity :: Int, currentSize :: Int, numberOfTxs :: Int }

Instances

• Generic MempoolSizeAndCapacity _
• Newtype MempoolSizeAndCapacity _
• Show MempoolSizeAndCapacity
• DecodeAeson MempoolSizeAndCapacity
• DecodeOgmios MempoolSizeAndCapacity

newtype MempoolSnapshotAcquired

Instances

• Show MempoolSnapshotAcquired
• DecodeAeson MempoolSnapshotAcquired
• DecodeOgmios MempoolSnapshotAcquired

newtype MempoolTransaction

Constructors

• MempoolTransaction { id :: OgmiosTxId, raw :: String }

Instances

• Generic MempoolTransaction _
• Newtype MempoolTransaction _

type OgmiosAddress = Bech32String

newtype OgmiosBlockHeaderHash

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

Constructors

• OgmiosBlockHeaderHash String

Instances

• Eq OgmiosBlockHeaderHash
• DecodeAeson OgmiosBlockHeaderHash
• Generic OgmiosBlockHeaderHash _
• Newtype OgmiosBlockHeaderHash _
• Show OgmiosBlockHeaderHash

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

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

newtype OgmiosProtocolParameters

Constructors

• OgmiosProtocolParameters ProtocolParameters

Instances

• Newtype OgmiosProtocolParameters _
• Generic OgmiosProtocolParameters _
• Eq OgmiosProtocolParameters
• Show OgmiosProtocolParameters
• DecodeAeson OgmiosProtocolParameters
• DecodeOgmios OgmiosProtocolParameters

newtype PParamRational

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

Constructors

• PParamRational Rational

Instances

• Newtype PParamRational _
• Generic PParamRational _
• Show PParamRational
• DecodeAeson PParamRational

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

newtype PoolParametersR

Constructors

• PoolParametersR (Map PoolPubKeyHash PoolParameters)

Instances

• Newtype PoolParametersR _
• Generic PoolParametersR _
• Show PoolParametersR
• DecodeAeson PoolParametersR
• DecodeOgmios PoolParametersR

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

data ReleasedMempool

Constructors

• ReleasedMempool

Instances

• Generic ReleasedMempool _
• Show ReleasedMempool
• DecodeAeson ReleasedMempool
• DecodeOgmios ReleasedMempool

data ScriptFailure

Reason a script failed.

Constructors

• ExtraRedeemers (Array RedeemerPointer)
• MissingRequiredDatums { missing :: Array OgmiosDatum, provided :: Maybe (Array OgmiosDatum) }
• MissingRequiredScripts { missing :: Array RedeemerPointer, resolved :: Maybe (Map RedeemerPointer ScriptHash) }
• ValidatorFailed { error :: String, traces :: Array String }
• UnknownInputReferencedByRedeemer (Array OgmiosTxIn)
• NonScriptInputReferencedByRedeemer OgmiosTxIn
• NoCostModelForLanguage (Array String)
• InternalLedgerTypeConversionError String
• IllFormedExecutionBudget (Maybe ExecutionUnits)

Instances

• Generic ScriptFailure _
• Show ScriptFailure
• DecodeAeson ScriptFailure

newtype AdditionalUtxoSet

Constructors

• AdditionalUtxoSet OgmiosUtxoMap

Instances

• Newtype AdditionalUtxoSet _
• Show AdditionalUtxoSet
• EncodeAeson AdditionalUtxoSet

type OgmiosUtxoMap = Map OgmiosTxOutRef OgmiosTxOut

type OgmiosDatum = String

newtype OgmiosEraSummaries

Constructors

• OgmiosEraSummaries EraSummaries

Instances

• Generic OgmiosEraSummaries _
• Newtype OgmiosEraSummaries _
• Eq OgmiosEraSummaries
• Show OgmiosEraSummaries
• DecodeAeson OgmiosEraSummaries
• EncodeAeson OgmiosEraSummaries
• DecodeOgmios OgmiosEraSummaries

type OgmiosScript = String

newtype OgmiosSystemStart

Constructors

• OgmiosSystemStart SystemStart

Instances

• Generic OgmiosSystemStart _
• Newtype OgmiosSystemStart _
• Eq OgmiosSystemStart
• Show OgmiosSystemStart
• DecodeAeson OgmiosSystemStart
• EncodeAeson OgmiosSystemStart
• DecodeOgmios OgmiosSystemStart

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

type OgmiosTxId = String

data SubmitTxR

Constructors

• SubmitTxSuccess TransactionHash
• SubmitFail OgmiosError

Instances

• Generic SubmitTxR _
• Show SubmitTxR
• DecodeOgmios SubmitTxR

newtype StakePoolsQueryArgument

Constructors

• StakePoolsQueryArgument (Maybe (Array PoolPubKeyHash))

Instances

• Newtype StakePoolsQueryArgument _
• EncodeAeson StakePoolsQueryArgument

data TxEvaluationFailure

Constructors

• UnparsedError String
• AdditionalUtxoOverlap (Array OgmiosTxOutRef)
• ScriptFailures (Map RedeemerPointer (Array ScriptFailure))

Instances

• Generic TxEvaluationFailure _
• Show TxEvaluationFailure
• DecodeAeson TxEvaluationFailure

newtype TxEvaluationResult

Constructors

• TxEvaluationResult (Map RedeemerPointer ExecutionUnits)

Instances

• Newtype TxEvaluationResult _
• Generic TxEvaluationResult _
• Show TxEvaluationResult
• DecodeAeson TxEvaluationResult

newtype TxEvaluationR

Constructors

• TxEvaluationR (Either TxEvaluationFailure TxEvaluationResult)

Instances

• Newtype TxEvaluationR _
• Generic TxEvaluationR _
• Show TxEvaluationR
• DecodeOgmios TxEvaluationR

newtype HasTxR

Constructors

• HasTxR Boolean

Instances

• Newtype HasTxR _
• DecodeOgmios HasTxR

newtype MaybeMempoolTransaction

Constructors

• MaybeMempoolTransaction (Maybe MempoolTransaction)

Instances

• DecodeAeson MaybeMempoolTransaction
• Newtype MaybeMempoolTransaction _
• DecodeOgmios MaybeMempoolTransaction

acquireMempoolSnapshotCall :: JsonRpc2Call Unit MempoolSnapshotAcquired

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

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

evaluateTxCall :: JsonRpc2Call (CborBytes /\ AdditionalUtxoSet) TxEvaluationR

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

queryStakePoolsCall :: JsonRpc2Call StakePoolsQueryArgument PoolParametersR

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

mempoolSnapshotHasTxCall :: MempoolSnapshotAcquired -> JsonRpc2Call TransactionHash HasTxR

mempoolSnapshotNextTxCall :: MempoolSnapshotAcquired -> JsonRpc2Call Unit MaybeMempoolTransaction

mempoolSnapshotSizeAndCapacityCall :: MempoolSnapshotAcquired -> JsonRpc2Call Unit MempoolSizeAndCapacity

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

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

queryChainTipCall :: JsonRpc2Call Unit ChainTipQR

Queries Ogmios for the chain’s current tip.

queryCurrentEpochCall :: JsonRpc2Call Unit CurrentEpoch

Queries Ogmios for the current epoch

queryEraSummariesCall :: JsonRpc2Call Unit OgmiosEraSummaries

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

queryProtocolParametersCall :: JsonRpc2Call Unit OgmiosProtocolParameters

Queries Ogmios for the current protocol parameters

querySystemStartCall :: JsonRpc2Call Unit OgmiosSystemStart

Queries Ogmios for the system start Datetime

queryDelegationsAndRewards :: JsonRpc2Call (Array String) DelegationsAndRewardsR

releaseMempoolCall :: MempoolSnapshotAcquired -> JsonRpc2Call Unit ReleasedMempool

submitTxCall :: JsonRpc2Call (TransactionHash /\ CborBytes) SubmitTxR

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

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

slotLengthFactor :: Number

parseIpv6String :: String -> Maybe Ipv6

rationalToSubcoin :: PParamRational -> Maybe UnitInterval

showRedeemerPointer :: RedeemerPointer -> String

decodeRedeemerPointer :: String -> Either JsonDecodeError RedeemerPointer

redeemerPtrTypeMismatch :: JsonDecodeError