cardano-crypto-1.1.1: Cryptography primitives for cardano
Maintainer vincent@typed.io
Safe Haskell None
Language Haskell2010

Cardano.Crypto.Wallet

Description

This provides similar functionality to BIP32 but using Ed25519 arithmetic instead of P256K1 arithmethic.

Key can be hierarchically derived from private key in two fashions: Hardened or Normal.

In the hardened scheme, the child secret key is not linearly derived, so that the child public key has no way to be efficiently computed from the parent public key.

The normal scheme allows anyone to derive public keys from public key.

Synopsis

Documentation

newtype ChainCode Source #

Constructors

ChainCode ByteString

Instances

Instances details
Eq ChainCode Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

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

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

Ord ChainCode Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

compare :: ChainCode -> ChainCode -> Ordering Source #

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

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

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

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

max :: ChainCode -> ChainCode -> ChainCode Source #

min :: ChainCode -> ChainCode -> ChainCode Source #

Show ChainCode Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

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

show :: ChainCode -> String Source #

showList :: [ ChainCode ] -> ShowS Source #

NFData ChainCode Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

rnf :: ChainCode -> () Source #

ByteArrayAccess ChainCode Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

length :: ChainCode -> Int Source #

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

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

Hashable ChainCode Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

hashWithSalt :: Int -> ChainCode -> Int Source #

hash :: ChainCode -> Int Source #

data DerivationScheme Source #

Constructors

DerivationScheme1
DerivationScheme2

Instances

Instances details
Bounded DerivationScheme Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

minBound :: DerivationScheme Source #

maxBound :: DerivationScheme Source #

Enum DerivationScheme Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

succ :: DerivationScheme -> DerivationScheme Source #

pred :: DerivationScheme -> DerivationScheme Source #

toEnum :: Int -> DerivationScheme Source #

fromEnum :: DerivationScheme -> Int Source #

enumFrom :: DerivationScheme -> [ DerivationScheme ] Source #

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

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

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

Eq DerivationScheme Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

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

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

Ord DerivationScheme Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

compare :: DerivationScheme -> DerivationScheme -> Ordering Source #

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

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

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

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

max :: DerivationScheme -> DerivationScheme -> DerivationScheme Source #

min :: DerivationScheme -> DerivationScheme -> DerivationScheme Source #

Show DerivationScheme Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

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

show :: DerivationScheme -> String Source #

showList :: [ DerivationScheme ] -> ShowS Source #

Arbitrary DerivationScheme Source #
Instance details

Defined in Cardano.Crypto.Wallet.Types

Methods

arbitrary :: Gen DerivationScheme Source #

type DerivationIndex = Word32 Source #

pattern LatestScheme :: DerivationScheme Source #

Extended Private & Public types

data XPrv Source #

Instances

Instances details
NFData XPrv Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

rnf :: XPrv -> () Source #

ByteArrayAccess XPrv Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

length :: XPrv -> Int Source #

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

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

data XPub Source #

Constructors

XPub

Fields

Instances

Instances details
Eq XPub Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

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

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

Ord XPub Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

compare :: XPub -> XPub -> Ordering Source #

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

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

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

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

max :: XPub -> XPub -> XPub Source #

min :: XPub -> XPub -> XPub Source #

Show XPub Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

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

show :: XPub -> String Source #

showList :: [ XPub ] -> ShowS Source #

Generic XPub Source #
Instance details

Defined in Cardano.Crypto.Wallet

Associated Types

type Rep XPub :: Type -> Type Source #

Methods

from :: XPub -> Rep XPub x Source #

to :: Rep XPub x -> XPub Source #

NFData XPub Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

rnf :: XPub -> () Source #

Hashable XPub Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

hashWithSalt :: Int -> XPub -> Int Source #

hash :: XPub -> Int Source #

type Rep XPub Source #
Instance details

Defined in Cardano.Crypto.Wallet

type Rep XPub = D1 (' MetaData "XPub" "Cardano.Crypto.Wallet" "cardano-crypto-1.1.1-AR10YQhE07qCYnMgL8MnSo" ' 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 Source #

Instances

Instances details
Eq XSignature Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

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

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

Ord XSignature Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

compare :: XSignature -> XSignature -> Ordering Source #

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

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

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

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

max :: XSignature -> XSignature -> XSignature Source #

min :: XSignature -> XSignature -> XSignature Source #

Show XSignature Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

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

show :: XSignature -> String Source #

showList :: [ XSignature ] -> ShowS Source #

NFData XSignature Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

rnf :: XSignature -> () Source #

ByteArrayAccess XSignature Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

length :: XSignature -> Int Source #

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

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

Hashable XSignature Source #
Instance details

Defined in Cardano.Crypto.Wallet

Methods

hashWithSalt :: Int -> XSignature -> Int Source #

hash :: XSignature -> Int Source #

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

Generate a new XPrv

The seed needs to be at least 32 bytes, otherwise an asynchronous error is thrown

generateNew Source #

Arguments

:: ( ByteArrayAccess keyPassPhrase, ByteArrayAccess generationPassPhrase, ByteArrayAccess seed)
=> seed

Raw entropy used as source of randomness for this algorithm

-> generationPassPhrase

User chosen passphrase for the generation phase

-> keyPassPhrase

Symmetric encryption key passphrase used for the in-memory security

-> XPrv

Generate a new XPrv from an entropy seed

The seed should be at least 16 bytes, although it is not enforced

The passphrase encrypt the secret key in memory

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

Simple constructor

xpub :: ByteString -> Either String XPub Source #

xsignature :: ByteString -> Either String XSignature Source #

unXPrv :: XPrv -> ByteString Source #

unXPub :: XPub -> ByteString Source #

unXSignature :: XSignature -> ByteString Source #

toXPub :: HasCallStack => XPrv -> XPub Source #

Generate extended public key from private key

xPubGetPublicKey :: XPub -> PublicKey Source #

Return the Ed25519 public key associated with a XPub context

xPrvChangePass Source #

Arguments

:: ( ByteArrayAccess oldPassPhrase, ByteArrayAccess newPassPhrase)
=> oldPassPhrase

passphrase to decrypt the current encrypted key

-> newPassPhrase

new passphrase to use for the new encrypted key

-> XPrv
-> XPrv

Derivation function

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

Derive a child extended private key from an extended private key

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

Derive a child extended public key from an extended public key

Signature & Verification from extended types

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

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