Struct Enr

pub struct Enr<K: EnrKey> { /* private fields */ }

The ENR, allowing for arbitrary signing algorithms.

This struct will always have a valid signature, known public key type, sequence number and NodeId. All other parameters are variable/optional.

Implementations

impl<K: EnrKey> Enr<K>

pub fn builder() -> Builder<K>

Get a builder::Builder with the default identity scheme.

pub fn empty(signing_key: &K) -> Result<Self, Error>

Get an empty Enr for the v4 identity scheme.

pub const fn node_id(&self) -> NodeId

The NodeId for the record.

pub const fn seq(&self) -> u64

The current sequence number of the ENR record.

pub fn get(&self, key: impl AsRef<[u8]>) -> Option<Bytes>

👎Deprecated since 0.11.2: use get_decodable

Reads a custom key from the record if it exists, decoded as data. Caution! Only use for data that is not an aggregate type. Default to using get_decodable.

pub fn get_decodable<T: Decodable>( &self, key: impl AsRef<[u8]>, ) -> Option<Result<T, DecoderError>>

Reads a custom key from the record if it exists, decoded as T.

pub fn get_raw_rlp(&self, key: impl AsRef<[u8]>) -> Option<&[u8]>

Reads a custom key from the record if it exists as raw RLP bytes.

pub fn iter(&self) -> impl Iterator<Item = (&Vec<u8>, &[u8])>

Returns an iterator over all key/value pairs in the ENR.

pub fn ip4(&self) -> Option<Ipv4Addr>

Returns the IPv4 address of the ENR record if it is defined.

pub fn ip6(&self) -> Option<Ipv6Addr>

Returns the IPv6 address of the ENR record if it is defined.

pub fn id(&self) -> Option<String>

The id of ENR record if it is defined.

pub fn client_info(&self) -> Option<(String, String, Option<String>)>

Returns EIP-7636 entry if it is defined.

pub fn tcp4(&self) -> Option<u16>

The TCP port of ENR record if it is defined.

pub fn tcp6(&self) -> Option<u16>

The IPv6-specific TCP port of ENR record if it is defined.

pub fn udp4(&self) -> Option<u16>

The UDP port of ENR record if it is defined.

pub fn udp6(&self) -> Option<u16>

The IPv6-specific UDP port of ENR record if it is defined.

pub fn udp4_socket(&self) -> Option<SocketAddrV4>

Provides a socket (based on the UDP port), if the IPv4 and UDP fields are specified.

pub fn udp6_socket(&self) -> Option<SocketAddrV6>

Provides a socket (based on the UDP port), if the IPv6 and UDP fields are specified.

pub fn tcp4_socket(&self) -> Option<SocketAddrV4>

Provides a socket (based on the TCP port), if the IP and TCP fields are specified.

pub fn tcp6_socket(&self) -> Option<SocketAddrV6>

Provides a socket (based on the TCP port), if the IPv6 and TCP6 fields are specified.

pub fn signature(&self) -> &[u8]

The signature of the ENR record.

pub fn public_key(&self) -> K::PublicKey

Returns the public key of the ENR record.

Panics

Will panic if the public key is not supported.

pub fn verify(&self) -> bool

Verify the signature of the ENR record.

pub fn compare_content(&self, other: &Self) -> bool

Compare if the content of 2 Enr’s match.

pub fn to_base64(&self) -> String

Provides the URL-safe base64 encoded “text” version of the ENR prefixed by “enr:”.

pub fn size(&self) -> usize

Returns the current size of the ENR.

pub fn set_seq(&mut self, seq: u64, key: &K) -> Result<(), Error>

Allows setting the sequence number to an arbitrary value.

pub fn insert<T: Encodable>( &mut self, key: impl AsRef<[u8]>, value: &T, enr_key: &K, ) -> Result<Option<Bytes>, Error>

Adds or modifies a key/value to the ENR record. A EnrKey is required to re-sign the record once modified.

Returns the previous value as rlp encoded bytes in the record if it exists.

pub fn insert_raw_rlp( &mut self, key: impl AsRef<[u8]>, value: Bytes, enr_key: &K, ) -> Result<Option<Bytes>, Error>

Adds or modifies a key/value to the ENR record. A EnrKey is required to re-sign the record once modified. The value here is interpreted as raw RLP data.

Returns the previous value as rlp encoded bytes in the record if it exists.

pub fn set_ip(&mut self, ip: IpAddr, key: &K) -> Result<Option<IpAddr>, Error>

Sets the ip field of the ENR. Returns any pre-existing IP address in the record.

pub fn set_udp4(&mut self, udp: u16, key: &K) -> Result<Option<u16>, Error>

Sets the udp field of the ENR. Returns any pre-existing UDP port in the record.

pub fn remove_udp4(&mut self, key: &K) -> Result<(), Error>

