Modulecardano-addresses-4.0.2Haskell2010

Cardano.Address.Style.Byron

3 types
20 values

Packagecardano-addresses-4.0.2
Exports24
LanguageHaskell2010
LicenceApache-2.0
SourceByron.hs

This module provides an implementation of:

GenMasterKey: for generating Byron master keys from mnemonic sentences
HardDerivation: for hierarchical derivation of parent to child keys
PaymentAddress: for constructing addresses from a public key

We call Byron addresses the old address type used by Daedalus in the early days of Cardano. Using this type of addresses and underlying key scheme is now considered deprecated because of some security implications.

The internals of the Byron does not matter for the reader, but basically contains what is necessary to perform key derivation and generate addresses from a Byron type.

Byron uses WholeDomain (meaning Soft+Hardened) for account key and payment key derivation. It should use Hardened for account and Soft for payment as design, but due to the error made prior 2019 in cardano-sl implementation WholeDomain was adopted to handle all the keys. Nevertheless, it was recommended and enforced to use Hardened for account derivation and Soft for payment key derivation from 2019 onwards. To sum up both account index and payment index can assume values from 0 to 4294967295 (ie. 0xFFFFFFFF)

Deprecation Notice

Unless you have good reason to do so (like writing backward-compatible code with an existing piece), any new implementation should use the Icarus style for key and addresses.

Byron

5 declarations

datadata Byron (depth :: Depth) key

Deprecated. see Icarus

Material for deriving HD random scheme keys, which can be used for making addresses.

Instances15HasNetworkDiscriminant, PaymentAddress, GenMasterKey, HardDerivation, Functor, Eq, …

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

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

