Skip to main content

Interface: AliasOutputBuilderParams

Options for building an Alias Output.

Hierarchy​

Table of contents​

Properties​

Properties​

aliasId​

• aliasId: string

Unique identifier of an alias, which is the BLAKE2b-256 hash of the Output ID that created it.


stateIndex​

• Optional stateIndex: number

A counter that must increase by 1 every time the alias is state transitioned.


stateMetadata​

• Optional stateMetadata: string

Metadata that can only be changed by the state controller.


foundryCounter​

• Optional foundryCounter: number

A counter that denotes the number of foundries created by this alias account.


immutableFeatures​

• Optional immutableFeatures: Feature[]

A list of immutable features.


amount​

• Optional amount: string | bigint

If not provided, minimum storage deposit will be used

Inherited from​

BasicOutputBuilderParams.amount


nativeTokens​

• Optional nativeTokens: INativeToken[]

The native tokens to be held by the output.

Inherited from​

BasicOutputBuilderParams.nativeTokens


unlockConditions​

• unlockConditions: UnlockCondition[]

The unlock conditions for the output.

Inherited from​

BasicOutputBuilderParams.unlockConditions


features​

• Optional features: Feature[]

Features to be contained by the output.

Inherited from​

BasicOutputBuilderParams.features