Class PlutusData

A type corresponding to the Plutus Core Data datatype.

The point of this type is to be opaque as to ensure that it is only used in ways that plutus scripts can handle.

Use this type to build any data structures that you want to be representable on-chain.

Hierarchy

PlutusData

Index

Constructors

constructor

new PlutusData(): Serialization.PlutusData
Returns Serialization.PlutusData

Properties

`Private` #bytes

#bytes: undefined | Uint8Array = undefined

`Private` #constr

#constr: undefined | Serialization.ConstrPlutusData = undefined

`Private` #integer

#integer: undefined | bigint = undefined

`Private` #kind

#kind: Serialization.PlutusDataKind = PlutusDataKind.ConstrPlutusData

`Private` #list

#list: undefined | Serialization.PlutusList = undefined

`Private` #map

#map: undefined | Serialization.PlutusMap = undefined

`Private` #originalBytes

#originalBytes: undefined | HexBlob = undefined

Methods

asBoundedBytes

asBoundedBytes(): undefined | Uint8Array
Down casts this PlutusData instance as a Uint8Array instance.

Returns
The Uint8Array or undefined if it can not be 'down cast'.

Returns undefined | Uint8Array
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:372

asConstrPlutusData

asConstrPlutusData(): undefined | Serialization.ConstrPlutusData
Down casts this PlutusData instance as a ConstrPlutusData instance.

Returns
The ConstrPlutusData instance or undefined if it can not be 'down cast'.

Returns undefined | Serialization.ConstrPlutusData
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:336

asInteger

asInteger(): undefined | bigint
Down casts this PlutusData instance as a bigint instance.

Returns
The bigint value or undefined if it can not be 'down cast'.

Returns undefined | bigint
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:363

asList

asList(): undefined | Serialization.PlutusList
Down casts this PlutusData instance as a PlutusList instance.

Returns
The PlutusList instance or undefined if it can not be 'down cast'.

Returns undefined | Serialization.PlutusList
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:354

asMap

asMap(): undefined | Serialization.PlutusMap
Down casts this PlutusData instance as a PlutusMap instance.

Returns
The PlutusMap instance or undefined if it can not be 'down cast'.

Returns undefined | Serialization.PlutusMap
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:345

equals

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

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

getKind

getKind(): Serialization.PlutusDataKind
Gets the underlying type of this PlutusData instance.

Returns
The underlying type.

Returns Serialization.PlutusDataKind
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:327

toCbor

toCbor(): HexBlob
Serializes this PlutusData 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/PlutusData.ts:38

toCore

toCore(): Cardano.PlutusData
Creates a Core Tx object from the current PlutusData object.

Returns
The PlutusData object.

Returns Cardano.PlutusData
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:184

`Static` `Private` bufferToBigint

bufferToBigint(buffer: Uint8Array): bigint
Converts an Uint8Array to a bigint.

Returns
The resulting bigint;
Parameters
- buffer: Uint8Array
  
  The buffer to be converted to bigint.
Returns bigint
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:448

`Static` fromCbor

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

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

`Static` fromCore

fromCore(data: Cardano.PlutusData): Serialization.PlutusData
Creates a PlutusData object from the given Core PlutusData object.
Parameters
- data: Cardano.PlutusData
  
  The core PlutusData object.
Returns Serialization.PlutusData
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:220

`Static` `Private` mapToCorePlutusList

mapToCorePlutusList(list: Serialization.PlutusList): Cardano.PlutusList
Maps to Core plutus list from PlutusList.
Parameters
- list: Serialization.PlutusList
  
  The PlutusList
Returns Cardano.PlutusList
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:433

`Static` `Private` mapToPlutusList

mapToPlutusList(list: Cardano.PlutusData[]): Serialization.PlutusList
Maps to PlutusList from a core plutus list.
Parameters
- list: Cardano.PlutusData[]
  
  The core plutus list.
Returns Serialization.PlutusList
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:420

