NFT

The NFT Contract represents an individual NFT within a collection.

It manages the state and behavior of a single NFT, including ownership, metadata, storage, pricing, and permissions. The contract provides functionality for updating NFT properties with proofs and permissions, transferring ownership, selling and buying NFTs, upgrading the verification key, and pausing or resuming the NFT.

Hierarchy

• unknown
  • NFT

Index

Constructors

• constructor

Properties

• events
• metadata
• metadataVerificationKeyHash
• name
• packedData
• storage

Methods

• approveAddress
• getState
• pause
• resume
• transfer
• update
• upgradeVerificationKey

Constructors

constructor

• new NFT(): NFT

• Inherited from SmartContract.constructor

  Returns NFT

Properties

events

events: { approve: any; pause: typeof PauseEvent; resume: typeof PauseEvent; transfer: typeof OwnershipChangeEvent; update: typeof UpdateEvent; upgradeVerificationKey: typeof UpgradeVerificationKeyEvent } = ...

Events emitted by the NFT contract.

---

Type declaration

• approve: any

• pause: typeof PauseEvent

• resume: typeof PauseEvent

• transfer: typeof OwnershipChangeEvent

• update: typeof UpdateEvent

• upgradeVerificationKey: typeof UpgradeVerificationKeyEvent

metadata

metadata: any = ...

The metadata associated with the NFT (Field).

metadataVerificationKeyHash

metadataVerificationKeyHash: any = ...

The hash of the verification key used for metadata proofs (Field).

name

name: any = ...

The name of the NFT (Field).

packedData

packedData: any = ...

A packed field containing additional NFT data and flags (Field).

storage

storage: any = ...

Holds off-chain storage information, e.g., IPFS hash (Storage).

Methods

approveAddress

• approveAddress(approved: PublicKey): Promise<PublicKey>

• Transfers ownership of the NFT from one user to another.

  ---

  Parameters

  • approved: PublicKey

    The public key of the approved address (PublicKey).

  Returns Promise<PublicKey>

  The public key of the owner (PublicKey).

getState

• getState(): Promise<NFTStateStruct>

• Returns Promise<NFTStateStruct>

pause

• pause(): Promise<PublicKey>

• Pauses the NFT, disabling certain actions.

  ---

  Returns Promise<PublicKey>

  An owner public key to be checked by the Collection contract

resume

• resume(): Promise<PublicKey>

• Resumes the NFT, re-enabling actions.

  ---

  Returns Promise<PublicKey>

  An owner public key to be checked by the Collection contract

transfer

• transfer(params: TransferExtendedParams): Promise<TransferExtendedParams>

• Transfers ownership of the NFT from one user to another.

  ---

  Parameters

  • params: TransferExtendedParams

    The parameters for the transfer (TransferExtendedParams).

  Returns Promise<TransferExtendedParams>

  The public key of the old owner (PublicKey).

update

• update(input: NFTState, output: NFTState, creator: PublicKey): Promise<Field>

• Updates the NFT's state with provided proofs and permissions.

  ---

  Parameters

  • input: NFTState

    The current state of the NFT (NFTState).

  • output: NFTState

    The desired new state of the NFT (NFTState).

  • creator: PublicKey

    The public key of the creator (PublicKey).

  Returns Promise<Field>

  The hash of the metadata verification key (Field).

upgradeVerificationKey

• upgradeVerificationKey(vk: VerificationKey): Promise<UpgradeVerificationKeyData>

• Upgrades the verification key used by the NFT contract.

  ---

  Parameters

  • vk: VerificationKey

    The new verification key (VerificationKey).

  Returns Promise<UpgradeVerificationKeyData>

  An owner public key to be checked by the Collection contract and the Boolean flag indicating if the owner's authorization is required