Unsets the udp field on the ENR.

pub fn set_udp6(&mut self, udp: u16, key: &K) -> Result<Option<u16>, Error>

Sets the udp6 field of the ENR. Returns any pre-existing UDP port in the record.

pub fn remove_udp6(&mut self, key: &K) -> Result<(), Error>

Unsets the udp6 field on the ENR.

pub fn set_tcp4(&mut self, tcp: u16, key: &K) -> Result<Option<u16>, Error>

Sets the tcp field of the ENR. Returns any pre-existing tcp port in the record.

pub fn remove_tcp(&mut self, key: &K) -> Result<(), Error>

Unsets the tcp field on the ENR.

pub fn set_tcp6(&mut self, tcp: u16, key: &K) -> Result<Option<u16>, Error>

Sets the tcp6 field of the ENR. Returns any pre-existing tcp6 port in the record.

pub fn remove_tcp6(&mut self, key: &K) -> Result<(), Error>

Unsets the tcp6 field on the ENR.

pub fn set_client_info( &mut self, name: String, version: String, build: Option<String>, key: &K, ) -> Result<(), Error>

Sets the EIP-7636 client field in the record.

pub fn set_udp_socket( &mut self, socket: SocketAddr, key: &K, ) -> Result<(), Error>

Sets the IP and UDP port in a single update with a single increment in sequence number.

pub fn remove_udp_socket(&mut self, key: &K) -> Result<(), Error>

Unsets the ip and udp fields on the ENR.

pub fn remove_udp6_socket(&mut self, key: &K) -> Result<(), Error>

Unsets the ip6 and udp6 fields on the ENR.

pub fn set_tcp_socket( &mut self, socket: SocketAddr, key: &K, ) -> Result<(), Error>

Sets the IP and TCP port in a single update with a single increment in sequence number.

pub fn remove_tcp_socket(&mut self, key: &K) -> Result<(), Error>

Unsets the ip and tcp fields on the ENR.

pub fn remove_tcp6_socket(&mut self, key: &K) -> Result<(), Error>

Unsets the ip6 and tcp6 fields on the ENR.

pub fn remove_key( &mut self, content_key: impl AsRef<[u8]>, enr_key: &K, ) -> Result<(), Error>

Removes a key from the ENR.

pub fn remove_insert<'a>( &mut self, remove_keys: impl Iterator<Item = impl AsRef<[u8]>>, insert_key_values: impl Iterator<Item = (impl AsRef<[u8]>, &'a [u8])>, enr_key: &K, ) -> Result<(Vec<Option<Bytes>>, Vec<Option<Bytes>>), Error>

Removes key/value mappings and adds or overwrites key/value mappings to the ENR record as one sequence number update. An EnrKey is required to re-sign the record once modified. Reverts whole ENR record on error.

Returns the previous values as rlp encoded bytes if they exist for the removed and added/ overwritten keys.

pub fn set_public_key( &mut self, public_key: &K::PublicKey, key: &K, ) -> Result<(), Error>

Sets a new public key for the record.

pub fn is_udp_reachable(&self) -> bool

Returns whether the node can be reached over UDP or not.

pub fn is_tcp_reachable(&self) -> bool

Returns whether the node can be reached over TCP or not.

Trait Implementations

impl<K: EnrKey> Clone for Enr<K>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: EnrKey> Debug for Enr<K>

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

Formats the value using the given formatter.

impl<K: EnrKey> Decodable for Enr<K>

fn decode(buf: &mut &[u8]) -> Result<Self, DecoderError>

Decodes the blob into the appropriate type. buf must be advanced past the decoded object.

impl<'de, K: EnrKey> Deserialize<'de> for Enr<K>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K: EnrKey> Display for Enr<K>

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

Formats the value using the given formatter.

impl<K: EnrKey> Encodable for Enr<K>

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes.

impl<T: EnrKey> From<&Enr<T>> for NodeId

fn from(enr: &Enr<T>) -> Self

Converts to this type from the input type.

impl<T: EnrKey> From<Enr<T>> for NodeId

fn from(enr: Enr<T>) -> Self

Converts to this type from the input type.

impl<K: EnrKey> FromStr for Enr<K>

Convert a URL-SAFE base64 encoded ENR into an ENR.

type Err = String

The associated error which can be returned from parsing.

fn from_str(base64_string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<K: EnrKey> Hash for Enr<K>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<K: EnrKey> IntoIterator for Enr<K>

type Item = (Vec<u8>, Bytes)

The type of the elements being iterated over.

type IntoIter = EnrIntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: EnrKey> PartialEq for Enr<K>

fn eq(&self, other: &Self) -> bool

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

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<K: EnrKey> Serialize for Enr<K>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<K: EnrKey> Eq for Enr<K>