Class: NFTData

Properties overview

  • approved: PublicKey = PublicKey;
  • canApprove: Bool = Bool;
  • canChangeMetadata: Bool = Bool;
  • canChangeMetadataVerificationKeyHash: Bool = Bool;
  • canChangeName: Bool = Bool;
  • canChangeOwnerByProof: Bool = Bool;
  • canChangeStorage: Bool = Bool;
  • canPause: Bool = Bool;
  • canTransfer: Bool = Bool;
  • id: UInt64 = UInt64;
  • isPaused: Bool = Bool;
  • owner: PublicKey = PublicKey;
  • requireOwnerAuthorizationToUpgrade: Bool = Bool;
  • version: UInt32 = UInt32;

Methods overview

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

Represents the data associated with an NFT, including state and permission flags.

Extends

  • {
    approved: PublicKey;
    canApprove: Bool;
    canChangeMetadata: Bool;
    canChangeMetadataVerificationKeyHash: Bool;
    canChangeName: Bool;
    canChangeOwnerByProof: Bool;
    canChangeStorage: Bool;
    canPause: Bool;
    canTransfer: Bool;
    id: UInt64;
    isPaused: Bool;
    owner: PublicKey;
    requireOwnerAuthorizationToUpgrade: Bool;
    version: UInt32;
    }

Constructors

new NFTData()

new NFTData(value: {
  approved: PublicKey;
  canApprove: Bool;
  canChangeMetadata: Bool;
  canChangeMetadataVerificationKeyHash: Bool;
  canChangeName: Bool;
  canChangeOwnerByProof: Bool;
  canChangeStorage: Bool;
  canPause: Bool;
  canTransfer: Bool;
  id: UInt64;
  isPaused: Bool;
  owner: PublicKey;
  requireOwnerAuthorizationToUpgrade: Bool;
  version: UInt32;
 }): NFTData

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

Parameters

value
approved

PublicKey = PublicKey

The approved address of the NFT.

canApprove

Bool = Bool

Specifies if the NFT's approved address can be changed (readonly).

canChangeMetadata

Bool = Bool

Indicates whether the NFT's metadata can be updated (readonly).

canChangeMetadataVerificationKeyHash

Bool = Bool

Indicates whether the verification key hash for the metadata can be changed (readonly).

canChangeName

Bool = Bool

Specifies if the name of the NFT can be changed (readonly).

canChangeOwnerByProof

Bool = Bool

Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly).

canChangeStorage

Bool = Bool

Determines whether the storage associated with the NFT can be altered (readonly).

canPause

Bool = Bool

Specifies if the NFT contract can be paused, preventing certain operations (readonly).

canTransfer

Bool = Bool

Specifies if the NFT's ownership can be transferred (readonly).

id

UInt64 = UInt64

The unique identifier of the NFT within the collection.

isPaused

Bool = Bool

Indicates whether the NFT contract is currently paused.

owner

PublicKey = PublicKey

The owner of the NFT.

requireOwnerAuthorizationToUpgrade

Bool = Bool

Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly).

version

UInt32 = UInt32

The version number of the NFT state.

Returns

NFTData

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).constructor

Properties

approved

approved: PublicKey = PublicKey;

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

The approved address of the NFT.

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).approved

canApprove

canApprove: Bool = Bool;

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

Specifies if the NFT's approved address can be changed (readonly).

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).canApprove

canChangeMetadata

canChangeMetadata: Bool = Bool;

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

Indicates whether the NFT's metadata can be updated (readonly).

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).canChangeMetadata

canChangeMetadataVerificationKeyHash

canChangeMetadataVerificationKeyHash: Bool = Bool;

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

Indicates whether the verification key hash for the metadata can be changed (readonly).

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).canChangeMetadataVerificationKeyHash

canChangeName

canChangeName: Bool = Bool;

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

Specifies if the name of the NFT can be changed (readonly).

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).canChangeName

canChangeOwnerByProof

