Safe Haskell	None
Language	Haskell2010

Bcc.CLI.Sophie.Key

Description

Sophie CLI option data types and functions for cryptographic keys.

Synopsis

data InputFormat a where
- InputFormatBech32 ∷ SerialiseAsBech32 a ⇒ InputFormat a
- InputFormatHex ∷ SerialiseAsRawBytes a ⇒ InputFormat a
- InputFormatTextEnvelope ∷ HasTextEnvelope a ⇒ InputFormat a
data InputDecodeError
- = InputTextEnvelopeError !TextEnvelopeError
- | InputBech32DecodeError !Bech32DecodeError
- | InputInvalidError
deserialiseInput ∷ ∀ a. AsType a → NonEmpty (InputFormat a) → ByteString → Either InputDecodeError a
deserialiseInputAnyOf ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → ByteString → Either InputDecodeError b
renderInputDecodeError ∷ InputDecodeError → Text
readKeyFile ∷ AsType a → NonEmpty (InputFormat a) → FilePath → IO (Either (FileError InputDecodeError) a)
readKeyFileAnyOf ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → FilePath → IO (Either (FileError InputDecodeError) b)
readKeyFileTextEnvelope ∷ HasTextEnvelope a ⇒ AsType a → FilePath → IO (Either (FileError InputDecodeError) a)
readSigningKeyFile ∷ ∀ keyrole. (HasTextEnvelope (SigningKey keyrole), SerialiseAsBech32 (SigningKey keyrole)) ⇒ AsType keyrole → SigningKeyFile → IO (Either (FileError InputDecodeError) (SigningKey keyrole))
readSigningKeyFileAnyOf ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → SigningKeyFile → IO (Either (FileError InputDecodeError) b)
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 ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → VerificationKeyTextOrFile → IO (Either VerificationKeyTextOrFileError b)
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
- = StakeVerifierKey (VerificationKeyOrFile StakeKey)
- | StakeVerifierScriptFile ScriptFile

Documentation

data InputFormat a where Source #

Input format/encoding.

Constructors

InputFormatBech32 ∷ SerialiseAsBech32 a ⇒ InputFormat a	Bech32 encoding.
InputFormatHex ∷ SerialiseAsRawBytes a ⇒ InputFormat a	Hex/Base16 encoding.
InputFormatTextEnvelope ∷ HasTextEnvelope a ⇒ InputFormat a	Text envelope format.

data InputDecodeError Source #

Input decoding error.

Constructors

InputTextEnvelopeError !TextEnvelopeError	The provided data seems to be a valid text envelope, but some error occurred in deserialising it.
InputBech32DecodeError !Bech32DecodeError	The provided data is valid Bech32, but some error occurred in deserialising it.
InputInvalidError	The provided data does not represent a valid value of the provided type.

Instances

Instances details

Eq InputDecodeError Source #
Instance details Defined in Bcc.CLI.Sophie.Key Methods (==) ∷ InputDecodeError → InputDecodeError → Bool Source # (/=) ∷ InputDecodeError → InputDecodeError → Bool Source #
Show InputDecodeError Source #
Instance details Defined in Bcc.CLI.Sophie.Key Methods showsPrec ∷ Int → InputDecodeError → ShowS Source # show ∷ InputDecodeError → String Source # showList ∷ [InputDecodeError] → ShowS Source #
Error InputDecodeError Source #
Instance details Defined in Bcc.CLI.Sophie.Key Methods displayError ∷ InputDecodeError → String Source #

deserialiseInput ∷ ∀ a. AsType a → NonEmpty (InputFormat a) → ByteString → Either InputDecodeError a Source #

Deserialise an input of some type that is formatted in some way.

deserialiseInputAnyOf ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → ByteString → Either InputDecodeError b Source #

Deserialise an input of some type that is formatted in some way.

The provided ByteString can either be Bech32-encoded or in the text envelope format.

renderInputDecodeError ∷ InputDecodeError → Text Source #

Render an error message for a InputDecodeError.

readKeyFile ∷ AsType a → NonEmpty (InputFormat a) → FilePath → IO (Either (FileError InputDecodeError) a) Source #

Read a cryptographic key from a file.

The contents of the file can either be Bech32-encoded, hex-encoded, or in the text envelope format.

