Safe Haskell	None
Language	Haskell2010

Maestro.Types.V1.Common

Description

Common (shared) types used which are not specific to single category of endpoints.

Synopsis

data PaymentCredentialAddress
data StakingCredentialAddress
data RewardAddress
data PoolId
newtype TaggedText (description ∷ Symbol) = TaggedText Text
data NonAdaNativeToken = NonAdaNativeToken !PolicyId !TokenName
data AssetUnit
- = Lovelace
- | UserMintedToken !NonAdaNativeToken
data Asset = Asset {
- assetAmount ∷ !Integer
- assetUnit ∷ !AssetUnit
}
class IsUtxo a where
- getAddress ∷ a → Bech32StringOf Address
- getAssets ∷ a → [Asset]
- getDatum ∷ a → Maybe DatumOption
- getTxHash ∷ a → TxHash
- getIndex ∷ a → TxIndex
- getReferenceScript ∷ a → Maybe Script
data UtxoWithSlot = UtxoWithSlot {
- utxoWithSlotAddress ∷ !(Bech32StringOf Address)
- utxoWithSlotAssets ∷ ![Asset]
- utxoWithSlotDatum ∷ !(Maybe DatumOption)
- utxoWithSlotIndex ∷ !TxIndex
- utxoWithSlotReferenceScript ∷ !(Maybe Script)
- utxoWithSlotTxHash ∷ !TxHash
- utxoWithSlotSlot ∷ !SlotNo
- utxoWithSlotTxoutCbor ∷ !(Maybe (HexStringOf TxOutCbor))
}
data PaginatedUtxoWithSlot = PaginatedUtxoWithSlot {
- paginatedUtxoWithSlotData ∷ ![UtxoWithSlot]
- paginatedUtxoWithSlotLastUpdated ∷ !LastUpdated
- paginatedUtxoWithSlotNextCursor ∷ !(Maybe NextCursor)
}
module Maestro.Types.Common
module Maestro.Types.V1.Common.Pagination
module Maestro.Types.V1.Common.Timestamped

Documentation

data PaymentCredentialAddress #

Phantom datatype to be used with, say Bech32StringOf to represent Bech32 representation of payment credential of an address.

data StakingCredentialAddress #

Phantom datatype to be used with, say Bech32StringOf to represent Bech32 representation of staking credential of an address.

data RewardAddress #

Phantom datatype to be used with, say Bech32StringOf to represent Bech32 representation of stake address (See CIP-19 for more details).

data PoolId #

Phantom datatype to be used with, say Bech32StringOf to represent Bech32 representation of a pool id.

newtype TaggedText (description ∷ Symbol) #

Wrapper around Text type with mentioned description of it.

Constructors

TaggedText Text

Instances

Instances details

