Modulecardano-addresses-4.0.2Haskell2010

Cardano.Address

Contents

Address
Conversion From / To Text

Synopsis

newtype Address
class PaymentAddress
class StakeAddress
class DelegationAddress
class PointerAddress
data ChainPointer
value unsafeMkAddress
value unAddress
value base58
value fromBase58
value bech32
value bech32With
value fromBech32
class HasNetworkDiscriminant
data AddressDiscrimination
newtype NetworkTag
value invariantSize
value invariantNetworkTag

Packagecardano-addresses-4.0.2
Exports18
LanguageHaskell2010
LicenceApache-2.0
SourceAddress.hs

Address

newtypenewtype Address

Source#

An Address type representing Cardano addresses. Internals are irrevelant to the user.

Instances6Eq, Ord, Show, Generic, NFData, Rep

Eq AddressDefined in cardano-addresses-4.0.2 · Cardano.Address
Ord AddressDefined in cardano-addresses-4.0.2 · Cardano.Address
Show AddressDefined in cardano-addresses-4.0.2 · Cardano.Address
Generic AddressDefined in cardano-addresses-4.0.2 · Cardano.Address
NFData AddressDefined in cardano-addresses-4.0.2 · Cardano.Address
type Rep Address = D1 ('MetaData "Address" "Cardano.Address" "cardano-addresses-4.0.2-IfBlVg9kl2D9r65sjHkHQ2" 'True) (C1 ('MetaCons "Address" 'PrefixI 'True) (S1 ('MetaSel ('Just "unAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))Defined in cardano-addresses-4.0.2 · Cardano.Address

classclass HasNetworkDiscriminant key => PaymentAddress (key :: Depth -> Type -> Type) where

Source#

Encoding of addresses for certain key types and backend targets.

Methods

paymentAddress :: NetworkDiscriminant key -> key 'PaymentK XPub -> Address
Convert a public key to a payment Address valid for the given network discrimination.

Instances2PaymentAddress

PaymentAddress ByronDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
PaymentAddress IcarusDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Icarus

classclass HasNetworkDiscriminant key => StakeAddress (key :: Depth -> Type -> Type) where

Source#

Encoding of addresses for certain key types and backend targets.

Methods

stakeAddress :: NetworkDiscriminant key -> key 'DelegationK XPub -> Address
Convert a delegation key to a stake Address (aka: reward account address) valid for the given network discrimination.

classclass PaymentAddress key => DelegationAddress (key :: Depth -> Type -> Type) where

Source#

Encoding of delegation addresses for certain key types and backend targets.

Methods

delegationAddress :: NetworkDiscriminant key -> key 'PaymentK XPub -> key 'DelegationK XPub -> Address
Convert a public key and a delegation key to a delegation Address valid for the given network discrimination. Funds sent to this address will be delegated according to the delegation settings attached to the delegation key.

classclass PaymentAddress key => PointerAddress (key :: Depth -> Type -> Type) where

Source#

Encoding of pointer addresses for payment key type, pointer to delegation certificate in the blockchain and backend targets.

Methods

pointerAddress :: NetworkDiscriminant key -> key 'PaymentK XPub -> ChainPointer -> Address
Convert a payment public key and a pointer to delegation key in the blockchain to a delegation Address valid for the given network discrimination. Funds sent to this address will be delegated according to the delegation settings attached to the delegation key located by ChainPointer.

datadata ChainPointer

Source#

A ChainPointer type representing location of some object in the blockchain (eg., delegation certificate). This can be achieved unambiguously by specifying slot number, transaction index and the index in the object list (eg., certification list). For delegation certificates, alternatively, the delegation key can be used and then DelegationAddress can be used.

Constructors

ChainPointer
- slotNum :: Natural
  Pointer to the slot
- transactionIndex :: Natural
  transaction index
- outputIndex :: Natural
  output list index

Instances7Eq, Ord, Show, Generic, NFData, ToJSON, …

Eq ChainPointerDefined in cardano-addresses-4.0.2 · Cardano.Address
Ord ChainPointerDefined in cardano-addresses-4.0.2 · Cardano.Address
Show ChainPointerDefined in cardano-addresses-4.0.2 · Cardano.Address
Generic ChainPointerDefined in cardano-addresses-4.0.2 · Cardano.Address
NFData ChainPointerDefined in cardano-addresses-4.0.2 · Cardano.Address
ToJSON ChainPointerDefined in cardano-addresses-4.0.2 · Cardano.Address
type Rep ChainPointer = D1 ('MetaData "ChainPointer" "Cardano.Address" "cardano-addresses-4.0.2-IfBlVg9kl2D9r65sjHkHQ2" 'False) (C1 ('MetaCons "ChainPointer" 'PrefixI 'True) (S1 ('MetaSel ('Just "slotNum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "transactionIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "outputIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural))))Defined in cardano-addresses-4.0.2 · Cardano.Address

valueunsafeMkAddress :: ByteString -> Address

Source#

Unsafe constructor for easily lifting bytes inside an Address.

Use at your own risks.

valueunAddress :: Address -> ByteString

Conversion From / To Text

valuebase58 :: Address -> Text

Source#

Encode an Address to a base58 Text.

valuefromBase58 :: Text -> Maybe Address

Source#

Decode a base58-encoded Text into an Address

valuebech32 :: Address -> Text

Source#

Encode a Shelley Address to bech32 Text, using addr or addr_test as a human readable prefix (depending on the network tag in the address).

valuebech32With :: HumanReadablePart -> Address -> Text

Source#

Encode an Address to bech32 Text, using the specified human readable prefix.

valuefromBech32 :: Text -> Maybe Address

Source#

Decode a bech32-encoded Text into an Address

classclass HasNetworkDiscriminant (key :: Depth -> Type -> Type) where

Associated types

type family NetworkDiscriminant (key :: Depth -> Type -> Type)

Methods

addressDiscrimination :: NetworkDiscriminant key -> AddressDiscrimination
networkTag :: NetworkDiscriminant key -> NetworkTag

Instances3HasNetworkDiscriminant

HasNetworkDiscriminant ByronDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
HasNetworkDiscriminant IcarusDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Icarus
HasNetworkDiscriminant ShelleyDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Shelley

datadata AddressDiscrimination

RequiresNetworkTag RequiresNoTag

Instances5Eq, Show, Generic, NFData, Rep

Eq AddressDiscriminationDefined in cardano-addresses-4.0.2 · Cardano.Address
Show AddressDiscriminationDefined in cardano-addresses-4.0.2 · Cardano.Address
Generic AddressDiscriminationDefined in cardano-addresses-4.0.2 · Cardano.Address
NFData AddressDiscriminationDefined in cardano-addresses-4.0.2 · Cardano.Address
type Rep AddressDiscrimination = D1 ('MetaData "AddressDiscrimination" "Cardano.Address" "cardano-addresses-4.0.2-IfBlVg9kl2D9r65sjHkHQ2" 'False) (C1 ('MetaCons "RequiresNetworkTag" 'PrefixI 'False) U1 :+: C1 ('MetaCons "RequiresNoTag" 'PrefixI 'False) U1)Defined in cardano-addresses-4.0.2 · Cardano.Address

newtypenewtype NetworkTag

Source#

Magic constant associated with a given network. This is mainly used in two places:

In Address payloads, to discriminate addresses between networks.
At the network-level, when doing handshake with nodes.

Constructors

NetworkTag
- unNetworkTag :: Word32

Instances6Eq, Show, Generic, NFData, ToJSON, Rep

Eq NetworkTagDefined in cardano-addresses-4.0.2 · Cardano.Address
Show NetworkTagDefined in cardano-addresses-4.0.2 · Cardano.Address
Generic NetworkTagDefined in cardano-addresses-4.0.2 · Cardano.Address
NFData NetworkTagDefined in cardano-addresses-4.0.2 · Cardano.Address
ToJSON NetworkTagDefined in cardano-addresses-4.0.2 · Cardano.Address
type Rep NetworkTag = D1 ('MetaData "NetworkTag" "Cardano.Address" "cardano-addresses-4.0.2-IfBlVg9kl2D9r65sjHkHQ2" 'True) (C1 ('MetaCons "NetworkTag" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNetworkTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))Defined in cardano-addresses-4.0.2 · Cardano.Address

valueinvariantSize :: HasCallStack => Int -> ByteString -> ByteString

valueinvariantNetworkTag :: HasCallStack => Word32 -> NetworkTag -> Word8