Skip to main content

Interface: PostageBatchOptions

Options for creation of postage batch

Hierarchy

Properties

fetch

Optional fetch: Fetch

User defined Fetch compatible function

Inherited from

RequestOptions.fetch

Defined in

bee-js/src/types/index.ts:128


gasPrice

Optional gasPrice: NumberString

Sets gas price in Wei for the transaction that creates the postage batch

Defined in

bee-js/src/types/index.ts:546


immutableFlag

Optional immutableFlag: boolean

Defined in

bee-js/src/types/index.ts:547


label

Optional label: string

Sets label for the postage batch

Defined in

bee-js/src/types/index.ts:541


retry

Optional retry: number

Configure backoff mechanism for requests retries. Specifies how many retries will be performed before failing a request. Retries are performed for GET, PUT, HEAD, DELETE, OPTIONS and TRACE requests. Default is 2.

Inherited from

RequestOptions.retry

Defined in

bee-js/src/types/index.ts:123


timeout

Optional timeout: number

Timeout of requests in milliseconds

Inherited from

RequestOptions.timeout

Defined in

bee-js/src/types/index.ts:115


waitForUsable

Optional waitForUsable: boolean

The returned Promise will await until the purchased Postage Batch is usable. In other word, it has to have enough block confirmations that Bee pronounce it usable. If turned on, this significantly prolong the creation of postage batch! If you plan to use the stamp right away for some action with Bee (like uploading using this stamp) it is highly recommended to use this option, otherwise you might get errors "stamp not usable" from Bee.

In next breaking release this option will be turned on by default.

default false

Defined in

bee-js/src/types/index.ts:559


waitForUsableTimeout

Optional waitForUsableTimeout: number

When waiting for the postage stamp to become usable, this specify the timeout for the waiting. Default: 120s

Defined in

bee-js/src/types/index.ts:565