Struct BundlePuller 

pub struct BundlePuller { /* private fields */ }

Pulls bundles into a directory over one paid run: one pool, one connection per node, one progress clock.

Build it with Self::builder. One puller serves one run: a manifest fetch and one Self::pull, or several pulls that share the run’s lanes.

Implementations

impl BundlePuller

pub fn builder( chain: ChainConfig, site: PullSite, endpoint: Endpoint, store: Arc<dyn BuyerPoolStore>, funding: Funding, discovery: DiscoveryOptions, nodes: NodeSelection, ) -> BundlePullerBuilder

A builder for a pull on chain, keeping its peer store and scratch files in site, dialing from endpoint, recording its pool and lanes in store, and paying from funding. discovery and nodes (select_nodes) say where entries find their holders.

pub async fn fetch_manifest( &self, hash: [u8; 32], out_dir: &Path, use_cache: bool, ) -> Result<BundleManifest>

Fetch the manifest blob hash, and cache it in out_dir. With use_cache, a manifest an earlier pull cached there is read instead, and nothing is paid; a cache file that cannot be read is reported to the observer and fetched over.

Errors

The fetch fails, or the bytes are not a manifest.

pub async fn pull( &mut self, manifest: &BundleManifest, out_dir: &Path, overwrite: bool, cancel: &CancellationToken, ) -> BundleOutcome

Pull every entry of manifest into out_dir. With overwrite, files already on disk are fetched again instead of skipped. A fired cancel stops every fetch where it is; what landed is recorded, and the next pull resumes.

An entry that fails does not stop the others. A fault only the user can fix, or the stop policy, ends the pull (BundleEnd).

pub fn replacements(&self) -> Vec<PoolReplaced>

Every pool replacement this puller’s funding recovery steps made, in order: its manifest fetches’ and its pulls’ alike, and a step in a pull its caller dropped or cancelled. Each closed pool may still hold a balance to reclaim once its dispute window ends. A replacement that ended a manifest fetch is in no BundleOutcome.

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

The warning for a wallet seen to hold too little USDC to top the pool up during this run, if one was.

pub const fn unconfirmed_escrows(&self) -> &UnconfirmedEscrows

The handle that holds each openPool and topUp of the puller that no local record credits yet, and each that escrowed with no local record crediting it: the one passed to BundlePullerBuilder::unconfirmed_escrows, or the puller’s own.

pub async fn finish(self)

Wait for every queued peer-record and watermark write to land. Call it before the process exits, after a cancelled pull too, so the next run resumes each lane from what it paid.

Trait Implementations

impl Debug for BundlePuller

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

Formats the value using the given formatter.