Copyright	© 2018-2020 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Cardano.Wallet.Primitive.AddressDerivation.Byron

Contents

Types
Generation
Derivation

Description

Implementation of address derivation for the random scheme, as implemented by the legacy Cardano wallets.

For full documentation of the key derivation schemes, see the Cardano.Crypto.Wallet module, and the implementation in cardano-crypto .

Synopsis

data ByronKey (depth :: Depth ) key = ByronKey {
- getKey :: key
- derivationPath :: DerivationPathFrom depth
- payloadPassphrase :: Passphrase "addr-derivation-payload"
}
type family DerivationPathFrom (depth :: Depth ) :: Type where ...
unsafeGenerateKeyFromSeed :: DerivationPathFrom depth -> SomeMnemonic -> Passphrase "encryption" -> ByronKey depth XPrv
generateKeyFromSeed :: SomeMnemonic -> Passphrase "encryption" -> ByronKey ' RootK XPrv
minSeedLengthBytes :: Int
unsafeMkByronKeyFromMasterKey :: DerivationPathFrom depth -> XPrv -> ByronKey depth XPrv
mkByronKeyFromMasterKey :: XPrv -> ByronKey ' RootK XPrv
deriveAccountPrivateKey :: Passphrase "encryption" -> ByronKey ' RootK XPrv -> Index ' WholeDomain ' AccountK -> ByronKey ' AccountK XPrv
deriveAddressPrivateKey :: Passphrase "encryption" -> ByronKey ' AccountK XPrv -> Index ' WholeDomain ' AddressK -> ByronKey ' AddressK XPrv

Types

data ByronKey (depth :: Depth ) key Source #

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

Constructors

ByronKey
Fields getKey :: key The raw private or public key. derivationPath :: DerivationPathFrom depth The address derivation indices for the level of this key. payloadPassphrase :: Passphrase "addr-derivation-payload" Used for encryption of payload containing address derivation path.

Instances

Instances details

