NFTImmutableState

Represents the immutable state of an NFT, containing read-only properties and flags that determine the NFT's behavior and permissions.

Hierarchy

• { address: PublicKey; canChangeMetadata: Bool; canChangeMetadataVerificationKeyHash: Bool; canChangeName: Bool; canChangeOwnerByProof: Bool; canChangeOwnerBySignature: Bool; canChangePrice: Bool; canChangeStorage: Bool; canPause: Bool; creator: PublicKey; id: UInt32; tokenId: Field }
  • NFTImmutableState

Index

Constructors

• constructor

Properties

• address
• canChangeMetadata
• canChangeMetadataVerificationKeyHash
• canChangeName
• canChangeOwnerByProof
• canChangeOwnerBySignature
• canChangePrice
• canChangeStorage
• canPause
• creator
• id
• tokenId

Methods

• assertEqual
• fromNFTData

Constructors

externalconstructor

• new NFTImmutableState(value: { address: PublicKey; canChangeMetadata: Bool; canChangeMetadataVerificationKeyHash: Bool; canChangeName: Bool; canChangeOwnerByProof: Bool; canChangeOwnerBySignature: Bool; canChangePrice: Bool; canChangeStorage: Bool; canPause: Bool; creator: PublicKey; id: UInt32; tokenId: Field }): NFTImmutableState

• Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).constructor

  Parameters

  • externalvalue: { address: PublicKey; canChangeMetadata: Bool; canChangeMetadataVerificationKeyHash: Bool; canChangeName: Bool; canChangeOwnerByProof: Bool; canChangeOwnerBySignature: Bool; canChangePrice: Bool; canChangeStorage: Bool; canPause: Bool; creator: PublicKey; id: UInt32; tokenId: Field }

  • externaladdress: PublicKey = PublicKey

    The address of the NFT contract (readonly).

  • externalcanChangeMetadata: Bool = Bool

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

  • externalcanChangeMetadataVerificationKeyHash: Bool = Bool

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

  • externalcanChangeName: Bool = Bool

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

  • externalcanChangeOwnerByProof: Bool = Bool

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

  • externalcanChangeOwnerBySignature: Bool = Bool

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

  • externalcanChangePrice: Bool = Bool

    Indicates if the price of the NFT can be modified (readonly).

  • externalcanChangeStorage: Bool = Bool

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

  • externalcanPause: Bool = Bool

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

  • externalcreator: PublicKey = PublicKey

    The public key of the creator of the NFT (readonly).

  • externalid: UInt32 = UInt32

    The unique identifier of the NFT within the collection (readonly).

  • externaltokenId: Field = Field

    The token ID associated with the NFT (readonly).

  Returns NFTImmutableState

Properties

address

address: PublicKey = PublicKey

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).address

The address of the NFT contract (readonly).

canChangeMetadata

canChangeMetadata: Bool = Bool

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).canChangeMetadata

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

canChangeMetadataVerificationKeyHash

canChangeMetadataVerificationKeyHash: Bool = Bool

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).canChangeMetadataVerificationKeyHash

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

canChangeName

canChangeName: Bool = Bool

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).canChangeName

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

canChangeOwnerByProof

canChangeOwnerByProof: Bool = Bool

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).canChangeOwnerByProof

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

canChangeOwnerBySignature

canChangeOwnerBySignature: Bool = Bool

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).canChangeOwnerBySignature

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

canChangePrice

canChangePrice: Bool = Bool

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).canChangePrice

Indicates if the price of the NFT can be modified (readonly).

canChangeStorage

canChangeStorage: Bool = Bool

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).canChangeStorage

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

canPause

canPause: Bool = Bool

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).canPause

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

creator

creator: PublicKey = PublicKey

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).creator

The public key of the creator of the NFT (readonly).

id

id: UInt32 = UInt32

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).id

The unique identifier of the NFT within the collection (readonly).

tokenId

tokenId: Field = Field

Inherited from Struct({ /** The public key of the creator of the NFT (readonly). */ creator: PublicKey, // readonly /** Determines if 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 through the owner's signature (readonly). */ canChangeOwnerBySignature: Bool, // readonly /** Indicates whether the NFT's metadata can be updated (readonly). */ canChangeMetadata: Bool, // readonly /** Indicates if the price of the NFT can be modified (readonly). */ canChangePrice: 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 /** The address of the NFT contract (readonly). */ address: PublicKey, // readonly /** The token ID associated with the NFT (readonly). */ tokenId: Field, // readonly /** The unique identifier of the NFT within the collection (readonly). */ id: UInt32, // readonly }).tokenId

The token ID associated with the NFT (readonly).

Methods

staticassertEqual

• assertEqual(a: NFTImmutableState, b: NFTImmutableState): void

• Asserts that two NFTImmutableState instances are equal.

  ---

  Parameters

  • a: NFTImmutableState

    The first NFTImmutableState instance.

  • b: NFTImmutableState

    The second NFTImmutableState instance.

  Returns void

staticfromNFTData

• fromNFTData(params: { address: PublicKey; creator: PublicKey; nftData: NFTData; tokenId: Field }): NFTImmutableState

• Creates a new NFTImmutableState from NFTData and other parameters.

  ---

  Parameters

  • params: { address: PublicKey; creator: PublicKey; nftData: NFTData; tokenId: Field }

    The parameters including nftData, creator, address, and tokenId.

  • address: PublicKey

  • creator: PublicKey

  • nftData: NFTData

  • tokenId: Field

  Returns NFTImmutableState

  A new NFTImmutableState instance.