cardano-api:internal
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.Address

Description

Cardano addresses: payment and stake addresses.

Synopsis

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
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) #

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 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 #

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 #

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 #

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 #

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 #

HasTypeProxy addrtype => HasTypeProxy (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType (Address addrtype) 
Instance details

Defined in Cardano.Api.Address

data AsType (Address addrtype) = AsAddress (AsType addrtype)

Methods

proxyToAsType :: Proxy (Address addrtype) -> AsType (Address addrtype) Source #

SerialiseAsBech32 (Address ShelleyAddr) Source # 
Instance details

Defined in Cardano.Api.Address

Methods

bech32PrefixFor :: Address ShelleyAddr -> Text Source #

bech32PrefixesPermitted :: AsType (Address ShelleyAddr) -> [Text] 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 #

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 #

NFData (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

Methods

rnf :: Address addrtype -> () Source #

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 #

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 
Instance details

Defined in Cardano.Api.Address

data AsType ByronAddr = AsByronAddr

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 #

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 #

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 #

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 
Instance details

Defined in Cardano.Api.Address

data AsType ShelleyAddr = AsShelleyAddr

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 #

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 #

SerialiseAsBech32 (Address ShelleyAddr) Source # 
Instance details

Defined in Cardano.Api.Address

Methods

bech32PrefixFor :: Address ShelleyAddr -> Text Source #

bech32PrefixesPermitted :: AsType (Address ShelleyAddr) -> [Text] 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 #

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
Show PaymentCredential Source # 
Instance details

Defined in Cardano.Api.Address

Methods

showsPrec :: Int -> PaymentCredential -> ShowS Source #

show :: PaymentCredential -> String Source #

showList :: [PaymentCredential] -> ShowS Source #

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 #

data StakeAddressReference Source #

Constructors

StakeAddressByValue StakeCredential 
StakeAddressByPointer StakeAddressPointer 
NoStakeAddress 

Instances

Instances details
Show StakeAddressReference Source # 
Instance details

Defined in Cardano.Api.Address

Methods

showsPrec :: Int -> StakeAddressReference -> ShowS Source #

show :: StakeAddressReference -> String Source #

showList :: [StakeAddressReference] -> ShowS Source #

Eq StakeAddressReference Source # 
Instance details

Defined in Cardano.Api.Address

Methods

(==) :: StakeAddressReference -> StakeAddressReference -> Bool Source #

(/=) :: StakeAddressReference -> StakeAddressReference -> Bool Source #

newtype StakeAddressPointer Source #

Constructors

StakeAddressPointer 

Fields

Instances

Instances details
Show StakeAddressPointer Source # 
Instance details

Defined in Cardano.Api.Address

Methods

showsPrec :: Int -> StakeAddressPointer -> ShowS Source #

show :: StakeAddressPointer -> String Source #

showList :: [StakeAddressPointer] -> ShowS Source #

Eq StakeAddressPointer Source # 
Instance details

Defined in Cardano.Api.Address

Methods

(==) :: StakeAddressPointer -> StakeAddressPointer -> Bool Source #

(/=) :: StakeAddressPointer -> StakeAddressPointer -> Bool 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
Show AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

Methods

showsPrec :: Int -> AddressAny -> ShowS Source #

show :: AddressAny -> String Source #

showList :: [AddressAny] -> ShowS Source #

SerialiseAddress AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

Methods

serialiseAddress :: AddressAny -> Text Source #

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

HasTypeProxy AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType AddressAny 
Instance details

Defined in Cardano.Api.Address

data AsType AddressAny = AsAddressAny

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 #

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 #

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 :: forall addrtype era. AddressTypeInEra addrtype era -> Address addrtype -> AddressInEra era 

Instances

Instances details
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 #

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 #

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 #

HasTypeProxy era => HasTypeProxy (AddressInEra era) Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType (AddressInEra era) 
Instance details

Defined in Cardano.Api.Address

data AsType (AddressInEra era) = AsAddressInEra (AsType era)

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 #

NFData (AddressInEra era) Source # 
Instance details

Defined in Cardano.Api.Address

Methods

rnf :: AddressInEra era -> () Source #

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 #

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 :: forall era. AddressTypeInEra ByronAddr era 
ShelleyAddressInEra :: forall era. 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
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 #

Show StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Methods

showsPrec :: Int -> StakeAddress -> ShowS Source #

show :: StakeAddress -> String Source #

showList :: [StakeAddress] -> ShowS Source #

SerialiseAddress StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Methods

serialiseAddress :: StakeAddress -> Text Source #

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

HasTypeProxy StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType StakeAddress 
Instance details

Defined in Cardano.Api.Address

data AsType StakeAddress = AsStakeAddress

Methods

proxyToAsType :: Proxy StakeAddress -> AsType StakeAddress Source #

SerialiseAsBech32 StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Methods

bech32PrefixFor :: StakeAddress -> Text Source #

bech32PrefixesPermitted :: AsType StakeAddress -> [Text] Source #

SerialiseAsRawBytes StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Methods

serialiseToRawBytes :: StakeAddress -> ByteString Source #

deserialiseFromRawBytes :: AsType StakeAddress -> ByteString -> Either SerialiseAsRawBytesError StakeAddress Source #

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 #

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
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 #

Show StakeCredential Source # 
Instance details

Defined in Cardano.Api.Address

Methods

showsPrec :: Int -> StakeCredential -> ShowS Source #

show :: StakeCredential -> String Source #

showList :: [StakeCredential] -> ShowS Source #

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 #

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 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType StakeKey = AsStakeKey

Methods

proxyToAsType :: Proxy StakeKey -> AsType StakeKey Source #

Key StakeKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Associated Types

newtype VerificationKey StakeKey 
Instance details

Defined in Cardano.Api.Keys.Shelley

newtype VerificationKey StakeKey = StakeVerificationKey {}
newtype SigningKey StakeKey 
Instance details

Defined in Cardano.Api.Keys.Shelley

newtype SigningKey StakeKey = StakeSigningKey (SignKeyDSIGN StandardCrypto)

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 StakeExtendedKey StakeKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

castVerificationKey :: VerificationKey StakeExtendedKey -> VerificationKey StakeKey Source #

CastVerificationKeyRole StakePoolKey StakeKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

castVerificationKey :: VerificationKey StakePoolKey -> VerificationKey StakeKey Source #

IsString (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromString :: String -> Hash StakeKey Source #

IsString (SigningKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromString :: String -> SigningKey StakeKey Source #

IsString (VerificationKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromString :: String -> VerificationKey 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 (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 #

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 #

SerialiseAsBech32 (SigningKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

bech32PrefixFor :: SigningKey StakeKey -> Text Source #

bech32PrefixesPermitted :: AsType (SigningKey StakeKey) -> [Text] 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 #

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 (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 #

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 #

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 (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 #

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 #

HasTextEnvelope (SigningKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

textEnvelopeType :: AsType (SigningKey StakeKey) -> TextEnvelopeType Source #

textEnvelopeDefaultDescr :: SigningKey StakeKey -> TextEnvelopeDescr 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 #

FromCBOR (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromCBOR :: Decoder s (Hash StakeKey) Source #

label :: Proxy (Hash StakeKey) -> Text Source #

FromCBOR (SigningKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromCBOR :: Decoder s (SigningKey StakeKey) Source #

label :: Proxy (SigningKey StakeKey) -> Text Source #

FromCBOR (VerificationKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromCBOR :: Decoder s (VerificationKey StakeKey) Source #

label :: Proxy (VerificationKey StakeKey) -> Text Source #

ToCBOR (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

toCBOR :: Hash StakeKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (Hash StakeKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [Hash StakeKey] -> Size Source #

ToCBOR (SigningKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

toCBOR :: SigningKey StakeKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (SigningKey StakeKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SigningKey StakeKey] -> Size Source #

ToCBOR (VerificationKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

toCBOR :: VerificationKey StakeKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (VerificationKey StakeKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [VerificationKey StakeKey] -> Size 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 #

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 {}
newtype SigningKey StakeKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

newtype SigningKey StakeKey = StakeSigningKey (SignKeyDSIGN StandardCrypto)
newtype VerificationKey StakeKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

newtype VerificationKey StakeKey = StakeVerificationKey {}

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 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType StakeExtendedKey = AsStakeExtendedKey

Methods

proxyToAsType :: Proxy StakeExtendedKey -> AsType StakeExtendedKey Source #

Key StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Associated Types

newtype VerificationKey StakeExtendedKey 
Instance details

Defined in Cardano.Api.Keys.Shelley

newtype VerificationKey StakeExtendedKey = StakeExtendedVerificationKey XPub
newtype SigningKey StakeExtendedKey 
Instance details

Defined in Cardano.Api.Keys.Shelley

newtype SigningKey StakeExtendedKey = StakeExtendedSigningKey XPrv

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 #

IsString (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromString :: String -> Hash StakeExtendedKey Source #

IsString (SigningKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromString :: String -> SigningKey StakeExtendedKey Source #

IsString (VerificationKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromString :: String -> VerificationKey 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 (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 #

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 #

SerialiseAsBech32 (SigningKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

bech32PrefixFor :: SigningKey StakeExtendedKey -> Text Source #

bech32PrefixesPermitted :: AsType (SigningKey StakeExtendedKey) -> [Text] 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 #

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 (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 #

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 #

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 (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 #

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 #

HasTextEnvelope (SigningKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

textEnvelopeType :: AsType (SigningKey StakeExtendedKey) -> TextEnvelopeType Source #

textEnvelopeDefaultDescr :: SigningKey StakeExtendedKey -> TextEnvelopeDescr 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 #

FromCBOR (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromCBOR :: Decoder s (Hash StakeExtendedKey) Source #

label :: Proxy (Hash StakeExtendedKey) -> Text Source #

FromCBOR (SigningKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromCBOR :: Decoder s (SigningKey StakeExtendedKey) Source #

label :: Proxy (SigningKey StakeExtendedKey) -> Text Source #

FromCBOR (VerificationKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

fromCBOR :: Decoder s (VerificationKey StakeExtendedKey) Source #

label :: Proxy (VerificationKey StakeExtendedKey) -> Text Source #

ToCBOR (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

toCBOR :: Hash StakeExtendedKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (Hash StakeExtendedKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [Hash StakeExtendedKey] -> Size Source #

ToCBOR (SigningKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

toCBOR :: SigningKey StakeExtendedKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (SigningKey StakeExtendedKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SigningKey StakeExtendedKey] -> Size Source #

ToCBOR (VerificationKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

Methods

toCBOR :: VerificationKey StakeExtendedKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (VerificationKey StakeExtendedKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [VerificationKey StakeExtendedKey] -> Size 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 #

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 {}
newtype SigningKey StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

newtype SigningKey StakeExtendedKey = StakeExtendedSigningKey XPrv
newtype VerificationKey StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

newtype VerificationKey StakeExtendedKey = StakeExtendedVerificationKey XPub

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 -> RewardAccount 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 :: RewardAccount 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 AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

Methods

serialiseAddress :: AddressAny -> Text Source #

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

SerialiseAddress StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Methods

serialiseAddress :: StakeAddress -> Text Source #

deserialiseAddress :: AsType StakeAddress -> Text -> Maybe StakeAddress 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 #

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 #

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 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 AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

data AsType AddressAny = AsAddressAny
data AsType ByronAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ByronAddr = AsByronAddr
data AsType ShelleyAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ShelleyAddr = AsShelleyAddr
data AsType StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

data AsType StakeAddress = AsStakeAddress
data AsType BlockHeader Source # 
Instance details

Defined in Cardano.Api.Block

data AsType BlockHeader = AsBlockHeader
data AsType DRepMetadata Source # 
Instance details

Defined in Cardano.Api.DRepMetadata

data AsType DRepMetadata = AsDRepMetadata
data AsType AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras.Core

data AsType AllegraEra = AsAllegraEra
data AsType AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras.Core

data AsType AlonzoEra = AsAlonzoEra
data AsType BabbageEra Source # 
Instance details

Defined in Cardano.Api.Eras.Core

data AsType BabbageEra = AsBabbageEra
data AsType ByronEra Source # 
Instance details

Defined in Cardano.Api.Eras.Core

data AsType ByronEra = AsByronEra
data AsType ConwayEra Source # 
Instance details

Defined in Cardano.Api.Eras.Core

data AsType ConwayEra = AsConwayEra
data AsType MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras.Core

data AsType MaryEra = AsMaryEra
data AsType ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras.Core

data AsType ShelleyEra = AsShelleyEra
data AsType GovernancePoll Source # 
Instance details

Defined in Cardano.Api.Governance.Poll

data AsType GovernancePoll = AsGovernancePoll
data AsType GovernancePollAnswer Source # 
Instance details

Defined in Cardano.Api.Governance.Poll

data AsType GovernancePollAnswer = AsGovernancePollAnswer
data AsType ByronKey Source # 
Instance details

Defined in Cardano.Api.Keys.Byron

data AsType ByronKey = AsByronKey
data AsType ByronKeyLegacy Source # 
Instance details

Defined in Cardano.Api.Keys.Byron

data AsType ByronKeyLegacy = AsByronKeyLegacy
data AsType KesKey Source # 
Instance details

Defined in Cardano.Api.Keys.Praos

data AsType KesKey = AsKesKey
data AsType VrfKey Source # 
Instance details

Defined in Cardano.Api.Keys.Praos

data AsType VrfKey = AsVrfKey
data AsType CommitteeColdExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType CommitteeColdExtendedKey = AsCommitteeColdExtendedKey
data AsType CommitteeColdKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType CommitteeColdKey = AsCommitteeColdKey
data AsType CommitteeHotExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType CommitteeHotExtendedKey = AsCommitteeHotExtendedKey
data AsType CommitteeHotKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType CommitteeHotKey = AsCommitteeHotKey
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 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 GenesisKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisKey = AsGenesisKey
data AsType GenesisUTxOKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisUTxOKey = AsGenesisUTxOKey
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 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 StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType StakePoolKey = AsStakePoolKey
data AsType OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

data AsType OperationalCertificate = AsOperationalCertificate
data AsType OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

data AsType OperationalCertificateIssueCounter = AsOperationalCertificateIssueCounter
data AsType PraosNonce Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType PraosNonce = AsPraosNonce
data AsType UpdateProposal Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType UpdateProposal = AsUpdateProposal
data AsType PlutusScriptV1 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV1 = AsPlutusScriptV1
data AsType PlutusScriptV2 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV2 = AsPlutusScriptV2
data AsType PlutusScriptV3 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV3 = AsPlutusScriptV3
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 SimpleScript' Source # 
Instance details

Defined in Cardano.Api.Script

data AsType SimpleScript' = AsSimpleScript
data AsType HashableScriptData Source # 
Instance details

Defined in Cardano.Api.ScriptData

data AsType HashableScriptData = AsHashableScriptData
data AsType ScriptData Source # 
Instance details

Defined in Cardano.Api.ScriptData

data AsType ScriptData = AsScriptData
data AsType TextEnvelope Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

data AsType TextEnvelope = AsTextEnvelope
data AsType ByronUpdateProposal Source # 
Instance details

Defined in Cardano.Api.SpecialByron

data AsType ByronUpdateProposal = AsByronUpdateProposal
data AsType ByronVote Source # 
Instance details

Defined in Cardano.Api.SpecialByron

data AsType ByronVote = AsByronVote
data AsType StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

data AsType StakePoolMetadata = AsStakePoolMetadata
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 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 (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (AddressInEra era) Source # 
Instance details

Defined in Cardano.Api.Address

data AsType (AddressInEra era) = AsAddressInEra (AsType era)
data AsType (Certificate era) Source # 
Instance details

Defined in Cardano.Api.Certificate

data AsType (Certificate era) = AsCertificate
data AsType (Proposal era) Source # 
Instance details

Defined in Cardano.Api.Governance.Actions.ProposalProcedure

data AsType (Proposal era) = AsProposal
data AsType (VotingProcedure era) Source # 
Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

data AsType (VotingProcedure era) = AsVote
data AsType (VotingProcedures era) Source # 
Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

data AsType (VotingProcedures era) = AsVotingProcedures
data AsType (Hash a) Source # 
Instance details

Defined in Cardano.Api.Hash

data AsType (Hash a) = AsHash (AsType a)
data AsType (SigningKey a) Source # 
Instance details

Defined in Cardano.Api.Keys.Class

data AsType (SigningKey a) = AsSigningKey (AsType a)
data AsType (VerificationKey a) Source # 
Instance details

Defined in Cardano.Api.Keys.Class

data AsType (VerificationKey a) = AsVerificationKey (AsType a)
data AsType (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)
data AsType (Script lang) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (Script lang) = AsScript (AsType lang)
data AsType (ScriptInEra era) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (ScriptInEra era) = AsScriptInEra (AsType era)
data AsType (KeyWitness era) Source # 
Instance details

Defined in Cardano.Api.Tx.Sign

data AsType (KeyWitness era) = AsKeyWitness (AsType era)
data AsType (Tx era) Source # 
Instance details

Defined in Cardano.Api.Tx.Sign

data AsType (Tx era) = AsTx (AsType era)
data AsType (TxBody era) Source # 
Instance details

Defined in Cardano.Api.Tx.Sign

data AsType (TxBody era) = AsTxBody (AsType era)

Helpers

isKeyAddress :: AddressInEra era -> Bool Source #

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