Modulecardano-crypto-1.3.0Haskell2010

Cardano.Crypto.Wallet

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.

6 types
15 values

Packagecardano-crypto-1.3.0
Exports22
LanguageHaskell2010
LicenceMIT
SourceWallet.hs

newtypenewtype ChainCode

Constructors

ChainCode ByteString

Instances6Eq, Ord, Show, NFData, Hashable, ByteArrayAccess

Eq ChainCodeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
Ord ChainCodeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
Show ChainCodeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
NFData ChainCodeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
Hashable ChainCodeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
ByteArrayAccess ChainCodeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types

datadata DerivationScheme

DerivationScheme1 DerivationScheme2

Instances6Bounded, Enum, Eq, Ord, Show, Arbitrary

Bounded DerivationSchemeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
Enum DerivationSchemeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
Eq DerivationSchemeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
Ord DerivationSchemeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
Show DerivationSchemeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types
Arbitrary DerivationSchemeDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet.Types

typetype DerivationIndex = Word32

patternpattern LatestScheme :: DerivationScheme

Extended Private & Public types

14 declarations

newtypenewtype XPrv

Instances2NFData, ByteArrayAccess

NFData XPrvDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
ByteArrayAccess XPrvDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet

datadata XPub

Constructors

XPub
- xpubPublicKey :: !ByteString
- xpubChaincode :: !ChainCode

Instances7Eq, Ord, Show, Generic, NFData, Hashable, …

Eq XPubDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
Ord XPubDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
Show XPubDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
Generic XPubDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
NFData XPubDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
Hashable XPubDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
type Rep XPub = D1 ('MetaData "XPub" "Cardano.Crypto.Wallet" "cardano-crypto-1.3.0-EriZzzm1Y3e2SQIl3MXU00" 'False) (C1 ('MetaCons "XPub" 'PrefixI 'True) (S1 ('MetaSel ('Just "xpubPublicKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "xpubChaincode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChainCode)))Defined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet

newtypenewtype XSignature

Instances6Eq, Ord, Show, NFData, Hashable, ByteArrayAccess

Eq XSignatureDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
Ord XSignatureDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
Show XSignatureDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
NFData XSignatureDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
Hashable XSignatureDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet
ByteArrayAccess XSignatureDefined in cardano-crypto-1.3.0 · Cardano.Crypto.Wallet

valuegenerate

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

Generate a new XPrv

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

valuegenerateNew

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

valuexprv :: ByteArrayAccess bin => bin -> Either String XPrv

Simple constructor

valuexpub :: ByteString -> Either String XPub

valuexsignature :: ByteString -> Either String XSignature

valueunXPrv :: XPrv -> ByteString

valueunXPub :: XPub -> ByteString

valueunXSignature :: XSignature -> ByteString

valuetoXPub :: HasCallStack => XPrv -> XPub

Generate extended public key from private key

valuexPubGetPublicKey :: XPub -> PublicKey

Return the Ed25519 public key associated with a XPub context

valuexPrvChangePass

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

2 declarations

valuederiveXPrv

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

Derive a child extended private key from an extended private key

valuederiveXPub :: DerivationScheme -> XPub -> Word32 -> Maybe XPub

Derive a child extended public key from an extended public key

Signature & Verification from extended types

2 declarations

valuesign

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

valueverify :: ByteArrayAccess msg => XPub -> msg -> XSignature -> Bool