Eq (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common Methods (==) ∷ TaggedText description → TaggedText description → Bool # (/=) ∷ TaggedText description → TaggedText description → Bool #
Ord (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common Methods compare ∷ TaggedText description → TaggedText description → Ordering # (<) ∷ TaggedText description → TaggedText description → Bool # (<=) ∷ TaggedText description → TaggedText description → Bool # (>) ∷ TaggedText description → TaggedText description → Bool # (>=) ∷ TaggedText description → TaggedText description → Bool # max ∷ TaggedText description → TaggedText description → TaggedText description # min ∷ TaggedText description → TaggedText description → TaggedText description #
Show (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common Methods showsPrec ∷ Int → TaggedText description → ShowS # show ∷ TaggedText description → String # showList ∷ [TaggedText description] → ShowS #
IsString (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common Methods fromString ∷ String → TaggedText description #
Generic (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common Associated Types type Rep (TaggedText description) ∷ Type → Type # Methods from ∷ TaggedText description → Rep (TaggedText description) x # to ∷ Rep (TaggedText description) x → TaggedText description #
FromHttpApiData (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common Methods parseUrlPiece ∷ Text → Either Text (TaggedText description) parseHeader ∷ ByteString → Either Text (TaggedText description) parseQueryParam ∷ Text → Either Text (TaggedText description)
ToHttpApiData (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common Methods toUrlPiece ∷ TaggedText description → Text toEncodedUrlPiece ∷ TaggedText description → Builder toHeader ∷ TaggedText description → ByteString toQueryParam ∷ TaggedText description → Text toEncodedQueryParam ∷ TaggedText description → Builder
ToJSON (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common Methods toJSON ∷ TaggedText description → Value toEncoding ∷ TaggedText description → Encoding toJSONList ∷ [TaggedText description] → Value toEncodingList ∷ [TaggedText description] → Encoding omitField ∷ TaggedText description → Bool
FromJSON (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common Methods parseJSON ∷ Value → Parser (TaggedText description) parseJSONList ∷ Value → Parser [TaggedText description] omittedField ∷ Maybe (TaggedText description)
type Rep (TaggedText description) #
Instance details Defined in Maestro.Types.V1.Common type Rep (TaggedText description) = D1 ('MetaData "TaggedText" "Maestro.Types.V1.Common" "maestro-sdk-1.7.3-inplace" 'True) (C1 ('MetaCons "TaggedText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data NonAdaNativeToken #

Type to denote for native tokens (besides ada).

Constructors

NonAdaNativeToken !PolicyId !TokenName

Instances

Instances details

Eq NonAdaNativeToken #
Instance details Defined in Maestro.Types.V1.Common Methods (==) ∷ NonAdaNativeToken → NonAdaNativeToken → Bool # (/=) ∷ NonAdaNativeToken → NonAdaNativeToken → Bool #
Ord NonAdaNativeToken #
Instance details Defined in Maestro.Types.V1.Common Methods compare ∷ NonAdaNativeToken → NonAdaNativeToken → Ordering # (<) ∷ NonAdaNativeToken → NonAdaNativeToken → Bool # (<=) ∷ NonAdaNativeToken → NonAdaNativeToken → Bool # (>) ∷ NonAdaNativeToken → NonAdaNativeToken → Bool # (>=) ∷ NonAdaNativeToken → NonAdaNativeToken → Bool # max ∷ NonAdaNativeToken → NonAdaNativeToken → NonAdaNativeToken # min ∷ NonAdaNativeToken → NonAdaNativeToken → NonAdaNativeToken #
Show NonAdaNativeToken #
Instance details Defined in Maestro.Types.V1.Common Methods showsPrec ∷ Int → NonAdaNativeToken → ShowS # show ∷ NonAdaNativeToken → String # showList ∷ [NonAdaNativeToken] → ShowS #
ToHttpApiData NonAdaNativeToken #
Instance details Defined in Maestro.Types.V1.Common Methods toUrlPiece ∷ NonAdaNativeToken → Text toEncodedUrlPiece ∷ NonAdaNativeToken → Builder toHeader ∷ NonAdaNativeToken → ByteString toQueryParam ∷ NonAdaNativeToken → Text toEncodedQueryParam ∷ NonAdaNativeToken → Builder

data AssetUnit #

Given asset name is either lovelace or concatenation of hex encoded policy ID and hex encoded asset name for native asset.

Constructors

Lovelace	Lovelace.
UserMintedToken !NonAdaNativeToken	For non-ada native-tokens.

Instances

Instances details

Eq AssetUnit #
Instance details Defined in Maestro.Types.V1.Common Methods (==) ∷ AssetUnit → AssetUnit → Bool # (/=) ∷ AssetUnit → AssetUnit → Bool #
Ord AssetUnit #
Instance details Defined in Maestro.Types.V1.Common Methods compare ∷ AssetUnit → AssetUnit → Ordering # (<) ∷ AssetUnit → AssetUnit → Bool # (<=) ∷ AssetUnit → AssetUnit → Bool # (>) ∷ AssetUnit → AssetUnit → Bool # (>=) ∷ AssetUnit → AssetUnit → Bool # max ∷ AssetUnit → AssetUnit → AssetUnit # min ∷ AssetUnit → AssetUnit → AssetUnit #
Show AssetUnit #
Instance details Defined in Maestro.Types.V1.Common Methods showsPrec ∷ Int → AssetUnit → ShowS # show ∷ AssetUnit → String # showList ∷ [AssetUnit] → ShowS #
ToJSON AssetUnit #
Instance details Defined in Maestro.Types.V1.Common Methods toJSON ∷ AssetUnit → Value toEncoding ∷ AssetUnit → Encoding toJSONList ∷ [AssetUnit] → Value toEncodingList ∷ [AssetUnit] → Encoding omitField ∷ AssetUnit → Bool
FromJSON AssetUnit #
Instance details Defined in Maestro.Types.V1.Common Methods parseJSON ∷ Value → Parser AssetUnit parseJSONList ∷ Value → Parser [AssetUnit] omittedField ∷ Maybe AssetUnit

data Asset #

Representation of asset in an UTxO.

Constructors

Asset
Fields assetAmount ∷ !Integer Amount of the asset. assetUnit ∷ !AssetUnit See `AssetUnit`.

Instances

Instances details

Eq Asset #
Instance details Defined in Maestro.Types.V1.Common Methods (==) ∷ Asset → Asset → Bool # (/=) ∷ Asset → Asset → Bool #
Ord Asset #
Instance details Defined in Maestro.Types.V1.Common Methods compare ∷ Asset → Asset → Ordering # (<) ∷ Asset → Asset → Bool # (<=) ∷ Asset → Asset → Bool # (>) ∷ Asset → Asset → Bool # (>=) ∷ Asset → Asset → Bool # max ∷ Asset → Asset → Asset # min ∷ Asset → Asset → Asset #
Show Asset #
Instance details Defined in Maestro.Types.V1.Common Methods showsPrec ∷ Int → Asset → ShowS # show ∷ Asset → String # showList ∷ [Asset] → ShowS #
Generic Asset #
Instance details Defined in Maestro.Types.V1.Common Associated Types type Rep Asset ∷ Type → Type # Methods from ∷ Asset → Rep Asset x # to ∷ Rep Asset x → Asset #
ToJSON Asset #
Instance details Defined in Maestro.Types.V1.Common Methods toJSON ∷ Asset → Value toEncoding ∷ Asset → Encoding toJSONList ∷ [Asset] → Value toEncodingList ∷ [Asset] → Encoding omitField ∷ Asset → Bool
FromJSON Asset #
Instance details Defined in Maestro.Types.V1.Common Methods parseJSON ∷ Value → Parser Asset parseJSONList ∷ Value → Parser [Asset] omittedField ∷ Maybe Asset
type Rep Asset #
Instance details Defined in Maestro.Types.V1.Common type Rep Asset = D1 ('MetaData "Asset" "Maestro.Types.V1.Common" "maestro-sdk-1.7.3-inplace" 'False) (C1 ('MetaCons "Asset" 'PrefixI 'True) (S1 ('MetaSel ('Just "assetAmount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "assetUnit") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AssetUnit)))

class IsUtxo a where #

To get basic details from an UTxO.

Methods

getAddress ∷ a → Bech32StringOf Address #

getAssets ∷ a → [Asset] #

getDatum ∷ a → Maybe DatumOption #

getTxHash ∷ a → TxHash #

getIndex ∷ a → TxIndex #

getReferenceScript ∷ a → Maybe Script #

Instances

Instances details

IsUtxo UtxoWithSlot #
Instance details Defined in Maestro.Types.V1.Common Methods getAddress ∷ UtxoWithSlot → Bech32StringOf Address # getAssets ∷ UtxoWithSlot → [Asset] # getDatum ∷ UtxoWithSlot → Maybe DatumOption # getTxHash ∷ UtxoWithSlot → TxHash # getIndex ∷ UtxoWithSlot → TxIndex # getReferenceScript ∷ UtxoWithSlot → Maybe Script #
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 #

data UtxoWithSlot #

Transaction output.

Constructors

UtxoWithSlot

Fields

utxoWithSlotAddress ∷ !(Bech32StringOf Address)
UTxO's address.
utxoWithSlotAssets ∷ ![Asset]
UTxO's assets.
utxoWithSlotDatum ∷ !(Maybe DatumOption)
UTxO's datum.
utxoWithSlotIndex ∷ !TxIndex
UTxO's transaction index.
utxoWithSlotReferenceScript ∷ !(Maybe Script)
UTxO's script.
utxoWithSlotTxHash ∷ !TxHash
UTxO's transaction hash.
utxoWithSlotSlot ∷ !SlotNo
Absolute slot of block which produced the UTxO.
utxoWithSlotTxoutCbor ∷ !(Maybe (HexStringOf TxOutCbor))
Hex encoded transaction output CBOR bytes.

Instances

Instances details

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

data PaginatedUtxoWithSlot #

A paginated response of transaction outputs.

Constructors

PaginatedUtxoWithSlot
Fields paginatedUtxoWithSlotData ∷ ![UtxoWithSlot] List of UTxOs. paginatedUtxoWithSlotLastUpdated ∷ !LastUpdated See `LastUpdated`. paginatedUtxoWithSlotNextCursor ∷ !(Maybe NextCursor) See `NextCursor`

Instances

Instances details

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

module Maestro.Types.Common

module Maestro.Types.V1.Common.Pagination

module Maestro.Types.V1.Common.Timestamped