Struct Batch 

pub struct Batch { /* private fields */ }

A postage batch represents a prepaid storage allocation in the Swarm network.

Batches are created by sending BZZ tokens to the postage stamp contract. Each batch has a depth that determines the maximum number of chunks it can stamp, and a bucket depth that controls the uniformity of chunk distribution.

Implementations

impl Batch

pub const fn new( id: BatchId, value: u128, start: u64, owner: Address, depth: u8, bucket_depth: u8, immutable: bool, ) -> Self

Creates a new batch with the given parameters.

pub const fn id(&self) -> BatchId

Returns the batch ID.

pub const fn value(&self) -> u128

Returns the normalized value (balance per chunk).

pub const fn start(&self) -> u64

Returns the block number when this batch was created.

pub const fn owner(&self) -> Address

Returns the owner’s Ethereum address.

pub const fn depth(&self) -> u8

Returns the batch depth.

The total capacity is 2^depth chunks.

pub const fn bucket_depth(&self) -> u8

Returns the bucket depth.

This controls the uniformity of chunk distribution across collision buckets.

pub const fn immutable(&self) -> bool

Returns whether this batch is immutable.

Immutable batches cannot be diluted (depth increased) and chunks cannot be overwritten. Mutable batches allow writing new chunks to the same bucket index with a later timestamp, replacing the previous chunk.

pub const fn bucket_upper_bound(&self) -> u32

Returns the maximum number of chunks per bucket.

This is equal to 2^(depth - bucket_depth).

pub const fn bucket_count(&self) -> u32

Returns the number of collision buckets.

This is equal to 2^bucket_depth.

pub const fn set_value(&mut self, value: u128)

Updates the batch value (for top-up operations).

pub const fn set_depth(&mut self, depth: u8)

Updates the batch depth (for dilution operations).

pub const fn is_expired(&self, total_amount: u128) -> bool

Checks if the batch has expired given the current chain state.

pub const fn is_usable(&self, current_block: u64, threshold: u64) -> bool

Checks if the batch is usable (has enough confirmations).

pub const fn validate_index(&self, index: &StampIndex) -> Result<(), StampError>

Validates that an index is within the valid range for this batch.

Checks that:

• The bucket is within the valid range (< bucket_count)
• The position within the bucket is within capacity (< bucket_upper_bound)

Returns

Ok(()) if the index is valid, or Err(StampError::InvalidIndex) otherwise.

pub fn bucket_for_address(&self, address: &SwarmAddress) -> u32

Calculates which bucket a chunk address belongs to.

The bucket is determined by taking the first bucket_depth bits of the chunk address, interpreted as a big-endian unsigned integer.

pub fn validate_bucket( &self, index: &StampIndex, address: &SwarmAddress, ) -> Result<(), StampError>

Checks if a chunk address matches the expected bucket for a stamp index.

Returns

Ok(()) if the bucket matches, or Err(StampError::BucketMismatch) otherwise.

Trait Implementations

impl<'a> Arbitrary<'a> for Batch

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Batch

fn clone(&self) -> Batch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Batch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Batch

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Batch

impl PartialEq for Batch

fn eq(&self, other: &Batch) -> 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 Serialize for Batch

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Batch