Safe Haskell	None
Language	Haskell2010

Cardano.Api.Address

Contents

Payment addresses
Stake addresses
Conversion functions
Internal conversion functions
Serialising addresses
Data family instances
Helpers

Description

Cardano addresses: payment and stake addresses.

Synopsis

data Address addrtype where
- ByronAddress :: Address -> Address ByronAddr
- ShelleyAddress :: Network -> PaymentCredential StandardCrypto -> StakeReference StandardCrypto -> Address ShelleyAddr
data ByronAddr
makeByronAddress :: NetworkId -> VerificationKey ByronKey -> Address ByronAddr
data ShelleyAddr
makeShelleyAddress :: NetworkId -> PaymentCredential -> StakeAddressReference -> Address ShelleyAddr
data PaymentCredential
- = PaymentCredentialByKey (Hash PaymentKey)
- | PaymentCredentialByScript ScriptHash
data StakeAddressReference
- = StakeAddressByValue StakeCredential
- | StakeAddressByPointer StakeAddressPointer
- | NoStakeAddress
newtype StakeAddressPointer = StakeAddressPointer {
- unStakeAddressPointer :: Ptr
}
data AddressAny
- = AddressByron !(Address ByronAddr)
- | AddressShelley !(Address ShelleyAddr)
lexPlausibleAddressString :: Parser Text
parseAddressAny :: Parser AddressAny
data AddressInEra era where
- AddressInEra :: AddressTypeInEra addrtype era -> Address addrtype -> AddressInEra era
data AddressTypeInEra addrtype era where
- ByronAddressInAnyEra :: AddressTypeInEra ByronAddr era
- ShelleyAddressInEra :: ShelleyBasedEra era -> AddressTypeInEra ShelleyAddr era
byronAddressInEra :: Address ByronAddr -> AddressInEra era
shelleyAddressInEra :: ShelleyBasedEra era -> Address ShelleyAddr -> AddressInEra era
anyAddressInShelleyBasedEra :: ShelleyBasedEra era -> AddressAny -> AddressInEra era
anyAddressInEra :: CardanoEra era -> AddressAny -> Either String (AddressInEra era)
toAddressAny :: Address addr -> AddressAny
makeByronAddressInEra :: NetworkId -> VerificationKey ByronKey -> AddressInEra era
makeShelleyAddressInEra :: ShelleyBasedEra era -> NetworkId -> PaymentCredential -> StakeAddressReference -> AddressInEra era
data StakeAddress where
- StakeAddress :: Network -> StakeCredential StandardCrypto -> StakeAddress
data StakeCredential
- = StakeCredentialByKey (Hash StakeKey)
- | StakeCredentialByScript ScriptHash
makeStakeAddress :: NetworkId -> StakeCredential -> StakeAddress
stakeAddressCredential :: StakeAddress -> StakeCredential
data StakeKey
data StakeExtendedKey
shelleyPayAddrToPlutusPubKHash :: Address ShelleyAddr -> Maybe PubKeyHash
toShelleyAddr :: AddressInEra era -> Addr StandardCrypto
toShelleyStakeAddr :: StakeAddress -> RewardAcnt StandardCrypto
toShelleyStakeCredential :: StakeCredential -> StakeCredential StandardCrypto
fromShelleyAddr :: ShelleyBasedEra era -> Addr StandardCrypto -> AddressInEra era
fromShelleyAddrIsSbe :: ShelleyBasedEra era -> Addr StandardCrypto -> AddressInEra era
fromShelleyAddrToAny :: Addr StandardCrypto -> AddressAny
fromShelleyPaymentCredential :: PaymentCredential StandardCrypto -> PaymentCredential
fromShelleyStakeAddr :: RewardAcnt StandardCrypto -> StakeAddress
fromShelleyStakeCredential :: StakeCredential StandardCrypto -> StakeCredential
fromShelleyStakeReference :: StakeReference StandardCrypto -> StakeAddressReference
class HasTypeProxy addr => SerialiseAddress addr where
- serialiseAddress :: addr -> Text
- deserialiseAddress :: AsType addr -> Text -> Maybe addr
data family AsType t
isKeyAddress :: AddressInEra era -> Bool

Payment addresses

Constructing and inspecting normal payment addresses

data Address addrtype where Source #

Addresses are used as locations where assets live. The address determines the rights needed to spend assets at the address: in particular holding some signing key or being able to satisfy the conditions of a script.

There are currently two types of address:

Byron addresses, which use the type tag ByronAddr; and
Shelley addresses, which use the type tag ShelleyAddr. Notably, Shelley addresses support scripts and stake delegation.

The address type is subtly from the ledger era in which each address type is valid: while Byron addresses are the only choice in the Byron era, the Shelley era and all subsequent eras support both Byron and Shelley addresses. The Address type param only says the type of the address (either Byron or Shelley). The AddressInEra type connects the address type with the era in which it is supported.

Constructors

ByronAddress :: Address -> Address ByronAddr	Byron addresses were the only supported address type in the original Byron era.
ShelleyAddress :: Network -> PaymentCredential StandardCrypto -> StakeReference StandardCrypto -> Address ShelleyAddr	Shelley addresses allow delegation. Shelley addresses were introduced in Shelley era and are thus supported from the Shelley era onwards

Instances

Instances details

