CollectionData

Represents the data associated with an NFT collection, including configuration parameters and permission flags.

Hierarchy

• any
  • CollectionData

Index

Constructors

• constructor

Methods

• pack
• isPaused
• mintingIsLimited
• new
• requireTransferApproval
• unpack

Constructors

constructor

• new CollectionData(): CollectionData

• Inherited from Struct({ /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, the minting is stopped and cannot be resumed. */ mintingIsLimited: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).constructor

  Returns CollectionData

Methods

pack

• pack(): Field

• Packs the CollectionData into a CollectionDataPacked representation for efficient storage.

  ---

  Returns Field

  The packed CollectionDataPacked instance.

staticisPaused

• isPaused(packed: Field): any

• Parameters

  • packed: Field

  Returns any

staticmintingIsLimited

• mintingIsLimited(packed: Field): any

• Parameters

  • packed: Field

  Returns any

staticnew

• new(params: { isPaused?: boolean; mintingIsLimited?: boolean; requireTransferApproval?: boolean; royaltyFee?: number; transferFee?: string | number | bigint }): CollectionData

• Creates a new CollectionData instance with specified parameters.

  ---

  Parameters

  • params: { isPaused?: boolean; mintingIsLimited?: boolean; requireTransferApproval?: boolean; royaltyFee?: number; transferFee?: string | number | bigint }

    The parameters to create the CollectionData.

  • optionalisPaused: boolean

  • optionalmintingIsLimited: boolean

  • optionalrequireTransferApproval: boolean

  • optionalroyaltyFee: number

  • optionaltransferFee: string | number | bigint

  Returns CollectionData

  A new CollectionData instance.

staticrequireTransferApproval

• requireTransferApproval(packed: Field): any

• Parameters

  • packed: Field

  Returns any

staticunpack

• unpack(packed: Field): CollectionData

• Unpacks a CollectionDataPacked instance into a CollectionData instance.

  ---

  Parameters

  • packed: Field

    The packed CollectionDataPacked instance.

  Returns CollectionData

  A new CollectionData instance.