ProtocolKey

mithril_common::crypto_helper

Struct ProtocolKey

pub struct ProtocolKey<T>where
    T: Serialize + DeserializeOwned,
{ /* private fields */ }

Expand description

A ProtocolKey is a wrapped that add Serialization capabilities.

When using serde to (de)serialize it will done using json hex (see key_decode_hex and key_encode_hex).

Implementations§

impl ProtocolKey<VerifyingKey>

pub fn verify( &self, message: &[u8], signature: &Ed25519Signature, ) -> StdResult<()>

Verifies the signature of a message

impl<T> ProtocolKey<T>
where T: Serialize + DeserializeOwned + TryToBytes + TryFromBytes,

pub fn new(key: T) -> Self

Create a ProtocolKey from the given key

pub fn from_json_hex(hex_string: &str) -> StdResult<Self>

Create an instance from a JSON hex representation

pub fn to_json_hex(&self) -> StdResult<String>

Create a JSON hex representation of the key

pub fn key_to_json_hex(key: &T) -> StdResult<String>

Create a JSON hash representation of the given key

pub fn write_json_hex_to_file(&self, path: &Path) -> StdResult<()>

Write to file in JSON hex format

pub fn read_json_hex_from_file(path: &Path) -> StdResult<Self>

Read from file in JSON hex format

pub fn from_bytes(bytes: &[u8]) -> StdResult<Self>

Create an instance from bytes

pub fn from_bytes_hex(hex_string: &str) -> StdResult<Self>

Create an instance from a bytes hex representation

pub fn to_bytes_hex(&self) -> StdResult<String>

Create a bytes hex representation of the key

pub fn key_to_bytes_hex(key: &T) -> StdResult<String>

Create a bytes hex representation of the given key

pub fn into_inner(self) -> T

Consume self and return the inner key

Trait Implementations§

impl<T> Clone for ProtocolKey<T>
where T: Serialize + DeserializeOwned + Clone,

fn clone(&self) -> ProtocolKey<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<T> Debug for ProtocolKey<T>
where T: Serialize + DeserializeOwned + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<T> Deref for ProtocolKey<T>
where T: Serialize + DeserializeOwned,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, T> Deserialize<'de> for ProtocolKey<T>
where T: ProtocolKeyCodec<T> + Serialize + DeserializeOwned + TryToBytes + TryFromBytes,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<AggregateSignature<CoreWrapper<CtVariableCoreWrapper<Blake2bVarCore, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>>>> for ProtocolKey<AggregateSignature<Blake2b<U32>>>

fn from(value: AggregateSignature<Blake2b<U32>>) -> Self

Converts to this type from the input type.

impl From<AggregateVerificationKey<CoreWrapper<CtVariableCoreWrapper<Blake2bVarCore, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>>>> for ProtocolKey<AggregateVerificationKey<Blake2b<U32>>>

fn from(value: AggregateVerificationKey<Blake2b<U32>>) -> Self

Converts to this type from the input type.

impl From<BlsVerificationKeyProofOfPossession> for ProtocolKey<VerificationKeyProofOfPossession>

fn from(value: VerificationKeyProofOfPossession) -> Self

Converts to this type from the input type.

impl From<MKProof> for ProtocolKey<MKProof>

fn from(value: MKProof) -> Self

Converts to this type from the input type.

impl From<OpCert> for ProtocolKey<OpCert>

fn from(value: OpCert) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<AggregateSignature<CoreWrapper<CtVariableCoreWrapper<Blake2bVarCore, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>>>>> for AggregateSignature<Blake2b<U32>>

fn from(value: ProtocolKey<AggregateSignature<Blake2b<U32>>>) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<AggregateVerificationKey<CoreWrapper<CtVariableCoreWrapper<Blake2bVarCore, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>>>>> for AggregateVerificationKey<Blake2b<U32>>

fn from(value: ProtocolKey<AggregateVerificationKey<Blake2b<U32>>>) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<BlsVerificationKeyProofOfPossession>> for VerificationKeyProofOfPossession

fn from(value: ProtocolKey<VerificationKeyProofOfPossession>) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<MKProof>> for MKProof

fn from(value: ProtocolKey<MKProof>) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<OpCert>> for OpCert

fn from(value: ProtocolKey<OpCert>) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<Signature>> for Signature

fn from(value: ProtocolKey<Signature>) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<SigningKey>> for SigningKey

fn from(value: ProtocolKey<SigningKey>) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<SingleSignature>> for SingleSignature

fn from(value: ProtocolKey<SingleSignature>) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<Sum6KesSig>> for Sum6KesSig

fn from(value: ProtocolKey<Sum6KesSig>) -> Self

Converts to this type from the input type.

impl From<ProtocolKey<VerifyingKey>> for VerifyingKey

fn from(value: ProtocolKey<VerifyingKey>) -> Self

Converts to this type from the input type.

impl From<Signature> for ProtocolKey<Signature>

fn from(value: Signature) -> Self

Converts to this type from the input type.

impl From<SigningKey> for ProtocolKey<SigningKey>

fn from(value: SigningKey) -> Self

Converts to this type from the input type.

impl From<SingleSignature> for ProtocolKey<SingleSignature>

fn from(value: SingleSignature) -> Self

Converts to this type from the input type.

impl From<Sum6KesSig> for ProtocolKey<Sum6KesSig>

fn from(value: Sum6KesSig) -> Self

Converts to this type from the input type.

impl From<VerifyingKey> for ProtocolKey<VerifyingKey>

fn from(value: VerifyingKey) -> Self

Converts to this type from the input type.

impl<T> PartialEq for ProtocolKey<T>
where T: Serialize + DeserializeOwned + PartialEq,

fn eq(&self, other: &ProtocolKey<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for ProtocolKey<T>
where T: ProtocolKeyCodec<T> + Serialize + DeserializeOwned + TryToBytes + TryFromBytes,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<T> TryFrom<&ProtocolKey<T>> for String
where T: ProtocolKeyCodec<T> + Serialize + DeserializeOwned + TryToBytes + TryFromBytes,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &ProtocolKey<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<&str> for ProtocolKey<T>
where T: ProtocolKeyCodec<T> + Serialize + DeserializeOwned + TryToBytes + TryFromBytes,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<ProtocolKey<T>> for String
where T: ProtocolKeyCodec<T> + Serialize + DeserializeOwned + TryToBytes + TryFromBytes,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: ProtocolKey<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<String> for ProtocolKey<T>
where T: ProtocolKeyCodec<T> + Serialize + DeserializeOwned + TryToBytes + TryFromBytes,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> Copy for ProtocolKey<T>
where T: Copy + Serialize + DeserializeOwned,

impl<T> Eq for ProtocolKey<T>
where T: Serialize + DeserializeOwned + Eq,

impl<T> StructuralPartialEq for ProtocolKey<T>
where T: Serialize + DeserializeOwned,

Auto Trait Implementations§

impl<T> Freeze for ProtocolKey<T>
where T: Freeze,

impl<T> RefUnwindSafe for ProtocolKey<T>
where T: RefUnwindSafe,

impl<T> Send for ProtocolKey<T>
where T: Send,

impl<T> Sync for ProtocolKey<T>
where T: Sync,

impl<T> Unpin for ProtocolKey<T>
where T: Unpin,

impl<T> UnwindSafe for ProtocolKey<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

fn lossy_into(self) -> Dst

Performs the conversion.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<T> Serialize for T
where T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,