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

Cardano.Wallet.Primitive.AddressDerivation.Shelley

Contents

Types
Constants
Generation and derivation
Reward Account

Description

Implementation of address derivation for Shelley Keys.

Synopsis

newtype ShelleyKey (depth :: Depth ) key = ShelleyKey {
- getKey :: key
}
minSeedLengthBytes :: Int
generateKeyFromSeed :: ( SomeMnemonic , Maybe SomeMnemonic ) -> Passphrase "encryption" -> ShelleyKey ' RootK XPrv
unsafeGenerateKeyFromSeed :: ( SomeMnemonic , Maybe SomeMnemonic ) -> Passphrase "encryption" -> ShelleyKey depth XPrv
unsafeGenerateKeyFromSeedShelley :: ( SomeMnemonic , Maybe SomeMnemonic ) -> Passphrase "encryption" -> XPrv
deriveAccountPrivateKeyShelley :: Index ' Hardened ' PurposeK -> Passphrase "encryption" -> XPrv -> Index ' Hardened ' AccountK -> XPrv
deriveAddressPrivateKeyShelley :: Enum a => Passphrase "encryption" -> XPrv -> a -> Index derivationType level -> XPrv
deriveAddressPublicKeyShelley :: Enum a => XPub -> a -> Index derivationType level -> XPub
toRewardAccountRaw :: XPub -> RewardAccount

Types

newtype ShelleyKey (depth :: Depth ) key Source #

A cryptographic key for Shelley address derivation, with phantom-types to disambiguate derivation paths

let rootPrivateKey = ShelleyKey 'RootK XPrv
let accountPubKey = ShelleyKey 'AccountK XPub
let addressPubKey = ShelleyKey 'AddressK XPub

Constructors

ShelleyKey
Fields getKey :: key

Instances

Instances details

