CollectionData

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

Hierarchy

• { canChangeBaseUri: Bool; canChangeCreator: Bool; canChangeName: Bool; canChangeRoyalty: Bool; canChangeTransferFee: Bool; canMint: Bool; canPause: Bool; canSetAdmin: Bool; isPaused: Bool; requireBuyApproval: Bool; requireCreatorSignatureToUpgradeCollection: Bool; requireCreatorSignatureToUpgradeNFT: Bool; requireSaleApproval: Bool; requireTransferApproval: Bool; requireUpdateApproval: Bool; royaltyFee: UInt32; transferFee: UInt64; upgradeAuthority: PublicKey }
  • CollectionData

Index

Constructors

• constructor

Properties

• canChangeBaseUri
• canChangeCreator
• canChangeName
• canChangeRoyalty
• canChangeTransferFee
• canMint
• canPause
• canSetAdmin
• isPaused
• requireBuyApproval
• requireCreatorSignatureToUpgradeCollection
• requireCreatorSignatureToUpgradeNFT
• requireSaleApproval
• requireTransferApproval
• requireUpdateApproval
• royaltyFee
• transferFee
• upgradeAuthority

Methods

• pack
• new
• unpack

Constructors

externalconstructor

• new CollectionData(value: { canChangeBaseUri: Bool; canChangeCreator: Bool; canChangeName: Bool; canChangeRoyalty: Bool; canChangeTransferFee: Bool; canMint: Bool; canPause: Bool; canSetAdmin: Bool; isPaused: Bool; requireBuyApproval: Bool; requireCreatorSignatureToUpgradeCollection: Bool; requireCreatorSignatureToUpgradeNFT: Bool; requireSaleApproval: Bool; requireTransferApproval: Bool; requireUpdateApproval: Bool; royaltyFee: UInt32; transferFee: UInt64; upgradeAuthority: PublicKey }): CollectionData

• Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).constructor

  Parameters

  • externalvalue: { canChangeBaseUri: Bool; canChangeCreator: Bool; canChangeName: Bool; canChangeRoyalty: Bool; canChangeTransferFee: Bool; canMint: Bool; canPause: Bool; canSetAdmin: Bool; isPaused: Bool; requireBuyApproval: Bool; requireCreatorSignatureToUpgradeCollection: Bool; requireCreatorSignatureToUpgradeNFT: Bool; requireSaleApproval: Bool; requireTransferApproval: Bool; requireUpdateApproval: Bool; royaltyFee: UInt32; transferFee: UInt64; upgradeAuthority: PublicKey }

  • externalcanChangeBaseUri: Bool = Bool

    If true, the base URI for the collection's metadata can be changed.

  • externalcanChangeCreator: Bool = Bool

    If true, the creator of the collection can be changed.

  • externalcanChangeName: Bool = Bool

    If true, the name of the collection can be changed.

  • externalcanChangeRoyalty: Bool = Bool

    If true, the royalty fee configuration can be changed.

  • externalcanChangeTransferFee: Bool = Bool

    If true, the transfer fee configuration can be changed.

  • externalcanMint: Bool = Bool

    If true, new NFTs can be minted in this collection.

  • externalcanPause: Bool = Bool

    If true, the collection can be paused and resumed by authorized parties.

  • externalcanSetAdmin: Bool = Bool

    If true, the admin contract associated with the collection can be changed.

  • externalisPaused: Bool = Bool

    Indicates whether the collection is currently paused.

  • externalrequireBuyApproval: Bool = Bool

    If true, purchasing NFTs requires approval from the admin contract.

  • externalrequireCreatorSignatureToUpgradeCollection: Bool = Bool

    If true, upgrading the collection's verification key requires the creator's signature.

  • externalrequireCreatorSignatureToUpgradeNFT: Bool = Bool

    If true, upgrading an NFT's verification key requires the creator's signature.

  • externalrequireSaleApproval: Bool = Bool

    If true, listing NFTs for sale requires approval from the admin contract.

  • externalrequireTransferApproval: Bool = Bool

    If true, transferring NFTs requires approval from the admin contract.

  • externalrequireUpdateApproval: Bool = Bool

    If true, updating NFTs requires approval from the admin contract.

  • externalroyaltyFee: UInt32 = UInt32

    The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%).

  • externaltransferFee: UInt64 = UInt64

    The transfer fee amount.

  • externalupgradeAuthority: PublicKey = PublicKey

    The public key of the upgrade authority contract.

  Returns CollectionData

Properties

canChangeBaseUri

canChangeBaseUri: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).canChangeBaseUri

If true, the base URI for the collection's metadata can be changed.

canChangeCreator

canChangeCreator: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).canChangeCreator

If true, the creator of the collection can be changed.

canChangeName

canChangeName: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).canChangeName

If true, the name of the collection can be changed.

canChangeRoyalty

canChangeRoyalty: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).canChangeRoyalty

If true, the royalty fee configuration can be changed.

canChangeTransferFee

canChangeTransferFee: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).canChangeTransferFee

If true, the transfer fee configuration can be changed.

canMint

canMint: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).canMint

If true, new NFTs can be minted in this collection.

canPause

canPause: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).canPause

If true, the collection can be paused and resumed by authorized parties.

canSetAdmin

canSetAdmin: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).canSetAdmin

If true, the admin contract associated with the collection can be changed.

isPaused

isPaused: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).isPaused

Indicates whether the collection is currently paused.

requireBuyApproval

requireBuyApproval: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).requireBuyApproval

If true, purchasing NFTs requires approval from the admin contract.

