Safe Haskell	None
Language	Haskell2010

Maestro.Types.V1.Transactions

Description

Module to define types for "Transactions" category endpoints defined at docs.gomaestro.org.

Synopsis

data OutputReference = OutputReference !TxHash !TxIndex
data UtxoWithBytes = UtxoWithBytes {
- utxoWithBytesAddress ∷ !(Bech32StringOf Address)
- utxoWithBytesAssets ∷ ![Asset]
- utxoWithBytesDatum ∷ !(Maybe DatumOption)
- utxoWithBytesIndex ∷ !TxIndex
- utxoWithBytesReferenceScript ∷ !(Maybe Script)
- utxoWithBytesTxHash ∷ !TxHash
- utxoWithBytesTxoutCbor ∷ !(Maybe (HexStringOf TxOutCbor))
}
data PaginatedUtxo = PaginatedUtxo {
- paginatedUtxoData ∷ ![UtxoWithBytes]
- paginatedUtxoLastUpdated ∷ !LastUpdated
- paginatedUtxoNextCursor ∷ !(Maybe NextCursor)
}
data TxDetails = TxDetails {
- txDetailsTxHash ∷ !TxHash
- txDetailsBlockHash ∷ !BlockHash
- txDetailsBlockAbsoluteSlot ∷ !Word64
- txDetailsBlockHeight ∷ !BlockHeight
- txDetailsBlockTimestamp ∷ !NominalDiffTime
- txDetailsBlockTxIndex ∷ !Natural
- txDetailsDeposit ∷ !Word64
- txDetailsFee ∷ !Word64
- txDetailsSize ∷ !Word64
- txDetailsScriptsSuccessful ∷ !Bool
- txDetailsInvalidBefore ∷ !(Maybe SlotNo)
- txDetailsInvalidHereafter ∷ !(Maybe SlotNo)
- txDetailsMetadata ∷ !(Maybe Value)
- txDetailsAdditionalSigners ∷ ![Text]
- txDetailsOutputs ∷ ![UtxoWithBytes]
- txDetailsInputs ∷ ![UtxoWithBytes]
- txDetailsReferenceInputs ∷ ![UtxoWithBytes]
- txDetailsCollateralInputs ∷ ![UtxoWithBytes]
- txDetailsCollateralReturn ∷ !(Maybe UtxoWithBytes)
- txDetailsMint ∷ ![Asset]
}
data TimestampedTxDetails = TimestampedTxDetails {
- timestampedTxDetailsData ∷ !TxDetails
- timestampedTxDetailsLastUpdated ∷ !LastUpdated
}

Documentation

data OutputReference #

An UTxO output reference.

Constructors

OutputReference !TxHash !TxIndex

Instances

Instances details

Eq OutputReference #
Instance details Defined in Maestro.Types.V1.Transactions Methods (==) ∷ OutputReference → OutputReference → Bool # (/=) ∷ OutputReference → OutputReference → Bool #
Ord OutputReference #
Instance details Defined in Maestro.Types.V1.Transactions Methods compare ∷ OutputReference → OutputReference → Ordering # (<) ∷ OutputReference → OutputReference → Bool # (<=) ∷ OutputReference → OutputReference → Bool # (>) ∷ OutputReference → OutputReference → Bool # (>=) ∷ OutputReference → OutputReference → Bool # max ∷ OutputReference → OutputReference → OutputReference # min ∷ OutputReference → OutputReference → OutputReference #
Show OutputReference #
Instance details Defined in Maestro.Types.V1.Transactions Methods showsPrec ∷ Int → OutputReference → ShowS # show ∷ OutputReference → String # showList ∷ [OutputReference] → ShowS #
ToHttpApiData OutputReference #
Instance details Defined in Maestro.Types.V1.Transactions Methods toUrlPiece ∷ OutputReference → Text toEncodedUrlPiece ∷ OutputReference → Builder toHeader ∷ OutputReference → ByteString toQueryParam ∷ OutputReference → Text toEncodedQueryParam ∷ OutputReference → Builder
ToJSON OutputReference #
Instance details Defined in Maestro.Types.V1.Transactions Methods toJSON ∷ OutputReference → Value toEncoding ∷ OutputReference → Encoding toJSONList ∷ [OutputReference] → Value toEncodingList ∷ [OutputReference] → Encoding omitField ∷ OutputReference → Bool

data UtxoWithBytes #

Transaction output.

Constructors

UtxoWithBytes

Fields

utxoWithBytesAddress ∷ !(Bech32StringOf Address)
UTxO's address.
utxoWithBytesAssets ∷ ![Asset]
UTxO's assets.
utxoWithBytesDatum ∷ !(Maybe DatumOption)
UTxO's datum.
utxoWithBytesIndex ∷ !TxIndex
UTxO's transaction index.
utxoWithBytesReferenceScript ∷ !(Maybe Script)
UTxO's script.
utxoWithBytesTxHash ∷ !TxHash
UTxO's transaction hash.
utxoWithBytesTxoutCbor ∷ !(Maybe (HexStringOf TxOutCbor))
Hex encoded transaction output CBOR bytes.

Instances

Instances details

Eq UtxoWithBytes #
Instance details Defined in Maestro.Types.V1.Transactions Methods (==) ∷ UtxoWithBytes → UtxoWithBytes → Bool # (/=) ∷ UtxoWithBytes → UtxoWithBytes → Bool #
Ord UtxoWithBytes #
Instance details Defined in Maestro.Types.V1.Transactions Methods compare ∷ UtxoWithBytes → UtxoWithBytes → Ordering # (<) ∷ UtxoWithBytes → UtxoWithBytes → Bool # (<=) ∷ UtxoWithBytes → UtxoWithBytes → Bool # (>) ∷ UtxoWithBytes → UtxoWithBytes → Bool # (>=) ∷ UtxoWithBytes → UtxoWithBytes → Bool # max ∷ UtxoWithBytes → UtxoWithBytes → UtxoWithBytes # min ∷ UtxoWithBytes → UtxoWithBytes → UtxoWithBytes #
Show UtxoWithBytes #
Instance details Defined in Maestro.Types.V1.Transactions Methods showsPrec ∷ Int → UtxoWithBytes → ShowS # show ∷ UtxoWithBytes → String # showList ∷ [UtxoWithBytes] → ShowS #
Generic UtxoWithBytes #
Instance details Defined in Maestro.Types.V1.Transactions Associated Types type Rep UtxoWithBytes ∷ Type → Type # Methods from ∷ UtxoWithBytes → Rep UtxoWithBytes x # to ∷ Rep UtxoWithBytes x → UtxoWithBytes #
ToJSON UtxoWithBytes #
Instance details Defined in Maestro.Types.V1.Transactions Methods toJSON ∷ UtxoWithBytes → Value toEncoding ∷ UtxoWithBytes → Encoding toJSONList ∷ [UtxoWithBytes] → Value toEncodingList ∷ [UtxoWithBytes] → Encoding omitField ∷ UtxoWithBytes → Bool
FromJSON UtxoWithBytes #
Instance details Defined in Maestro.Types.V1.Transactions Methods parseJSON ∷ Value → Parser UtxoWithBytes parseJSONList ∷ Value → Parser [UtxoWithBytes] omittedField ∷ Maybe UtxoWithBytes
IsUtxo UtxoWithBytes #
Instance details Defined in Maestro.Types.V1.Transactions Methods getAddress ∷ UtxoWithBytes → Bech32StringOf Address # getAssets ∷ UtxoWithBytes → [Asset] # getDatum ∷ UtxoWithBytes → Maybe DatumOption # getTxHash ∷ UtxoWithBytes → TxHash # getIndex ∷ UtxoWithBytes → TxIndex # getReferenceScript ∷ UtxoWithBytes → Maybe Script #
type Rep UtxoWithBytes #
Instance details Defined in Maestro.Types.V1.Transactions type Rep UtxoWithBytes = D1 ('MetaData "UtxoWithBytes" "Maestro.Types.V1.Transactions" "maestro-sdk-1.7.3-inplace" 'False) (C1 ('MetaCons "UtxoWithBytes" 'PrefixI 'True) ((S1 ('MetaSel ('Just "utxoWithBytesAddress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Bech32StringOf Address)) :: (S1 ('MetaSel ('Just "utxoWithBytesAssets") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Asset]) :: S1 ('MetaSel ('Just "utxoWithBytesDatum") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe DatumOption)))) :: ((S1 ('MetaSel ('Just "utxoWithBytesIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TxIndex) :: S1 ('MetaSel ('Just "utxoWithBytesReferenceScript") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Script))) :: (S1 ('MetaSel ('Just "utxoWithBytesTxHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TxHash) :: S1 ('MetaSel ('Just "utxoWithBytesTxoutCbor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (HexStringOf TxOutCbor)))))))

data PaginatedUtxo #

A paginated response of transaction outputs.

Constructors

PaginatedUtxo
Fields paginatedUtxoData ∷ ![UtxoWithBytes] List of UTxOs. paginatedUtxoLastUpdated ∷ !LastUpdated See `LastUpdated`. paginatedUtxoNextCursor ∷ !(Maybe NextCursor) See `NextCursor`

Instances

Instances details

Eq PaginatedUtxo #
Instance details Defined in Maestro.Types.V1.Transactions Methods (==) ∷ PaginatedUtxo → PaginatedUtxo → Bool # (/=) ∷ PaginatedUtxo → PaginatedUtxo → Bool #
Show PaginatedUtxo #
Instance details Defined in Maestro.Types.V1.Transactions Methods showsPrec ∷ Int → PaginatedUtxo → ShowS # show ∷ PaginatedUtxo → String # showList ∷ [PaginatedUtxo] → ShowS #
Generic PaginatedUtxo #
Instance details Defined in Maestro.Types.V1.Transactions Associated Types type Rep PaginatedUtxo ∷ Type → Type # Methods from ∷ PaginatedUtxo → Rep PaginatedUtxo x # to ∷ Rep PaginatedUtxo x → PaginatedUtxo #
ToJSON PaginatedUtxo #
Instance details Defined in Maestro.Types.V1.Transactions Methods toJSON ∷ PaginatedUtxo → Value toEncoding ∷ PaginatedUtxo → Encoding toJSONList ∷ [PaginatedUtxo] → Value toEncodingList ∷ [PaginatedUtxo] → Encoding omitField ∷ PaginatedUtxo → Bool
FromJSON PaginatedUtxo #
Instance details Defined in Maestro.Types.V1.Transactions Methods parseJSON ∷ Value → Parser PaginatedUtxo parseJSONList ∷ Value → Parser [PaginatedUtxo] omittedField ∷ Maybe PaginatedUtxo
IsTimestamped PaginatedUtxo #
Instance details Defined in Maestro.Types.V1.Transactions Associated Types type TimestampedData PaginatedUtxo # Methods getTimestampedData ∷ PaginatedUtxo → TimestampedData PaginatedUtxo # getTimestamp ∷ PaginatedUtxo → LastUpdated #
HasCursor PaginatedUtxo #
Instance details Defined in Maestro.Types.V1.Transactions Methods getNextCursor ∷ PaginatedUtxo → Maybe NextCursor #
type Rep PaginatedUtxo #
Instance details Defined in Maestro.Types.V1.Transactions type Rep PaginatedUtxo = D1 ('MetaData "PaginatedUtxo" "Maestro.Types.V1.Transactions" "maestro-sdk-1.7.3-inplace" 'False) (C1 ('MetaCons "PaginatedUtxo" 'PrefixI 'True) (S1 ('MetaSel ('Just "paginatedUtxoData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [UtxoWithBytes]) :: (S1 ('MetaSel ('Just "paginatedUtxoLastUpdated") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LastUpdated) :: S1 ('MetaSel ('Just "paginatedUtxoNextCursor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe NextCursor)))))
type TimestampedData PaginatedUtxo #
Instance details Defined in Maestro.Types.V1.Transactions type TimestampedData PaginatedUtxo = [UtxoWithBytes]

data TxDetails #

Complete transaction Details when queried by its hash.

Constructors

TxDetails

Fields

txDetailsTxHash ∷ !TxHash
Transaction hash (identifier)
txDetailsBlockHash ∷ !BlockHash
Hash of the block which includes the transaction.
txDetailsBlockAbsoluteSlot ∷ !Word64
Absolute slot of the block which includes the transaction
txDetailsBlockHeight ∷ !BlockHeight
Block height (number) of the block which includes the transaction
txDetailsBlockTimestamp ∷ !NominalDiffTime
UNIX timestamp of the block which includes the transaction
txDetailsBlockTxIndex ∷ !Natural
The transaction's position within the block which includes it
txDetailsDeposit ∷ !Word64
The amount of lovelace used for deposits (negative if being returned)
txDetailsFee ∷ !Word64
The fee specified in the transaction
txDetailsSize ∷ !Word64
Size of the transaction in bytes
txDetailsScriptsSuccessful ∷ !Bool
False if any executed Plutus scripts failed (aka phase-two validity), meaning collateral was processed.
txDetailsInvalidBefore ∷ !(Maybe SlotNo)
The slot before which the transaction would not be accepted onto the chain
txDetailsInvalidHereafter ∷ !(Maybe SlotNo)
The slot from which the transaction would not be accepted onto the chain
txDetailsMetadata ∷ !(Maybe Value)
Transaction metadata JSON
txDetailsAdditionalSigners ∷ ![Text]
Additional required signers
txDetailsOutputs ∷ ![UtxoWithBytes]
Transaction outputs
txDetailsInputs ∷ ![UtxoWithBytes]
Transaction inputs
txDetailsReferenceInputs ∷ ![UtxoWithBytes]
Reference inputs
txDetailsCollateralInputs ∷ ![UtxoWithBytes]
Collateral inputs, to be taken if Plutus scripts are not successful
txDetailsCollateralReturn ∷ !(Maybe UtxoWithBytes)
Transaction output
txDetailsMint ∷ ![Asset]
Native assets minted or burned by the transaction

Instances

Instances details

Eq TxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Methods (==) ∷ TxDetails → TxDetails → Bool # (/=) ∷ TxDetails → TxDetails → Bool #
Show TxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Methods showsPrec ∷ Int → TxDetails → ShowS # show ∷ TxDetails → String # showList ∷ [TxDetails] → ShowS #
Generic TxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Associated Types type Rep TxDetails ∷ Type → Type # Methods from ∷ TxDetails → Rep TxDetails x # to ∷ Rep TxDetails x → TxDetails #
ToJSON TxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Methods toJSON ∷ TxDetails → Value toEncoding ∷ TxDetails → Encoding toJSONList ∷ [TxDetails] → Value toEncodingList ∷ [TxDetails] → Encoding omitField ∷ TxDetails → Bool
FromJSON TxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Methods parseJSON ∷ Value → Parser TxDetails parseJSONList ∷ Value → Parser [TxDetails] omittedField ∷ Maybe TxDetails
type Rep TxDetails #
Instance details Defined in Maestro.Types.V1.Transactions type Rep TxDetails = D1 ('MetaData "TxDetails" "Maestro.Types.V1.Transactions" "maestro-sdk-1.7.3-inplace" 'False) (C1 ('MetaCons "TxDetails" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "txDetailsTxHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TxHash) :: S1 ('MetaSel ('Just "txDetailsBlockHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlockHash)) :: (S1 ('MetaSel ('Just "txDetailsBlockAbsoluteSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: (S1 ('MetaSel ('Just "txDetailsBlockHeight") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlockHeight) :: S1 ('MetaSel ('Just "txDetailsBlockTimestamp") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NominalDiffTime)))) :: ((S1 ('MetaSel ('Just "txDetailsBlockTxIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "txDetailsDeposit") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :: (S1 ('MetaSel ('Just "txDetailsFee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: (S1 ('MetaSel ('Just "txDetailsSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Just "txDetailsScriptsSuccessful") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))) :: (((S1 ('MetaSel ('Just "txDetailsInvalidBefore") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe SlotNo)) :: S1 ('MetaSel ('Just "txDetailsInvalidHereafter") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe SlotNo))) :: (S1 ('MetaSel ('Just "txDetailsMetadata") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Value)) :: (S1 ('MetaSel ('Just "txDetailsAdditionalSigners") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "txDetailsOutputs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [UtxoWithBytes])))) :: ((S1 ('MetaSel ('Just "txDetailsInputs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [UtxoWithBytes]) :: S1 ('MetaSel ('Just "txDetailsReferenceInputs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [UtxoWithBytes])) :: (S1 ('MetaSel ('Just "txDetailsCollateralInputs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [UtxoWithBytes]) :: (S1 ('MetaSel ('Just "txDetailsCollateralReturn") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe UtxoWithBytes)) :*: S1 ('MetaSel ('Just "txDetailsMint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Asset])))))))

data TimestampedTxDetails #

Timestamped TxDetails response.

Constructors

TimestampedTxDetails
Fields timestampedTxDetailsData ∷ !TxDetails See `TxDetails`. timestampedTxDetailsLastUpdated ∷ !LastUpdated See `LastUpdated`.

Instances

Instances details

Eq TimestampedTxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Methods (==) ∷ TimestampedTxDetails → TimestampedTxDetails → Bool # (/=) ∷ TimestampedTxDetails → TimestampedTxDetails → Bool #
Show TimestampedTxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Methods showsPrec ∷ Int → TimestampedTxDetails → ShowS # show ∷ TimestampedTxDetails → String # showList ∷ [TimestampedTxDetails] → ShowS #
Generic TimestampedTxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Associated Types type Rep TimestampedTxDetails ∷ Type → Type # Methods from ∷ TimestampedTxDetails → Rep TimestampedTxDetails x # to ∷ Rep TimestampedTxDetails x → TimestampedTxDetails #
ToJSON TimestampedTxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Methods toJSON ∷ TimestampedTxDetails → Value toEncoding ∷ TimestampedTxDetails → Encoding toJSONList ∷ [TimestampedTxDetails] → Value toEncodingList ∷ [TimestampedTxDetails] → Encoding omitField ∷ TimestampedTxDetails → Bool
FromJSON TimestampedTxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Methods parseJSON ∷ Value → Parser TimestampedTxDetails parseJSONList ∷ Value → Parser [TimestampedTxDetails] omittedField ∷ Maybe TimestampedTxDetails
IsTimestamped TimestampedTxDetails #
Instance details Defined in Maestro.Types.V1.Transactions Associated Types type TimestampedData TimestampedTxDetails # Methods getTimestampedData ∷ TimestampedTxDetails → TimestampedData TimestampedTxDetails # getTimestamp ∷ TimestampedTxDetails → LastUpdated #
type Rep TimestampedTxDetails #
Instance details Defined in Maestro.Types.V1.Transactions type Rep TimestampedTxDetails = D1 ('MetaData "TimestampedTxDetails" "Maestro.Types.V1.Transactions" "maestro-sdk-1.7.3-inplace" 'False) (C1 ('MetaCons "TimestampedTxDetails" 'PrefixI 'True) (S1 ('MetaSel ('Just "timestampedTxDetailsData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TxDetails) :*: S1 ('MetaSel ('Just "timestampedTxDetailsLastUpdated") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LastUpdated)))
type TimestampedData TimestampedTxDetails #
Instance details Defined in Maestro.Types.V1.Transactions type TimestampedData TimestampedTxDetails = TxDetails