readKeyFileAnyOf ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → FilePath → IO (Either (FileError InputDecodeError) b) Source #

Read a cryptographic key from a file given that it is one of the provided types.

The contents of the file can either be Bech32-encoded or in the text envelope format.

readKeyFileTextEnvelope ∷ HasTextEnvelope a ⇒ AsType a → FilePath → IO (Either (FileError InputDecodeError) a) Source #

Read a cryptographic key from a file.

The contents of the file must be in the text envelope format.

readSigningKeyFile ∷ ∀ keyrole. (HasTextEnvelope (SigningKey keyrole), SerialiseAsBech32 (SigningKey keyrole)) ⇒ AsType keyrole → SigningKeyFile → IO (Either (FileError InputDecodeError) (SigningKey keyrole)) Source #

Read a signing key from a file.

The contents of the file can either be Bech32-encoded, hex-encoded, or in the text envelope format.

readSigningKeyFileAnyOf ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → SigningKeyFile → IO (Either (FileError InputDecodeError) b) Source #

Read a signing key from a file given that it is one of the provided types of signing key.

The contents of the file can either be Bech32-encoded or in the text envelope format.

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

Eq (VerificationKey keyrole) ⇒ Eq (VerificationKeyOrFile keyrole) Source #
Instance details Defined in Bcc.CLI.Sophie.Key Methods (==) ∷ VerificationKeyOrFile keyrole → VerificationKeyOrFile keyrole → Bool Source # (/=) ∷ VerificationKeyOrFile keyrole → VerificationKeyOrFile keyrole → Bool Source #
Show (VerificationKey keyrole) ⇒ Show (VerificationKeyOrFile keyrole) Source #
Instance details Defined in Bcc.CLI.Sophie.Key Methods showsPrec ∷ Int → VerificationKeyOrFile keyrole → ShowS Source # show ∷ VerificationKeyOrFile keyrole → String Source # showList ∷ [VerificationKeyOrFile keyrole] → ShowS 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

Eq VerificationKeyTextOrFile Source #
Instance details Defined in Bcc.CLI.Sophie.Key Methods (==) ∷ VerificationKeyTextOrFile → VerificationKeyTextOrFile → Bool Source # (/=) ∷ VerificationKeyTextOrFile → VerificationKeyTextOrFile → Bool Source #
Show VerificationKeyTextOrFile Source #
Instance details Defined in Bcc.CLI.Sophie.Key Methods showsPrec ∷ Int → VerificationKeyTextOrFile → ShowS Source # show ∷ VerificationKeyTextOrFile → String Source # showList ∷ [VerificationKeyTextOrFile] → ShowS 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 Bcc.CLI.Sophie.Key Methods showsPrec ∷ Int → VerificationKeyTextOrFileError → ShowS Source # show ∷ VerificationKeyTextOrFileError → String Source # showList ∷ [VerificationKeyTextOrFileError] → ShowS Source #

readVerificationKeyTextOrFileAnyOf ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → VerificationKeyTextOrFile → IO (Either VerificationKeyTextOrFileError b) Source #

Deserialise a verification key from text or a verification key file given that it is one of the provided types.

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

(Eq (VerificationKeyOrFile keyrole), Eq (Hash keyrole)) ⇒ Eq (VerificationKeyOrHashOrFile keyrole) Source #
Instance details Defined in Bcc.CLI.Sophie.Key Methods (==) ∷ VerificationKeyOrHashOrFile keyrole → VerificationKeyOrHashOrFile keyrole → Bool Source # (/=) ∷ VerificationKeyOrHashOrFile keyrole → VerificationKeyOrHashOrFile keyrole → Bool Source #
(Show (VerificationKeyOrFile keyrole), Show (Hash keyrole)) ⇒ Show (VerificationKeyOrHashOrFile keyrole) Source #
Instance details Defined in Bcc.CLI.Sophie.Key Methods showsPrec ∷ Int → VerificationKeyOrHashOrFile keyrole → ShowS Source # show ∷ VerificationKeyOrHashOrFile keyrole → String Source # showList ∷ [VerificationKeyOrHashOrFile keyrole] → ShowS 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

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

data StakeVerifier Source #

Constructors

StakeVerifierKey (VerificationKeyOrFile StakeKey)
StakeVerifierScriptFile ScriptFile

Instances

Instances details

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