Skip to main content

Interface: PostageBatch

Defined in: bee-js/src/types/index.ts:466

Properties

amount

amount: NumberString

Defined in: bee-js/src/types/index.ts:480


batchID

batchID: BatchId

Defined in: bee-js/src/types/index.ts:467


blockNumber

blockNumber: number

Defined in: bee-js/src/types/index.ts:482


bucketDepth

bucketDepth: number

Defined in: bee-js/src/types/index.ts:481


depth

depth: number

Defined in: bee-js/src/types/index.ts:479


duration

duration: Duration

Defined in: bee-js/src/types/index.ts:487

Estimated time until the batch expires


immutableFlag

immutableFlag: boolean

Defined in: bee-js/src/types/index.ts:483


label

label: string

Defined in: bee-js/src/types/index.ts:478


remainingSize

remainingSize: Size

Defined in: bee-js/src/types/index.ts:503

Estimated remaining size


size

size: Size

Defined in: bee-js/src/types/index.ts:499

Effective size


theoreticalSize

theoreticalSize: Size

Defined in: bee-js/src/types/index.ts:507

Theoretical size in bytes


usable

usable: boolean

Defined in: bee-js/src/types/index.ts:477


usage

usage: number

Defined in: bee-js/src/types/index.ts:491

A floating point number from 0 to 1, where 0 is no usage, 1 is full usage.


usageText

usageText: string

Defined in: bee-js/src/types/index.ts:495

Human readable usage text, like "50%" or "100%", no fractions


utilization

utilization: number

Defined in: bee-js/src/types/index.ts:476

Represents how much of the batch is used up.

Max utilization = 2 ** (depth - bucketDepth)

Since the smallest depth is 17, and one batch has 65,536 buckets, and one chunk is 4,096 bytes, the 512MB theoretical max size for the smallest stamp comes from 2 * 65536 * 4096 = 512MB

💬 Get Help