canChangeOwnerByProof: Bool = Bool;

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

Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly).

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).canChangeOwnerByProof

canChangeStorage

canChangeStorage: Bool = Bool;

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

Determines whether the storage associated with the NFT can be altered (readonly).

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).canChangeStorage

canPause

canPause: Bool = Bool;

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

Specifies if the NFT contract can be paused, preventing certain operations (readonly).

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).canPause

canTransfer

canTransfer: Bool = Bool;

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

Specifies if the NFT's ownership can be transferred (readonly).

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).canTransfer

id

id: UInt64 = UInt64;

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

The unique identifier of the NFT within the collection.

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).id

isPaused

isPaused: Bool = Bool;

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

Indicates whether the NFT contract is currently paused.

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).isPaused

owner

owner: PublicKey = PublicKey;

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

The owner of the NFT.

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).owner

requireOwnerAuthorizationToUpgrade

requireOwnerAuthorizationToUpgrade: Bool = Bool;

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

Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly).

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).requireOwnerAuthorizationToUpgrade

version

version: UInt32 = UInt32;

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

The version number of the NFT state.

Inherited from

Struct({
  / The owner of the NFT. /
  owner: PublicKey,
  / The approved address of the NFT. /
  approved: PublicKey,
  / The version number of the NFT state. /
  version: UInt32,
  / The unique identifier of the NFT within the collection. /
  id: UInt64,
  / Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly). /
  canChangeOwnerByProof: Bool, // readonly
  / Specifies if the NFT's ownership can be transferred (readonly). /
  canTransfer: Bool, // readonly
  / Specifies if the NFT's approved address can be changed (readonly). /
  canApprove: Bool, // readonly
  / Indicates whether the NFT's metadata can be updated (readonly). /
  canChangeMetadata: Bool, // readonly
  / Determines whether the storage associated with the NFT can be altered (readonly). /
  canChangeStorage: Bool, // readonly
  / Specifies if the name of the NFT can be changed (readonly). /
  canChangeName: Bool, // readonly
  / Indicates whether the verification key hash for the metadata can be changed (readonly). /
  canChangeMetadataVerificationKeyHash: Bool, // readonly
  / Specifies if the NFT contract can be paused, preventing certain operations (readonly). /
  canPause: Bool, // readonly
  / Indicates whether the NFT contract is currently paused. /
  isPaused: Bool,
  / Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly). /
  requireOwnerAuthorizationToUpgrade: Bool, // readonly
}).version

Methods

pack()

pack(): NFTDataPacked

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

Packs the NFTData into a single Field for efficient storage.

Returns

NFTDataPacked

The packed Field representation of the NFTData.


new()

static new(params: {
  approved: string | PublicKey;
  canApprove: boolean;
  canChangeMetadata: boolean;
  canChangeMetadataVerificationKeyHash: boolean;
  canChangeName: boolean;
  canChangeOwnerByProof: boolean;
  canChangeStorage: boolean;
  canPause: boolean;
  canTransfer: boolean;
  id: bigint;
  isPaused: boolean;
  owner: string | PublicKey;
  requireOwnerAuthorizationToUpgrade: boolean;
  version: number;
 }): NFTData

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

Creates a new NFTData instance with optional parameters.

Parameters

params

The parameters to create the NFTData.

approved

string | PublicKey

canApprove

boolean

canChangeMetadata

boolean

canChangeMetadataVerificationKeyHash

boolean

canChangeName

boolean

canChangeOwnerByProof

boolean

canChangeStorage

boolean

canPause

boolean

canTransfer

boolean

id

bigint

isPaused

boolean

owner

string | PublicKey

requireOwnerAuthorizationToUpgrade

boolean

version

number

Returns

NFTData

A new NFTData instance.


unpack()

static unpack(packed: NFTDataPacked): NFTData

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

Unpacks a Field into an NFTData instance.

Parameters

packed

NFTDataPacked

The packed Field representation of the NFTData.

Returns

NFTData

A new NFTData instance.