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

GeniusYield.Types.StakePoolId

Description

Documentation

type GYStakePoolId = GYKeyHash 'GYKeyRoleStakePool #

type GYStakePoolId = GYKeyHash 'GYKeyRoleStakePool

stakePoolIdToApi :: GYStakePoolId -> Hash StakePoolKey #

>>> let Just spid = Aeson.decode @GYStakePoolId "\"c485ab20bd3f105e59f3c50a0d3fbaf615a51f70a1c6d29d00a1fd27\""
>>> stakePoolIdToApi spid
"c485ab20bd3f105e59f3c50a0d3fbaf615a51f70a1c6d29d00a1fd27"

stakePoolIdFromApi :: Hash StakePoolKey -> GYStakePoolId #

>>> stakePoolIdFromApi "c485ab20bd3f105e59f3c50a0d3fbaf615a51f70a1c6d29d00a1fd27"
GYKeyHash (GYKeyRoleStakePool) "c485ab20bd3f105e59f3c50a0d3fbaf615a51f70a1c6d29d00a1fd27"

stakePoolIdToLedger :: GYStakePoolId -> KeyHash 'StakePool #

Convert to corresponding ledger type.

stakePoolIdFromLedger :: KeyHash 'StakePool -> GYStakePoolId #

Convert from corresponding ledger type.

stakePoolIdFromTextMaybe :: Text -> Maybe GYStakePoolId #

Obtain GYStakePoolId from bech32 encoding of stake pool id.

>>> stakePoolIdFromTextMaybe "pool1cjz6kg9a8ug9uk0nc59q60a67c2628ms58rd98gq587jwa2x5qt"
Just (GYKeyHash (GYKeyRoleStakePool) "c485ab20bd3f105e59f3c50a0d3fbaf615a51f70a1c6d29d00a1fd27")
>>> stakePoolIdFromTextMaybe "c485ab20bd3f105e59f3c50a0d3fbaf615a51f70a1c6d29d00a1fd27"
Nothing

unsafeStakePoolIdFromText :: Text -> GYStakePoolId #

Like stakePoolIdFromTextMaybe but errors on Nothing case.

stakePoolIdToText :: GYStakePoolId -> Text #

Serialises GYStakePoolId to it's bech32 representation.

>>> stakePoolIdToText spId
"pool1cjz6kg9a8ug9uk0nc59q60a67c2628ms58rd98gq587jwa2x5qt"

data GYStakePoolIdBech32 #

GYStakePoolIdBech32 which uses "bech32" format

>>> Web.toUrlPiece $ stakePoolIdToBech32 spId
"pool1cjz6kg9a8ug9uk0nc59q60a67c2628ms58rd98gq587jwa2x5qt"

Instances

Instances details