WalletKey ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods changePassphrase :: forall (depth :: Depth ). ( PassphraseScheme , Passphrase "user") -> ( PassphraseScheme , Passphrase "user") -> ShelleyKey depth XPrv -> ShelleyKey depth XPrv Source # publicKey :: forall (depth :: Depth ). ShelleyKey depth XPrv -> ShelleyKey depth XPub Source # digest :: forall a (depth :: Depth ). HashAlgorithm a => ShelleyKey depth XPub -> Digest a Source # keyTypeDescriptor :: Proxy ShelleyKey -> String Source # getRawKey :: forall (depth :: Depth ) raw. ShelleyKey depth raw -> raw Source # liftRawKey :: forall raw (depth :: Depth ). raw -> ShelleyKey depth raw Source #
ToRewardAccount ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods toRewardAccount :: ShelleyKey ' AddressK XPub -> RewardAccount Source # someRewardAccount :: SomeMnemonic -> ( XPrv , RewardAccount , NonEmpty DerivationIndex ) Source #
SoftDerivation ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods deriveAddressPublicKey :: ShelleyKey ' AccountK XPub -> Role -> Index ' Soft ' AddressK -> ShelleyKey ' AddressK XPub Source #
HardDerivation ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Associated Types type AddressIndexDerivationType ShelleyKey :: DerivationType Source # Methods deriveAccountPrivateKey :: Passphrase "encryption" -> ShelleyKey ' RootK XPrv -> Index ' Hardened ' AccountK -> ShelleyKey ' AccountK XPrv Source # deriveAddressPrivateKey :: Passphrase "encryption" -> ShelleyKey ' AccountK XPrv -> Role -> Index ( AddressIndexDerivationType ShelleyKey ) ' AddressK -> ShelleyKey ' AddressK XPrv Source #
GetPurpose ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods getPurpose :: Index ' Hardened ' PurposeK Source #
MkKeyFingerprint ShelleyKey Address Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods paymentKeyFingerprint :: Address -> Either ( ErrMkKeyFingerprint ShelleyKey Address ) ( KeyFingerprint "payment" ShelleyKey ) Source #
DelegationAddress ' Mainnet ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods delegationAddress :: ShelleyKey ' AddressK XPub -> ShelleyKey ' AddressK XPub -> Address Source # liftDelegationAddress :: KeyFingerprint "payment" ShelleyKey -> ShelleyKey ' AddressK XPub -> Address Source #
PaymentAddress ' Mainnet ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods paymentAddress :: ShelleyKey ' AddressK XPub -> Address Source # liftPaymentAddress :: KeyFingerprint "payment" ShelleyKey -> Address Source #
MkKeyFingerprint ShelleyKey ( Proxy n, ShelleyKey ' AddressK XPub ) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods paymentKeyFingerprint :: ( Proxy n, ShelleyKey ' AddressK XPub ) -> Either ( ErrMkKeyFingerprint ShelleyKey ( Proxy n, ShelleyKey ' AddressK XPub )) ( KeyFingerprint "payment" ShelleyKey ) Source #
PersistPublicKey ( ShelleyKey depth) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods serializeXPub :: ShelleyKey depth XPub -> ByteString Source # unsafeDeserializeXPub :: ByteString -> ShelleyKey depth XPub Source #
PersistPrivateKey ( ShelleyKey ' RootK ) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods serializeXPrv :: ( ShelleyKey ' RootK XPrv , PassphraseHash ) -> ( ByteString , ByteString ) Source # unsafeDeserializeXPrv :: ( ByteString , ByteString ) -> ( ShelleyKey ' RootK XPrv , PassphraseHash ) Source #
DelegationAddress (' Testnet pm) ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods delegationAddress :: ShelleyKey ' AddressK XPub -> ShelleyKey ' AddressK XPub -> Address Source # liftDelegationAddress :: KeyFingerprint "payment" ShelleyKey -> ShelleyKey ' AddressK XPub -> Address Source #
PaymentAddress (' Testnet pm) ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods paymentAddress :: ShelleyKey ' AddressK XPub -> Address Source # liftPaymentAddress :: KeyFingerprint "payment" ShelleyKey -> Address Source #
Eq key => Eq ( ShelleyKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods (==) :: ShelleyKey depth key -> ShelleyKey depth key -> Bool Source # (/=) :: ShelleyKey depth key -> ShelleyKey depth key -> Bool Source #
Show key => Show ( ShelleyKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods showsPrec :: Int -> ShelleyKey depth key -> ShowS Source # show :: ShelleyKey depth key -> String Source # showList :: [ ShelleyKey depth key] -> ShowS Source #
Generic ( ShelleyKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Associated Types type Rep ( ShelleyKey depth key) :: Type -> Type Source # Methods from :: ShelleyKey depth key -> Rep ( ShelleyKey depth key) x Source # to :: Rep ( ShelleyKey depth key) x -> ShelleyKey depth key Source #
NFData key => NFData ( ShelleyKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods rnf :: ShelleyKey depth key -> () Source #
DelegationAddress n ShelleyKey => MaybeLight ( SeqState n ShelleyKey ) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods maybeDiscover :: Maybe (LightDiscoverTxs ( SeqState n ShelleyKey )) Source #
BoundedAddressLength ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods maxLengthAddressFor :: Proxy ShelleyKey -> Address Source #
IsOurs ( SeqState n ShelleyKey ) RewardAccount Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley Methods isOurs :: RewardAccount -> SeqState n ShelleyKey -> ( Maybe ( NonEmpty DerivationIndex ), SeqState n ShelleyKey ) Source #
type AddressIndexDerivationType ShelleyKey Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley type AddressIndexDerivationType ShelleyKey = ' Soft
type Rep ( ShelleyKey depth key) Source #
Instance details Defined in Cardano.Wallet.Primitive.AddressDerivation.Shelley type Rep ( ShelleyKey depth key) = D1 (' MetaData "ShelleyKey" "Cardano.Wallet.Primitive.AddressDerivation.Shelley" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "ShelleyKey" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getKey") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 key)))

Constants

minSeedLengthBytes :: Int Source #

The minimum seed length for generateKeyFromSeed and unsafeGenerateKeyFromSeed .

Generation and derivation

generateKeyFromSeed Source #

Arguments

:: ( SomeMnemonic , Maybe SomeMnemonic )	The actual seed and its recovery / generation passphrase
-> Passphrase "encryption"
-> ShelleyKey ' RootK XPrv

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

unsafeGenerateKeyFromSeed Source #

Arguments

:: ( SomeMnemonic , Maybe SomeMnemonic )	The actual seed and its recovery / generation passphrase
-> Passphrase "encryption"
-> ShelleyKey depth XPrv

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 .

unsafeGenerateKeyFromSeedShelley Source #

Arguments

:: ( SomeMnemonic , Maybe SomeMnemonic )	The actual seed and its recovery / generation passphrase
-> Passphrase "encryption"
-> XPrv

deriveAccountPrivateKeyShelley :: Index ' Hardened ' PurposeK -> Passphrase "encryption" -> XPrv -> Index ' Hardened ' AccountK -> XPrv Source #

deriveAddressPrivateKeyShelley :: Enum a => Passphrase "encryption" -> XPrv -> a -> Index derivationType level -> XPrv Source #

deriveAddressPublicKeyShelley :: Enum a => XPub -> a -> Index derivationType level -> XPub Source #

Reward Account

toRewardAccountRaw :: XPub -> RewardAccount Source #