Copyright	© 2021 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Cardano.Wallet.Address.Book

Description

Address books consist of a Prologue and discovered addresses ( Discoveries ).

Synopsis

class ( Eq ( Prologue s), Eq ( Discoveries s)) => AddressBookIso s where
- data Prologue s :: Type
- data Discoveries s :: Type
- addressIso :: Iso' s ( Prologue s, Discoveries s)
getPrologue :: AddressBookIso s => s -> Prologue s
getDiscoveries :: AddressBookIso s => s -> Discoveries s
newtype SeqAddressMap (c :: Role ) (key :: Depth -> Type -> Type ) = SeqAddressMap ( Map ( KeyFingerprint "payment" key) ( Index ' Soft ' AddressK , AddressState ))
newtype SharedAddressMap (c :: Role ) (key :: Depth -> Type -> Type ) = SharedAddressMap ( Map ( KeyFingerprint "payment" key) ( Index ' Soft ' ScriptK , AddressState ))

Documentation

class ( Eq ( Prologue s), Eq ( Discoveries s)) => AddressBookIso s where Source #

FIXME LATER during ADP-1043: Move Prologue and Discoveries closer into address types.

Associated Types

data Prologue s :: Type Source #

Address information contained in the prologue of the address book, such as public keys or the address gap.

data Discoveries s :: Type Source #

Addresses that were collected during discovery on the blockchain.

Methods

addressIso :: Iso' s ( Prologue s, Discoveries s) Source #

Isomorphism between the address book type s and its two components.

Instances

Instances details

AddressBookIso ( RndState n) Source #	Isomorphism for HD random address book.
Instance details Defined in Cardano.Wallet.Address.Book Associated Types data Prologue ( RndState n) Source # data Discoveries ( RndState n) Source # Methods addressIso :: Iso' ( RndState n) ( Prologue ( RndState n), Discoveries ( RndState n)) Source #
AddressBookIso ( RndAnyState n p) Source #
Instance details Defined in Cardano.Wallet.Address.Book Associated Types data Prologue ( RndAnyState n p) Source # data Discoveries ( RndAnyState n p) Source # Methods addressIso :: Iso' ( RndAnyState n p) ( Prologue ( RndAnyState n p), Discoveries ( RndAnyState n p)) Source #
((key == SharedKey ) ~ ' False , Eq ( SeqState n key)) => AddressBookIso ( SeqState n key) Source #	Isomorphism for sequential address book.
Instance details Defined in Cardano.Wallet.Address.Book Associated Types data Prologue ( SeqState n key) Source # data Discoveries ( SeqState n key) Source # Methods addressIso :: Iso' ( SeqState n key) ( Prologue ( SeqState n key), Discoveries ( SeqState n key)) Source #
key ~ SharedKey => AddressBookIso ( SharedState n key) Source #	Isomorphism for multi-sig address book.
Instance details Defined in Cardano.Wallet.Address.Book Associated Types data Prologue ( SharedState n key) Source # data Discoveries ( SharedState n key) Source # Methods addressIso :: Iso' ( SharedState n key) ( Prologue ( SharedState n key), Discoveries ( SharedState n key)) Source #
((key == SharedKey ) ~ ' False , Eq ( SeqState n key)) => AddressBookIso ( SeqAnyState n key p) Source #
Instance details Defined in Cardano.Wallet.Address.Book Associated Types data Prologue ( SeqAnyState n key p) Source # data Discoveries ( SeqAnyState n key p) Source # Methods addressIso :: Iso' ( SeqAnyState n key p) ( Prologue ( SeqAnyState n key p), Discoveries ( SeqAnyState n key p)) Source #

getPrologue :: AddressBookIso s => s -> Prologue s Source #

getDiscoveries :: AddressBookIso s => s -> Discoveries s Source #

newtype SeqAddressMap (c :: Role ) (key :: Depth -> Type -> Type ) Source #

Address data from sequential address pool. The phantom type parameter c prevents mixing up the internal with the external pool.

Constructors

SeqAddressMap ( Map ( KeyFingerprint "payment" key) ( Index ' Soft ' AddressK , AddressState ))

Instances

Instances details

Eq ( SeqAddressMap c key) Source #
Instance details Defined in Cardano.Wallet.Address.Book Methods (==) :: SeqAddressMap c key -> SeqAddressMap c key -> Bool Source # (/=) :: SeqAddressMap c key -> SeqAddressMap c key -> Bool Source #

newtype SharedAddressMap (c :: Role ) (key :: Depth -> Type -> Type ) Source #

Constructors

SharedAddressMap ( Map ( KeyFingerprint "payment" key) ( Index ' Soft ' ScriptK , AddressState ))

Instances

Instances details

Eq ( SharedAddressMap c key) Source #
Instance details Defined in Cardano.Wallet.Address.Book Methods (==) :: SharedAddressMap c key -> SharedAddressMap c key -> Bool Source # (/=) :: SharedAddressMap c key -> SharedAddressMap c key -> Bool Source #