Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.CLI.Shelley.Key

Description

Shelley CLI option data types and functions for cryptographic keys.

Synopsis

data VerificationKeyOrFile keyrole
- = VerificationKeyValue !(VerificationKey keyrole)
- | VerificationKeyFilePath !VerificationKeyFile
readVerificationKeyOrFile ∷ (HasTextEnvelope (VerificationKey keyrole), SerialiseAsBech32 (VerificationKey keyrole)) ⇒ AsType keyrole → VerificationKeyOrFile keyrole → IO (Either (FileError InputDecodeError) (VerificationKey keyrole))
readVerificationKeyOrTextEnvFile ∷ HasTextEnvelope (VerificationKey keyrole) ⇒ AsType keyrole → VerificationKeyOrFile keyrole → IO (Either (FileError InputDecodeError) (VerificationKey keyrole))
data VerificationKeyTextOrFile
- = VktofVerificationKeyText !Text
- | VktofVerificationKeyFile !VerificationKeyFile
data VerificationKeyTextOrFileError
- = VerificationKeyTextError !InputDecodeError
- | VerificationKeyFileError !(FileError InputDecodeError)
readVerificationKeyTextOrFileAnyOf ∷ VerificationKeyTextOrFile → IO (Either VerificationKeyTextOrFileError SomeAddressVerificationKey)
renderVerificationKeyTextOrFileError ∷ VerificationKeyTextOrFileError → Text
data VerificationKeyOrHashOrFile keyrole
- = VerificationKeyOrFile !(VerificationKeyOrFile keyrole)
- | VerificationKeyHash !(Hash keyrole)
readVerificationKeyOrHashOrFile ∷ (Key keyrole, SerialiseAsBech32 (VerificationKey keyrole)) ⇒ AsType keyrole → VerificationKeyOrHashOrFile keyrole → IO (Either (FileError InputDecodeError) (Hash keyrole))
readVerificationKeyOrHashOrTextEnvFile ∷ Key keyrole ⇒ AsType keyrole → VerificationKeyOrHashOrFile keyrole → IO (Either (FileError InputDecodeError) (Hash keyrole))
data PaymentVerifier
- = PaymentVerifierKey VerificationKeyTextOrFile
- | PaymentVerifierScriptFile ScriptFile
data StakeVerifier
generateKeyPair ∷ Key keyrole ⇒ AsType keyrole → IO (VerificationKey keyrole, SigningKey keyrole)

Documentation

data VerificationKeyOrFile keyrole Source #

Either a verification key or path to a verification key file.

Constructors

VerificationKeyValue !(VerificationKey keyrole)	A verification key.
VerificationKeyFilePath !VerificationKeyFile	A path to a verification key file. Note that this file hasn't been validated at all (whether it exists, contains a key of the correct type, etc.)

Instances

Instances details

Show (VerificationKey keyrole) ⇒ Show (VerificationKeyOrFile keyrole) Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods showsPrec ∷ Int → VerificationKeyOrFile keyrole → ShowS Source # show ∷ VerificationKeyOrFile keyrole → String Source # showList ∷ [VerificationKeyOrFile keyrole] → ShowS Source #
Eq (VerificationKey keyrole) ⇒ Eq (VerificationKeyOrFile keyrole) Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods (==) ∷ VerificationKeyOrFile keyrole → VerificationKeyOrFile keyrole → Bool Source # (/=) ∷ VerificationKeyOrFile keyrole → VerificationKeyOrFile keyrole → Bool Source #

readVerificationKeyOrFile ∷ (HasTextEnvelope (VerificationKey keyrole), SerialiseAsBech32 (VerificationKey keyrole)) ⇒ AsType keyrole → VerificationKeyOrFile keyrole → IO (Either (FileError InputDecodeError) (VerificationKey keyrole)) Source #

Read a verification key or verification key file and return a verification key.

If a filepath is provided, the file can either be formatted as Bech32, hex, or text envelope.

readVerificationKeyOrTextEnvFile ∷ HasTextEnvelope (VerificationKey keyrole) ⇒ AsType keyrole → VerificationKeyOrFile keyrole → IO (Either (FileError InputDecodeError) (VerificationKey keyrole)) Source #

Read a verification key or verification key file and return a verification key.

If a filepath is provided, it will be interpreted as a text envelope formatted file.

data VerificationKeyTextOrFile Source #

Either an unvalidated text representation of a verification key or a path to a verification key file.

Constructors

VktofVerificationKeyText !Text
VktofVerificationKeyFile !VerificationKeyFile

Instances

Instances details