`Static` newBytes

newBytes(bytes: Uint8Array): Serialization.PlutusData
Create a PlutusData type from the given Uint8Array.

Returns
The Uint8Array as a PlutusList object.
Parameters
- bytes: Uint8Array
  
  The Uint8Array to be 'cast' as PlutusData.
Returns Serialization.PlutusData
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:313

`Static` newConstrPlutusData

newConstrPlutusData(constrPlutusData: Serialization.ConstrPlutusData): Serialization.PlutusData
Create a PlutusData type from the given ConstrPlutusData.

Returns
The ConstrPlutusData as a PlutusData object.
Parameters
- constrPlutusData: Serialization.ConstrPlutusData
  
  The ConstrPlutusData to be 'cast' as PlutusData.
Returns Serialization.PlutusData
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:253

`Static` newInteger

newInteger(integer: bigint): Serialization.PlutusData
Create a PlutusData type from the given bigint.

Returns
The bigint as a PlutusList object.
Parameters
- integer: bigint
  
  The bigint to be 'cast' as PlutusData.
Returns Serialization.PlutusData
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:298

`Static` newList

newList(list: Serialization.PlutusList): Serialization.PlutusData
Create a PlutusData type from the given PlutusList.

Returns
The PlutusMap as a PlutusList object.
Parameters
- list: Serialization.PlutusList
  
  The PlutusList to be 'cast' as PlutusData.
Returns Serialization.PlutusData
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:283

`Static` newMap

newMap(map: Serialization.PlutusMap): Serialization.PlutusData
Create a PlutusData type from the given PlutusMap.

Returns
The PlutusMap as a PlutusData object.
Parameters
- map: Serialization.PlutusMap
  
  The PlutusMap to be 'cast' as PlutusData.
Returns Serialization.PlutusData
- Defined in packages/core/src/Serialization/PlutusData/PlutusData.ts:268

Class PlutusData

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Serialization.PlutusData

Properties

Private #bytes

Private #constr

Private #integer

Private #kind

Private #list

Private #map

Private #originalBytes

Methods

asBoundedBytes

Returns

Returns undefined | Uint8Array

asConstrPlutusData

Returns

Returns undefined | Serialization.ConstrPlutusData

asInteger

Returns

Returns undefined | bigint

asList

Returns

Returns undefined | Serialization.PlutusList

asMap

Returns

Returns undefined | Serialization.PlutusMap

equals

Returns

Parameters

other: Serialization.PlutusData

Returns boolean

getKind

Returns

Returns Serialization.PlutusDataKind

toCbor

Returns

Returns HexBlob

toCore

Returns

Returns Cardano.PlutusData

Static Private bufferToBigint

Returns

Parameters

buffer: Uint8Array

Returns bigint

Static fromCbor

Returns

Parameters

cbor: HexBlob

Returns Serialization.PlutusData

Static fromCore

Parameters

data: Cardano.PlutusData

Returns Serialization.PlutusData

Static Private mapToCorePlutusList

Parameters

list: Serialization.PlutusList

Returns Cardano.PlutusList

Static Private mapToPlutusList

Parameters

list: Cardano.PlutusData[]

Returns Serialization.PlutusList

Static newBytes

Returns

Parameters

bytes: Uint8Array

Returns Serialization.PlutusData

Static newConstrPlutusData

Returns

Parameters

constrPlutusData: Serialization.ConstrPlutusData

Returns Serialization.PlutusData

Static newInteger

`Private` #bytes

`Private` #constr

`Private` #integer

`Private` #kind

`Private` #list

`Private` #map

`Private` #originalBytes

`Static` `Private` bufferToBigint

`Static` fromCbor

`Static` fromCore

`Static` `Private` mapToCorePlutusList

`Static` `Private` mapToPlutusList

`Static` newBytes

`Static` newConstrPlutusData

`Static` newInteger

`Static` newList

`Static` newMap