Class TransactionMetadatum

Transaction metadatum (or simply metadata) is supplementary information that can be attached to a transaction. Unlike the core components of a transaction (such as inputs, outputs, and witnesses), metadata isn't used to determine transaction validity. Instead, it provides a way to embed additional, arbitrary data into the blockchain.

Hierarchy

TransactionMetadatum

Index

Constructors

constructor

new TransactionMetadatum(): Serialization.TransactionMetadatum
Returns Serialization.TransactionMetadatum

Properties

`Private` #bytes

#bytes: undefined | Uint8Array = undefined

`Private` #integer

#integer: undefined | bigint = undefined

`Private` #kind

#kind: Serialization.TransactionMetadatumKind = TransactionMetadatumKind.Map

`Private` #list

#list: undefined | Serialization.MetadatumList = undefined

`Private` #map

#map: undefined | Serialization.MetadatumMap = undefined

`Private` #originalBytes

#originalBytes: undefined | HexBlob = undefined

`Private` #text

#text: undefined | string = undefined

Methods

asBytes

asBytes(): undefined | Uint8Array
Down casts this TransactionMetadatum 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/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:362

asInteger

asInteger(): undefined | bigint
Down casts this TransactionMetadatum 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/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:353

asList

asList(): undefined | Serialization.MetadatumList
Down casts this TransactionMetadatum instance as a MetadatumList instance.

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

Returns undefined | Serialization.MetadatumList
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:344

asMap

asMap(): undefined | Serialization.MetadatumMap
Down casts this TransactionMetadatum instance as a MetadatumMap instance.

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

Returns undefined | Serialization.MetadatumMap
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:335

asText

asText(): undefined | string
Down casts this TransactionMetadatum instance as a string instance.

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

Returns undefined | string
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:371

equals

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

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

getKind

getKind(): Serialization.TransactionMetadatumKind
Gets the underlying type of this TransactionMetadatum instance.

Returns
The underlying type.

Returns Serialization.TransactionMetadatumKind
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:326

toCbor

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

Returns
The CBOR representation of this instance as a HexBlob.

Returns HexBlob
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:43

toCore

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

Returns
The TransactionMetadatum object.

Returns Cardano.Metadatum
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:181

`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/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:434

`Static` fromCbor

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

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

`Static` fromCore

fromCore(metadatum: Cardano.Metadatum): Serialization.TransactionMetadatum
Creates a TransactionMetadatum object from the given Core TransactionMetadatum object.
Parameters
- metadatum: Cardano.Metadatum
  
  The core TransactionMetadatum object.
Returns Serialization.TransactionMetadatum
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:211

`Static` `Private` mapToCoreMetadatumList

mapToCoreMetadatumList(list: Serialization.MetadatumList): Cardano.Metadatum
Maps to Core metadatum list from MetadatumList.
Parameters
- list: Serialization.MetadatumList
  
  The MetadatumList
Returns Cardano.Metadatum
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:419

`Static` newBytes

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

Returns
The Uint8Array as a MetadatumList object.
Parameters
- bytes: Uint8Array
  
  The Uint8Array to be 'cast' as TransactionMetadatum.
Returns Serialization.TransactionMetadatum
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:297

`Static` newInteger

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

Returns
The bigint as a MetadatumList object.
Parameters
- integer: bigint
  
  The bigint to be 'cast' as TransactionMetadatum.
Returns Serialization.TransactionMetadatum
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:282

`Static` newList

newList(list: Serialization.MetadatumList): Serialization.TransactionMetadatum
Create a TransactionMetadatum type from the given MetadatumList.

Returns
The MetadatumMap as a MetadatumList object.
Parameters
- list: Serialization.MetadatumList
  
  The MetadatumList to be 'cast' as TransactionMetadatum.
Returns Serialization.TransactionMetadatum
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:267

`Static` newMap

newMap(map: Serialization.MetadatumMap): Serialization.TransactionMetadatum
Create a TransactionMetadatum type from the given MetadatumMap.

Returns
The MetadatumMap as a TransactionMetadatum object.
Parameters
- map: Serialization.MetadatumMap
  
  The MetadatumMap to be 'cast' as TransactionMetadatum.
Returns Serialization.TransactionMetadatum
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:252

`Static` newText

newText(text: string): Serialization.TransactionMetadatum
Create a TransactionMetadatum type from the given string.

Returns
The string as a MetadatumList object.
Parameters
- text: string
  
  The string to be 'cast' as TransactionMetadatum.
Returns Serialization.TransactionMetadatum
- Defined in packages/core/src/Serialization/AuxiliaryData/TransactionMetadata/TransactionMetadatum.ts:312

Class TransactionMetadatum

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Serialization.TransactionMetadatum

Properties

Private #bytes

Private #integer

Private #kind

Private #list

Private #map

Private #originalBytes

Private #text

Methods

asBytes

Returns

Returns undefined | Uint8Array

asInteger

Returns

Returns undefined | bigint

asList

Returns

Returns undefined | Serialization.MetadatumList

asMap

Returns

Returns undefined | Serialization.MetadatumMap

asText

Returns

Returns undefined | string

equals

Returns

Parameters

other: Serialization.TransactionMetadatum

Returns boolean

getKind

Returns

Returns Serialization.TransactionMetadatumKind

toCbor

Returns

Returns HexBlob

toCore

Returns

Returns Cardano.Metadatum

Static Private bufferToBigint

Returns

Parameters

buffer: Uint8Array

Returns bigint

Static fromCbor

Returns

Parameters

cbor: HexBlob

Returns Serialization.TransactionMetadatum

Static fromCore

Parameters

metadatum: Cardano.Metadatum

Returns Serialization.TransactionMetadatum

Static Private mapToCoreMetadatumList

Parameters

list: Serialization.MetadatumList

Returns Cardano.Metadatum

Static newBytes

Returns

Parameters

bytes: Uint8Array

Returns Serialization.TransactionMetadatum

Static newInteger

Returns

Parameters

integer: bigint

Returns Serialization.TransactionMetadatum

Static newList

Returns

Parameters

list: Serialization.MetadatumList

Returns Serialization.TransactionMetadatum

`Private` #bytes

`Private` #integer

`Private` #kind

`Private` #list

`Private` #map

`Private` #originalBytes

`Private` #text

`Static` `Private` bufferToBigint

`Static` fromCbor

`Static` fromCore

`Static` `Private` mapToCoreMetadatumList

`Static` newBytes

`Static` newInteger

`Static` newList

`Static` newMap

`Static` newText