pub struct BootstrapManager { /* private fields */ }Expand description
Bootstrap cache initialization and management
Implementations§
Source§impl BootstrapManager
impl BootstrapManager
Sourcepub async fn with_config(config: CacheConfig) -> Result<Self>
pub async fn with_config(config: CacheConfig) -> Result<Self>
Create a new bootstrap manager with custom configuration
Sourcepub async fn with_rate_limiting(
config: CacheConfig,
rate_limit_config: JoinRateLimiterConfig,
) -> Result<Self>
pub async fn with_rate_limiting( config: CacheConfig, rate_limit_config: JoinRateLimiterConfig, ) -> Result<Self>
Create a new bootstrap manager with custom configuration and rate limiting
Sourcepub async fn with_full_config(
config: CacheConfig,
rate_limit_config: JoinRateLimiterConfig,
diversity_config: IPDiversityConfig,
) -> Result<Self>
pub async fn with_full_config( config: CacheConfig, rate_limit_config: JoinRateLimiterConfig, diversity_config: IPDiversityConfig, ) -> Result<Self>
Create a new bootstrap manager with full custom configuration
Sourcepub async fn get_bootstrap_peers(
&self,
count: usize,
) -> Result<Vec<ContactEntry>>
pub async fn get_bootstrap_peers( &self, count: usize, ) -> Result<Vec<ContactEntry>>
Get bootstrap peers for initial connection
Sourcepub async fn add_contact(&mut self, contact: ContactEntry) -> Result<()>
pub async fn add_contact(&mut self, contact: ContactEntry) -> Result<()>
Add a discovered peer to the cache
This method enforces both rate limiting and IP diversity checks to prevent Sybil attacks:
- Rate limiting: Per-subnet (IPv6 /64, /48 and IPv4 /24) and global limits
- IP diversity: Ensures geographic and ASN diversity across the network
§Errors
Returns an error if:
- The contact has no addresses
- Join rate limit is exceeded for the IP subnet
- IP diversity limits are exceeded
- The cache operation fails
Sourcepub async fn add_contact_trusted(&mut self, contact: ContactEntry) -> Result<()>
pub async fn add_contact_trusted(&mut self, contact: ContactEntry) -> Result<()>
Add a contact bypassing rate limiting and diversity checks (for internal/trusted sources)
Use this method only for contacts from trusted sources like:
- Well-known bootstrap nodes
- Pre-configured seed nodes
- Admin-approved contacts
§Safety
This method does not enforce rate limiting or diversity checks. Only use for trusted sources.
Sourcepub async fn update_contact_metrics(
&mut self,
peer_id: &PeerId,
metrics: QualityMetrics,
) -> Result<()>
pub async fn update_contact_metrics( &mut self, peer_id: &PeerId, metrics: QualityMetrics, ) -> Result<()>
Update contact performance metrics
Sourcepub async fn start_background_tasks(&mut self) -> Result<()>
pub async fn start_background_tasks(&mut self) -> Result<()>
Start background maintenance tasks
Sourcepub async fn get_stats(&self) -> Result<CacheStats>
pub async fn get_stats(&self) -> Result<CacheStats>
Get cache statistics
Sourcepub async fn force_merge(&self) -> Result<MergeResult>
pub async fn force_merge(&self) -> Result<MergeResult>
Force a cache merge operation
Sourcepub fn encode_address(
&self,
socket_addr: &SocketAddr,
) -> Result<FourWordAddress>
pub fn encode_address( &self, socket_addr: &SocketAddr, ) -> Result<FourWordAddress>
Convert socket address to four-word address
Sourcepub fn decode_address(&self, words: &FourWordAddress) -> Result<SocketAddr>
pub fn decode_address(&self, words: &FourWordAddress) -> Result<SocketAddr>
Convert four-word address to socket address
Sourcepub fn validate_words(&self, words: &FourWordAddress) -> Result<()>
pub fn validate_words(&self, words: &FourWordAddress) -> Result<()>
Validate four-word address format
Sourcepub fn word_encoder(&self) -> &WordEncoder
pub fn word_encoder(&self) -> &WordEncoder
Get the word encoder for direct access
Sourcepub fn get_well_known_word_addresses(
&self,
) -> Vec<(FourWordAddress, SocketAddr)>
pub fn get_well_known_word_addresses( &self, ) -> Vec<(FourWordAddress, SocketAddr)>
Get well-known bootstrap addresses as four-word addresses
Auto Trait Implementations§
impl !Freeze for BootstrapManager
impl !RefUnwindSafe for BootstrapManager
impl Send for BootstrapManager
impl Sync for BootstrapManager
impl Unpin for BootstrapManager
impl !UnwindSafe for BootstrapManager
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: '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
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§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.Source§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.Source§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.Source§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.Source§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.Source§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.Source§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.Source§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.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§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 moreSource§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 moreSource§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
Source§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
Source§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.Source§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.Source§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.Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.Source§impl<T> Tap for T
impl<T> Tap for T
Source§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 moreSource§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 moreSource§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 moreSource§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 moreSource§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 moreSource§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 moreSource§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.Source§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.Source§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.Source§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.Source§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.Source§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.Source§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.