Eq (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address Methods (==) :: Address addrtype -> Address addrtype -> Bool Source # (/=) :: Address addrtype -> Address addrtype -> Bool Source #
Ord (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address Methods compare :: Address addrtype -> Address addrtype -> Ordering Source # (<) :: Address addrtype -> Address addrtype -> Bool Source # (<=) :: Address addrtype -> Address addrtype -> Bool Source # (>) :: Address addrtype -> Address addrtype -> Bool Source # (>=) :: Address addrtype -> Address addrtype -> Bool Source # max :: Address addrtype -> Address addrtype -> Address addrtype Source # min :: Address addrtype -> Address addrtype -> Address addrtype Source #
Show (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> Address addrtype -> ShowS Source # show :: Address addrtype -> String Source # showList :: [Address addrtype] -> ShowS Source #
NFData (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address Methods rnf :: Address addrtype -> () Source #
FromJSON (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods parseJSON :: Value -> Parser (Address ShelleyAddr) # parseJSONList :: Value -> Parser [Address ShelleyAddr] # omittedField :: Maybe (Address ShelleyAddr) #
FromJSON (Address ByronAddr) Source #
Instance details Defined in Cardano.Api.Address Methods parseJSON :: Value -> Parser (Address ByronAddr) # parseJSONList :: Value -> Parser [Address ByronAddr] # omittedField :: Maybe (Address ByronAddr) #
ToJSON (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods toJSON :: Address ShelleyAddr -> Value # toEncoding :: Address ShelleyAddr -> Encoding # toJSONList :: [Address ShelleyAddr] -> Value # toEncodingList :: [Address ShelleyAddr] -> Encoding # omitField :: Address ShelleyAddr -> Bool #
ToJSON (Address ByronAddr) Source #
Instance details Defined in Cardano.Api.Address Methods toJSON :: Address ByronAddr -> Value # toEncoding :: Address ByronAddr -> Encoding # toJSONList :: [Address ByronAddr] -> Value # toEncodingList :: [Address ByronAddr] -> Encoding # omitField :: Address ByronAddr -> Bool #
HasTypeProxy addrtype => HasTypeProxy (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address Associated Types data AsType (Address addrtype) Source # Methods proxyToAsType :: Proxy (Address addrtype) -> AsType (Address addrtype) Source #
SerialiseAsRawBytes (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseToRawBytes :: Address ShelleyAddr -> ByteString Source # deserialiseFromRawBytes :: AsType (Address ShelleyAddr) -> ByteString -> Either SerialiseAsRawBytesError (Address ShelleyAddr) Source #
SerialiseAsRawBytes (Address ByronAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseToRawBytes :: Address ByronAddr -> ByteString Source # deserialiseFromRawBytes :: AsType (Address ByronAddr) -> ByteString -> Either SerialiseAsRawBytesError (Address ByronAddr) Source #
SerialiseAsBech32 (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods bech32PrefixFor :: Address ShelleyAddr -> Text Source # bech32PrefixesPermitted :: AsType (Address ShelleyAddr) -> [Text] Source #
SerialiseAddress (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: Address ShelleyAddr -> Text Source # deserialiseAddress :: AsType (Address ShelleyAddr) -> Text -> Maybe (Address ShelleyAddr) Source #
SerialiseAddress (Address ByronAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: Address ByronAddr -> Text Source # deserialiseAddress :: AsType (Address ByronAddr) -> Text -> Maybe (Address ByronAddr) Source #
data AsType (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address data AsType (Address addrtype) = AsAddress (AsType addrtype)

Byron addresses

data ByronAddr Source #

A type used as a tag to distinguish Byron addresses.

Instances

Instances details

HasTypeProxy ByronAddr Source #
Instance details Defined in Cardano.Api.Address Associated Types data AsType ByronAddr Source # Methods proxyToAsType :: Proxy ByronAddr -> AsType ByronAddr Source #
FromJSON (Address ByronAddr) Source #
Instance details Defined in Cardano.Api.Address Methods parseJSON :: Value -> Parser (Address ByronAddr) # parseJSONList :: Value -> Parser [Address ByronAddr] # omittedField :: Maybe (Address ByronAddr) #
ToJSON (Address ByronAddr) Source #
Instance details Defined in Cardano.Api.Address Methods toJSON :: Address ByronAddr -> Value # toEncoding :: Address ByronAddr -> Encoding # toJSONList :: [Address ByronAddr] -> Value # toEncodingList :: [Address ByronAddr] -> Encoding # omitField :: Address ByronAddr -> Bool #
SerialiseAsRawBytes (Address ByronAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseToRawBytes :: Address ByronAddr -> ByteString Source # deserialiseFromRawBytes :: AsType (Address ByronAddr) -> ByteString -> Either SerialiseAsRawBytesError (Address ByronAddr) Source #
SerialiseAddress (Address ByronAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: Address ByronAddr -> Text Source # deserialiseAddress :: AsType (Address ByronAddr) -> Text -> Maybe (Address ByronAddr) Source #
data AsType ByronAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ByronAddr = AsByronAddr

makeByronAddress :: NetworkId -> VerificationKey ByronKey -> Address ByronAddr Source #

Shelley addresses

data ShelleyAddr Source #

A type used as a tag to distinguish Shelley addresses.

Instances

Instances details

HasTypeProxy ShelleyAddr Source #
Instance details Defined in Cardano.Api.Address Associated Types data AsType ShelleyAddr Source # Methods proxyToAsType :: Proxy ShelleyAddr -> AsType ShelleyAddr Source #
FromJSON (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods parseJSON :: Value -> Parser (Address ShelleyAddr) # parseJSONList :: Value -> Parser [Address ShelleyAddr] # omittedField :: Maybe (Address ShelleyAddr) #
ToJSON (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods toJSON :: Address ShelleyAddr -> Value # toEncoding :: Address ShelleyAddr -> Encoding # toJSONList :: [Address ShelleyAddr] -> Value # toEncodingList :: [Address ShelleyAddr] -> Encoding # omitField :: Address ShelleyAddr -> Bool #
SerialiseAsRawBytes (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseToRawBytes :: Address ShelleyAddr -> ByteString Source # deserialiseFromRawBytes :: AsType (Address ShelleyAddr) -> ByteString -> Either SerialiseAsRawBytesError (Address ShelleyAddr) Source #
SerialiseAsBech32 (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods bech32PrefixFor :: Address ShelleyAddr -> Text Source # bech32PrefixesPermitted :: AsType (Address ShelleyAddr) -> [Text] Source #
SerialiseAddress (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: Address ShelleyAddr -> Text Source # deserialiseAddress :: AsType (Address ShelleyAddr) -> Text -> Maybe (Address ShelleyAddr) Source #
data AsType ShelleyAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ShelleyAddr = AsShelleyAddr

makeShelleyAddress :: NetworkId -> PaymentCredential -> StakeAddressReference -> Address ShelleyAddr Source #

data PaymentCredential Source #

Constructors

PaymentCredentialByKey (Hash PaymentKey)
PaymentCredentialByScript ScriptHash

Instances

Instances details

Eq PaymentCredential Source #
Instance details Defined in Cardano.Api.Address Methods (==) :: PaymentCredential -> PaymentCredential -> Bool Source # (/=) :: PaymentCredential -> PaymentCredential -> Bool Source #
Ord PaymentCredential Source #
Instance details Defined in Cardano.Api.Address Methods compare :: PaymentCredential -> PaymentCredential -> Ordering Source # (<) :: PaymentCredential -> PaymentCredential -> Bool Source # (<=) :: PaymentCredential -> PaymentCredential -> Bool Source # (>) :: PaymentCredential -> PaymentCredential -> Bool Source # (>=) :: PaymentCredential -> PaymentCredential -> Bool Source # max :: PaymentCredential -> PaymentCredential -> PaymentCredential Source # min :: PaymentCredential -> PaymentCredential -> PaymentCredential Source #
Show PaymentCredential Source #
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> PaymentCredential -> ShowS Source # show :: PaymentCredential -> String Source # showList :: [PaymentCredential] -> ShowS Source #

data StakeAddressReference Source #

Constructors

StakeAddressByValue StakeCredential
StakeAddressByPointer StakeAddressPointer
NoStakeAddress

Instances

Instances details

Eq StakeAddressReference Source #
Instance details Defined in Cardano.Api.Address Methods (==) :: StakeAddressReference -> StakeAddressReference -> Bool Source # (/=) :: StakeAddressReference -> StakeAddressReference -> Bool Source #
Show StakeAddressReference Source #
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> StakeAddressReference -> ShowS Source # show :: StakeAddressReference -> String Source # showList :: [StakeAddressReference] -> ShowS Source #

newtype StakeAddressPointer Source #

Constructors

StakeAddressPointer
Fields unStakeAddressPointer :: Ptr

Instances

Instances details

Eq StakeAddressPointer Source #
Instance details Defined in Cardano.Api.Address Methods (==) :: StakeAddressPointer -> StakeAddressPointer -> Bool Source # (/=) :: StakeAddressPointer -> StakeAddressPointer -> Bool Source #
Show StakeAddressPointer Source #
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> StakeAddressPointer -> ShowS Source # show :: StakeAddressPointer -> String Source # showList :: [StakeAddressPointer] -> ShowS Source #

Addresses in any era

data AddressAny Source #

Either a Byron address or a Shelley address.

Sometimes we need to be able to work with either of the two types of address (Byron or Shelley addresses), but without reference to an era in which the address will be used. This type serves that purpose.

Constructors

AddressByron !(Address ByronAddr)
AddressShelley !(Address ShelleyAddr)

Instances

Instances details

Eq AddressAny Source #
Instance details Defined in Cardano.Api.Address Methods (==) :: AddressAny -> AddressAny -> Bool Source # (/=) :: AddressAny -> AddressAny -> Bool Source #
Ord AddressAny Source #
Instance details Defined in Cardano.Api.Address Methods compare :: AddressAny -> AddressAny -> Ordering Source # (<) :: AddressAny -> AddressAny -> Bool Source # (<=) :: AddressAny -> AddressAny -> Bool Source # (>) :: AddressAny -> AddressAny -> Bool Source # (>=) :: AddressAny -> AddressAny -> Bool Source # max :: AddressAny -> AddressAny -> AddressAny Source # min :: AddressAny -> AddressAny -> AddressAny Source #
Show AddressAny Source #
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> AddressAny -> ShowS Source # show :: AddressAny -> String Source # showList :: [AddressAny] -> ShowS Source #
HasTypeProxy AddressAny Source #
Instance details Defined in Cardano.Api.Address Associated Types data AsType AddressAny Source # Methods proxyToAsType :: Proxy AddressAny -> AsType AddressAny Source #
SerialiseAsRawBytes AddressAny Source #
Instance details Defined in Cardano.Api.Address Methods serialiseToRawBytes :: AddressAny -> ByteString Source # deserialiseFromRawBytes :: AsType AddressAny -> ByteString -> Either SerialiseAsRawBytesError AddressAny Source #
SerialiseAddress AddressAny Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: AddressAny -> Text Source # deserialiseAddress :: AsType AddressAny -> Text -> Maybe AddressAny Source #
data AsType AddressAny Source #
Instance details Defined in Cardano.Api.Address data AsType AddressAny = AsAddressAny

lexPlausibleAddressString :: Parser Text Source #

parseAddressAny :: Parser AddressAny Source #

Addresses in specific eras

data AddressInEra era where Source #

An Address that can be used in a particular ledger era.

All current ledger eras support Byron addresses. Shelley addresses are supported in the ShelleyEra and later eras.

Constructors

AddressInEra :: AddressTypeInEra addrtype era -> Address addrtype -> AddressInEra era

Instances

Instances details

Eq (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Methods (==) :: AddressInEra era -> AddressInEra era -> Bool Source # (/=) :: AddressInEra era -> AddressInEra era -> Bool Source #
Ord (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Methods compare :: AddressInEra era -> AddressInEra era -> Ordering Source # (<) :: AddressInEra era -> AddressInEra era -> Bool Source # (<=) :: AddressInEra era -> AddressInEra era -> Bool Source # (>) :: AddressInEra era -> AddressInEra era -> Bool Source # (>=) :: AddressInEra era -> AddressInEra era -> Bool Source # max :: AddressInEra era -> AddressInEra era -> AddressInEra era Source # min :: AddressInEra era -> AddressInEra era -> AddressInEra era Source #
Show (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> AddressInEra era -> ShowS Source # show :: AddressInEra era -> String Source # showList :: [AddressInEra era] -> ShowS Source #
NFData (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Methods rnf :: AddressInEra era -> () Source #
IsShelleyBasedEra era => FromJSON (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Methods parseJSON :: Value -> Parser (AddressInEra era) # parseJSONList :: Value -> Parser [AddressInEra era] # omittedField :: Maybe (AddressInEra era) #
IsCardanoEra era => ToJSON (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Methods toJSON :: AddressInEra era -> Value # toEncoding :: AddressInEra era -> Encoding # toJSONList :: [AddressInEra era] -> Value # toEncodingList :: [AddressInEra era] -> Encoding # omitField :: AddressInEra era -> Bool #
HasTypeProxy era => HasTypeProxy (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Associated Types data AsType (AddressInEra era) Source # Methods proxyToAsType :: Proxy (AddressInEra era) -> AsType (AddressInEra era) Source #
IsCardanoEra era => SerialiseAsRawBytes (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseToRawBytes :: AddressInEra era -> ByteString Source # deserialiseFromRawBytes :: AsType (AddressInEra era) -> ByteString -> Either SerialiseAsRawBytesError (AddressInEra era) Source #
IsCardanoEra era => SerialiseAddress (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: AddressInEra era -> Text Source # deserialiseAddress :: AsType (AddressInEra era) -> Text -> Maybe (AddressInEra era) Source #
data AsType (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address data AsType (AddressInEra era) = AsAddressInEra (AsType era)

data AddressTypeInEra addrtype era where Source #

Constructors

ByronAddressInAnyEra :: AddressTypeInEra ByronAddr era
ShelleyAddressInEra :: ShelleyBasedEra era -> AddressTypeInEra ShelleyAddr era

Instances

Instances details

Show (AddressTypeInEra addrtype era) Source #
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> AddressTypeInEra addrtype era -> ShowS Source # show :: AddressTypeInEra addrtype era -> String Source # showList :: [AddressTypeInEra addrtype era] -> ShowS Source #
NFData (AddressTypeInEra addrtype era) Source #
Instance details Defined in Cardano.Api.Address Methods rnf :: AddressTypeInEra addrtype era -> () Source #

byronAddressInEra :: Address ByronAddr -> AddressInEra era Source #

shelleyAddressInEra :: ShelleyBasedEra era -> Address ShelleyAddr -> AddressInEra era Source #

anyAddressInShelleyBasedEra :: ShelleyBasedEra era -> AddressAny -> AddressInEra era Source #

anyAddressInEra :: CardanoEra era -> AddressAny -> Either String (AddressInEra era) Source #

toAddressAny :: Address addr -> AddressAny Source #

makeByronAddressInEra :: NetworkId -> VerificationKey ByronKey -> AddressInEra era Source #

makeShelleyAddressInEra :: ShelleyBasedEra era -> NetworkId -> PaymentCredential -> StakeAddressReference -> AddressInEra era Source #

Stake addresses

Constructing and inspecting stake addresses

data StakeAddress where Source #

Constructors

StakeAddress :: Network -> StakeCredential StandardCrypto -> StakeAddress

Instances

Instances details

Eq StakeAddress Source #
Instance details Defined in Cardano.Api.Address Methods (==) :: StakeAddress -> StakeAddress -> Bool Source # (/=) :: StakeAddress -> StakeAddress -> Bool Source #
Ord StakeAddress Source #
Instance details Defined in Cardano.Api.Address Methods compare :: StakeAddress -> StakeAddress -> Ordering Source # (<) :: StakeAddress -> StakeAddress -> Bool Source # (<=) :: StakeAddress -> StakeAddress -> Bool Source # (>) :: StakeAddress -> StakeAddress -> Bool Source # (>=) :: StakeAddress -> StakeAddress -> Bool Source # max :: StakeAddress -> StakeAddress -> StakeAddress Source # min :: StakeAddress -> StakeAddress -> StakeAddress Source #
Show StakeAddress Source #
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> StakeAddress -> ShowS Source # show :: StakeAddress -> String Source # showList :: [StakeAddress] -> ShowS Source #
FromJSON StakeAddress Source #
Instance details Defined in Cardano.Api.Address Methods parseJSON :: Value -> Parser StakeAddress # parseJSONList :: Value -> Parser [StakeAddress] # omittedField :: Maybe StakeAddress #
ToJSON StakeAddress Source #
Instance details Defined in Cardano.Api.Address Methods toJSON :: StakeAddress -> Value # toEncoding :: StakeAddress -> Encoding # toJSONList :: [StakeAddress] -> Value # toEncodingList :: [StakeAddress] -> Encoding # omitField :: StakeAddress -> Bool #
HasTypeProxy StakeAddress Source #
Instance details Defined in Cardano.Api.Address Associated Types data AsType StakeAddress Source # Methods proxyToAsType :: Proxy StakeAddress -> AsType StakeAddress Source #
SerialiseAsRawBytes StakeAddress Source #
Instance details Defined in Cardano.Api.Address Methods serialiseToRawBytes :: StakeAddress -> ByteString Source # deserialiseFromRawBytes :: AsType StakeAddress -> ByteString -> Either SerialiseAsRawBytesError StakeAddress Source #
SerialiseAsBech32 StakeAddress Source #
Instance details Defined in Cardano.Api.Address Methods bech32PrefixFor :: StakeAddress -> Text Source # bech32PrefixesPermitted :: AsType StakeAddress -> [Text] Source #
SerialiseAddress StakeAddress Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: StakeAddress -> Text Source # deserialiseAddress :: AsType StakeAddress -> Text -> Maybe StakeAddress Source #
data AsType StakeAddress Source #
Instance details Defined in Cardano.Api.Address data AsType StakeAddress = AsStakeAddress

data StakeCredential Source #

Constructors

StakeCredentialByKey (Hash StakeKey)
StakeCredentialByScript ScriptHash

Instances

Instances details

Eq StakeCredential Source #
Instance details Defined in Cardano.Api.Address Methods (==) :: StakeCredential -> StakeCredential -> Bool Source # (/=) :: StakeCredential -> StakeCredential -> Bool Source #
Ord StakeCredential Source #
Instance details Defined in Cardano.Api.Address Methods compare :: StakeCredential -> StakeCredential -> Ordering Source # (<) :: StakeCredential -> StakeCredential -> Bool Source # (<=) :: StakeCredential -> StakeCredential -> Bool Source # (>) :: StakeCredential -> StakeCredential -> Bool Source # (>=) :: StakeCredential -> StakeCredential -> Bool Source # max :: StakeCredential -> StakeCredential -> StakeCredential Source # min :: StakeCredential -> StakeCredential -> StakeCredential Source #
Show StakeCredential Source #
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> StakeCredential -> ShowS Source # show :: StakeCredential -> String Source # showList :: [StakeCredential] -> ShowS Source #
ToJSON StakeCredential Source #
Instance details Defined in Cardano.Api.Address Methods toJSON :: StakeCredential -> Value # toEncoding :: StakeCredential -> Encoding # toJSONList :: [StakeCredential] -> Value # toEncodingList :: [StakeCredential] -> Encoding # omitField :: StakeCredential -> Bool #

makeStakeAddress :: NetworkId -> StakeCredential -> StakeAddress Source #

stakeAddressCredential :: StakeAddress -> StakeCredential Source #

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

data StakeKey Source #

Instances

Instances details

HasTypeProxy StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley Associated Types data AsType StakeKey Source # Methods proxyToAsType :: Proxy StakeKey -> AsType StakeKey Source #
Key StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley Associated Types data VerificationKey StakeKey Source # data SigningKey StakeKey Source # Methods getVerificationKey :: SigningKey StakeKey -> VerificationKey StakeKey Source # deterministicSigningKey :: AsType StakeKey -> Seed -> SigningKey StakeKey Source # deterministicSigningKeySeedSize :: AsType StakeKey -> Word Source # verificationKeyHash :: VerificationKey StakeKey -> Hash StakeKey Source #
CastVerificationKeyRole StakePoolKey StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods castVerificationKey :: VerificationKey StakePoolKey -> VerificationKey StakeKey Source #
CastVerificationKeyRole StakeExtendedKey StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods castVerificationKey :: VerificationKey StakeExtendedKey -> VerificationKey StakeKey Source #
Eq (Hash StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods (==) :: Hash StakeKey -> Hash StakeKey -> Bool Source # (/=) :: Hash StakeKey -> Hash StakeKey -> Bool Source #
Eq (VerificationKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods (==) :: VerificationKey StakeKey -> VerificationKey StakeKey -> Bool Source # (/=) :: VerificationKey StakeKey -> VerificationKey StakeKey -> Bool Source #
Ord (Hash StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods compare :: Hash StakeKey -> Hash StakeKey -> Ordering Source # (<) :: Hash StakeKey -> Hash StakeKey -> Bool Source # (<=) :: Hash StakeKey -> Hash StakeKey -> Bool Source # (>) :: Hash StakeKey -> Hash StakeKey -> Bool Source # (>=) :: Hash StakeKey -> Hash StakeKey -> Bool Source # max :: Hash StakeKey -> Hash StakeKey -> Hash StakeKey Source # min :: Hash StakeKey -> Hash StakeKey -> Hash StakeKey Source #
Show (Hash StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods showsPrec :: Int -> Hash StakeKey -> ShowS Source # show :: Hash StakeKey -> String Source # showList :: [Hash StakeKey] -> ShowS Source #
Show (VerificationKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods showsPrec :: Int -> VerificationKey StakeKey -> ShowS Source # show :: VerificationKey StakeKey -> String Source # showList :: [VerificationKey StakeKey] -> ShowS Source #
Show (SigningKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods showsPrec :: Int -> SigningKey StakeKey -> ShowS Source # show :: SigningKey StakeKey -> String Source # showList :: [SigningKey StakeKey] -> ShowS Source #
IsString (Hash StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromString :: String -> Hash StakeKey Source #
IsString (VerificationKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromString :: String -> VerificationKey StakeKey Source #
IsString (SigningKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromString :: String -> SigningKey StakeKey Source #
FromCBOR (Hash StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromCBOR :: Decoder s (Hash StakeKey) # label :: Proxy (Hash StakeKey) -> Text #
FromCBOR (VerificationKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromCBOR :: Decoder s (VerificationKey StakeKey) # label :: Proxy (VerificationKey StakeKey) -> Text #
FromCBOR (SigningKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromCBOR :: Decoder s (SigningKey StakeKey) # label :: Proxy (SigningKey StakeKey) -> Text #
ToCBOR (Hash StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods toCBOR :: Hash StakeKey -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (Hash StakeKey) -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [Hash StakeKey] -> Size #
ToCBOR (VerificationKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods toCBOR :: VerificationKey StakeKey -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (VerificationKey StakeKey) -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [VerificationKey StakeKey] -> Size #
ToCBOR (SigningKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods toCBOR :: SigningKey StakeKey -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (SigningKey StakeKey) -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SigningKey StakeKey] -> Size #
SerialiseAsCBOR (Hash StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToCBOR :: Hash StakeKey -> ByteString Source # deserialiseFromCBOR :: AsType (Hash StakeKey) -> ByteString -> Either DecoderError (Hash StakeKey) Source #
SerialiseAsCBOR (VerificationKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToCBOR :: VerificationKey StakeKey -> ByteString Source # deserialiseFromCBOR :: AsType (VerificationKey StakeKey) -> ByteString -> Either DecoderError (VerificationKey StakeKey) Source #
SerialiseAsCBOR (SigningKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToCBOR :: SigningKey StakeKey -> ByteString Source # deserialiseFromCBOR :: AsType (SigningKey StakeKey) -> ByteString -> Either DecoderError (SigningKey StakeKey) Source #
SerialiseAsRawBytes (Hash StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToRawBytes :: Hash StakeKey -> ByteString Source # deserialiseFromRawBytes :: AsType (Hash StakeKey) -> ByteString -> Either SerialiseAsRawBytesError (Hash StakeKey) Source #
SerialiseAsRawBytes (VerificationKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToRawBytes :: VerificationKey StakeKey -> ByteString Source # deserialiseFromRawBytes :: AsType (VerificationKey StakeKey) -> ByteString -> Either SerialiseAsRawBytesError (VerificationKey StakeKey) Source #
SerialiseAsRawBytes (SigningKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToRawBytes :: SigningKey StakeKey -> ByteString Source # deserialiseFromRawBytes :: AsType (SigningKey StakeKey) -> ByteString -> Either SerialiseAsRawBytesError (SigningKey StakeKey) Source #
SerialiseAsBech32 (VerificationKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods bech32PrefixFor :: VerificationKey StakeKey -> Text Source # bech32PrefixesPermitted :: AsType (VerificationKey StakeKey) -> [Text] Source #
SerialiseAsBech32 (SigningKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods bech32PrefixFor :: SigningKey StakeKey -> Text Source # bech32PrefixesPermitted :: AsType (SigningKey StakeKey) -> [Text] Source #
HasTextEnvelope (VerificationKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods textEnvelopeType :: AsType (VerificationKey StakeKey) -> TextEnvelopeType Source # textEnvelopeDefaultDescr :: VerificationKey StakeKey -> TextEnvelopeDescr Source #
HasTextEnvelope (SigningKey StakeKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods textEnvelopeType :: AsType (SigningKey StakeKey) -> TextEnvelopeType Source # textEnvelopeDefaultDescr :: SigningKey StakeKey -> TextEnvelopeDescr Source #
data AsType StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeKey = AsStakeKey
newtype Hash StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley newtype Hash StakeKey = StakeKeyHash (KeyHash 'Staking StandardCrypto)
newtype VerificationKey StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley newtype VerificationKey StakeKey = StakeVerificationKey { unStakeVerificationKey :: VKey 'Staking StandardCrypto }
newtype SigningKey StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley newtype SigningKey StakeKey = StakeSigningKey (SignKeyDSIGN StandardCrypto)

data StakeExtendedKey Source #

Shelley-era stake keys using extended ed25519 cryptographic keys.

They can be used for Shelley stake addresses and witnessing transactions that use stake addresses.

These extended keys are used by HD wallets. So this type provides interoperability with HD wallets. The ITN CLI also supported this key type.

The extended verification keys can be converted (via castVerificationKey) to ordinary keys (i.e. VerificationKey StakeKey) but this is not the case for the signing keys. The signing keys can be used to witness transactions directly, with verification via their non-extended verification key (VerificationKey StakeKey).

This is a type level tag, used with other interfaces like Key.

Instances

Instances details

HasTypeProxy StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley Associated Types data AsType StakeExtendedKey Source # Methods proxyToAsType :: Proxy StakeExtendedKey -> AsType StakeExtendedKey Source #
Key StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley Associated Types data VerificationKey StakeExtendedKey Source # data SigningKey StakeExtendedKey Source # Methods getVerificationKey :: SigningKey StakeExtendedKey -> VerificationKey StakeExtendedKey Source # deterministicSigningKey :: AsType StakeExtendedKey -> Seed -> SigningKey StakeExtendedKey Source # deterministicSigningKeySeedSize :: AsType StakeExtendedKey -> Word Source # verificationKeyHash :: VerificationKey StakeExtendedKey -> Hash StakeExtendedKey Source #
CastVerificationKeyRole StakeExtendedKey StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods castVerificationKey :: VerificationKey StakeExtendedKey -> VerificationKey StakeKey Source #
Eq (Hash StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods (==) :: Hash StakeExtendedKey -> Hash StakeExtendedKey -> Bool Source # (/=) :: Hash StakeExtendedKey -> Hash StakeExtendedKey -> Bool Source #
Eq (VerificationKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods (==) :: VerificationKey StakeExtendedKey -> VerificationKey StakeExtendedKey -> Bool Source # (/=) :: VerificationKey StakeExtendedKey -> VerificationKey StakeExtendedKey -> Bool Source #
Ord (Hash StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods compare :: Hash StakeExtendedKey -> Hash StakeExtendedKey -> Ordering Source # (<) :: Hash StakeExtendedKey -> Hash StakeExtendedKey -> Bool Source # (<=) :: Hash StakeExtendedKey -> Hash StakeExtendedKey -> Bool Source # (>) :: Hash StakeExtendedKey -> Hash StakeExtendedKey -> Bool Source # (>=) :: Hash StakeExtendedKey -> Hash StakeExtendedKey -> Bool Source # max :: Hash StakeExtendedKey -> Hash StakeExtendedKey -> Hash StakeExtendedKey Source # min :: Hash StakeExtendedKey -> Hash StakeExtendedKey -> Hash StakeExtendedKey Source #
Show (Hash StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods showsPrec :: Int -> Hash StakeExtendedKey -> ShowS Source # show :: Hash StakeExtendedKey -> String Source # showList :: [Hash StakeExtendedKey] -> ShowS Source #
Show (VerificationKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods showsPrec :: Int -> VerificationKey StakeExtendedKey -> ShowS Source # show :: VerificationKey StakeExtendedKey -> String Source # showList :: [VerificationKey StakeExtendedKey] -> ShowS Source #
Show (SigningKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods showsPrec :: Int -> SigningKey StakeExtendedKey -> ShowS Source # show :: SigningKey StakeExtendedKey -> String Source # showList :: [SigningKey StakeExtendedKey] -> ShowS Source #
IsString (Hash StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromString :: String -> Hash StakeExtendedKey Source #
IsString (VerificationKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromString :: String -> VerificationKey StakeExtendedKey Source #
IsString (SigningKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromString :: String -> SigningKey StakeExtendedKey Source #
FromCBOR (Hash StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromCBOR :: Decoder s (Hash StakeExtendedKey) # label :: Proxy (Hash StakeExtendedKey) -> Text #
FromCBOR (VerificationKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromCBOR :: Decoder s (VerificationKey StakeExtendedKey) # label :: Proxy (VerificationKey StakeExtendedKey) -> Text #
FromCBOR (SigningKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods fromCBOR :: Decoder s (SigningKey StakeExtendedKey) # label :: Proxy (SigningKey StakeExtendedKey) -> Text #
ToCBOR (Hash StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods toCBOR :: Hash StakeExtendedKey -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (Hash StakeExtendedKey) -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [Hash StakeExtendedKey] -> Size #
ToCBOR (VerificationKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods toCBOR :: VerificationKey StakeExtendedKey -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (VerificationKey StakeExtendedKey) -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [VerificationKey StakeExtendedKey] -> Size #
ToCBOR (SigningKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods toCBOR :: SigningKey StakeExtendedKey -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (SigningKey StakeExtendedKey) -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SigningKey StakeExtendedKey] -> Size #
SerialiseAsCBOR (Hash StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToCBOR :: Hash StakeExtendedKey -> ByteString Source # deserialiseFromCBOR :: AsType (Hash StakeExtendedKey) -> ByteString -> Either DecoderError (Hash StakeExtendedKey) Source #
SerialiseAsCBOR (VerificationKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToCBOR :: VerificationKey StakeExtendedKey -> ByteString Source # deserialiseFromCBOR :: AsType (VerificationKey StakeExtendedKey) -> ByteString -> Either DecoderError (VerificationKey StakeExtendedKey) Source #
SerialiseAsCBOR (SigningKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToCBOR :: SigningKey StakeExtendedKey -> ByteString Source # deserialiseFromCBOR :: AsType (SigningKey StakeExtendedKey) -> ByteString -> Either DecoderError (SigningKey StakeExtendedKey) Source #
SerialiseAsRawBytes (Hash StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToRawBytes :: Hash StakeExtendedKey -> ByteString Source # deserialiseFromRawBytes :: AsType (Hash StakeExtendedKey) -> ByteString -> Either SerialiseAsRawBytesError (Hash StakeExtendedKey) Source #
SerialiseAsRawBytes (VerificationKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToRawBytes :: VerificationKey StakeExtendedKey -> ByteString Source # deserialiseFromRawBytes :: AsType (VerificationKey StakeExtendedKey) -> ByteString -> Either SerialiseAsRawBytesError (VerificationKey StakeExtendedKey) Source #
SerialiseAsRawBytes (SigningKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods serialiseToRawBytes :: SigningKey StakeExtendedKey -> ByteString Source # deserialiseFromRawBytes :: AsType (SigningKey StakeExtendedKey) -> ByteString -> Either SerialiseAsRawBytesError (SigningKey StakeExtendedKey) Source #
SerialiseAsBech32 (VerificationKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods bech32PrefixFor :: VerificationKey StakeExtendedKey -> Text Source # bech32PrefixesPermitted :: AsType (VerificationKey StakeExtendedKey) -> [Text] Source #
SerialiseAsBech32 (SigningKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods bech32PrefixFor :: SigningKey StakeExtendedKey -> Text Source # bech32PrefixesPermitted :: AsType (SigningKey StakeExtendedKey) -> [Text] Source #
HasTextEnvelope (VerificationKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods textEnvelopeType :: AsType (VerificationKey StakeExtendedKey) -> TextEnvelopeType Source # textEnvelopeDefaultDescr :: VerificationKey StakeExtendedKey -> TextEnvelopeDescr Source #
HasTextEnvelope (SigningKey StakeExtendedKey) Source #
Instance details Defined in Cardano.Api.Keys.Shelley Methods textEnvelopeType :: AsType (SigningKey StakeExtendedKey) -> TextEnvelopeType Source # textEnvelopeDefaultDescr :: SigningKey StakeExtendedKey -> TextEnvelopeDescr Source #
data AsType StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeExtendedKey = AsStakeExtendedKey
newtype Hash StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley newtype Hash StakeExtendedKey = StakeExtendedKeyHash (KeyHash 'Staking StandardCrypto)
newtype VerificationKey StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley newtype VerificationKey StakeExtendedKey = StakeExtendedVerificationKey XPub
newtype SigningKey StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley newtype SigningKey StakeExtendedKey = StakeExtendedSigningKey XPrv

Conversion functions

shelleyPayAddrToPlutusPubKHash :: Address ShelleyAddr -> Maybe PubKeyHash Source #

Converts a Shelley payment address to a Plutus public key hash.

Internal conversion functions

toShelleyAddr :: AddressInEra era -> Addr StandardCrypto Source #

toShelleyStakeAddr :: StakeAddress -> RewardAcnt StandardCrypto Source #

toShelleyStakeCredential :: StakeCredential -> StakeCredential StandardCrypto Source #

fromShelleyAddr :: ShelleyBasedEra era -> Addr StandardCrypto -> AddressInEra era Source #

fromShelleyAddrIsSbe :: ShelleyBasedEra era -> Addr StandardCrypto -> AddressInEra era Source #

fromShelleyAddrToAny :: Addr StandardCrypto -> AddressAny Source #

fromShelleyPaymentCredential :: PaymentCredential StandardCrypto -> PaymentCredential Source #

fromShelleyStakeAddr :: RewardAcnt StandardCrypto -> StakeAddress Source #

fromShelleyStakeCredential :: StakeCredential StandardCrypto -> StakeCredential Source #

fromShelleyStakeReference :: StakeReference StandardCrypto -> StakeAddressReference Source #

Serialising addresses

class HasTypeProxy addr => SerialiseAddress addr where Source #

Address serialisation uses different serialisation formats for different kinds of addresses, so it needs its own class.

In particular, Byron addresses are typically formatted in base 58, while Shelley addresses (payment and stake) are formatted using Bech32.

Methods

serialiseAddress :: addr -> Text Source #

deserialiseAddress :: AsType addr -> Text -> Maybe addr Source #

Instances

Instances details

SerialiseAddress StakeAddress Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: StakeAddress -> Text Source # deserialiseAddress :: AsType StakeAddress -> Text -> Maybe StakeAddress Source #
SerialiseAddress AddressAny Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: AddressAny -> Text Source # deserialiseAddress :: AsType AddressAny -> Text -> Maybe AddressAny Source #
IsCardanoEra era => SerialiseAddress (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: AddressInEra era -> Text Source # deserialiseAddress :: AsType (AddressInEra era) -> Text -> Maybe (AddressInEra era) Source #
SerialiseAddress (Address ShelleyAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: Address ShelleyAddr -> Text Source # deserialiseAddress :: AsType (Address ShelleyAddr) -> Text -> Maybe (Address ShelleyAddr) Source #
SerialiseAddress (Address ByronAddr) Source #
Instance details Defined in Cardano.Api.Address Methods serialiseAddress :: Address ByronAddr -> Text Source # deserialiseAddress :: AsType (Address ByronAddr) -> Text -> Maybe (Address ByronAddr) Source #

Data family instances

data family AsType t Source #

A family of singleton types used in this API to indicate which type to use where it would otherwise be ambiguous or merely unclear.

Values of this type are passed to deserialisation functions for example.

Instances

Instances details

data AsType ConwayEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ConwayEra = AsConwayEra
data AsType BabbageEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType BabbageEra = AsBabbageEra
data AsType AlonzoEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType AlonzoEra = AsAlonzoEra
data AsType MaryEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType MaryEra = AsMaryEra
data AsType AllegraEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType AllegraEra = AsAllegraEra
data AsType ShelleyEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ShelleyEra = AsShelleyEra
data AsType ByronEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ByronEra = AsByronEra
data AsType TxId Source #
Instance details Defined in Cardano.Api.TxIn data AsType TxId = AsTxId
data AsType TxMetadata Source #
Instance details Defined in Cardano.Api.TxMetadata data AsType TxMetadata = AsTxMetadata
data AsType TextEnvelope Source #
Instance details Defined in Cardano.Api.SerialiseTextEnvelope data AsType TextEnvelope = AsTextEnvelope
data AsType DRepExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepExtendedKey = AsDRepExtendedKey
data AsType DRepKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepKey = AsDRepKey
data AsType StakePoolKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakePoolKey = AsStakePoolKey
data AsType GenesisUTxOKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisUTxOKey = AsGenesisUTxOKey
data AsType GenesisDelegateExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateExtendedKey = AsGenesisDelegateExtendedKey
data AsType GenesisDelegateKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateKey = AsGenesisDelegateKey
data AsType GenesisExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisExtendedKey = AsGenesisExtendedKey
data AsType CommitteeColdKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeColdKey = AsCommitteeColdKey
data AsType CommitteeHotKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeHotKey = AsCommitteeHotKey
data AsType GenesisKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisKey = AsGenesisKey
data AsType StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeExtendedKey = AsStakeExtendedKey
data AsType StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeKey = AsStakeKey
data AsType PaymentExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentExtendedKey = AsPaymentExtendedKey
data AsType PaymentKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentKey = AsPaymentKey
data AsType VrfKey Source #
Instance details Defined in Cardano.Api.Keys.Praos data AsType VrfKey = AsVrfKey
data AsType KesKey Source #
Instance details Defined in Cardano.Api.Keys.Praos data AsType KesKey = AsKesKey
data AsType ByronKeyLegacy Source #
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKeyLegacy = AsByronKeyLegacy
data AsType ByronKey Source #
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKey = AsByronKey
data AsType ByronVote Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronVote = AsByronVote
data AsType ByronUpdateProposal Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronUpdateProposal = AsByronUpdateProposal
data AsType ScriptData Source #
Instance details Defined in Cardano.Api.ScriptData data AsType ScriptData = AsScriptData
data AsType HashableScriptData Source #
Instance details Defined in Cardano.Api.ScriptData data AsType HashableScriptData = AsHashableScriptData
data AsType ScriptHash Source #
Instance details Defined in Cardano.Api.Script data AsType ScriptHash = AsScriptHash
data AsType ScriptInAnyLang Source #
Instance details Defined in Cardano.Api.Script data AsType ScriptInAnyLang = AsScriptInAnyLang
data AsType PlutusScriptV3 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV3 = AsPlutusScriptV3
data AsType PlutusScriptV2 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV2 = AsPlutusScriptV2
data AsType PlutusScriptV1 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV1 = AsPlutusScriptV1
data AsType SimpleScript' Source #
Instance details Defined in Cardano.Api.Script data AsType SimpleScript' = AsSimpleScript
data AsType AssetName Source #
Instance details Defined in Cardano.Api.Value data AsType AssetName = AsAssetName
data AsType PolicyId Source #
Instance details Defined in Cardano.Api.Value data AsType PolicyId = AsPolicyId
data AsType StakePoolMetadata Source #
Instance details Defined in Cardano.Api.StakePoolMetadata data AsType StakePoolMetadata = AsStakePoolMetadata
data AsType DRepMetadata Source #
Instance details Defined in Cardano.Api.DRepMetadata data AsType DRepMetadata = AsDRepMetadata
data AsType StakeAddress Source #
Instance details Defined in Cardano.Api.Address data AsType StakeAddress = AsStakeAddress
data AsType AddressAny Source #
Instance details Defined in Cardano.Api.Address data AsType AddressAny = AsAddressAny
data AsType ShelleyAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ShelleyAddr = AsShelleyAddr
data AsType ByronAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ByronAddr = AsByronAddr
data AsType UpdateProposal Source #
Instance details Defined in Cardano.Api.ProtocolParameters data AsType UpdateProposal = AsUpdateProposal
data AsType PraosNonce Source #
Instance details Defined in Cardano.Api.ProtocolParameters data AsType PraosNonce = AsPraosNonce
data AsType GovernancePollAnswer Source #
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePollAnswer = AsGovernancePollAnswer
data AsType GovernancePoll Source #
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePoll = AsGovernancePoll
data AsType BlockHeader Source #
Instance details Defined in Cardano.Api.Block data AsType BlockHeader = AsBlockHeader
data AsType OperationalCertificateIssueCounter Source #
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificateIssueCounter = AsOperationalCertificateIssueCounter
data AsType OperationalCertificate Source #
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificate = AsOperationalCertificate
data AsType (Hash a) Source #
Instance details Defined in Cardano.Api.Hash data AsType (Hash a) = AsHash (AsType a)
data AsType (VerificationKey a) Source #
Instance details Defined in Cardano.Api.Keys.Class data AsType (VerificationKey a) = AsVerificationKey (AsType a)
data AsType (SigningKey a) Source #
Instance details Defined in Cardano.Api.Keys.Class data AsType (SigningKey a) = AsSigningKey (AsType a)
data AsType (PlutusScript lang) Source #
Instance details Defined in Cardano.Api.Script data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)
data AsType (ScriptInEra era) Source #
Instance details Defined in Cardano.Api.Script data AsType (ScriptInEra era) = AsScriptInEra (AsType era)
data AsType (Script lang) Source #
Instance details Defined in Cardano.Api.Script data AsType (Script lang) = AsScript (AsType lang)
data AsType (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address data AsType (AddressInEra era) = AsAddressInEra (AsType era)
data AsType (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (Proposal era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.ProposalProcedure data AsType (Proposal era) = AsProposal
data AsType (VotingProcedures era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedures era) = AsVotingProcedures
data AsType (VotingProcedure era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedure era) = AsVote
data AsType (Certificate era) Source #
Instance details Defined in Cardano.Api.Certificate data AsType (Certificate era) = AsCertificate
data AsType (TxBody era) Source #
Instance details Defined in Cardano.Api.TxBody data AsType (TxBody era) = AsTxBody (AsType era)
data AsType (KeyWitness era) Source #
Instance details Defined in Cardano.Api.Tx data AsType (KeyWitness era) = AsKeyWitness (AsType era)
data AsType (Tx era) Source #
Instance details Defined in Cardano.Api.Tx data AsType (Tx era) = AsTx (AsType era)

Helpers

isKeyAddress :: AddressInEra era -> Bool Source #

Is the UTxO at the address only spendable via a key witness.