Cardano.Address.Derivation · cardano-addresses-4.0.2

Overview

0 declarations

These abstractions allow generating root private key, also called Master Key and then basing on it enable address derivation

Key Derivation

0 declarations

Types

newtypenewtype Index (derivationType :: DerivationType) (depth :: Depth)

#

A derivation index, with phantom-types to disambiguate derivation type.

let accountIx = Index 'Hardened 'AccountK
let addressIx = Index 'Soft 'PaymentK

Instances10Bounded, Eq, Ord, Show, Generic, NFData, …

Bounded (Index 'Hardened depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
Bounded (Index 'Soft depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
Bounded (Index 'WholeDomain depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
Eq (Index derivationType depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
Ord (Index derivationType depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
Show (Index derivationType depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
Generic (Index derivationType depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
NFData (Index derivationType depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
Buildable (Index derivationType depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
type Rep (Index derivationType depth) = D1 ('MetaData "Index" "Cardano.Address.Derivation" "cardano-addresses-4.0.2-IfBlVg9kl2D9r65sjHkHQ2" 'True) (C1 ('MetaCons "Index" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexToWord32") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))Defined in cardano-addresses-4.0.2 · Cardano.Address.Derivation

valueindexToWord32 :: Index derivationType depth -> Word32

#

Get the index as a Word32 @since 3.3.0

valueindexFromWord32

:: (ix ~ Index derivationType depth, Bounded ix)
=> Word32
-> Maybe ix

#

Construct derivation path indices from raw Word32 values.

valuewholeDomainIndex :: Word32 -> Index 'WholeDomain depth

#

Constructs a full domain Index. This can't fail, unlike fromWord32.

valuecoerceWholeDomainIndex :: Index ty depth0 -> Index 'WholeDomain depth1

#

Upcasts an Index to one with the full Word32 domain.

valuenextIndex :: (ix ~ Index derivationType depth, Bounded ix) => ix -> Maybe ix

#

Increment an index, if possible.

datadata Depth

#

Key Depth in the derivation path, according to BIP-0039 and BIP-0044.

root | purpose' | cointype' | account' | role | address
0th      1st         2nd        3rd       4th     5th

We do not manipulate purpose, cointype and change paths directly, so there are no constructors for these.

RootK AccountK PaymentK DelegationK DRepK CCColdK CCHotK ScriptK PolicyK

datadata DerivationType

#

Type of derivation that should be used with the given indexes.

In theory, we should only consider two derivation types: soft and hard.

However, historically, addresses in Cardano used to be generated across both the soft and the hard domain. We therefore introduce a WholeDomain derivation type that is the exact union of Hardened and Soft.

Hardened Soft WholeDomain

Abstractions

3 declarations

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

#

Abstract interface for constructing a Master Key.

Associated types

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

Methods

genMasterKeyFromMnemonic :: SomeMnemonic -> SecondFactor key -> key 'RootK XPrv
Generate a root key from a corresponding mnemonic.
genMasterKeyFromXPrv :: XPrv -> key 'RootK XPrv
Generate a root key from a corresponding root XPrv

Instances4GenMasterKey

GenMasterKey ByronDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron

Key Derivation

Example:

Generating a root key from SomeMnemonic

>>> :set -XOverloadedStrings
>>> :set -XTypeApplications
>>> :set -XDataKinds
>>> :set -XFlexibleContexts
>>> import Cardano.Mnemonic ( mkSomeMnemonic )
>>> import Cardano.Address ( base58 )
>>> import Cardano.Address.Derivation ( toXPub )
>>> import qualified Cardano.Address.Style.Byron as Byron

>>> let (Right mw) = mkSomeMnemonic @'[12] ["moon","fox","ostrich","quick","cactus","raven","wasp","intact","first","ring","crumble","error"]
>>> let rootK = Byron.genMasterKeyFromMnemonic mw :: Byron 'RootK XPrv

Deriving child keys

Both accIx and addIx assume values from 0 to 4294967295 (ie. 0xFFFFFFFF) In case of account one can get this bound via

let accIxMin = minBound (Index 'WholeDomain 'AccountK)
let accIxMax = maxBound (Index 'WholeDomain 'AccountK)

>>> let Just accIx = wholeDomainIndex 0x80000000
>>> let acctK = Byron.deriveAccountPrivateKey rootK accIx

>>> let Just addIx = wholeDomainIndex 0x80000014
>>> let addrK = Byron.deriveAddressPrivateKey acctK addIx

>>> base58 $ Byron.paymentAddress Byron.byronMainnet (toXPub $ addrK)
DdzFFzCqrhsq3KjLtT51mESbZ4RepiHPzLqEhamexVFTJpGbCXmh7qSxnHvaL88QmtVTD1E1sjx8Z1ZNDhYmcBV38ZjDST9kYVxSkhcw

GenMasterKey IcarusDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Icarus
GenMasterKey SharedDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Shared
GenMasterKey ShelleyDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Shelley

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

#

An interface for doing hard derivations from the root private key, Master Key

Associated types

type family AccountIndexDerivationType (key :: Depth -> Type -> Type) :: DerivationType
type family AddressIndexDerivationType (key :: Depth -> Type -> Type) :: DerivationType
type family WithRole (key :: Depth -> Type -> Type)

Methods

deriveAccountPrivateKey :: key 'RootK XPrv -> Index (AccountIndexDerivationType key) 'AccountK -> key 'AccountK XPrv
Derives account private key from the given root private key, using derivation scheme 2 (see cardano-crypto package for more details).
deriveAddressPrivateKey :: key 'AccountK XPrv -> WithRole key -> Index (AddressIndexDerivationType key) 'PaymentK -> key 'PaymentK XPrv
Derives address private key from the given account private key, using derivation scheme 2 (see cardano-crypto package for more details).

Instances4HardDerivation

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

classclass HardDerivation key => SoftDerivation (key :: Depth -> Type -> Type) where

#

An interface for doing soft derivations from an account public key

Methods

deriveAddressPublicKey :: key 'AccountK XPub -> WithRole key -> Index 'Soft 'PaymentK -> key 'PaymentK XPub
Derives address public key from the given account public key, using derivation scheme 2 (see cardano-crypto package for more details).
This is the preferred way of deriving new sequential address public keys.

Instances3SoftDerivation

SoftDerivation IcarusDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Icarus
SoftDerivation SharedDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Shared
SoftDerivation ShelleyDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Shelley

Low-Level Cryptography Primitives

0 declarations

XPrv

typetype XPrv = XPrv

#

An opaque type representing an extended private key.

Properties:

Roundtripping

forall xprv. xprvFromBytes (xprvToBytes xprv) == Just xprv

Chain Code Invariance

forall xprv. xprvChainCode xprv == xpubChainCode (toXPub xprv)

Public Key Signature

forall xprv msg. verify (toXPub xprv) msg (sign xprv msg) == True

valuexprvFromBytes :: ByteString -> Maybe XPrv

#

Construct an XPrv from raw ByteString (96 bytes).

valuexprvToBytes :: XPrv -> ByteString

#

Convert an XPrv to a raw ByteString (96 bytes).

valuexprvPrivateKey :: XPrv -> ByteString

#

Extract the private key from an XPrv as a raw ByteString (64 bytes).

valuexprvChainCode :: XPrv -> ByteString

#

Extract the chain code from an XPrv as a raw ByteString (32 bytes).

valuetoXPub :: HasCallStack => XPrv -> XPub

#

Derive the XPub associated with an XPrv.

XPub

typetype XPub = XPub

#

An opaque type representing an extended public key.

Properties:

Roundtripping

forall xpub. xpubFromBytes (xpubToBytes xpub) == Just xpub

valuexpubFromBytes :: ByteString -> Maybe XPub

#

Construct an XPub from raw ByteString (64 bytes).

valuexpubToBytes :: XPub -> ByteString

#

Convert an XPub to a raw ByteString (64 bytes).

valuexpubPublicKey :: XPub -> ByteString

#

Extract the public key from an XPub as a raw ByteString (32 bytes).

valuexpubChainCode :: XPub -> ByteString

#

Extract the chain code from an XPub as a raw ByteString (32 bytes).

Pub

newtypenewtype Pub

#

An opaque type representing a non-extended public key.

Properties:

Roundtripping

forall pub. pubFromBytes (pubToBytes pub) == Just pub

Instances2Eq, Show

Eq PubDefined in cardano-addresses-4.0.2 · Cardano.Address.Derivation
Show PubDefined in cardano-addresses-4.0.2 · Cardano.Address.Derivation

valuepubFromBytes :: ByteString -> Maybe Pub

#

Construct a Pub from raw ByteString (32 bytes).

valuepubToBytes :: Pub -> ByteString

#

Convert an Pub to a raw ByteString (32 bytes).

valuexpubToPub :: XPub -> Pub

#

Extract the public key from an XPub as a Pub (32 bytes).

XSignature

typetype XSignature = XSignature

#

An opaque type representing a signature made from an XPrv.

valuesign :: ByteArrayAccess msg => XPrv -> msg -> XSignature

#

Produce a signature of the given msg from an XPrv.

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

#

Verify the XSignature of a msg with the XPub associated with the XPrv used for signing.

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