Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.Types.Address

Contents

newtype wrapper
Stake address.
newtype wrapper

Description

Synopsis

data GYAddress
addressToApi ∷ GYAddress → AddressAny
addressToApi' ∷ GYAddress → AddressInEra BabbageEra
addressFromApi ∷ AddressAny → GYAddress
addressFromApi' ∷ AddressInEra era → GYAddress
addressToPlutus ∷ GYAddress → Address
addressFromPlutus ∷ GYNetworkId → Address → Either PlutusToCardanoError GYAddress
addressToPaymentCredential ∷ GYAddress → Maybe GYPaymentCredential
addressToStakeCredential ∷ GYAddress → Maybe GYStakeCredential
addressFromPubKeyHash ∷ GYNetworkId → GYPubKeyHash → GYAddress
addressFromPaymentKeyHash ∷ GYNetworkId → GYPaymentKeyHash → GYAddress
addressFromValidator ∷ GYNetworkId → GYValidator v → GYAddress
addressFromCredential ∷ GYNetworkId → GYPaymentCredential → Maybe GYStakeCredential → GYAddress
addressFromValidatorHash ∷ GYNetworkId → GYValidatorHash → GYAddress
addressToText ∷ GYAddress → Text
addressFromTextMaybe ∷ Text → Maybe GYAddress
unsafeAddressFromText ∷ Text → GYAddress
addressToPubKeyHash ∷ GYAddress → Maybe GYPubKeyHash
addressToValidatorHash ∷ GYAddress → Maybe GYValidatorHash
data GYAddressBech32
addressToBech32 ∷ GYAddress → GYAddressBech32
addressFromBech32 ∷ GYAddressBech32 → GYAddress
data GYStakeAddress
stakeAddressFromApi ∷ StakeAddress → GYStakeAddress
stakeAddressToApi ∷ GYStakeAddress → StakeAddress
stakeAddressFromTextMaybe ∷ Text → Maybe GYStakeAddress
unsafeStakeAddressFromText ∷ Text → GYStakeAddress
stakeAddressToText ∷ GYStakeAddress → Text
stakeAddressCredential ∷ GYStakeAddress → GYStakeCredential
stakeAddressToCredential ∷ GYStakeAddress → GYStakeCredential
stakeAddressFromCredential ∷ GYNetworkId → GYStakeCredential → GYStakeAddress
type GYStakeKeyHashString = String
stakeKeyFromAddress ∷ GYAddress → Maybe GYStakeKeyHashString
data GYStakeAddressBech32
stakeAddressToBech32 ∷ GYStakeAddress → GYStakeAddressBech32
stakeAddressFromBech32 ∷ GYStakeAddressBech32 → GYStakeAddress

Documentation

data GYAddress #

Addresses on the blockchain.

Instances

Instances details