HardDerivation ByronDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
Functor (Byron depth)Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
(Eq key, Eq (DerivationPath depth)) => Eq (Byron depth key)Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
(Show key, Show (DerivationPath depth)) => Show (Byron depth key)Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
Generic (Byron depth key)Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
(NFData key, NFData (DerivationPath depth)) => NFData (Byron depth key)Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
type Rep (Byron depth key) = D1 ('MetaData "Byron" "Cardano.Address.Style.Byron" "cardano-addresses-4.0.2-IfBlVg9kl2D9r65sjHkHQ2" 'False) (C1 ('MetaCons "Byron" 'PrefixI 'True) (S1 ('MetaSel ('Just "getKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 key) :*: (S1 ('MetaSel ('Just "derivationPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (DerivationPath depth)) :*: S1 ('MetaSel ('Just "payloadPassphrase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScrubbedBytes))))Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
type NetworkDiscriminant Byron = (AddressDiscrimination, NetworkTag)Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
type SecondFactor Byron = ()Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
type AccountIndexDerivationType Byron = 'WholeDomainDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
type AddressIndexDerivationType Byron = 'WholeDomainDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
type WithRole Byron = ()Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron

familytype family DerivationPath (depth :: Depth) where

Deprecated. see Icarus

The hierarchical derivation indices for a given level/depth.

Equations

DerivationPath 'RootK = ()
DerivationPath 'AccountK = Index 'WholeDomain 'AccountK
DerivationPath 'PaymentK = (Index 'WholeDomain 'AccountK, Index 'WholeDomain 'PaymentK)

valuepayloadPassphrase :: Byron depth key -> ScrubbedBytes

Deprecated. see Icarus

Used for encryption of the derivation path payload within an address.

valuederivationPath :: Byron depth key -> DerivationPath depth

Deprecated. see Icarus

The address derivation indices for the level of this key.

valuegetKey :: Byron depth key -> key

Deprecated. see Icarus

The raw private or public key.

Key Derivation

4 declarations

valuegenMasterKeyFromXPrv :: XPrv -> Byron 'RootK XPrv

Deprecated. see Icarus

Generate a root key from a corresponding root XPrv

valuegenMasterKeyFromMnemonic

:: SomeMnemonic
Some valid mnemonic sentence.
-> Byron 'RootK XPrv

Deprecated. see Icarus

Generate a root key from a corresponding mnemonic.

valuederiveAccountPrivateKey

Deprecated. see Icarus

Derives an account private key from the given root private key.

valuederiveAddressPrivateKey

Deprecated. see Icarus

Derives an address private key from the given account private key.

Addresses

7 declarations

datadata AddressInfo

The result of eitherInspectAddress for Byron addresses.

Constructors

AddressInfo
- infoAddressRoot :: !ByteString
- infoPayload :: !PayloadInfo
- infoNetworkTag :: !Maybe NetworkTag

Instances5Eq, Show, Generic, ToJSON, Rep

Eq AddressInfoDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
Show AddressInfoDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
Generic AddressInfoDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
ToJSON AddressInfoDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
type Rep AddressInfo = D1 ('MetaData "AddressInfo" "Cardano.Address.Style.Byron" "cardano-addresses-4.0.2-IfBlVg9kl2D9r65sjHkHQ2" 'False) (C1 ('MetaCons "AddressInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "infoAddressRoot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: (S1 ('MetaSel ('Just "infoPayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PayloadInfo) :*: S1 ('MetaSel ('Just "infoNetworkTag") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe NetworkTag)))))Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron

valueeitherInspectAddress

:: Maybe XPub
-> Address
-> Either ErrInspectAddress AddressInfo

Determines whether an Address is a Byron address.

Returns either details about the Address, or ErrInspectAddress if it's not a valid address.

valueinspectAddress :: MonadThrow m => Maybe XPub -> Address -> m Value

Determines whether an Address is a Byron address.

Returns a JSON object with information about the address, or throws ErrInspectAddress if the address isn't a byron address.

valueinspectByronAddress :: MonadThrow m => Maybe XPub -> Address -> m Value

Deprecated. use qualified inspectAddress instead.

Determines whether an Address is a Byron address.

Returns a JSON object with information about the address, or throws ErrInspectAddress if the address isn't a byron address.

valuepaymentAddress

Convert a public key to a payment Address valid for the given network discrimination.

datadata ErrInspectAddress

Possible errors from inspecting a Byron address

Constructors

MissingExpectedDerivationPath
DeserialiseError DeserialiseFailure
FailedToDecryptPath

Instances6Eq, Show, Generic, Exception, ToJSON, Rep

Eq ErrInspectAddressDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
Show ErrInspectAddressDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
Generic ErrInspectAddressDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
Exception ErrInspectAddressDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
ToJSON ErrInspectAddressDefined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron
type Rep ErrInspectAddress = D1 ('MetaData "ErrInspectAddress" "Cardano.Address.Style.Byron" "cardano-addresses-4.0.2-IfBlVg9kl2D9r65sjHkHQ2" 'False) (C1 ('MetaCons "MissingExpectedDerivationPath" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "DeserialiseError" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DeserialiseFailure)) :+: C1 ('MetaCons "FailedToDecryptPath" 'PrefixI 'False) U1))Defined in cardano-addresses-4.0.2 · Cardano.Address.Style.Byron

valueprettyErrInspectAddress :: ErrInspectAddress -> String

Pretty-print an ErrInspectAddress

Network Discrimination

5 declarations

valuebyronMainnet :: NetworkDiscriminant Byron

NetworkDiscriminant for Cardano MainNet & Byron

valuebyronStaging :: NetworkDiscriminant Byron

NetworkDiscriminant for Cardano Staging & Byron

valuebyronTestnet :: NetworkDiscriminant Byron

NetworkDiscriminant for Cardano Testnet & Byron

valuebyronPreprod :: NetworkDiscriminant Byron

NetworkDiscriminant for Cardano Preprod & Byron

valuebyronPreview :: NetworkDiscriminant Byron

NetworkDiscriminant for Cardano Preview & Byron

Unsafe

3 declarations

valueliftXPrv

:: XPub
A root public key
-> DerivationPath depth
-> XPrv
-> Byron depth XPrv

Deprecated. see Icarus

Backdoor for generating a new key from a raw XPrv.

Note that the depth is left open so that the caller gets to decide what type of key this is. This is mostly for testing, in practice, seeds are used to represent root keys, and one should genMasterKeyFromXPrv

The first argument is a type-family DerivationPath and its type depends on the depth of the key.

examples:

Example1 expression

>>> liftXPrv rootPrv () prv_ :: Byron RootK XPrv

Example1 expression

>>> liftXPrv rootPrv minBound prv_ :: Byron AccountK XPrv

Example1 expression

>>> liftXPrv rootPrv (minBound, minBound) prv_ :: Byron PaymentK XPrv

valueliftXPub

:: XPub
A root public key
-> DerivationPath depth
-> XPub
-> Byron depth XPub

Deprecated. see Icarus

Backdoor for generating a new key from a raw XPub.