Class: MetadataValue

Properties overview

• height: Field = Field; ↗
• length: Field = Field; ↗
• type: Field = Field; ↗
• value: Field = Field; ↗

Methods overview

• hash() ↗
• new() ↗

Defined in: packages/nft/src/metadata/metadata.ts:41

Represents a metadata value with its type and associated data.

Extends

• {
  height: Field;
  length: Field;
  type: Field;
  value: Field;
  }

Constructors

new MetadataValue()

new MetadataValue(value: {
  height: Field;
  length: Field;
  type: Field;
  value: Field;
 }): MetadataValue

Defined in: node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103

Parameters

value

height

Field = Field

length

Field = Field

type

Field = Field

value

Field = Field

Returns

MetadataValue

Inherited from

Struct({
  value: Field,
  type: Field,
  length: Field,
  height: Field,
}).constructor

Properties

height

height: Field = Field;

Defined in: packages/nft/src/metadata/metadata.ts:45

Inherited from

Struct({
  value: Field,
  type: Field,
  length: Field,
  height: Field,
}).height

length

length: Field = Field;

Defined in: packages/nft/src/metadata/metadata.ts:44

Inherited from

Struct({
  value: Field,
  type: Field,
  length: Field,
  height: Field,
}).length

type

type: Field = Field;

Defined in: packages/nft/src/metadata/metadata.ts:43

Inherited from

Struct({
  value: Field,
  type: Field,
  length: Field,
  height: Field,
}).type

value

value: Field = Field;

Defined in: packages/nft/src/metadata/metadata.ts:42

Inherited from

Struct({
  value: Field,
  type: Field,
  length: Field,
  height: Field,
}).value

Methods

hash()

hash(): Field

Defined in: packages/nft/src/metadata/metadata.ts:105

Computes the Poseidon hash of the metadata value.

Returns

Field

The hash as a Field.

new()

static new(params: {
  type: MetadataFieldType;
  value:   | Field
     | Text
     | MetadataTree
     | Metadata;
 }): MetadataValue

Defined in: packages/nft/src/metadata/metadata.ts:52

Creates a new MetadataValue instance.

Parameters

params

The parameters including value and type.

type

MetadataFieldType

value

| Field
| Text
| MetadataTree
| Metadata

Returns

MetadataValue

A new MetadataValue.