Collection Management

Overview

Collection management is at the core of CreateKit. This guide covers everything you need to know about creating, configuring, and managing NFT collections using the BaseMint protocol.

Collection Metadata Structure

Every collection requires specific metadata that defines its characteristics:

Required Parameters

Optional Parameters

Creating Collections

Basic Collection

typescript
import { CollectionManager, b3Testnet } from '@b3dotfun/basemint'
import { createPublicClient, createWalletClient, http } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'

const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`)
const publicClient = createPublicClient({
  chain: b3Testnet,
  transport: http()
})

const walletClient = createWalletClient({
  chain: b3Testnet,
  transport: http(),
  account
})

const collectionManager = new CollectionManager(publicClient)

// Define basic collection
const basicCollection = {
  name: "My Art Collection",
  symbol: "MAC",
  creator: account.address,
  gameOwner: account.address,
  description: "A collection of digital art pieces",
  image: "https://example.com/collection-image.png"
}

// Generate creator signature
const creatorSignature = await collectionManager.generateCreatorSignature(
  walletClient,
  basicCollection
)

Advanced Collection Configuration

typescript
import { parseEther } from 'viem'

const advancedCollection = {
  // Required
  name: "Premium Gaming Items",
  symbol: "PGI",
  creator: account.address,
  gameOwner: "0x1234567890123456789012345678901234567890", // Different game owner
  
  // Supply and pricing
  maxSupply: 5000n,
  mintPrice: parseEther("0.01"), // 0.01 ETH
  maxPerWallet: 5n,
  
  // Timing controls
  startTime: BigInt(Math.floor(Date.now() / 1000) + 3600), // Start in 1 hour
  endTime: BigInt(Math.floor(Date.now() / 1000) + 86400 * 7), // End in 7 days
  
  // Whitelist configuration
  isWhitelistEnabled: true,
  whitelistMerkleRoot: "0x..." as `0x${string}`,
  
  // Metadata
  description: "Exclusive gaming items for premium players",
  image: "https://example.com/premium-collection.png",
  external_url: "https://mygame.com/premium-items",
  animation_url: "https://example.com/collection-animation.mp4",
  
  // Collection attributes
  attributes: [
    { trait_type: "Category", value: "Gaming" },
    { trait_type: "Rarity", value: "Premium" },
    { trait_type: "Edition", value: "First" }
  ],
  
  // Technical
  tokenStandard: "ERC1155" as const,
  chainId: 1993
}

Token Standards

CreateKit supports both ERC721 and ERC1155 standards:

typescript
const erc721Collection = {
  name: "Unique Art Pieces",
  symbol: "UAP",
  creator: account.address,
  gameOwner: account.address,
  tokenStandard: "ERC721" as const,
  maxSupply: 1000n, // Each token is unique
  description: "One-of-a-kind digital art pieces"
}

// ERC721 minting (quantity always 1)
const collection721 = collectionManager.createCollection(
  predictedAddress,
  "ERC721"
)

await collection721.mint(
  walletClient,
  1n, // Always 1 for ERC721
  undefined, // metadata URI
  mintPrice,
  proof
)

typescript
const erc1155Collection = {
  name: "Game Resources",
  symbol: "GRS",
  creator: account.address,
  gameOwner: account.address,
  tokenStandard: "ERC1155" as const,
  maxSupply: 100000n, // Total across all token types
  description: "Fungible and semi-fungible game resources"
}

// ERC1155 minting (can mint multiple)
const collection1155 = collectionManager.createCollection(
  predictedAddress,
  "ERC1155"
)

await collection1155.mint(
  walletClient,
  10n, // Can mint multiple tokens
  "https://example.com/token/1", // specific token metadata
  mintPrice,
  proof
)

Metadata Management

Collection-Level Metadata

typescript
const collectionMetadata = {
  name: "My Collection",
  description: "A fantastic collection of digital assets",
  image: "https://example.com/collection-image.png",
  external_url: "https://mywebsite.com/collection",
  
  // Background and banner for marketplaces
  background_color: "ffffff",
  banner_image_url: "https://example.com/banner.png",
  
  // Collection attributes
  attributes: [
    { trait_type: "Theme", value: "Fantasy" },
    { trait_type: "Artist", value: "Digital Creator" }
  ]
}

Token-Level Metadata

CreateKit automatically generates token metadata based on your collection settings:

typescript
import { NFTMetadataManager, MediaType } from '@b3dotfun/basemint'

// Generate metadata for different media types
const artworkMetadata = NFTMetadataManager.generateNFTMetadata(
  collectionMetadata,
  MediaType.ARTWORK
)

const model3dMetadata = NFTMetadataManager.generateNFTMetadata(
  collectionMetadata,
  MediaType.MODEL_3D
)

const videoMetadata = NFTMetadataManager.generateNFTMetadata(
  collectionMetadata,
  MediaType.VIDEO
)

// Convert to JSON
const metadataJson = NFTMetadataManager.generateJSON(artworkMetadata)
console.log(metadataJson)

typescript
// For custom metadata, provide your own baseURI
const customCollection = {
  name: "Custom Metadata Collection",
  symbol: "CMC",
  creator: account.address,
  gameOwner: account.address,
  baseURI: "https://myapi.com/metadata/", // Your custom metadata endpoint
  description: "Collection with custom metadata"
}

// Your API should respond to: https://myapi.com/metadata/{tokenId}
// With standard OpenSea metadata format

Collection Validation

CreateKit provides built-in validation for collection parameters:

typescript
import { validateCollectionMetadata } from '@b3dotfun/basemint'

try {
  // Validate collection metadata
  const validation = validateCollectionMetadata(collectionMetadata)
  
  if (!validation.isValid) {
    console.error("Validation errors:", validation.errors)
    return
  }
  
  console.log("✅ Collection metadata is valid")
  
  // Proceed with signature generation
  const signature = await collectionManager.generateCreatorSignature(
    walletClient,
    collectionMetadata
  )
} catch (error) {
  console.error("Validation failed:", error)
}

Address Prediction

One of CreateKit's key features is deterministic address prediction:

typescript
// Generate creator signature first
const creatorSignature = await collectionManager.generateCreatorSignature(
  walletClient,
  collectionMetadata
)

// Predict the collection address
const predictedAddress = collectionManager.predictCollectionAddress(
  collectionMetadata,
  creatorSignature
)

console.log(`Collection will be deployed at: ${predictedAddress}`)

// You can now use this address before deployment
// for marketplace integration, frontend display, etc.

Collection Management Operations

Checking Collection Status

typescript
const collection = collectionManager.createCollection(
  predictedAddress,
  "ERC721"
)

// Check if collection is deployed
const isDeployed = await collection.isDeployed()
console.log(`Deployed: ${isDeployed}`)

// Get collection info (only works after deployment)
if (isDeployed) {
  const info = await collection.getCollectionInfo()
  console.log("Collection Info:", {
    name: info.name,
    symbol: info.symbol,
    totalSupply: info.totalSupply.toString(),
    maxSupply: info.maxSupply.toString(),
    mintPrice: info.mintPrice.toString(),
    maxPerWallet: info.maxPerWallet.toString()
  })
}

Updating Collection Settings

typescript
// Only certain operations are possible after deployment

// Check current mint price (if dynamic pricing is implemented)
const currentPrice = await collection.getCurrentMintPrice()

// Check if minting is currently active
const isMintingActive = await collection.isMintingActive()

// Get remaining supply
const remainingSupply = await collection.getRemainingSupply()

console.log({
  currentPrice: currentPrice.toString(),
  isMintingActive,
  remainingSupply: remainingSupply.toString()
})

Best Practices

1. Collection Planning

2. Metadata Quality

typescript
const qualityCollection = {
  name: "Professional Art Collection",
  symbol: "PAC",
  creator: account.address,
  gameOwner: account.address,
  
  // High-quality descriptions
  description: "A curated collection of professional digital artworks featuring contemporary themes and innovative techniques.",
  
  // Professional imagery (minimum 640x640px)
  image: "https://example.com/high-res-collection-image.png",
  
  // Comprehensive attributes for better discoverability
  attributes: [
    { trait_type: "Art Style", value: "Contemporary" },
    { trait_type: "Medium", value: "Digital" },
    { trait_type: "Artist Verification", value: "Verified" },
    { trait_type: "Edition Type", value: "Limited" }
  ],
  
  // External links for credibility
  external_url: "https://professionalartist.com/collection"
}

3. Security Considerations

Troubleshooting

Next Steps

Now that you understand collection management, explore these related topics: