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

name

string

The name of your NFT collection (e.g., “Bored Ape Yacht Club”)

symbol

string

The symbol/ticker for your collection (e.g., “BAYC”)

creator

0x${string}

The Ethereum address of the collection creator

gameOwner

0x${string}

The Ethereum address of the game owner (can be same as creator)

Optional Parameters

maxSupply

bigint

default:"10000n"

Maximum number of tokens that can be minted

mintPrice

bigint

default:"0n"

Price per token in wei (use parseEther() for ETH values)

maxPerWallet

bigint

default:"100n"

Maximum tokens that can be minted per wallet

isWhitelistEnabled

boolean

default:"false"

Whether whitelist-only minting is enabled

startTime

bigint

default:"0n"

Unix timestamp when minting starts (0 = immediate)

endTime

bigint

default:"BigInt(Date.now() / 1000 + 86400 * 365 * 100)"

Unix timestamp when minting ends

tokenStandard

'ERC721' | 'ERC1155'

default:"'ERC721'"

The token standard to use

chainId

number

default:"1993"

Chain ID (1993 = B3 Testnet, 8333 = B3 Mainnet)

Creating Collections

Basic Collection

Basic Collection Creation

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

Advanced Collection Setup

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:

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
)

Metadata Management

Collection-Level Metadata

Collection Metadata

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:

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)

Collection Validation

CreateKit provides built-in validation for collection parameters:

Parameter Validation

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:

Address Prediction

// 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.