Class ConstrPlutusData

The main datatype Constr represents the nth constructor along with its arguments.

Remark: We don't directly serialize the alternative in the tag, instead the scheme is:

Alternatives 0-6 -> tags 121-127, followed by the arguments in a list.
Alternatives 7-127 -> tags 1280-1400, followed by the arguments in a list.
Any alternatives, including those that don't fit in the above -> tag 102 followed by a list containing an unsigned integer for the actual alternative, and then the arguments in a (nested!) list.

Hierarchy

ConstrPlutusData

Index

Constructors

constructor

new ConstrPlutusData(alternative: bigint, data: Serialization.PlutusList): Serialization.ConstrPlutusData
Initializes a new instance of the ConstrPlutusData class.
Parameters
- alternative: bigint
  
  Get the Constr alternative. The alternative represents the nth constructor of a 'Sum Type'.
- data: Serialization.PlutusList
  
  Gets the list of arguments of the 'Sum Type' as a 'PlutusList'.
Returns Serialization.ConstrPlutusData
- Defined in packages/core/src/Serialization/PlutusData/ConstrPlutusData.ts:32

Properties

`Private` `Readonly` #alternative

#alternative: bigint = ...

`Private` `Readonly` #data

#data: Serialization.PlutusList = ...

Methods

equals

equals(other: Serialization.ConstrPlutusData): boolean
Indicates whether some other ConstrPlutusData is "equal to" this one.

Returns
true if objects are equals; otherwise false.
Parameters
- other: Serialization.ConstrPlutusData
  
  The other object to be compared.
Returns boolean
- Defined in packages/core/src/Serialization/PlutusData/ConstrPlutusData.ts:114

getAlternative

getAlternative(): bigint
Gets the ConstrPlutusData alternative. The alternative represents the nth constructor of a 'Sum Type'.

Returns
The alternative constructor of the 'Sum Type'.

Returns bigint
- Defined in packages/core/src/Serialization/PlutusData/ConstrPlutusData.ts:95

getData

getData(): Serialization.PlutusList
The list of arguments of the 'Sum Type' as a 'PlutusList'.

Returns
The list of arguments.

Returns Serialization.PlutusList
- Defined in packages/core/src/Serialization/PlutusData/ConstrPlutusData.ts:104

toCbor

toCbor(): HexBlob
Serializes this ConstrPlutusData instance into its CBOR representation as a Uint8Array.

Returns
The CBOR representation of this instance as a Uint8Array.

Returns HexBlob
- Defined in packages/core/src/Serialization/PlutusData/ConstrPlutusData.ts:42

`Static` `Private` alternativeToCompactCborTag

alternativeToCompactCborTag(alternative: bigint): bigint
Converts the constructor alternative to its CBOR compact tag.

Returns
The compact CBOR tag.
Parameters
- alternative: bigint
  
  The Constr alternative to be converted.
Returns bigint
- Defined in packages/core/src/Serialization/PlutusData/ConstrPlutusData.ts:142

`Static` `Private` compactCborTagToAlternative

compactCborTagToAlternative(tag: bigint): bigint
Converts a CBOR compact tag to a Constr alternative.

Returns
The Constr alternative.
Parameters
- tag: bigint
  
  The tag to be converted.
Returns bigint
- Defined in packages/core/src/Serialization/PlutusData/ConstrPlutusData.ts:129

`Static` fromCbor

fromCbor(cbor: HexBlob): Serialization.ConstrPlutusData
Deserializes a ConstrPlutusData instance from its CBOR representation.

Returns
A ConstrPlutusData instance.
Parameters
- cbor: HexBlob
  
  The CBOR representation of this instance as a Uint8Array.
Returns Serialization.ConstrPlutusData
- Defined in packages/core/src/Serialization/PlutusData/ConstrPlutusData.ts:65

Class ConstrPlutusData

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

alternative: bigint

data: Serialization.PlutusList

Returns Serialization.ConstrPlutusData

Properties

Private Readonly #alternative

Private Readonly #data

Methods

equals

Returns

Parameters

other: Serialization.ConstrPlutusData

Returns boolean

getAlternative

Returns

Returns bigint

getData

Returns

Returns Serialization.PlutusList

toCbor

Returns

Returns HexBlob

Static Private alternativeToCompactCborTag

Returns

Parameters

alternative: bigint

Returns bigint

Static Private compactCborTagToAlternative

Returns

Parameters

tag: bigint

Returns bigint

Static fromCbor

Returns

Parameters

cbor: HexBlob

Returns Serialization.ConstrPlutusData

Settings

Member Visibility

Theme

`Private` `Readonly` #alternative

`Private` `Readonly` #data

`Static` `Private` alternativeToCompactCborTag

`Static` `Private` compactCborTagToAlternative

`Static` fromCbor