Helios API/ API Reference/ Classes/
UplcList
Plutus-core list value class. Only used during evaluation.
Implements
Hierarchy
-
↳
UplcList
Implements
Implemented by
Index
Constructors
constructor
• new UplcList(site, itemType, items)
Parameters
Overrides
UplcValueImpl.constructor
Accessors
bool
• get bool(): boolean
Returns
boolean
Implementation of
UplcList.bool
Inherited from
UplcValueImpl.bool
bytes
• get bytes(): number[]
Returns
number[]
Implementation of
UplcList.bytes
Inherited from
UplcValueImpl.bytes
data
• get data(): UplcData
Returns
Implementation of
UplcList.data
Inherited from
UplcValueImpl.data
first
• get first(): UplcValue
Returns
Implementation of
UplcList.first
Inherited from
UplcValueImpl.first
flatSize
• get flatSize(): number
10 + nItemType type bits, value bits of each item (must be corrected by itemType)
Returns
number
Implementation of
UplcList.flatSize
int
• get int(): bigint
Returns
bigint
Implementation of
UplcList.int
Inherited from
UplcValueImpl.int
itemType
• get itemType(): UplcType
Returns
Implementation of
UplcList.itemType
Inherited from
UplcValueImpl.itemType
length
• get length(): number
Returns
number
Implementation of
UplcList.length
Inherited from
UplcValueImpl.length
list
• get list(): UplcValue[]
Returns
Implementation of
UplcList.list
Inherited from
UplcValueImpl.list
memSize
• get memSize(): number
Returns
number
Implementation of
UplcList.memSize
second
• get second(): UplcValue
Returns
Implementation of
UplcList.second
Inherited from
UplcValueImpl.second
site
• get site(): Site
Returns
Implementation of
UplcList.site
Inherited from
UplcValueImpl.site
string
• get string(): string
Returns
string
Implementation of
UplcList.string
Inherited from
UplcValueImpl.string
Methods
assertUnit
▸ assertUnit(): UplcUnit
Returns
Implementation of
UplcList.assertUnit
Inherited from
UplcValueImpl.assertUnit
copy
▸ copy(newSite): UplcList
Parameters
| Name | Type |
|---|---|
newSite | Site |
Returns
Implementation of
UplcList.copy
isAny
▸ isAny(): boolean
Returns
boolean
Implementation of
UplcList.isAny
Inherited from
UplcValueImpl.isAny
isData
▸ isData(): boolean
Returns
boolean
Implementation of
UplcList.isData
Inherited from
UplcValueImpl.isData
isDataList
▸ isDataList(): boolean
Returns
boolean
Implementation of
UplcList.isDataList
isDataMap
▸ isDataMap(): boolean
Returns
boolean
Implementation of
UplcList.isDataMap
isList
▸ isList(): boolean
Distinguishes a list from a map
Returns
boolean
Implementation of
UplcList.isList
Inherited from
UplcValueImpl.isList
isPair
▸ isPair(): boolean
Distinguishes a pair from a mapItem
Returns
boolean
Implementation of
UplcList.isPair
Inherited from
UplcValueImpl.isPair
toFlatValue
▸ toFlatValue(bitWriter): void
Encodes value with plutus flat encoding. Member function not named 'toFlat' as not to confuse with 'toFlat' member of terms.
Parameters
| Name | Type |
|---|---|
bitWriter | BitWriter |
Returns
void
Implementation of
UplcList.toFlatValue
Inherited from
UplcValueImpl.toFlatValue
toFlatValueInternal
▸ toFlatValueInternal(bitWriter): void
Encodes value without type header
Parameters
| Name | Type |
|---|---|
bitWriter | BitWriter |
Returns
void
Implementation of
UplcList.toFlatValueInternal
Inherited from
UplcValueImpl.toFlatValueInternal
transfer
▸ transfer(other): any
Parameters
| Name | Type |
|---|---|
other | TransferUplcAst |
Returns
any
Implementation of
UplcList.transfer
typeBits
▸ typeBits(): string
Returns
string
Implementation of
UplcList.typeBits
Inherited from
UplcValueImpl.typeBits
new
▸ Static new(type, items): UplcList
Constructs a UplcList without requiring a Site