cardano-addresses
Safe HaskellNone
LanguageHaskell2010

Cardano.Address.Crypto.Wallet

Description

Vendored from cardano-crypto (Apache-2.0). Original: Cardano.Crypto.Wallet

HD Wallet routines using Ed25519 arithmetic.

Synopsis

Documentation

newtype ChainCode #

Constructors

ChainCode ByteString 

Instances

Instances details
NFData ChainCode # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

rnf :: ChainCode -> () #

Show ChainCode # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

showsPrec :: Int -> ChainCode -> ShowS #

show :: ChainCode -> String #

showList :: [ChainCode] -> ShowS #

Eq ChainCode # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

(==) :: ChainCode -> ChainCode -> Bool #

(/=) :: ChainCode -> ChainCode -> Bool #

Ord ChainCode # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

compare :: ChainCode -> ChainCode -> Ordering #

(<) :: ChainCode -> ChainCode -> Bool #

(<=) :: ChainCode -> ChainCode -> Bool #

(>) :: ChainCode -> ChainCode -> Bool #

(>=) :: ChainCode -> ChainCode -> Bool #

max :: ChainCode -> ChainCode -> ChainCode #

min :: ChainCode -> ChainCode -> ChainCode #

Hashable ChainCode # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

hashWithSalt :: Int -> ChainCode -> Int #

hash :: ChainCode -> Int #

ByteArrayAccess ChainCode # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

length :: ChainCode -> Int #

withByteArray :: ChainCode -> (Ptr p -> IO a) -> IO a #

copyByteArrayToPtr :: ChainCode -> Ptr p -> IO () #

data DerivationScheme #

Constructors

DerivationScheme1 
DerivationScheme2 

Instances

Instances details
NFData DerivationScheme # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

rnf :: DerivationScheme -> () #

Bounded DerivationScheme # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

minBound :: DerivationScheme #

maxBound :: DerivationScheme #

Enum DerivationScheme # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

succ :: DerivationScheme -> DerivationScheme #

pred :: DerivationScheme -> DerivationScheme #

toEnum :: Int -> DerivationScheme #

fromEnum :: DerivationScheme -> Int #

enumFrom :: DerivationScheme -> [DerivationScheme] #

enumFromThen :: DerivationScheme -> DerivationScheme -> [DerivationScheme] #

enumFromTo :: DerivationScheme -> DerivationScheme -> [DerivationScheme] #

enumFromThenTo :: DerivationScheme -> DerivationScheme -> DerivationScheme -> [DerivationScheme] #

Generic DerivationScheme # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Associated Types

type Rep DerivationScheme 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