FromJSON GYAddress #	In JSON context addresses are represented in hex. `>>>` `Aeson.decode @GYAddress "\"00e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f616\""`Just (unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5")
Instance details Defined in GeniusYield.Types.Address Methods parseJSON ∷ Value → Parser GYAddress Source # parseJSONList ∷ Value → Parser [GYAddress] Source #
ToJSON GYAddress #	`>>>` `LBS8.putStrLn $ Aeson.encode addr`"00e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f616"
Instance details Defined in GeniusYield.Types.Address Methods toJSON ∷ GYAddress → Value Source # toEncoding ∷ GYAddress → Encoding Source # toJSONList ∷ [GYAddress] → Value Source # toEncodingList ∷ [GYAddress] → Encoding Source #
Generic GYAddress #
Instance details Defined in GeniusYield.Types.Address Associated Types type Rep GYAddress ∷ Type → Type Source # Methods from ∷ GYAddress → Rep GYAddress x Source # to ∷ Rep GYAddress x → GYAddress Source #
Show GYAddress #	`>>>` `let addr = unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"`
Instance details Defined in GeniusYield.Types.Address Methods showsPrec ∷ Int → GYAddress → ShowS Source # show ∷ GYAddress → String Source # showList ∷ [GYAddress] → ShowS Source #
PrintfArg GYAddress #	This instance is using for logging `>>>` `Printf.printf "addr = %s" addr`addr = addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5
Instance details Defined in GeniusYield.Types.Address Methods formatArg ∷ GYAddress → FieldFormatter Source # parseFormat ∷ GYAddress → ModifierParser Source #
FromField GYAddress #	`>>>` `Csv.runParser $ Csv.parseField @GYAddress "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"`Right (unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5") `>>>` `Csv.runParser $ Csv.parseField @GYAddress "not an address"`Left "Not an address: not an address"
Instance details Defined in GeniusYield.Types.Address Methods parseField ∷ Field → Parser GYAddress Source #
FromRecord GYAddress #	`>>>` `Csv.decode @GYAddress Csv.NoHeader "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5\n"`Right [unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"] `>>>` `Csv.decode @GYAddress Csv.NoHeader "not an address\n"`Left "parse error (Failed reading: conversion error: Not an address: not an address) at \"\\n\"" `>>>` `Csv.decode @GYAddress Csv.NoHeader "not, an, address\n"`Left "parse error (Failed reading: conversion error: expected exactly one field, but got: [\"not\",\" an\",\" address\"]) at \"\\n\""
Instance details Defined in GeniusYield.Types.Address Methods parseRecord ∷ Record → Parser GYAddress Source #
ToField GYAddress #	`>>>` `Csv.toField $ unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"`"addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"
Instance details Defined in GeniusYield.Types.Address Methods toField ∷ GYAddress → Field Source #
ToRecord GYAddress #	`>>>` `Csv.encodeWith (Csv.defaultEncodeOptions {Csv.encUseCrLf = False}) [unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"]`"addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5\n"
Instance details Defined in GeniusYield.Types.Address Methods toRecord ∷ GYAddress → Record Source #
Eq GYAddress #
Instance details Defined in GeniusYield.Types.Address Methods (==) ∷ GYAddress → GYAddress → Bool Source # (/=) ∷ GYAddress → GYAddress → Bool Source #
Ord GYAddress #
Instance details Defined in GeniusYield.Types.Address Methods compare ∷ GYAddress → GYAddress → Ordering Source # (<) ∷ GYAddress → GYAddress → Bool Source # (<=) ∷ GYAddress → GYAddress → Bool Source # (>) ∷ GYAddress → GYAddress → Bool Source # (>=) ∷ GYAddress → GYAddress → Bool Source # max ∷ GYAddress → GYAddress → GYAddress Source # min ∷ GYAddress → GYAddress → GYAddress Source #
Hashable GYAddress #
Instance details Defined in GeniusYield.Types.Address Methods hashWithSalt ∷ Int → GYAddress → Int Source # hash ∷ GYAddress → Int Source #
FromHttpApiData GYAddress #	`>>>` `Web.parseUrlPiece @GYAddress "00e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f616"`Right (unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5") `>>>` `Web.parseUrlPiece @GYAddress "00"`Left "Not an address: 00; Reason: RawBytesHexErrorRawBytesDecodeFail \"00\" AddressAny (SerialiseAsRawBytesError {unSerialiseAsRawBytesError = \"Unable to deserialise AddressAny\"})"
Instance details Defined in GeniusYield.Types.Address Methods parseUrlPiece ∷ Text → Either Text GYAddress Source # parseHeader ∷ ByteString → Either Text GYAddress Source # parseQueryParam ∷ Text → Either Text GYAddress Source #
ToHttpApiData GYAddress #	In an HTTP context, addresses are represented in hex. `>>>` `Web.toUrlPiece addr`"00e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f616"
Instance details Defined in GeniusYield.Types.Address Methods toUrlPiece ∷ GYAddress → Text Source # toEncodedUrlPiece ∷ GYAddress → Builder Source # toHeader ∷ GYAddress → ByteString Source # toQueryParam ∷ GYAddress → Text Source #
ToParamSchema GYAddress #
Instance details Defined in GeniusYield.Types.Address Methods toParamSchema ∷ ∀ (t ∷ SwaggerKind Type). Proxy GYAddress → ParamSchema t Source #
ToSchema GYAddress #
Instance details Defined in GeniusYield.Types.Address Methods declareNamedSchema ∷ Proxy GYAddress → Declare (Definitions Schema) NamedSchema Source #
type Rep GYAddress #
Instance details Defined in GeniusYield.Types.Address type Rep GYAddress = D1 ('MetaData "GYAddress" "GeniusYield.Types.Address" "atlas-cardano-0.4.0-inplace" 'True) (C1 ('MetaCons "GYAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AddressAny)))

addressToApi ∷ GYAddress → AddressAny #

>>> addressToApi addr
AddressShelley (ShelleyAddress Testnet (KeyHashObj (KeyHash "e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d")) (StakeRefBase (KeyHashObj (KeyHash "1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f616"))))
>>> addressToApi addrByron1
AddressByron (ByronAddress (Address {addrRoot = 04865e42d2373addbebd5d2acf81c760c848970142889f7ee763091b, addrAttributes = Attributes { data_ = AddrAttributes {aaVKDerivationPath = Nothing, aaNetworkMagic = NetworkMainOrStage} }, addrType = ATVerKey}))
>>> addressToApi addrByron2
AddressByron (ByronAddress (Address {addrRoot = 3f04ff82d3008d3a4f3d2be7d66141dcbcbda74d6a805e463895b72a, addrAttributes = Attributes { data_ = AddrAttributes {aaVKDerivationPath = Just (HDAddressPayload {getHDAddressPayload = "\251C\"a\SUB\209\210M\245S\200S\144\160\190\237y[s\176\148\n3!\DLE\147\141\168"}), aaNetworkMagic = NetworkMainOrStage} }, addrType = ATVerKey}))

addressToApi' ∷ GYAddress → AddressInEra BabbageEra #

addressFromApi ∷ AddressAny → GYAddress #

addressFromApi' ∷ AddressInEra era → GYAddress #

addressToPlutus ∷ GYAddress → Address #

>>> addressToPlutus addr
Address {addressCredential = PubKeyCredential e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d, addressStakingCredential = Just (StakingHash (PubKeyCredential 1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f616))}

addressFromPlutus ∷ GYNetworkId → Address → Either PlutusToCardanoError GYAddress #

Used to inject wallet pubkeyhashes into addresses.

>>> import GeniusYield.Types.NetworkId

>>> addressFromPlutus GYTestnetPreprod $ addressToPlutus addr
Right (unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5")

addressToPaymentCredential ∷ GYAddress → Maybe GYPaymentCredential #

If an address is a shelley address, then we'll return payment credential wrapped in Just, Nothing otherwise.

>>> addressToPaymentCredential addr
Just (GYPaymentCredentialByKey (GYPaymentKeyHash "e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d"))
>>> addressToPaymentCredential addrScript
Just (GYPaymentCredentialByScript (GYValidatorHash "178155803bc461c5b0b371c779cb481ec7420df0c619cd9860e570d2"))
>>> addressToPaymentCredential addrByron1
Nothing
>>> addressToPaymentCredential addrByron2
Nothing

addressToStakeCredential ∷ GYAddress → Maybe GYStakeCredential #

If an address is a shelley address, then we'll return stake credential, if present, wrapped in Just and Nothing otherwise.

>>> addressToStakeCredential addr
Just (GYStakeCredentialByKey (GYStakeKeyHash "1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f616"))
>>> addressToStakeCredential addrScript
Nothing
>>> addressToStakeCredential addrByron1
Nothing
>>> addressToStakeCredential addrByron2
Nothing

addressFromPubKeyHash ∷ GYNetworkId → GYPubKeyHash → GYAddress #

Deprecated: Use addressFromPaymentKeyHash.

Create address from GYPubKeyHash.

note: no stake credential.

addressFromPaymentKeyHash ∷ GYNetworkId → GYPaymentKeyHash → GYAddress #

Create address from GYPaymentKeyHash.

note: no stake credential.

addressFromValidator ∷ GYNetworkId → GYValidator v → GYAddress #

Create address from GYValidator.

note: no stake credential.

addressFromCredential ∷ GYNetworkId → GYPaymentCredential → Maybe GYStakeCredential → GYAddress #

Create an address from payment & optionally, a stake credential.

addressFromValidatorHash ∷ GYNetworkId → GYValidatorHash → GYAddress #

Create address from GYValidatorHash.

note: no stake credential.

addressToText ∷ GYAddress → Text #

addressFromTextMaybe ∷ Text → Maybe GYAddress #

unsafeAddressFromText ∷ Text → GYAddress #

addressToPubKeyHash ∷ GYAddress → Maybe GYPubKeyHash #

addressToValidatorHash ∷ GYAddress → Maybe GYValidatorHash #

newtype wrapper

data GYAddressBech32 #

GYAddressBech32 which uses "bech32" format

>>> Web.toUrlPiece $ addressToBech32 addr
"addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"

Instances

Instances details

FromJSON GYAddressBech32 #	`>>>` `Aeson.decode @GYAddressBech32 "\"addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5\""`Just (unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5")
Instance details Defined in GeniusYield.Types.Address Methods parseJSON ∷ Value → Parser GYAddressBech32 Source # parseJSONList ∷ Value → Parser [GYAddressBech32] Source #
ToJSON GYAddressBech32 #	`>>>` `LBS8.putStrLn $ Aeson.encode $ addressToBech32 addr`"addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"
Instance details Defined in GeniusYield.Types.Address Methods toJSON ∷ GYAddressBech32 → Value Source # toEncoding ∷ GYAddressBech32 → Encoding Source # toJSONList ∷ [GYAddressBech32] → Value Source # toEncodingList ∷ [GYAddressBech32] → Encoding Source #
IsString GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods fromString ∷ String → GYAddressBech32 Source #
Show GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods showsPrec ∷ Int → GYAddressBech32 → ShowS Source # show ∷ GYAddressBech32 → String Source # showList ∷ [GYAddressBech32] → ShowS Source #
PrintfArg GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods formatArg ∷ GYAddressBech32 → FieldFormatter Source # parseFormat ∷ GYAddressBech32 → ModifierParser Source #
Eq GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods (==) ∷ GYAddressBech32 → GYAddressBech32 → Bool Source # (/=) ∷ GYAddressBech32 → GYAddressBech32 → Bool Source #
Ord GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods compare ∷ GYAddressBech32 → GYAddressBech32 → Ordering Source # (<) ∷ GYAddressBech32 → GYAddressBech32 → Bool Source # (<=) ∷ GYAddressBech32 → GYAddressBech32 → Bool Source # (>) ∷ GYAddressBech32 → GYAddressBech32 → Bool Source # (>=) ∷ GYAddressBech32 → GYAddressBech32 → Bool Source # max ∷ GYAddressBech32 → GYAddressBech32 → GYAddressBech32 Source # min ∷ GYAddressBech32 → GYAddressBech32 → GYAddressBech32 Source #
FromHttpApiData GYAddressBech32 #	`>>>` `Web.parseUrlPiece @GYAddressBech32 "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"`Right (unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5")
Instance details Defined in GeniusYield.Types.Address Methods parseUrlPiece ∷ Text → Either Text GYAddressBech32 Source # parseHeader ∷ ByteString → Either Text GYAddressBech32 Source # parseQueryParam ∷ Text → Either Text GYAddressBech32 Source #
ToHttpApiData GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods toUrlPiece ∷ GYAddressBech32 → Text Source # toEncodedUrlPiece ∷ GYAddressBech32 → Builder Source # toHeader ∷ GYAddressBech32 → ByteString Source # toQueryParam ∷ GYAddressBech32 → Text Source #
FromField GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods fromField ∷ FieldParser GYAddressBech32 Source #
ToField GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods toField ∷ GYAddressBech32 → Action Source #
ToParamSchema GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods toParamSchema ∷ ∀ (t ∷ SwaggerKind Type). Proxy GYAddressBech32 → ParamSchema t Source #
ToSchema GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods declareNamedSchema ∷ Proxy GYAddressBech32 → Declare (Definitions Schema) NamedSchema Source #

addressToBech32 ∷ GYAddress → GYAddressBech32 #

addressFromBech32 ∷ GYAddressBech32 → GYAddress #

Stake address.

data GYStakeAddress #

Stake Address.

Instances

Instances details

FromJSON GYStakeAddress #	In JSON context, stake addresses are represented in hex. `>>>` `Aeson.decode @GYStakeAddress "\"e07a77d120b9e86addc7388dbbb1bd2350490b7d140ab234038632334d\""`Just (unsafeStakeAddressFromText "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3")
Instance details Defined in GeniusYield.Types.Address Methods parseJSON ∷ Value → Parser GYStakeAddress Source # parseJSONList ∷ Value → Parser [GYStakeAddress] Source #
ToJSON GYStakeAddress #	`>>>` `LBS8.putStrLn $ Aeson.encode stakeAddr`"e07a77d120b9e86addc7388dbbb1bd2350490b7d140ab234038632334d"
Instance details Defined in GeniusYield.Types.Address Methods toJSON ∷ GYStakeAddress → Value Source # toEncoding ∷ GYStakeAddress → Encoding Source # toJSONList ∷ [GYStakeAddress] → Value Source # toEncodingList ∷ [GYStakeAddress] → Encoding Source #
Generic GYStakeAddress #
Instance details Defined in GeniusYield.Types.Address Associated Types type Rep GYStakeAddress ∷ Type → Type Source # Methods from ∷ GYStakeAddress → Rep GYStakeAddress x Source # to ∷ Rep GYStakeAddress x → GYStakeAddress Source #
Show GYStakeAddress #
Instance details Defined in GeniusYield.Types.Address Methods showsPrec ∷ Int → GYStakeAddress → ShowS Source # show ∷ GYStakeAddress → String Source # showList ∷ [GYStakeAddress] → ShowS Source #
PrintfArg GYStakeAddress #	This instance is using for logging `>>>` `Printf.printf "stake addr = %s" stakeAddr`stake addr = stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3
Instance details Defined in GeniusYield.Types.Address Methods formatArg ∷ GYStakeAddress → FieldFormatter Source # parseFormat ∷ GYStakeAddress → ModifierParser Source #
FromField GYStakeAddress #	`>>>` `Csv.runParser $ Csv.parseField @GYStakeAddress "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"`Right (unsafeStakeAddressFromText "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3") `>>>` `Csv.runParser $ Csv.parseField @GYStakeAddress "not a stake address"`Left "Not a stake address: not a stake address"
Instance details Defined in GeniusYield.Types.Address Methods parseField ∷ Field → Parser GYStakeAddress Source #
FromRecord GYStakeAddress #	`>>>` `Csv.decode @GYStakeAddress Csv.NoHeader "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3\n"`Right [unsafeStakeAddressFromText "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"] `>>>` `Csv.decode @GYStakeAddress Csv.NoHeader "not a stake address\n"`Left "parse error (Failed reading: conversion error: Not a stake address: not a stake address) at \"\\n\"" `>>>` `Csv.decode @GYStakeAddress Csv.NoHeader "not, a, stake address\n"`Left "parse error (Failed reading: conversion error: expected exactly one field, but got: [\"not\",\" a\",\" stake address\"]) at \"\\n\""
Instance details Defined in GeniusYield.Types.Address Methods parseRecord ∷ Record → Parser GYStakeAddress Source #
ToField GYStakeAddress #	`>>>` `Csv.toField stakeAddr`"stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"
Instance details Defined in GeniusYield.Types.Address Methods toField ∷ GYStakeAddress → Field Source #
ToRecord GYStakeAddress #	`>>>` `Csv.encodeWith (Csv.defaultEncodeOptions {Csv.encUseCrLf = False}) [stakeAddr]`"stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3\n"
Instance details Defined in GeniusYield.Types.Address Methods toRecord ∷ GYStakeAddress → Record Source #
Eq GYStakeAddress #
Instance details Defined in GeniusYield.Types.Address Methods (==) ∷ GYStakeAddress → GYStakeAddress → Bool Source # (/=) ∷ GYStakeAddress → GYStakeAddress → Bool Source #
Ord GYStakeAddress #
Instance details Defined in GeniusYield.Types.Address Methods compare ∷ GYStakeAddress → GYStakeAddress → Ordering Source # (<) ∷ GYStakeAddress → GYStakeAddress → Bool Source # (<=) ∷ GYStakeAddress → GYStakeAddress → Bool Source # (>) ∷ GYStakeAddress → GYStakeAddress → Bool Source # (>=) ∷ GYStakeAddress → GYStakeAddress → Bool Source # max ∷ GYStakeAddress → GYStakeAddress → GYStakeAddress Source # min ∷ GYStakeAddress → GYStakeAddress → GYStakeAddress Source #
Hashable GYStakeAddress #
Instance details Defined in GeniusYield.Types.Address Methods hashWithSalt ∷ Int → GYStakeAddress → Int Source # hash ∷ GYStakeAddress → Int Source #
FromHttpApiData GYStakeAddress #	`>>>` `Web.parseUrlPiece @GYStakeAddress "e07a77d120b9e86addc7388dbbb1bd2350490b7d140ab234038632334d"`Right (unsafeStakeAddressFromText "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3") `>>>` `Web.parseUrlPiece @GYStakeAddress "00"`Left "Not a stake address: 00; Reason: RawBytesHexErrorRawBytesDecodeFail \"00\" StakeAddress (SerialiseAsRawBytesError {unSerialiseAsRawBytesError = \"Unable to deserialise StakeAddress\"})"
Instance details Defined in GeniusYield.Types.Address Methods parseUrlPiece ∷ Text → Either Text GYStakeAddress Source # parseHeader ∷ ByteString → Either Text GYStakeAddress Source # parseQueryParam ∷ Text → Either Text GYStakeAddress Source #
ToHttpApiData GYStakeAddress #	In an HTTP context, stake addresses are represented in hex. `>>>` `Web.toUrlPiece stakeAddr`"e07a77d120b9e86addc7388dbbb1bd2350490b7d140ab234038632334d"
Instance details Defined in GeniusYield.Types.Address Methods toUrlPiece ∷ GYStakeAddress → Text Source # toEncodedUrlPiece ∷ GYStakeAddress → Builder Source # toHeader ∷ GYStakeAddress → ByteString Source # toQueryParam ∷ GYStakeAddress → Text Source #
ToParamSchema GYStakeAddress #
Instance details Defined in GeniusYield.Types.Address Methods toParamSchema ∷ ∀ (t ∷ SwaggerKind Type). Proxy GYStakeAddress → ParamSchema t Source #
ToSchema GYStakeAddress #
Instance details Defined in GeniusYield.Types.Address Methods declareNamedSchema ∷ Proxy GYStakeAddress → Declare (Definitions Schema) NamedSchema Source #
type Rep GYStakeAddress #
Instance details Defined in GeniusYield.Types.Address type Rep GYStakeAddress = D1 ('MetaData "GYStakeAddress" "GeniusYield.Types.Address" "atlas-cardano-0.4.0-inplace" 'True) (C1 ('MetaCons "GYStakeAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StakeAddress)))

stakeAddressFromApi ∷ StakeAddress → GYStakeAddress #

Get GY type from corresponding type in cardano-api library.

stakeAddressToApi ∷ GYStakeAddress → StakeAddress #

Convert GY type to corresponding type in cardano-api library.

stakeAddressFromTextMaybe ∷ Text → Maybe GYStakeAddress #

Obtain GYStakeAddress from bech32 encoding of stake address.

>>> stakeAddressFromTextMaybe "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"
Just (unsafeStakeAddressFromText "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3")
>>> stakeAddressFromTextMaybe "e07a77d120b9e86addc7388dbbb1bd2350490b7d140ab234038632334d"
Nothing

unsafeStakeAddressFromText ∷ Text → GYStakeAddress #

Like stakeAddressFromTextMaybe but errors on Nothing case.

stakeAddressToText ∷ GYStakeAddress → Text #

Serialises GYStakeAddress to it's bech32 representation.

>>> stakeAddressToText stakeAddr
"stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"

stakeAddressCredential ∷ GYStakeAddress → GYStakeCredential #

Deprecated: Use stakeAddressToCredential.

Get a stake credential from a stake address. This drops the network information.

stakeAddressToCredential ∷ GYStakeAddress → GYStakeCredential #

Get a stake credential from a stake address. This drops the network information.

stakeAddressFromCredential ∷ GYNetworkId → GYStakeCredential → GYStakeAddress #

Get a stake address from a stake credential. This also requires network information.

>>> stakeAddr == stakeAddressFromCredential GYTestnetPreprod (stakeAddressToCredential stakeAddr)
True

type GYStakeKeyHashString = String #

stakeKeyFromAddress ∷ GYAddress → Maybe GYStakeKeyHashString #

>>> stakeKeyFromAddress addr
Just "1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f616"

newtype wrapper

data GYStakeAddressBech32 #

GYStakeAddressBech32 which uses "bech32" format

>>> Web.toUrlPiece $ stakeAddressToBech32 stakeAddr
"stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"

Instances

Instances details

FromJSON GYStakeAddressBech32 #	`>>>` `Aeson.decode @GYStakeAddressBech32 "\"stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3\""`Just (unsafeStakeAddressFromText "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3")
Instance details Defined in GeniusYield.Types.Address Methods parseJSON ∷ Value → Parser GYStakeAddressBech32 Source # parseJSONList ∷ Value → Parser [GYStakeAddressBech32] Source #
ToJSON GYStakeAddressBech32 #	`>>>` `LBS8.putStrLn $ Aeson.encode $ stakeAddressToBech32 stakeAddr`"stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"
Instance details Defined in GeniusYield.Types.Address Methods toJSON ∷ GYStakeAddressBech32 → Value Source # toEncoding ∷ GYStakeAddressBech32 → Encoding Source # toJSONList ∷ [GYStakeAddressBech32] → Value Source # toEncodingList ∷ [GYStakeAddressBech32] → Encoding Source #
IsString GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods fromString ∷ String → GYStakeAddressBech32 Source #
Show GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods showsPrec ∷ Int → GYStakeAddressBech32 → ShowS Source # show ∷ GYStakeAddressBech32 → String Source # showList ∷ [GYStakeAddressBech32] → ShowS Source #
PrintfArg GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods formatArg ∷ GYStakeAddressBech32 → FieldFormatter Source # parseFormat ∷ GYStakeAddressBech32 → ModifierParser Source #
Eq GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods (==) ∷ GYStakeAddressBech32 → GYStakeAddressBech32 → Bool Source # (/=) ∷ GYStakeAddressBech32 → GYStakeAddressBech32 → Bool Source #
Ord GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods compare ∷ GYStakeAddressBech32 → GYStakeAddressBech32 → Ordering Source # (<) ∷ GYStakeAddressBech32 → GYStakeAddressBech32 → Bool Source # (<=) ∷ GYStakeAddressBech32 → GYStakeAddressBech32 → Bool Source # (>) ∷ GYStakeAddressBech32 → GYStakeAddressBech32 → Bool Source # (>=) ∷ GYStakeAddressBech32 → GYStakeAddressBech32 → Bool Source # max ∷ GYStakeAddressBech32 → GYStakeAddressBech32 → GYStakeAddressBech32 Source # min ∷ GYStakeAddressBech32 → GYStakeAddressBech32 → GYStakeAddressBech32 Source #
FromHttpApiData GYStakeAddressBech32 #	`>>>` `Web.parseUrlPiece @GYStakeAddressBech32 "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"`Right (unsafeStakeAddressFromText "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3")
Instance details Defined in GeniusYield.Types.Address Methods parseUrlPiece ∷ Text → Either Text GYStakeAddressBech32 Source # parseHeader ∷ ByteString → Either Text GYStakeAddressBech32 Source # parseQueryParam ∷ Text → Either Text GYStakeAddressBech32 Source #
ToHttpApiData GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods toUrlPiece ∷ GYStakeAddressBech32 → Text Source # toEncodedUrlPiece ∷ GYStakeAddressBech32 → Builder Source # toHeader ∷ GYStakeAddressBech32 → ByteString Source # toQueryParam ∷ GYStakeAddressBech32 → Text Source #
FromField GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods fromField ∷ FieldParser GYStakeAddressBech32 Source #
ToField GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods toField ∷ GYStakeAddressBech32 → Action Source #
ToParamSchema GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods toParamSchema ∷ ∀ (t ∷ SwaggerKind Type). Proxy GYStakeAddressBech32 → ParamSchema t Source #
ToSchema GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods declareNamedSchema ∷ Proxy GYStakeAddressBech32 → Declare (Definitions Schema) NamedSchema Source #

stakeAddressToBech32 ∷ GYStakeAddress → GYStakeAddressBech32 #

stakeAddressFromBech32 ∷ GYStakeAddressBech32 → GYStakeAddress #