FromJSON GYStakePoolIdBech32 #	`>>>` `Aeson.decode @GYStakePoolIdBech32 "\"pool1cjz6kg9a8ug9uk0nc59q60a67c2628ms58rd98gq587jwa2x5qt\""`Just pool1cjz6kg9a8ug9uk0nc59q60a67c2628ms58rd98gq587jwa2x5qt
Instance details Defined in GeniusYield.Types.StakePoolId Methods parseJSON :: Value -> Parser GYStakePoolIdBech32 # parseJSONList :: Value -> Parser [GYStakePoolIdBech32] # omittedField :: Maybe GYStakePoolIdBech32 #
FromJSONKey GYStakePoolIdBech32 #
Instance details Defined in GeniusYield.Types.StakePoolId Methods fromJSONKey :: FromJSONKeyFunction GYStakePoolIdBech32 # fromJSONKeyList :: FromJSONKeyFunction [GYStakePoolIdBech32] #
ToJSON GYStakePoolIdBech32 #	`>>>` `LBS8.putStrLn $ Aeson.encode $ stakePoolIdToBech32 spId`"pool1cjz6kg9a8ug9uk0nc59q60a67c2628ms58rd98gq587jwa2x5qt"
Instance details Defined in GeniusYield.Types.StakePoolId Methods toJSON :: GYStakePoolIdBech32 -> Value # toEncoding :: GYStakePoolIdBech32 -> Encoding # toJSONList :: [GYStakePoolIdBech32] -> Value # toEncodingList :: [GYStakePoolIdBech32] -> Encoding # omitField :: GYStakePoolIdBech32 -> Bool #
IsString GYStakePoolIdBech32 #
Instance details Defined in GeniusYield.Types.StakePoolId Methods fromString :: String -> GYStakePoolIdBech32 #
Show GYStakePoolIdBech32 #
Instance details Defined in GeniusYield.Types.StakePoolId Methods showsPrec :: Int -> GYStakePoolIdBech32 -> ShowS # show :: GYStakePoolIdBech32 -> String # showList :: [GYStakePoolIdBech32] -> ShowS #
Eq GYStakePoolIdBech32 #
Instance details Defined in GeniusYield.Types.StakePoolId Methods (==) :: GYStakePoolIdBech32 -> GYStakePoolIdBech32 -> Bool # (/=) :: GYStakePoolIdBech32 -> GYStakePoolIdBech32 -> Bool #
Ord GYStakePoolIdBech32 #
Instance details Defined in GeniusYield.Types.StakePoolId Methods compare :: GYStakePoolIdBech32 -> GYStakePoolIdBech32 -> Ordering # (<) :: GYStakePoolIdBech32 -> GYStakePoolIdBech32 -> Bool # (<=) :: GYStakePoolIdBech32 -> GYStakePoolIdBech32 -> Bool # (>) :: GYStakePoolIdBech32 -> GYStakePoolIdBech32 -> Bool # (>=) :: GYStakePoolIdBech32 -> GYStakePoolIdBech32 -> Bool # max :: GYStakePoolIdBech32 -> GYStakePoolIdBech32 -> GYStakePoolIdBech32 # min :: GYStakePoolIdBech32 -> GYStakePoolIdBech32 -> GYStakePoolIdBech32 #
FromHttpApiData GYStakePoolIdBech32 #	`>>>` `Web.parseUrlPiece @GYStakePoolIdBech32 "pool1cjz6kg9a8ug9uk0nc59q60a67c2628ms58rd98gq587jwa2x5qt"`Right pool1cjz6kg9a8ug9uk0nc59q60a67c2628ms58rd98gq587jwa2x5qt
Instance details Defined in GeniusYield.Types.StakePoolId Methods parseUrlPiece :: Text -> Either Text GYStakePoolIdBech32 # parseHeader :: ByteString -> Either Text GYStakePoolIdBech32 # parseQueryParam :: Text -> Either Text GYStakePoolIdBech32 #
ToHttpApiData GYStakePoolIdBech32 #
Instance details Defined in GeniusYield.Types.StakePoolId Methods toUrlPiece :: GYStakePoolIdBech32 -> Text # toEncodedUrlPiece :: GYStakePoolIdBech32 -> Builder # toHeader :: GYStakePoolIdBech32 -> ByteString # toQueryParam :: GYStakePoolIdBech32 -> Text # toEncodedQueryParam :: GYStakePoolIdBech32 -> Builder #
ToParamSchema GYStakePoolIdBech32 #
Instance details Defined in GeniusYield.Types.StakePoolId Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy GYStakePoolIdBech32 -> ParamSchema t #
ToSchema GYStakePoolIdBech32 #	`>>>` `Aeson.encode (Swagger.toSchema (Proxy :: Proxy GYStakePoolIdBech32))`"{\"description\":\"A stake pool id, serialised as Bech32.\",\"example\":\"pool1cjz6kg9a8ug9uk0nc59q60a67c2628ms58rd98gq587jwa2x5qt\",\"format\":\"bech32\",\"type\":\"string\"}"
Instance details Defined in GeniusYield.Types.StakePoolId Methods declareNamedSchema :: Proxy GYStakePoolIdBech32 -> Declare (Definitions Schema) NamedSchema #

stakePoolIdFromBech32 :: GYStakePoolIdBech32 -> GYStakePoolId #

stakePoolIdToBech32 :: GYStakePoolId -> GYStakePoolIdBech32 #