Skip to content

Commit 8655a3f

Browse files
Boog900hinto-janai
andauthored
dandelion-tower: improve API (#257)
* init * reduce the jobs handled by the dandelion pool * fix docs * resolve todo * review changes * Update p2p/dandelion-tower/src/pool/incoming_tx.rs Co-authored-by: hinto-janai <hinto.janai@protonmail.com> * Update p2p/dandelion-tower/src/pool/incoming_tx.rs Co-authored-by: hinto-janai <hinto.janai@protonmail.com> * `PId` -> `PeerId` --------- Co-authored-by: hinto-janai <hinto.janai@protonmail.com>
1 parent ccff750 commit 8655a3f

File tree

9 files changed

+595
-599
lines changed

9 files changed

+595
-599
lines changed

p2p/dandelion-tower/src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
//!
33
//! This crate implements [dandelion++](https://arxiv.org/pdf/1805.11060.pdf), using [`tower`].
44
//!
5-
//! This crate provides 2 [`tower::Service`]s, a [`DandelionRouter`] and a [`DandelionPool`](pool::DandelionPool).
5+
//! This crate provides 2 [`tower::Service`]s, a [`DandelionRouter`] and a [`DandelionPoolManager`](pool::DandelionPoolManager).
66
//! The router is pretty minimal and only handles the absolute necessary data to route transactions, whereas the
77
//! pool keeps track of all data necessary for dandelion++ but requires you to provide a backing tx-pool.
88
//!
9-
//! This split was done not because the [`DandelionPool`](pool::DandelionPool) is unnecessary but because it is hard
10-
//! to cover a wide range of projects when abstracting over the tx-pool. Not using the [`DandelionPool`](pool::DandelionPool)
9+
//! This split was done not because the [`DandelionPoolManager`](pool::DandelionPoolManager) is unnecessary but because it is hard
10+
//! to cover a wide range of projects when abstracting over the tx-pool. Not using the [`DandelionPoolManager`](pool::DandelionPoolManager)
1111
//! requires you to implement part of the paper yourself.
1212
//!
1313
//! # Features
1414
//!
15-
//! This crate only has one feature `txpool` which enables [`DandelionPool`](pool::DandelionPool).
15+
//! This crate only has one feature `txpool` which enables [`DandelionPoolManager`](pool::DandelionPoolManager).
1616
//!
1717
//! # Needed Services
1818
//!
@@ -45,7 +45,7 @@
4545
//!
4646
//! ## Backing Pool
4747
//!
48-
//! ([`DandelionPool`](pool::DandelionPool) only)
48+
//! ([`DandelionPoolManager`](pool::DandelionPoolManager) only)
4949
//!
5050
//! This service is a backing tx-pool, in memory or on disk.
5151
//! The backing pool should have a request of [`TxStoreRequest`](traits::TxStoreRequest) and a response of

0 commit comments

Comments
 (0)