Class AuxiliaryData

Auxiliary Data encapsulate certain optional information that can be attached to a transaction. This data includes transaction metadata and scripts.

The Auxiliary Data is hashed and referenced in the transaction body.

Hierarchy

AuxiliaryData

Constructors

constructor

new AuxiliaryData(): Serialization.AuxiliaryData
Returns Serialization.AuxiliaryData

Properties

`Private` #metadata

#metadata: undefined | Serialization.GeneralTransactionMetadata

`Private` #nativeScripts

#nativeScripts: undefined | Serialization.NativeScript[]

`Private` #originalBytes

#originalBytes: undefined | HexBlob = undefined

`Private` #plutusV1Scripts

#plutusV1Scripts: undefined | Serialization.PlutusV1Script[]

`Private` #plutusV2Scripts

#plutusV2Scripts: undefined | Serialization.PlutusV2Script[]

`Private` #plutusV3Scripts

#plutusV3Scripts: undefined | Serialization.PlutusV3Script[]

Methods

`Private` #getCoreScripts

#getCoreScripts(): Cardano.Script[]
Private
Gets all the scripts present in this witness as Core scripts.

Returns
The list of scripts.

Returns Cardano.Script[]
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:386

`Private` #getMapSize

#getMapSize(): number
Private
Gets the size of the serialized map.

Returns number
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:368

metadata

metadata(): undefined | Serialization.GeneralTransactionMetadata
Gets the transaction metadata. this is supplementary information that can be attached to a transaction. It's not essential for transaction validation but can be used for various purposes, including record-keeping, identity solutions, and more.

Returns
The transaction metadata.

Returns undefined | Serialization.GeneralTransactionMetadata
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:271

nativeScripts

nativeScripts(): undefined | Serialization.NativeScript[]
Gets the set of native scripts present in the auxiliary data.

Returns
The set of native scripts.

Returns undefined | Serialization.NativeScript[]
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:292

plutusV1Scripts

plutusV1Scripts(): undefined | Serialization.PlutusV1Script[]
Gets the set of plutus v1 scripts present in the auxiliary data.

Returns
The set of plutus v1 scripts.

Returns undefined | Serialization.PlutusV1Script[]
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:311

plutusV2Scripts

plutusV2Scripts(): undefined | Serialization.PlutusV2Script[]
Gets the set of plutus v2 scripts present in the auxiliary data.

Returns
The set of plutus v2 scripts.

Returns undefined | Serialization.PlutusV2Script[]
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:330

plutusV3Scripts

plutusV3Scripts(): undefined | Serialization.PlutusV3Script[]
Gets the set of plutus v3 scripts present in the auxiliary data.

Returns
The set of plutus v3 scripts.

Returns undefined | Serialization.PlutusV3Script[]
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:349

setMetadata

setMetadata(metadata: Serialization.GeneralTransactionMetadata): void
Sets the transaction metadata. this is supplementary information that can be attached to a transaction. It's not essential for transaction validation but can be used for various purposes, including record-keeping, identity solutions, and more.
Parameters
- metadata: Serialization.GeneralTransactionMetadata
  
  The transaction metadata.
Returns void
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:282

setNativeScripts

setNativeScripts(nativeScripts: Serialization.NativeScript[]): void
Sets the set of native scripts present in the auxiliary data.
Parameters
- nativeScripts: Serialization.NativeScript[]
  
  The set of native scripts.
Returns void
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:301

setPlutusV1Scripts

setPlutusV1Scripts(plutusV1Scripts: Serialization.PlutusV1Script[]): void
Sets the set of v1 scripts scripts present in the auxiliary data.
Parameters
- plutusV1Scripts: Serialization.PlutusV1Script[]
  
  The set of v1 scripts scripts.
Returns void
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:320

setPlutusV2Scripts

setPlutusV2Scripts(plutusV2Scripts: Serialization.PlutusV2Script[]): void
Sets the set of v2 scripts present in the auxiliary data.
Parameters
- plutusV2Scripts: Serialization.PlutusV2Script[]
  
  The set of v2 scripts.
Returns void
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:339

setPlutusV3Scripts

setPlutusV3Scripts(plutusV3Scripts: Serialization.PlutusV3Script[]): void
Sets the set of v3 scripts present in the auxiliary data.
Parameters
- plutusV3Scripts: Serialization.PlutusV3Script[]
  
  The set of v3 scripts.
Returns void
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:358

toCbor

toCbor(): HexBlob
Serializes a AuxiliaryData into CBOR format.

Returns
The AuxiliaryData in CBOR format.

Returns HexBlob
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:41

toCore

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

Returns
The Core AuxiliaryData object.

Returns Cardano.AuxiliaryData
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:229

`Static` `Private` #getCddlScripts

#getCddlScripts(scripts: Cardano.Script[]): CddlScripts
Private
Gets all the scripts present in this witness as CDDL scripts.

Returns
The list of scripts.
Parameters
- scripts: Cardano.Script[]
Returns CddlScripts
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:401

`Static` fromCbor

fromCbor(cbor: HexBlob): Serialization.AuxiliaryData
Deserializes the AuxiliaryData from a CBOR byte array.

Returns
The new AuxiliaryData instance.
Parameters
- cbor: HexBlob
  
  The CBOR encoded AuxiliaryData object.
Returns Serialization.AuxiliaryData
- Defined in packages/core/src/Serialization/AuxiliaryData/AuxiliaryData.ts:129

`Static` fromCore

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

Class AuxiliaryData

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Serialization.AuxiliaryData

Properties

Private #metadata

Private #nativeScripts

Private #originalBytes

Private #plutusV1Scripts

Private #plutusV2Scripts

Private #plutusV3Scripts

Methods

Private #getCoreScripts

Returns

Returns Cardano.Script[]

Private #getMapSize

Returns number

metadata

Returns

Returns undefined | Serialization.GeneralTransactionMetadata

nativeScripts

Returns

Returns undefined | Serialization.NativeScript[]

plutusV1Scripts

Returns

Returns undefined | Serialization.PlutusV1Script[]

plutusV2Scripts

Returns

Returns undefined | Serialization.PlutusV2Script[]

plutusV3Scripts

Returns

Returns undefined | Serialization.PlutusV3Script[]

setMetadata

Parameters

metadata: Serialization.GeneralTransactionMetadata

Returns void

setNativeScripts

Parameters

nativeScripts: Serialization.NativeScript[]

Returns void

setPlutusV1Scripts

Parameters

plutusV1Scripts: Serialization.PlutusV1Script[]

Returns void

setPlutusV2Scripts

Parameters

plutusV2Scripts: Serialization.PlutusV2Script[]

Returns void

setPlutusV3Scripts

Parameters

plutusV3Scripts: Serialization.PlutusV3Script[]

Returns void

toCbor

Returns

Returns HexBlob

toCore

Returns

Returns Cardano.AuxiliaryData

Static Private #getCddlScripts

Returns

Parameters

scripts: Cardano.Script[]

Returns CddlScripts

Static fromCbor

Returns

Parameters

cbor: HexBlob

Returns Serialization.AuxiliaryData

Static fromCore

Parameters

auxData: Cardano.AuxiliaryData

Returns Serialization.AuxiliaryData

Settings

Member Visibility

Theme

`Private` #metadata

`Private` #nativeScripts

`Private` #originalBytes

`Private` #plutusV1Scripts

`Private` #plutusV2Scripts

`Private` #plutusV3Scripts

`Private` #getCoreScripts

`Private` #getMapSize

`Static` `Private` #getCddlScripts

`Static` fromCbor

`Static` fromCore