Safe Haskell	None
Language	Haskell2010

Maestro.Client.V1.Addresses

Description

Module to query for "addresses" category of endpoints defined at docs.gomaestro.org.

Synopsis

utxosAtAddress ∷ MaestroEnv 'V1 → Bech32StringOf Address → Maybe Bool → Maybe Bool → Maybe NonAdaNativeToken → Cursor → IO PaginatedUtxoWithSlot
utxosAtMultiAddresses ∷ MaestroEnv 'V1 → Maybe Bool → Maybe Bool → Cursor → [Bech32StringOf Address] → IO PaginatedUtxoWithSlot
getRefsAtAddress ∷ MaestroEnv 'V1 → Bech32StringOf Address → Cursor → IO PaginatedOutputReferenceObject
utxosByPaymentCredential ∷ MaestroEnv 'V1 → Bech32StringOf PaymentCredentialAddress → Maybe Bool → Maybe Bool → Maybe NonAdaNativeToken → Cursor → IO PaginatedUtxoWithSlot
utxosByMultiPaymentCredentials ∷ MaestroEnv 'V1 → Maybe Bool → Maybe Bool → Cursor → [Bech32StringOf PaymentCredentialAddress] → IO PaginatedUtxoWithSlot
txsByAddress ∷ MaestroEnv 'V1 → Bech32StringOf Address → Maybe Order → Maybe SlotNo → Maybe SlotNo → Cursor → IO PaginatedAddressTransaction
txsByPaymentCredential ∷ MaestroEnv 'V1 → Bech32StringOf PaymentCredentialAddress → Maybe Order → Maybe SlotNo → Maybe SlotNo → Cursor → IO PaginatedPaymentCredentialTransaction

Documentation

utxosAtAddress #

Arguments

∷ MaestroEnv 'V1	The Maestro Environment.
→ Bech32StringOf Address	Address in bech32 format to fetch utxo from.
→ Maybe Bool	Query param to include the corresponding datums for datum hashes.
→ Maybe Bool	Query Param to include the CBOR encodings of the transaction outputs in the response.
→ Maybe NonAdaNativeToken	Query Param to return for only those UTxOs which contain this given asset.
→ Cursor	The pagination attributes.
→ IO PaginatedUtxoWithSlot

Returns list of utxos for a given address.

utxosAtMultiAddresses #

Arguments

∷ MaestroEnv 'V1	The Maestro Environment.
→ Maybe Bool	Query param to include the corresponding datums for datum hashes.
→ Maybe Bool	Query Param to include the CBOR encodings of the transaction outputs in the response.
→ Cursor	The pagination attributes.
→ [Bech32StringOf Address]	List of Address in bech32 format to fetch utxo from.
→ IO PaginatedUtxoWithSlot

Returns list of utxos for multiple addresses.

getRefsAtAddress #

Arguments

∷ MaestroEnv 'V1
→ Bech32StringOf Address	The Address in Bech32 format.
→ Cursor	The pagination attributes.
→ IO PaginatedOutputReferenceObject

UTxO IDs for all the unspent transaction outputs at an address.

utxosByPaymentCredential #

Arguments

∷ MaestroEnv 'V1
→ Bech32StringOf PaymentCredentialAddress	The Address in Bech32 format.
→ Maybe Bool	Query param to include the corresponding datums for datum hashes.
→ Maybe Bool	Query Param to include the CBOR encodings of the transaction outputs in the response.
→ Maybe NonAdaNativeToken	Query Param to return for only those UTxOs which contain this given asset.
→ Cursor	The pagination attributes.
→ IO PaginatedUtxoWithSlot

Query UTxOs by payment credential in bech32 format.

utxosByMultiPaymentCredentials #

Arguments

∷ MaestroEnv 'V1	The Maestro Environment.
→ Maybe Bool	Query param to include the corresponding datums for datum hashes.
→ Maybe Bool	Query Param to include the CBOR encodings of the transaction outputs in the response.
→ Cursor	The pagination attributes.
→ [Bech32StringOf PaymentCredentialAddress]	List of payment credential in bech32 format to fetch utxo from.
→ IO PaginatedUtxoWithSlot

Returns list of utxos for multiple payment credentials.

txsByAddress #

Arguments

∷ MaestroEnv 'V1
→ Bech32StringOf Address	Address in bech32 format.
→ Maybe Order	The order in which the results are sorted (by point in chain).
→ Maybe SlotNo	Return only transactions minted on or after a specific slot.
→ Maybe SlotNo	Return only transactions minted on or before a specific slot.
→ Cursor	The pagination attributes.
→ IO PaginatedAddressTransaction

Returns transactions in which the specified address spent or received funds.

Specifically, the transactions where: the address controlled at least one of the transaction inputs andor receives one of the outputs AND the transaction is phase-2 valid, OR, the address controlled at least one of the collateral inputs andor receives the collateral return output AND the transaction is phase-2 invalid. Read more.

txsByPaymentCredential #

Arguments

∷ MaestroEnv 'V1
→ Bech32StringOf PaymentCredentialAddress	Payment credential in bech32 format.
→ Maybe Order	The order in which the results are sorted (by point in chain).
→ Maybe SlotNo	Return only transactions minted on or after a specific slot.
→ Maybe SlotNo	Return only transactions minted on or before a specific slot.
→ Cursor	The pagination attributes.
→ IO PaginatedPaymentCredentialTransaction

Returns transactions in which the specified payment credential spent or received funds, or was a required signer.

Specifically, "spent or received funds" meaning: the payment credential was used in an address which controlled at least one of the transaction inputs andor receives one of the outputs AND the transaction is phase-2 valid, OR, the address controlled at least one of the collateral inputs andor receives the collateral return output AND the transaction is phase-2 invalid. Read more.