Helios API/ API Reference/ Classes/

Value

Represents a collection of tokens.

Hierarchy

• HeliosData

  ↳ Value

Index

Constructors

constructor

• new Value(props?, assets?)

Parameters

Overrides

HeliosData.constructor

Accessors

assets

• get assets(): Assets

Gets the Assets contained in the Value.

Returns

Assets

lovelace

• get lovelace(): bigint

Gets the lovelace quantity contained in the Value.

Returns

bigint

Methods

_toUplcData

▸ _toUplcData(isInScriptContext?): MapData

Used when building script context

Parameters

Returns

MapData

add

▸ add(other): Value

Adds two Value instances together. Returns a new Value instance.

Parameters

Returns

Value

assertAllPositive

▸ assertAllPositive(): Value

Throws an error if any of the Value entries is negative.

Used when building transactions because transactions can't contain negative values.

Returns

Value

• returns this

dump

▸ dump(): any

Returns

any

eq

▸ eq(other): boolean

Checks if two Value instances are equal (Assets need to be in the same order).

Parameters

Returns

boolean

ge

▸ ge(other): boolean

Checks if a Value instance is strictly greater or equal to another Value instance. Returns false if any asset is missing.

Parameters

Returns

boolean

gt

▸ gt(other): boolean

Checks if a Value instance is strictly greater than another Value instance. Returns false if any asset is missing.

Parameters

Returns

boolean

mul

▸ mul(scalar): Value

Multiplies a Value by a whole number.

Parameters

Returns

Value

setLovelace

▸ setLovelace(lovelace): void

Mutates the quantity of lovelace in a Value.

Parameters

Returns

void

sub

▸ sub(other): Value

Substracts one Value instance from another. Returns a new Value instance.

Parameters

Returns

Value

toCbor

▸ toCbor(): number[]

Returns

number[]

Inherited from

HeliosData.toCbor

toCborHex

▸ toCborHex(): string

Returns

string

Inherited from

HeliosData.toCborHex

toSchemaJson

▸ toSchemaJson(): string

Returns

string

Inherited from

HeliosData.toSchemaJson

asset

▸ Static asset(mph, tokenName, qty): Value

Parameters

Returns

Value

cleanConstructorArgs

▸ Static cleanConstructorArgs(props, maybeAssets): [HInt | HIntProps, Assets | AssetsProps]

Parameters

Returns

[HInt | HIntProps, Assets | AssetsProps]

fromCbor

▸ Static fromCbor(bytes): Value

Parameters

Returns

Value

fromProps

▸ Static fromProps(props): Value

Parameters

Returns

Value

fromUplcCbor

▸ Static fromUplcCbor(bytes): Value

Parameters

Returns

Value

fromUplcData

▸ Static fromUplcData(data): Value

Converts a UplcData instance into a Value. Throws an error if it isn't in the right format.

Parameters

Returns

Value

sum

▸ Static sum(values): Value

Parameters

Returns

Value