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

GeniusYield.Types.Address

Contents

newtype wrapper
Stake address.
newtype wrapper

Description

Synopsis

data GYAddress
addressToApi :: GYAddress -> AddressAny
addressToApi' :: GYAddress -> AddressInEra ApiEra
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
addressFromScript :: forall (v :: PlutusVersion). GYNetworkId -> GYScript v -> GYAddress
addressFromValidator :: forall (v :: PlutusVersion). GYNetworkId -> GYScript v -> GYAddress
addressFromCredential :: GYNetworkId -> GYPaymentCredential -> Maybe GYStakeCredential -> GYAddress
addressFromValidatorHash :: GYNetworkId -> GYScriptHash -> GYAddress
addressFromScriptHash :: GYNetworkId -> GYScriptHash -> GYAddress
addressFromSimpleScript :: GYNetworkId -> GYSimpleScript -> GYAddress
addressToText :: GYAddress -> Text
addressFromTextMaybe :: Text -> Maybe GYAddress
unsafeAddressFromText :: Text -> GYAddress
addressToPubKeyHash :: GYAddress -> Maybe GYPubKeyHash
addressToValidatorHash :: GYAddress -> Maybe GYScriptHash
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
stakeAddressToLedger :: GYStakeAddress -> RewardAccount
stakeAddressFromLedger :: RewardAccount -> GYStakeAddress
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 #

parseJSONList :: Value -> Parser [GYAddress] #

omittedField :: Maybe GYAddress #

ToJSON GYAddress #

>>> LBS8.putStrLn $ Aeson.encode addr
"00e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f616"

Instance details

Defined in GeniusYield.Types.Address

Methods

toJSON :: GYAddress -> Value #

toEncoding :: GYAddress -> Encoding #

toJSONList :: [GYAddress] -> Value #

toEncodingList :: [GYAddress] -> Encoding #

omitField :: GYAddress -> Bool #

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 #

parseFormat :: GYAddress -> ModifierParser #

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 #

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 #

ToField GYAddress #

>>> Csv.toField $ unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"
"addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"

Instance details

Defined in GeniusYield.Types.Address

Methods

toField :: GYAddress -> Field #

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 #

Generic GYAddress #

Instance details

Defined in GeniusYield.Types.Address

Associated Types