type Rep DerivationScheme = D1 ('MetaData "DerivationScheme" "Cardano.Address.Crypto.Wallet.Types" "cardano-addresses-4.0.2-inplace" 'False) (C1 ('MetaCons "DerivationScheme1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DerivationScheme2" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: DerivationScheme -> Rep DerivationScheme x #

to :: Rep DerivationScheme x -> DerivationScheme #

Show DerivationScheme # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

showsPrec :: Int -> DerivationScheme -> ShowS #

show :: DerivationScheme -> String #

showList :: [DerivationScheme] -> ShowS #

Eq DerivationScheme # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

(==) :: DerivationScheme -> DerivationScheme -> Bool #

(/=) :: DerivationScheme -> DerivationScheme -> Bool #

Ord DerivationScheme # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

Methods

compare :: DerivationScheme -> DerivationScheme -> Ordering #

(<) :: DerivationScheme -> DerivationScheme -> Bool #

(<=) :: DerivationScheme -> DerivationScheme -> Bool #

(>) :: DerivationScheme -> DerivationScheme -> Bool #

(>=) :: DerivationScheme -> DerivationScheme -> Bool #

max :: DerivationScheme -> DerivationScheme -> DerivationScheme #

min :: DerivationScheme -> DerivationScheme -> DerivationScheme #

type Rep DerivationScheme # 
Instance details

Defined in Cardano.Address.Crypto.Wallet.Types

type Rep DerivationScheme = D1 ('MetaData "DerivationScheme" "Cardano.Address.Crypto.Wallet.Types" "cardano-addresses-4.0.2-inplace" 'False) (C1 ('MetaCons "DerivationScheme1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DerivationScheme2" 'PrefixI 'False) (U1 :: Type -> Type))

type DerivationIndex = Word32 #

pattern LatestScheme :: DerivationScheme #

Extended Private & Public types

data XPrv #

Instances

Instances details
NFData XPrv # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

rnf :: XPrv -> () #

ByteArrayAccess XPrv # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

length :: XPrv -> Int #

withByteArray :: XPrv -> (Ptr p -> IO a) -> IO a #

copyByteArrayToPtr :: XPrv -> Ptr p -> IO () #

data XPub #

Constructors

XPub 

Fields

Instances

Instances details
NFData XPub # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

rnf :: XPub -> () #

Generic XPub # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Associated Types

type Rep XPub 
Instance details

Defined in Cardano.Address.Crypto.Wallet

type Rep XPub = D1 ('MetaData "XPub" "Cardano.Address.Crypto.Wallet" "cardano-addresses-4.0.2-inplace" 'False) (C1 ('MetaCons "XPub" 'PrefixI 'True) (S1 ('MetaSel ('Just "xpubPublicKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "xpubChaincode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChainCode)))

Methods

from :: XPub -> Rep XPub x #

to :: Rep XPub x -> XPub #

Show XPub # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

showsPrec :: Int -> XPub -> ShowS #

show :: XPub -> String #

showList :: [XPub] -> ShowS #

Eq XPub # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

(==) :: XPub -> XPub -> Bool #

(/=) :: XPub -> XPub -> Bool #

Ord XPub # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

compare :: XPub -> XPub -> Ordering #

(<) :: XPub -> XPub -> Bool #

(<=) :: XPub -> XPub -> Bool #

(>) :: XPub -> XPub -> Bool #

(>=) :: XPub -> XPub -> Bool #

max :: XPub -> XPub -> XPub #

min :: XPub -> XPub -> XPub #

Hashable XPub # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

hashWithSalt :: Int -> XPub -> Int #

hash :: XPub -> Int #

type Rep XPub # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

type Rep XPub = D1 ('MetaData "XPub" "Cardano.Address.Crypto.Wallet" "cardano-addresses-4.0.2-inplace" 'False) (C1 ('MetaCons "XPub" 'PrefixI 'True) (S1 ('MetaSel ('Just "xpubPublicKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "xpubChaincode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChainCode)))

data XSignature #

Instances

Instances details
NFData XSignature # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

rnf :: XSignature -> () #

Show XSignature # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

showsPrec :: Int -> XSignature -> ShowS #

show :: XSignature -> String #

showList :: [XSignature] -> ShowS #

Eq XSignature # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

(==) :: XSignature -> XSignature -> Bool #

(/=) :: XSignature -> XSignature -> Bool #

Ord XSignature # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

compare :: XSignature -> XSignature -> Ordering #

(<) :: XSignature -> XSignature -> Bool #

(<=) :: XSignature -> XSignature -> Bool #

(>) :: XSignature -> XSignature -> Bool #

(>=) :: XSignature -> XSignature -> Bool #

max :: XSignature -> XSignature -> XSignature #

min :: XSignature -> XSignature -> XSignature #

Hashable XSignature # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

hashWithSalt :: Int -> XSignature -> Int #

hash :: XSignature -> Int #

ByteArrayAccess XSignature # 
Instance details

Defined in Cardano.Address.Crypto.Wallet

Methods

length :: XSignature -> Int #

withByteArray :: XSignature -> (Ptr p -> IO a) -> IO a #

copyByteArrayToPtr :: XSignature -> Ptr p -> IO () #

generate :: (ByteArrayAccess passPhrase, ByteArrayAccess seed) => seed -> passPhrase -> XPrv #

Generate a new XPrv (legacy Byron method).

The seed needs to be >= 32 bytes.

generateNew :: (ByteArrayAccess keyPassPhrase, ByteArrayAccess generationPassPhrase, ByteArrayAccess seed) => seed -> generationPassPhrase -> keyPassPhrase -> XPrv #

Generate a new XPrv from entropy (Icarus method).

The seed should be at least 16 bytes.

xprv :: ByteArrayAccess bin => bin -> Either String XPrv #

xpub :: ByteString -> Either String XPub #

xsignature :: ByteString -> Either String XSignature #

unXPrv :: XPrv -> ByteString #

unXPub :: XPub -> ByteString #

unXSignature :: XSignature -> ByteString #

toXPub :: XPrv -> XPub #

xPubGetPublicKey :: XPub -> PublicKey #

xPrvChangePass :: (ByteArrayAccess oldPassPhrase, ByteArrayAccess newPassPhrase) => oldPassPhrase -> newPassPhrase -> XPrv -> XPrv #

Derivation function

deriveXPrv :: ByteArrayAccess passPhrase => DerivationScheme -> passPhrase -> XPrv -> Word32 -> XPrv #

deriveXPub :: DerivationScheme -> XPub -> Word32 -> Maybe XPub #

Signature & Verification from extended types

sign :: (ByteArrayAccess passPhrase, ByteArrayAccess msg) => passPhrase -> XPrv -> msg -> XSignature #

verify :: ByteArrayAccess msg => XPub -> msg -> XSignature -> Bool #