requireCreatorSignatureToUpgradeCollection

requireCreatorSignatureToUpgradeCollection: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).requireCreatorSignatureToUpgradeCollection

If true, upgrading the collection's verification key requires the creator's signature.

requireCreatorSignatureToUpgradeNFT

requireCreatorSignatureToUpgradeNFT: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).requireCreatorSignatureToUpgradeNFT

If true, upgrading an NFT's verification key requires the creator's signature.

requireSaleApproval

requireSaleApproval: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).requireSaleApproval

If true, listing NFTs for sale requires approval from the admin contract.

requireTransferApproval

requireTransferApproval: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).requireTransferApproval

If true, transferring NFTs requires approval from the admin contract.

requireUpdateApproval

requireUpdateApproval: Bool = Bool

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).requireUpdateApproval

If true, updating NFTs requires approval from the admin contract.

royaltyFee

royaltyFee: UInt32 = UInt32

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).royaltyFee

The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%).

transferFee

transferFee: UInt64 = UInt64

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).transferFee

The transfer fee amount.

upgradeAuthority

upgradeAuthority: PublicKey = PublicKey

Inherited from Struct({ /** The public key of the upgrade authority contract. */ upgradeAuthority: PublicKey, /** The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%). */ royaltyFee: UInt32, // 1000 = 1%, 100 = 0.1%, 10000 = 10% /** The transfer fee amount. */ transferFee: UInt64, /** If true, transferring NFTs requires approval from the admin contract. */ requireTransferApproval: Bool, /** If true, updating NFTs requires approval from the admin contract. */ requireUpdateApproval: Bool, /** If true, listing NFTs for sale requires approval from the admin contract. */ requireSaleApproval: Bool, /** If true, purchasing NFTs requires approval from the admin contract. */ requireBuyApproval: Bool, /** If true, upgrading the collection's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeCollection: Bool, /** If true, upgrading an NFT's verification key requires the creator's signature. */ requireCreatorSignatureToUpgradeNFT: Bool, /** If true, new NFTs can be minted in this collection. */ canMint: Bool, /** If true, the collection can be paused and resumed by authorized parties. */ canPause: Bool, /** If true, the name of the collection can be changed. */ canChangeName: Bool, /** If true, the creator of the collection can be changed. */ canChangeCreator: Bool, /** If true, the base URI for the collection's metadata can be changed. */ canChangeBaseUri: Bool, /** If true, the royalty fee configuration can be changed. */ canChangeRoyalty: Bool, /** If true, the transfer fee configuration can be changed. */ canChangeTransferFee: Bool, /** If true, the admin contract associated with the collection can be changed. */ canSetAdmin: Bool, /** Indicates whether the collection is currently paused. */ isPaused: Bool, }).upgradeAuthority

The public key of the upgrade authority contract.

Methods

pack

• pack(): CollectionDataPacked

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

  ---

  Returns CollectionDataPacked

  The packed CollectionDataPacked instance.

staticnew

• new(params: { canChangeBaseUri?: boolean; canChangeCreator?: boolean; canChangeName?: boolean; canChangeRoyalty?: boolean; canChangeTransferFee?: boolean; canMint?: boolean; canPause?: boolean; canSetAdmin?: boolean; isPaused?: boolean; requireBuyApproval?: boolean; requireCreatorSignatureToUpgradeCollection?: boolean; requireCreatorSignatureToUpgradeNFT?: boolean; requireSaleApproval?: boolean; requireTransferApproval?: boolean; requireUpdateApproval?: boolean; royaltyFee?: number; transferFee?: number; upgradeAuthority?: PublicKey }): CollectionData

• Creates a new CollectionData instance with specified parameters.

  ---

  Parameters

  • params: { canChangeBaseUri?: boolean; canChangeCreator?: boolean; canChangeName?: boolean; canChangeRoyalty?: boolean; canChangeTransferFee?: boolean; canMint?: boolean; canPause?: boolean; canSetAdmin?: boolean; isPaused?: boolean; requireBuyApproval?: boolean; requireCreatorSignatureToUpgradeCollection?: boolean; requireCreatorSignatureToUpgradeNFT?: boolean; requireSaleApproval?: boolean; requireTransferApproval?: boolean; requireUpdateApproval?: boolean; royaltyFee?: number; transferFee?: number; upgradeAuthority?: PublicKey }

    The parameters to create the CollectionData.

  • optionalcanChangeBaseUri: boolean

  • optionalcanChangeCreator: boolean

  • optionalcanChangeName: boolean

  • optionalcanChangeRoyalty: boolean

  • optionalcanChangeTransferFee: boolean

  • optionalcanMint: boolean

  • optionalcanPause: boolean

  • optionalcanSetAdmin: boolean

  • optionalisPaused: boolean

  • optionalrequireBuyApproval: boolean

  • optionalrequireCreatorSignatureToUpgradeCollection: boolean

  • optionalrequireCreatorSignatureToUpgradeNFT: boolean

  • optionalrequireSaleApproval: boolean

  • optionalrequireTransferApproval: boolean

  • optionalrequireUpdateApproval: boolean

  • optionalroyaltyFee: number

  • optionaltransferFee: number

  • optionalupgradeAuthority: PublicKey

  Returns CollectionData

  A new CollectionData instance.

staticunpack

• unpack(packed: CollectionDataPacked): CollectionData

• Unpacks a CollectionDataPacked instance into a CollectionData instance.

  ---

  Parameters

  • packed: CollectionDataPacked

    The packed CollectionDataPacked instance.

  Returns CollectionData

  A new CollectionData instance.