type Rep GYAddress
Instance details Defined in GeniusYield.Types.Address type Rep GYAddress = D1 ('MetaData "GYAddress" "GeniusYield.Types.Address" "atlas-cardano-0.14.1-inplace" 'True) (C1 ('MetaCons "GYAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AddressAny)))

Methods

from :: GYAddress -> Rep GYAddress x #

to :: Rep GYAddress x -> GYAddress #

Show GYAddress #

>>> let addr = unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"

Instance details

Defined in GeniusYield.Types.Address

Methods

showsPrec :: Int -> GYAddress -> ShowS #

show :: GYAddress -> String #

showList :: [GYAddress] -> ShowS #

Eq GYAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

(==) :: GYAddress -> GYAddress -> Bool #

(/=) :: GYAddress -> GYAddress -> Bool #

Ord GYAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

compare :: GYAddress -> GYAddress -> Ordering #

(<) :: GYAddress -> GYAddress -> Bool #

(<=) :: GYAddress -> GYAddress -> Bool #

(>) :: GYAddress -> GYAddress -> Bool #

(>=) :: GYAddress -> GYAddress -> Bool #

max :: GYAddress -> GYAddress -> GYAddress #

min :: GYAddress -> GYAddress -> GYAddress #

Hashable GYAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

hashWithSalt :: Int -> GYAddress -> Int #

hash :: GYAddress -> Int #

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 #

parseHeader :: ByteString -> Either Text GYAddress #

parseQueryParam :: Text -> Either Text GYAddress #

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 #

toEncodedUrlPiece :: GYAddress -> Builder #

toHeader :: GYAddress -> ByteString #

toQueryParam :: GYAddress -> Text #

toEncodedQueryParam :: GYAddress -> Builder #

ToParamSchema GYAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

toParamSchema :: forall (t :: SwaggerKind Type). Proxy GYAddress -> ParamSchema t #

ToSchema GYAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

declareNamedSchema :: Proxy GYAddress -> Declare (Definitions Schema) NamedSchema #

type Rep GYAddress #

Instance details

Defined in GeniusYield.Types.Address

type Rep GYAddress = D1 ('MetaData "GYAddress" "GeniusYield.Types.Address" "atlas-cardano-0.14.1-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 {unKeyHash = "e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d"})) (StakeRefBase (KeyHashObj (KeyHash {unKeyHash = "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 ApiEra #

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 (GYCredentialByKey (GYKeyHash (GYKeyRolePayment) "e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d"))
>>> addressToPaymentCredential addrScript
Just (GYCredentialByScript (GYScriptHash "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 (GYCredentialByKey (GYKeyHash (GYKeyRoleStaking) "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.

addressFromScript :: forall (v :: PlutusVersion). GYNetworkId -> GYScript v -> GYAddress #

Create address from GYScript.

note: no stake credential.

addressFromValidator :: forall (v :: PlutusVersion). GYNetworkId -> GYScript v -> GYAddress #

Create address from GYScript.

note: no stake credential.

addressFromCredential :: GYNetworkId -> GYPaymentCredential -> Maybe GYStakeCredential -> GYAddress #

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

addressFromValidatorHash :: GYNetworkId -> GYScriptHash -> GYAddress #

Create address from GYScriptHash.

note: no stake credential.

addressFromScriptHash :: GYNetworkId -> GYScriptHash -> GYAddress #

Create address from GYScriptHash.

addressFromSimpleScript :: GYNetworkId -> GYSimpleScript -> GYAddress #

Create address from GYSimpleScript.

addressToText :: GYAddress -> Text #

addressFromTextMaybe :: Text -> Maybe GYAddress #

unsafeAddressFromText :: Text -> GYAddress #

addressToPubKeyHash :: GYAddress -> Maybe GYPubKeyHash #

addressToValidatorHash :: GYAddress -> Maybe GYScriptHash #

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

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 #

parseJSONList :: Value -> Parser [GYStakeAddress] #

omittedField :: Maybe GYStakeAddress #

ToJSON GYStakeAddress #

>>> LBS8.putStrLn $ Aeson.encode stakeAddr
"e07a77d120b9e86addc7388dbbb1bd2350490b7d140ab234038632334d"

Instance details

Defined in GeniusYield.Types.Address

Methods

toJSON :: GYStakeAddress -> Value #

toEncoding :: GYStakeAddress -> Encoding #

toJSONList :: [GYStakeAddress] -> Value #

toEncodingList :: [GYStakeAddress] -> Encoding #

omitField :: GYStakeAddress -> Bool #

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 #

parseFormat :: GYStakeAddress -> ModifierParser #

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 #

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 #

ToField GYStakeAddress #

>>> Csv.toField stakeAddr
"stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"

Instance details

Defined in GeniusYield.Types.Address

Methods

toField :: GYStakeAddress -> Field #

ToRecord GYStakeAddress #

>>> Csv.encodeWith (Csv.defaultEncodeOptions {Csv.encUseCrLf = False}) [stakeAddr]
"stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3\n"

Instance details

Defined in GeniusYield.Types.Address

Methods

toRecord :: GYStakeAddress -> Record #

Generic GYStakeAddress #

Instance details

Defined in GeniusYield.Types.Address

Associated Types

type Rep GYStakeAddress
Instance details Defined in GeniusYield.Types.Address type Rep GYStakeAddress = D1 ('MetaData "GYStakeAddress" "GeniusYield.Types.Address" "atlas-cardano-0.14.1-inplace" 'True) (C1 ('MetaCons "GYStakeAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StakeAddress)))

Methods

from :: GYStakeAddress -> Rep GYStakeAddress x #

to :: Rep GYStakeAddress x -> GYStakeAddress #

Show GYStakeAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

showsPrec :: Int -> GYStakeAddress -> ShowS #

show :: GYStakeAddress -> String #

showList :: [GYStakeAddress] -> ShowS #

Eq GYStakeAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

(==) :: GYStakeAddress -> GYStakeAddress -> Bool #

(/=) :: GYStakeAddress -> GYStakeAddress -> Bool #

Ord GYStakeAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

compare :: GYStakeAddress -> GYStakeAddress -> Ordering #

(<) :: GYStakeAddress -> GYStakeAddress -> Bool #

(<=) :: GYStakeAddress -> GYStakeAddress -> Bool #

(>) :: GYStakeAddress -> GYStakeAddress -> Bool #

(>=) :: GYStakeAddress -> GYStakeAddress -> Bool #

max :: GYStakeAddress -> GYStakeAddress -> GYStakeAddress #

min :: GYStakeAddress -> GYStakeAddress -> GYStakeAddress #

Hashable GYStakeAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

hashWithSalt :: Int -> GYStakeAddress -> Int #

hash :: GYStakeAddress -> Int #

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 #

parseHeader :: ByteString -> Either Text GYStakeAddress #

parseQueryParam :: Text -> Either Text GYStakeAddress #

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 #

toEncodedUrlPiece :: GYStakeAddress -> Builder #

toHeader :: GYStakeAddress -> ByteString #

toQueryParam :: GYStakeAddress -> Text #

toEncodedQueryParam :: GYStakeAddress -> Builder #

ToParamSchema GYStakeAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

toParamSchema :: forall (t :: SwaggerKind Type). Proxy GYStakeAddress -> ParamSchema t #

ToSchema GYStakeAddress #

Instance details

Defined in GeniusYield.Types.Address

Methods

declareNamedSchema :: Proxy GYStakeAddress -> Declare (Definitions Schema) NamedSchema #

type Rep GYStakeAddress #

Instance details

Defined in GeniusYield.Types.Address

type Rep GYStakeAddress = D1 ('MetaData "GYStakeAddress" "GeniusYield.Types.Address" "atlas-cardano-0.14.1-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"

stakeAddressToLedger :: GYStakeAddress -> RewardAccount #

stakeAddressFromLedger :: RewardAccount -> GYStakeAddress #

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 # parseJSONList :: Value -> Parser [GYStakeAddressBech32] # omittedField :: Maybe GYStakeAddressBech32 #
FromJSONKey GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods fromJSONKey :: FromJSONKeyFunction GYStakeAddressBech32 # fromJSONKeyList :: FromJSONKeyFunction [GYStakeAddressBech32] #
ToJSON GYStakeAddressBech32 #	`>>>` `LBS8.putStrLn $ Aeson.encode $ stakeAddressToBech32 stakeAddr`"stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"
Instance details Defined in GeniusYield.Types.Address Methods toJSON :: GYStakeAddressBech32 -> Value # toEncoding :: GYStakeAddressBech32 -> Encoding # toJSONList :: [GYStakeAddressBech32] -> Value # toEncodingList :: [GYStakeAddressBech32] -> Encoding # omitField :: GYStakeAddressBech32 -> Bool #
PrintfArg GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods formatArg :: GYStakeAddressBech32 -> FieldFormatter # parseFormat :: GYStakeAddressBech32 -> ModifierParser #
IsString GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods fromString :: String -> GYStakeAddressBech32 #
Show GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods showsPrec :: Int -> GYStakeAddressBech32 -> ShowS # show :: GYStakeAddressBech32 -> String # showList :: [GYStakeAddressBech32] -> ShowS #
Eq GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods (==) :: GYStakeAddressBech32 -> GYStakeAddressBech32 -> Bool # (/=) :: GYStakeAddressBech32 -> GYStakeAddressBech32 -> Bool #
Ord GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods compare :: GYStakeAddressBech32 -> GYStakeAddressBech32 -> Ordering # (<) :: GYStakeAddressBech32 -> GYStakeAddressBech32 -> Bool # (<=) :: GYStakeAddressBech32 -> GYStakeAddressBech32 -> Bool # (>) :: GYStakeAddressBech32 -> GYStakeAddressBech32 -> Bool # (>=) :: GYStakeAddressBech32 -> GYStakeAddressBech32 -> Bool # max :: GYStakeAddressBech32 -> GYStakeAddressBech32 -> GYStakeAddressBech32 # min :: GYStakeAddressBech32 -> GYStakeAddressBech32 -> GYStakeAddressBech32 #
FromHttpApiData GYStakeAddressBech32 #	`>>>` `Web.parseUrlPiece @GYStakeAddressBech32 "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3"`Right (unsafeStakeAddressFromText "stake_test1upa805fqh85x4hw88zxmhvdaydgyjzmazs9tydqrscerxnghfq4t3")
Instance details Defined in GeniusYield.Types.Address Methods parseUrlPiece :: Text -> Either Text GYStakeAddressBech32 # parseHeader :: ByteString -> Either Text GYStakeAddressBech32 # parseQueryParam :: Text -> Either Text GYStakeAddressBech32 #
ToHttpApiData GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods toUrlPiece :: GYStakeAddressBech32 -> Text # toEncodedUrlPiece :: GYStakeAddressBech32 -> Builder # toHeader :: GYStakeAddressBech32 -> ByteString # toQueryParam :: GYStakeAddressBech32 -> Text # toEncodedQueryParam :: GYStakeAddressBech32 -> Builder #
FromField GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods fromField :: FieldParser GYStakeAddressBech32 #
ToField GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods toField :: GYStakeAddressBech32 -> Action #
ToParamSchema GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy GYStakeAddressBech32 -> ParamSchema t #
ToSchema GYStakeAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods declareNamedSchema :: Proxy GYStakeAddressBech32 -> Declare (Definitions Schema) NamedSchema #

stakeAddressToBech32 :: GYStakeAddress -> GYStakeAddressBech32 #

stakeAddressFromBech32 :: GYStakeAddressBech32 -> GYStakeAddress #