Modulecardano-addresses-4.0.2Haskell2010

Options.Applicative.Derivation

Contents

Derivation Path
Type
Applicative Parser
Derivation Index
XPub Pub XPrv / KeyHash
Internal

Synopsis

newtype DerivationPath
value castDerivationPath
value derivationPathToString
value derivationPathFromString
value derivationPathArg
newtype DerivationIndex
value mkDerivationIndex
value firstHardened
value indexToInteger
value derivationIndexToString
value derivationIndexFromString
value xpubReader
value xpubOpt
value xpubArg
value keyhashReader
value pubReader
value bech32Reader

Packagecardano-addresses-4.0.2
Exports17
LanguageHaskell2010
LicenceApache-2.0
SourceDerivation.hs

Derivation Path

Type

newtypenewtype DerivationPath

Source#

Represent a user-provided DerivationPath.

Instances2Eq, Show

Eq DerivationPathDefined in cardano-addresses-4.0.2 · Options.Applicative.Derivation
Show DerivationPathDefined in cardano-addresses-4.0.2 · Options.Applicative.Derivation

valuecastDerivationPath :: DerivationPath -> [Index 'WholeDomain depth]

valuederivationPathToString :: DerivationPath -> String

valuederivationPathFromString :: String -> Either String DerivationPath

Applicative Parser

valuederivationPathArg :: Parser DerivationPath

Derivation Index

newtypenewtype DerivationIndex

Instances4Bounded, Eq, Ord, Show

Bounded DerivationIndexDefined in cardano-addresses-4.0.2 · Options.Applicative.Derivation
Eq DerivationIndexDefined in cardano-addresses-4.0.2 · Options.Applicative.Derivation
Ord DerivationIndexDefined in cardano-addresses-4.0.2 · Options.Applicative.Derivation
Show DerivationIndexDefined in cardano-addresses-4.0.2 · Options.Applicative.Derivation

valuemkDerivationIndex :: Integer -> Either String DerivationIndex

Source#

Smart-constructor for a DerivationIndex

valuefirstHardened :: DerivationIndex

Source#

Get the first DerivationIndex considered hardened.

valueindexToInteger :: DerivationIndex -> Integer

Source#

Safely cast a DerivationIndex to an Integer.

valuederivationIndexToString :: DerivationIndex -> String

Source#

Convert a DerivationIndex back to string.

valuederivationIndexFromString :: String -> Either String DerivationIndex

Source#

Convert a string to a derivation index. String must be followed by a capital H to mark hardened index. For example 0 refers to the first soft index, whereas 0H refers to the first hardened index.

XPub Pub XPrv / KeyHash

valuexpubReader :: [HumanReadablePart] -> String -> Either String XPub

valuexpubOpt :: [HumanReadablePart] -> String -> String -> Parser XPub

valuexpubArg :: [HumanReadablePart] -> String -> Parser XPub

valuekeyhashReader

valuepubReader :: [HumanReadablePart] -> String -> Either String Pub

Internal

valuebech32Reader

:: [HumanReadablePart]
-> String
-> Either String (HumanReadablePart, ByteString)