Show VerificationKeyTextOrFile Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods showsPrec ∷ Int → VerificationKeyTextOrFile → ShowS Source # show ∷ VerificationKeyTextOrFile → String Source # showList ∷ [VerificationKeyTextOrFile] → ShowS Source #
Eq VerificationKeyTextOrFile Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods (==) ∷ VerificationKeyTextOrFile → VerificationKeyTextOrFile → Bool Source # (/=) ∷ VerificationKeyTextOrFile → VerificationKeyTextOrFile → Bool Source #

data VerificationKeyTextOrFileError Source #

An error in deserialising a VerificationKeyTextOrFile to a VerificationKey.

Constructors

VerificationKeyTextError !InputDecodeError
VerificationKeyFileError !(FileError InputDecodeError)

Instances

Instances details

Show VerificationKeyTextOrFileError Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods showsPrec ∷ Int → VerificationKeyTextOrFileError → ShowS Source # show ∷ VerificationKeyTextOrFileError → String Source # showList ∷ [VerificationKeyTextOrFileError] → ShowS Source #

readVerificationKeyTextOrFileAnyOf ∷ VerificationKeyTextOrFile → IO (Either VerificationKeyTextOrFileError SomeAddressVerificationKey) Source #

Deserialise a verification key from text or a verification key file. If a filepath is provided, the file can either be formatted as Bech32, hex, or text envelope.

renderVerificationKeyTextOrFileError ∷ VerificationKeyTextOrFileError → Text Source #

Render an error message for a VerificationKeyTextOrFileError.

data VerificationKeyOrHashOrFile keyrole Source #

Verification key, verification key hash, or path to a verification key file.

Constructors

VerificationKeyOrFile !(VerificationKeyOrFile keyrole)	Either a verification key or path to a verification key file.
VerificationKeyHash !(Hash keyrole)	A verification key hash.

Instances

Instances details

(Show (VerificationKeyOrFile keyrole), Show (Hash keyrole)) ⇒ Show (VerificationKeyOrHashOrFile keyrole) Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods showsPrec ∷ Int → VerificationKeyOrHashOrFile keyrole → ShowS Source # show ∷ VerificationKeyOrHashOrFile keyrole → String Source # showList ∷ [VerificationKeyOrHashOrFile keyrole] → ShowS Source #
(Eq (VerificationKeyOrFile keyrole), Eq (Hash keyrole)) ⇒ Eq (VerificationKeyOrHashOrFile keyrole) Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods (==) ∷ VerificationKeyOrHashOrFile keyrole → VerificationKeyOrHashOrFile keyrole → Bool Source # (/=) ∷ VerificationKeyOrHashOrFile keyrole → VerificationKeyOrHashOrFile keyrole → Bool Source #

readVerificationKeyOrHashOrFile ∷ (Key keyrole, SerialiseAsBech32 (VerificationKey keyrole)) ⇒ AsType keyrole → VerificationKeyOrHashOrFile keyrole → IO (Either (FileError InputDecodeError) (Hash keyrole)) Source #

Read a verification key or verification key hash or verification key file and return a verification key hash.

If a filepath is provided, the file can either be formatted as Bech32, hex, or text envelope.

readVerificationKeyOrHashOrTextEnvFile ∷ Key keyrole ⇒ AsType keyrole → VerificationKeyOrHashOrFile keyrole → IO (Either (FileError InputDecodeError) (Hash keyrole)) Source #

Read a verification key or verification key hash or verification key file and return a verification key hash.

If a filepath is provided, it will be interpreted as a text envelope formatted file.

data PaymentVerifier Source #

Constructors

PaymentVerifierKey VerificationKeyTextOrFile
PaymentVerifierScriptFile ScriptFile

Instances

Instances details

Show PaymentVerifier Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods showsPrec ∷ Int → PaymentVerifier → ShowS Source # show ∷ PaymentVerifier → String Source # showList ∷ [PaymentVerifier] → ShowS Source #
Eq PaymentVerifier Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods (==) ∷ PaymentVerifier → PaymentVerifier → Bool Source # (/=) ∷ PaymentVerifier → PaymentVerifier → Bool Source #

data StakeVerifier Source #

Constructors

StakeVerifierKey (VerificationKeyOrFile StakeKey)
StakeVerifierScriptFile ScriptFile
StakeVerifierAddress StakeAddress

Instances

Instances details

Show StakeVerifier Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods showsPrec ∷ Int → StakeVerifier → ShowS Source # show ∷ StakeVerifier → String Source # showList ∷ [StakeVerifier] → ShowS Source #
Eq StakeVerifier Source #
Instance details Defined in Cardano.CLI.Shelley.Key Methods (==) ∷ StakeVerifier → StakeVerifier → Bool Source # (/=) ∷ StakeVerifier → StakeVerifier → Bool Source #

generateKeyPair ∷ Key keyrole ⇒ AsType keyrole → IO (VerificationKey keyrole, SigningKey keyrole) Source #