Skip to main content

Class: FoundryOutput

A Foundry output.

Hierarchy​

  • ImmutableFeaturesOutput

    ↳ FoundryOutput

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new FoundryOutput(amount, serialNumber, unlockConditions, tokenScheme)

Parameters​

NameTypeDescription
amountbigintThe amount of the output.
serialNumbernumberThe serial number of the Foundry with respect to the controlling alias.
unlockConditionsUnlockCondition[]The unlock conditions of the output.
tokenSchemeTokenSchemeThe token scheme for the Foundry.

Overrides​

ImmutableFeaturesOutput.constructor

Properties​

amount​

• Readonly amount: string

Inherited from​

ImmutableFeaturesOutput.amount


type​

• Readonly type: OutputType

Inherited from​

ImmutableFeaturesOutput.type


unlockConditions​

• Readonly unlockConditions: UnlockCondition[]

Inherited from​

ImmutableFeaturesOutput.unlockConditions


nativeTokens​

• Optional Readonly nativeTokens: INativeToken[]

Inherited from​

ImmutableFeaturesOutput.nativeTokens


features​

• Optional Readonly features: Feature[]

Inherited from​

ImmutableFeaturesOutput.features


immutableFeatures​

• Optional Readonly immutableFeatures: Feature[]

Inherited from​

ImmutableFeaturesOutput.immutableFeatures


serialNumber​

• Readonly serialNumber: number

The serial number of the Foundry with respect to the controlling alias.


tokenScheme​

• Readonly tokenScheme: TokenScheme

The token scheme for the Foundry.

Methods​

getType​

▸ getType(): OutputType

Get the type of output.

Returns​

OutputType

Inherited from​

ImmutableFeaturesOutput.getType


getAmount​

▸ getAmount(): bigint

Get the amount of the output.

Returns​

bigint

Inherited from​

ImmutableFeaturesOutput.getAmount


parse​

▸ Static parse(data): Output

Parse an output from a plain JS JSON object.

Parameters​

NameType
dataany

Returns​

Output

Inherited from​

ImmutableFeaturesOutput.parse


getUnlockConditions​

▸ getUnlockConditions(): UnlockCondition[]

The unlock conditions for the output.

Returns​

UnlockCondition[]

Inherited from​

ImmutableFeaturesOutput.getUnlockConditions


getNativeTokens​

▸ getNativeTokens(): undefined | INativeToken[]

The native tokens held by the output.

Returns​

undefined | INativeToken[]

Inherited from​

ImmutableFeaturesOutput.getNativeTokens


getFeatures​

▸ getFeatures(): undefined | Feature[]

Get the features contained by the output.

Returns​

undefined | Feature[]

Inherited from​

ImmutableFeaturesOutput.getFeatures


getImmutableFeatures​

▸ getImmutableFeatures(): undefined | Feature[]

Immutable features contained by the output.

Returns​

undefined | Feature[]

Inherited from​

ImmutableFeaturesOutput.getImmutableFeatures


getSerialNumber​

▸ getSerialNumber(): number

Get the serial number of the Foundry.

Returns​

number


getTokenScheme​

▸ getTokenScheme(): TokenScheme

Get the token scheme for the Foundry.

Returns​

TokenScheme