WalletKey ByronKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Methods changePassphrase :: forall (depth :: Depth ). ( PassphraseScheme , Passphrase "user") -> ( PassphraseScheme , Passphrase "user") -> ByronKey depth XPrv -> ByronKey depth XPrv Source # publicKey :: forall (depth :: Depth ). ByronKey depth XPrv -> ByronKey depth XPub Source # digest :: forall a (depth :: Depth ). HashAlgorithm a => ByronKey depth XPub -> Digest a Source # keyTypeDescriptor :: Proxy ByronKey -> String Source # getRawKey :: forall (depth :: Depth ) raw. ByronKey depth raw -> raw Source # liftRawKey :: forall raw (depth :: Depth ). raw -> ByronKey depth raw Source #
HardDerivation ByronKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Associated Types type AddressIndexDerivationType ByronKey :: DerivationType Source # Methods deriveAccountPrivateKey :: Passphrase "encryption" -> ByronKey ' RootK XPrv -> Index ' Hardened ' AccountK -> ByronKey ' AccountK XPrv Source # deriveAddressPrivateKey :: Passphrase "encryption" -> ByronKey ' AccountK XPrv -> Role -> Index ( AddressIndexDerivationType ByronKey ) ' AddressK -> ByronKey ' AddressK XPrv Source #
MkKeyFingerprint ByronKey Address Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Methods paymentKeyFingerprint :: Address -> Either ( ErrMkKeyFingerprint ByronKey Address ) ( KeyFingerprint "payment" ByronKey ) Source #
PaymentAddress ' Mainnet ByronKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Methods paymentAddress :: ByronKey ' AddressK XPub -> Address Source # liftPaymentAddress :: KeyFingerprint "payment" ByronKey -> Address Source #
PersistPrivateKey ( ByronKey ' RootK ) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Methods serializeXPrv :: ( ByronKey ' RootK XPrv , PassphraseHash ) -> ( ByteString , ByteString ) Source # unsafeDeserializeXPrv :: ( ByteString , ByteString ) -> ( ByronKey ' RootK XPrv , PassphraseHash ) Source #
KnownNat pm => PaymentAddress (' Testnet pm) ByronKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Methods paymentAddress :: ByronKey ' AddressK XPub -> Address Source # liftPaymentAddress :: KeyFingerprint "payment" ByronKey -> Address Source #
IsOwned ( RndState n) ByronKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDiscovery.Random Methods isOwned :: RndState n -> ( ByronKey ' RootK XPrv , Passphrase "encryption") -> Address -> Maybe ( ByronKey ' AddressK XPrv , Passphrase "encryption") Source #
( Eq key, Eq ( DerivationPathFrom depth)) => Eq ( ByronKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Methods (==) :: ByronKey depth key -> ByronKey depth key -> Bool Source # (/=) :: ByronKey depth key -> ByronKey depth key -> Bool Source #
( Show key, Show ( DerivationPathFrom depth)) => Show ( ByronKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Methods showsPrec :: Int -> ByronKey depth key -> ShowS Source # show :: ByronKey depth key -> String Source # showList :: [ ByronKey depth key] -> ShowS Source #
Generic ( ByronKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Associated Types type Rep ( ByronKey depth key) :: Type -> Type Source # Methods from :: ByronKey depth key -> Rep ( ByronKey depth key) x Source # to :: Rep ( ByronKey depth key) x -> ByronKey depth key Source #
( NFData key, NFData ( DerivationPathFrom depth)) => NFData ( ByronKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Methods rnf :: ByronKey depth key -> () Source #
BoundedAddressLength ByronKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron Methods maxLengthAddressFor :: Proxy ByronKey -> Address Source #
KnownNat p => IsOwned ( RndAnyState n p) ByronKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDiscovery.Random Methods isOwned :: RndAnyState n p -> ( ByronKey ' RootK XPrv , Passphrase "encryption") -> Address -> Maybe ( ByronKey ' AddressK XPrv , Passphrase "encryption") Source #
type AddressIndexDerivationType ByronKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron type AddressIndexDerivationType ByronKey = ' WholeDomain
type Rep ( ByronKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Byron type Rep ( ByronKey depth key) = D1 (' MetaData "ByronKey" "Cardano.Wallet.Primitive.AddressDerivation.Byron" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ByronKey" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getKey") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 key) :: ( S1 (' MetaSel (' Just "derivationPath") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( DerivationPathFrom depth)) :: S1 (' MetaSel (' Just "payloadPassphrase") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Passphrase "addr-derivation-payload")))))

type family DerivationPathFrom (depth :: Depth ) :: Type where ... Source #

The hierarchical derivation indices for a given level/depth.

Equations

DerivationPathFrom ' RootK = ()
DerivationPathFrom ' AccountK = Index ' WholeDomain ' AccountK
DerivationPathFrom ' AddressK = ( Index ' WholeDomain ' AccountK , Index ' WholeDomain ' AddressK )

Generation

unsafeGenerateKeyFromSeed :: DerivationPathFrom depth -> SomeMnemonic -> Passphrase "encryption" -> ByronKey depth XPrv Source #

Generate a new key from seed. 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 use generateKeyFromSeed .

generateKeyFromSeed :: SomeMnemonic -> Passphrase "encryption" -> ByronKey ' RootK XPrv Source #

Generate a root key from a corresponding seed. The seed should be at least 16 bytes.

minSeedLengthBytes :: Int Source #

The amount of entropy carried by a BIP-39 12-word mnemonic is 16 bytes.

unsafeMkByronKeyFromMasterKey :: DerivationPathFrom depth -> XPrv -> ByronKey depth XPrv Source #

mkByronKeyFromMasterKey :: XPrv -> ByronKey ' RootK XPrv Source #

Derivation

deriveAccountPrivateKey :: Passphrase "encryption" -> ByronKey ' RootK XPrv -> Index ' WholeDomain ' AccountK -> ByronKey ' AccountK XPrv Source #

Derives account private key from the given root private key, using derivation scheme 1.

NOTE: The caller is expected to provide the corresponding passphrase (and to have checked that the passphrase is valid). Providing a wrong passphrase will not make the function fail but will instead, yield an incorrect new key that doesn't belong to the wallet.

deriveAddressPrivateKey :: Passphrase "encryption" -> ByronKey ' AccountK XPrv -> Index ' WholeDomain ' AddressK -> ByronKey ' AddressK XPrv Source #

Derives address private key from the given account private key, using derivation scheme 1.

NOTE: The caller is expected to provide the corresponding passphrase (and to have checked that the passphrase is valid). Providing a wrong passphrase will not make the function fail but will instead, yield an incorrect new key that doesn't belong to the wallet.