Struct OffchainPublicKey
pub struct OffchainPublicKey([u8; 32]);Expand description
Represents an Ed25519 public key in its compact (compressed) form.
This is the form to use wherever the key acts as an identifier: in maps, paths, protocol messages and anything that is stored. It is 32 bytes and cheap to copy, hash and compare.
Constructing it does not check that the bytes are a valid curve point, because doing so
costs a point decompression and the vast majority of keys never enter an EC computation. Use
OffchainPublicKey::validate at trust boundaries, or convert to
[ExpandedOffchainPublicKey], which performs the check as part of the conversion.
Tuple Fields§
§0: [u8; 32]Implementations§
§impl OffchainPublicKey
impl OffchainPublicKey
pub fn from_privkey(
private_key: &[u8],
) -> Result<OffchainPublicKey, CryptoError>
pub fn from_privkey( private_key: &[u8], ) -> Result<OffchainPublicKey, CryptoError>
Tries to create the public key from a Ed25519 private key.
The length must be exactly ed25519_dalek::SECRET_KEY_LENGTH.
pub fn to_peerid_str(&self) -> String
pub fn to_peerid_str(&self) -> String
Outputs the public key as PeerId represented as Base58 string.
pub fn from_peerid(peerid: &PeerId) -> Result<OffchainPublicKey, GeneralError>
pub fn from_peerid(peerid: &PeerId) -> Result<OffchainPublicKey, GeneralError>
Tries to convert an Ed25519 PeerId to OffchainPublicKey.
Reads the key straight out of the peer id’s identity multihash. As with
TryFrom<&[u8]>, the bytes are not checked against the
curve; see the note on OffchainPublicKey.
pub fn validate(&self) -> Result<(), GeneralError>
pub fn validate(&self) -> Result<(), GeneralError>
Checks that these bytes really are a point on the Ed25519 curve.
This is CPU-intensive, since it performs the point decompression. Use it at boundaries where an unvalidated key would only fail much later, such as when ingesting keys from the chain indexer or from storage.
Trait Implementations§
§impl AsRef<[u8]> for OffchainPublicKey
impl AsRef<[u8]> for OffchainPublicKey
§impl BytesRepresentable for OffchainPublicKey
impl BytesRepresentable for OffchainPublicKey
§impl Clone for OffchainPublicKey
impl Clone for OffchainPublicKey
§fn clone(&self) -> OffchainPublicKey
fn clone(&self) -> OffchainPublicKey
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreimpl Copy for OffchainPublicKey
§impl Debug for OffchainPublicKey
impl Debug for OffchainPublicKey
§impl<'de> Deserialize<'de> for OffchainPublicKey
impl<'de> Deserialize<'de> for OffchainPublicKey
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<OffchainPublicKey, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<OffchainPublicKey, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl Display for OffchainPublicKey
impl Display for OffchainPublicKey
impl Eq for OffchainPublicKey
§impl<'a> From<&'a OffchainPublicKey> for &'a Array<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>
impl<'a> From<&'a OffchainPublicKey> for &'a Array<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>
§impl From<&ExpandedOffchainPublicKey> for OffchainPublicKey
impl From<&ExpandedOffchainPublicKey> for OffchainPublicKey
§fn from(value: &ExpandedOffchainPublicKey) -> OffchainPublicKey
fn from(value: &ExpandedOffchainPublicKey) -> OffchainPublicKey
§impl From<&OffchainPublicKey> for PeerId
impl From<&OffchainPublicKey> for PeerId
§fn from(value: &OffchainPublicKey) -> PeerId
fn from(value: &OffchainPublicKey) -> PeerId
§impl From<ExpandedOffchainPublicKey> for OffchainPublicKey
impl From<ExpandedOffchainPublicKey> for OffchainPublicKey
§fn from(value: ExpandedOffchainPublicKey) -> OffchainPublicKey
fn from(value: ExpandedOffchainPublicKey) -> OffchainPublicKey
§impl From<OffchainPublicKey> for [u8; 32]
impl From<OffchainPublicKey> for [u8; 32]
§fn from(value: OffchainPublicKey) -> [u8; 32]
fn from(value: OffchainPublicKey) -> [u8; 32]
§impl From<OffchainPublicKey> for PeerId
impl From<OffchainPublicKey> for PeerId
§fn from(value: OffchainPublicKey) -> PeerId
fn from(value: OffchainPublicKey) -> PeerId
§impl FromStr for OffchainPublicKey
impl FromStr for OffchainPublicKey
§impl Hash for OffchainPublicKey
impl Hash for OffchainPublicKey
§impl PartialEq for OffchainPublicKey
impl PartialEq for OffchainPublicKey
§impl Serialize for OffchainPublicKey
impl Serialize for OffchainPublicKey
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl StructuralPartialEq for OffchainPublicKey
§impl TryFrom<&[u8]> for OffchainPublicKey
impl TryFrom<&[u8]> for OffchainPublicKey
§fn try_from(
value: &[u8],
) -> Result<OffchainPublicKey, <OffchainPublicKey as TryFrom<&[u8]>>::Error>
fn try_from( value: &[u8], ) -> Result<OffchainPublicKey, <OffchainPublicKey as TryFrom<&[u8]>>::Error>
Checks the length only. See the note on OffchainPublicKey about curve validity.
§impl TryFrom<NodeId> for OffchainPublicKey
impl TryFrom<NodeId> for OffchainPublicKey
§fn try_from(
value: NodeId,
) -> Result<OffchainPublicKey, <OffchainPublicKey as TryFrom<NodeId>>::Error>
fn try_from( value: NodeId, ) -> Result<OffchainPublicKey, <OffchainPublicKey as TryFrom<NodeId>>::Error>
Auto Trait Implementations§
impl Freeze for OffchainPublicKey
impl RefUnwindSafe for OffchainPublicKey
impl Send for OffchainPublicKey
impl Sync for OffchainPublicKey
impl Unpin for OffchainPublicKey
impl UnsafeUnpin for OffchainPublicKey
impl UnwindSafe for OffchainPublicKey
Blanket Implementations§
§impl<A, T> AsBits<T> for A
impl<A, T> AsBits<T> for A
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<'de, T> BorrowedRpcObject<'de> for Twhere
T: RpcBorrow<'de> + RpcSend,
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreimpl<T> MeasurableNode for Twhere
T: Into<OffchainPublicKey>,
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
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) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
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
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
impl<'de, T> RpcBorrow<'de> for T
impl<T> RpcObject for Twhere
T: RpcSend + RpcRecv,
impl<T> RpcRecv for T
impl<T> RpcSend for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.§impl<T> ToHex for Twhere
T: BytesRepresentable,
impl<T> ToHex for Twhere
T: BytesRepresentable,
§impl<T> ToHex for T
impl<T> ToHex for T
§fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
use ToHexExt instead
self into the result.
Lower case letters are used (e.g. f9b4ca).§fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
use ToHexExt instead
self into the result.
Upper case letters are used (e.g. F9B4CA).Source§impl<T> ToHex for T
impl<T> ToHex for T
Source§fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
self into the result. Lower case
letters are used (e.g. f9b4ca)Source§fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
self into the result. Upper case
letters are used (e.g. F9B4CA)§impl<T> ToHexExt for T
impl<T> ToHexExt for T
§fn encode_hex(&self) -> String
fn encode_hex(&self) -> String
self into the result.
Lower case letters are used (e.g. f9b4ca).§fn encode_hex_upper(&self) -> String
fn encode_hex_upper(&self) -> String
self into the result.
Upper case letters are used (e.g. F9B4CA).§fn encode_hex_with_prefix(&self) -> String
fn encode_hex_with_prefix(&self) -> String
self into the result with prefix 0x.
Lower case letters are used (e.g. 0xf9b4ca).§fn encode_hex_upper_with_prefix(&self) -> String
fn encode_hex_upper_with_prefix(&self) -> String
self into the result with prefix 0X.
Upper case letters are used (e.g. 0xF9B4CA).