Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	support@geniusyield.co
Stability	develop
Safe Haskell	None
Language	Haskell2010

GeniusYield.Types.Address

Contents

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
addressFromPubKeyHash ∷ GYNetworkId → GYPubKeyHash → GYAddress
addressFromValidator ∷ GYNetworkId → GYValidator v → 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
stakeKeyFromAddress ∷ GYAddress → Maybe GYStakeKeyHash
type GYStakeKeyHash = String

Documentation

data GYAddress #

Addresses on the blockchain.

Instances

Instances details

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 #
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 #
Generic GYAddress #
Instance details Defined in GeniusYield.Types.Address Associated Types type Rep GYAddress ∷ Type → Type # Methods from ∷ GYAddress → Rep GYAddress x # to ∷ Rep GYAddress x → GYAddress #
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 #
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] #
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 #
ToField GYAddress #	`>>>` `Csv.toField $ unsafeAddressFromText "addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"`"addr_test1qrsuhwqdhz0zjgnf46unas27h93amfghddnff8lpc2n28rgmjv8f77ka0zshfgssqr5cnl64zdnde5f8q2xt923e7ctqu49mg5"
Instance details Defined in GeniusYield.Types.Address Methods toField ∷ GYAddress → Field
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\""
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
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
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
ToParamSchema GYAddress #
Instance details Defined in GeniusYield.Types.Address Methods toParamSchema ∷ ∀ (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-0.1.0.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' ∷ 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")

addressFromPubKeyHash ∷ GYNetworkId → GYPubKeyHash → GYAddress #

Create address from GYPubKeyHash.

note: no stake credential.

addressFromValidator ∷ GYNetworkId → GYValidator v → GYAddress #

Create address from GYValidator.

note: no 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 #

GYAddress which uses "serialized" format

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

Instances

Instances details

Show GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods showsPrec ∷ Int → GYAddressBech32 → ShowS # show ∷ GYAddressBech32 → String # showList ∷ [GYAddressBech32] → ShowS #
IsString GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods fromString ∷ String → GYAddressBech32 #
PrintfArg GYAddressBech32 #
Instance details Defined in GeniusYield.Types.Address Methods formatArg ∷ GYAddressBech32 → FieldFormatter # parseFormat ∷ GYAddressBech32 → ModifierParser #
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] #
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 #
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
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 ∷ ∀ (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 #

stakeKeyFromAddress ∷ GYAddress → Maybe GYStakeKeyHash #

Extract stakeKey Hash from Address

type GYStakeKeyHash = String #