Struct PostageApi 

pub struct PostageApi { /* private fields */ }

Handle exposing the postage endpoints. Cheap to clone.

Implementations

impl PostageApi

pub async fn get_postage_batches(&self) -> Result<Vec<PostageBatch>, Error>

Every postage batch owned by this node — GET /stamps.

pub async fn get_postage_batch( &self, batch_id: &BatchId, ) -> Result<PostageBatch, Error>

Single owned batch by id — GET /stamps/{id}.

pub async fn get_postage_batch_buckets( &self, batch_id: &BatchId, ) -> Result<PostageBatchBuckets, Error>

Per-bucket collision stats — GET /stamps/{id}/buckets.

pub async fn get_global_postage_batches( &self, ) -> Result<Vec<GlobalPostageBatch>, Error>

Every chain-visible postage batch — GET /batches. Returns the chain-wide view (no owner-only fields).

pub async fn create_postage_batch( &self, amount: &BigInt, depth: u8, label: Option<&str>, ) -> Result<BatchId, Error>

Buy a new postage batch — POST /stamps/{amount}/{depth}. Returns the freshly-minted BatchId.

amount is the per-chunk amount (PLUR) and depth is the stamp depth — together they determine effective capacity and TTL. For a (size, duration)-shaped API see crate::storage::buy_storage.

Examples

use bee::Client;
use num_bigint::BigInt;

let client = Client::new("http://localhost:1633")?;
let amount = BigInt::from(414_720_000u64);
let batch_id = client
    .postage()
    .create_postage_batch(&amount, 22, Some("my-batch"))
    .await?;
println!("bought batch {}", batch_id.to_hex());

pub async fn create_postage_batch_with_options( &self, amount: &BigInt, depth: u8, opts: Option<&PostageBatchOptions>, ) -> Result<BatchId, Error>

Buy a new postage batch with full options support. Mirrors bee-js Bee.createPostageBatch and bee-go’s options-style constructor — label and immutable map to query parameters, gas_price / gas_limit map to Gas-Price / Gas-Limit headers.

pub async fn top_up_batch( &self, batch_id: &BatchId, amount: &BigInt, ) -> Result<(), Error>

Top up an existing batch — PATCH /stamps/topup/{id}/{amount}.

pub async fn dilute_batch( &self, batch_id: &BatchId, depth: u8, ) -> Result<(), Error>

Increase the depth of an existing batch — PATCH /stamps/dilute/{id}/{depth}.

Trait Implementations

impl Clone for PostageApi

fn clone(&self) -> PostageApi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PostageApi

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

Formats the value using the given formatter.