Class: NFTStateStruct

Properties overview

metadata: Field = Field; ↗
metadataVerificationKeyHash: Field = Field; ↗
name: Field = Field; ↗
packedData: NFTDataPacked = NFTDataPacked; ↗
storage: Storage = Storage; ↗
Returns: {
metadata: Field;
metadataVerificationKeyHash: Field;
name: Field;
packedData: NFTDataPacked;
storage: Storage;
} ↗
metadata: Field = Field; ↗
metadataVerificationKeyHash: Field = Field; ↗
name: Field = Field; ↗
packedData: NFTDataPacked = NFTDataPacked; ↗
storage: Storage = Storage; ↗

Methods overview

assertEqual() ↗
fromAccount() ↗

Defined in: packages/nft/src/interfaces/types.ts:51

Represents the on-chain state structure of an NFT.
The order of the fields is important and should match the NFT SmartContract.

Extends

{
metadata: Field;
metadataVerificationKeyHash: Field;
name: Field;
packedData: NFTDataPacked;
storage: Storage;
}

Constructors

new NFTStateStruct()

new NFTStateStruct(value: {
  metadata: Field;
  metadataVerificationKeyHash: Field;
  name: Field;
  packedData: NFTDataPacked;
  storage: Storage;
 }): NFTStateStruct

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

Parameters

value

metadata

Field = Field

metadataVerificationKeyHash

Field = Field

name

Field = Field

packedData

NFTDataPacked = NFTDataPacked

storage

Storage = Storage

Returns

NFTStateStruct

Inherited from

Struct({
  name: Field,
  metadata: Field,
  storage: Storage,
  packedData: NFTDataPacked,
  metadataVerificationKeyHash: Field,
}).constructor

Properties

metadata

metadata: Field = Field;

Defined in: packages/nft/src/interfaces/types.ts:53

Inherited from

Struct({
  name: Field,
  metadata: Field,
  storage: Storage,
  packedData: NFTDataPacked,
  metadataVerificationKeyHash: Field,
}).metadata

metadataVerificationKeyHash

metadataVerificationKeyHash: Field = Field;

Defined in: packages/nft/src/interfaces/types.ts:56

Inherited from

Struct({
  name: Field,
  metadata: Field,
  storage: Storage,
  packedData: NFTDataPacked,
  metadataVerificationKeyHash: Field,
}).metadataVerificationKeyHash

name

name: Field = Field;

Defined in: packages/nft/src/interfaces/types.ts:52

Inherited from

Struct({
  name: Field,
  metadata: Field,
  storage: Storage,
  packedData: NFTDataPacked,
  metadataVerificationKeyHash: Field,
}).name

packedData

packedData: NFTDataPacked = NFTDataPacked;

Defined in: packages/nft/src/interfaces/types.ts:55

Inherited from

Struct({
  name: Field,
  metadata: Field,
  storage: Storage,
  packedData: NFTDataPacked,
  metadataVerificationKeyHash: Field,
}).packedData

storage

storage: Storage = Storage;

Defined in: packages/nft/src/interfaces/types.ts:54

Inherited from

Struct({
  name: Field,
  metadata: Field,
  storage: Storage,
  packedData: NFTDataPacked,
  metadataVerificationKeyHash: Field,
}).storage

Methods

assertEqual()

static assertEqual(a: NFTStateStruct, b: NFTStateStruct): void

Defined in: packages/nft/src/interfaces/types.ts:78

Asserts that two NFTStateStruct instances are equal.

Parameters

a

NFTStateStruct

The first NFTStateStruct instance.

b

NFTStateStruct

The second NFTStateStruct instance.

Returns

void

fromAccount()

static fromAccount(account: Account): {
  metadata: Field;
  metadataVerificationKeyHash: Field;
  name: Field;
  packedData: NFTDataPacked;
  storage: Storage;
}

Defined in: packages/nft/src/interfaces/types.ts:63

Creates an NFTStateStruct from an account's app state.

Parameters

account

Account

The account containing the zkApp state.

Returns

{
  metadata: Field;
  metadataVerificationKeyHash: Field;
  name: Field;
  packedData: NFTDataPacked;
  storage: Storage;
}

A new NFTStateStruct instance.

metadata

metadata: Field = Field;

metadataVerificationKeyHash

metadataVerificationKeyHash: Field = Field;

name

name: Field = Field;

packedData

packedData: NFTDataPacked = NFTDataPacked;

storage

storage: Storage = Storage;