Dynamic Badges Documentation

// SaaS Onboarding Example
import { BlockquestBadges } from '@blockquest/badges';

const badges = new BlockquestBadges({
  apiKey: 'YOUR_API_KEY',
  baseUrl: 'https://dynamic-badges.vercel.app/api'
});

// Award badge on signup
async function handleUserSignup(email) {
  await badges.smartMint({
    campaignId: 'onboarding-champion',
    userEmail: email,
    tier: 1,
    metadata: { source: 'signup' }
  });
}

// Award badge on profile completion
async function handleProfileCompleted(email) {
  await badges.trigger('profile_completed', {
    userEmail: email,
    metadata: { completedAt: new Date().toISOString() }
  });
}

// Upgrade badge on milestone
async function handleMilestone(email, milestoneCount) {
  const tier = milestoneCount >= 10 ? 3 : milestoneCount >= 5 ? 2 : 1;
  
  await badges.upgrade({
    campaignId: 'power-user',
    userEmail: email,
    newTier: tier
  });
}

// Check for premium access
async function checkPremiumAccess(email) {
  const hasPremiumBadge = await badges.verifyBadge({
    campaignId: 'premium-member',
    userEmail: email
  });
  
  return hasPremiumBadge;
}

// KOL Campaign Example
import { BlockquestBadges } from '@blockquest/badges';

const badges = new BlockquestBadges({
  apiKey: 'YOUR_API_KEY',
  baseUrl: 'https://dynamic-badges.vercel.app/api'
});

// Award badge to event attendee
async function awardEventBadge(attendeeEmail, eventName) {
  const result = await badges.smartMint({
    campaignId: 'event-attendee-2024',
    userEmail: attendeeEmail,
    tier: 1,
    metadata: {
      eventName,
      attendedAt: new Date().toISOString()
    }
  });
  
  if (result.success) {
    if (result.data.flow === 'claim_link') {
      // Send claim link to attendee
      console.log('Claim URL:', result.data.claim_url);
      // Email or SMS this to the attendee
    } else {
      console.log('Badge minted to:', result.data.badge.wallet_address);
    }
  }
}

// Award VIP badge to top supporters
async function awardVipBadge(supporterEmail) {
  await badges.smartMint({
    campaignId: 'vip-supporter',
    userEmail: supporterEmail,
    tier: 3, // Gold tier
    metadata: {
      vipLevel: 'gold',
      awardedAt: new Date().toISOString()
    }
  });
}

// Get all badges for a user
async function getUserBadges(email) {
  const result = await badges.getUserBadges(email);
  
  if (result.success) {
    console.log(`User has ${result.data.length} badges`);
    return result.data;
  }
}

// E-commerce Loyalty Example
import { BlockquestBadges } from '@blockquest/badges';

const badges = new BlockquestBadges({
  apiKey: 'YOUR_API_KEY',
  baseUrl: 'https://dynamic-badges.vercel.app/api'
});

// Award badge on first purchase
async function handleFirstPurchase(customerEmail, orderId, amount) {
  await badges.smartMint({
    campaignId: 'first-purchase',
    userEmail: customerEmail,
    tier: 1,
    metadata: {
      orderId,
      amount,
      purchaseDate: new Date().toISOString()
    }
  });
}

// Loyalty tier system based on total purchases
async function updateLoyaltyTier(customerEmail, totalPurchases) {
  let tier = 1; // Bronze
  let campaignId = 'loyalty-program';
  
  if (totalPurchases >= 10) {
    tier = 3; // Gold
  } else if (totalPurchases >= 5) {
    tier = 2; // Silver
  }
  
  // Check if user has badge
  const existingBadge = await badges.getUserBadge({
    campaignId,
    userEmail: customerEmail
  });
  
  if (existingBadge.success && existingBadge.data) {
    // Upgrade existing badge
    if (existingBadge.data.tier < tier) {
      await badges.upgrade({
        campaignId,
        userEmail: customerEmail,
        newTier: tier
      });
    }
  } else {
    // Mint new badge
    await badges.smartMint({
      campaignId,
      userEmail: customerEmail,
      tier,
      metadata: { totalPurchases }
    });
  }
}

// Check for loyalty discount eligibility
async function checkDiscountEligibility(customerEmail) {
  const badge = await badges.getUserBadge({
    campaignId: 'loyalty-program',
    userEmail: customerEmail
  });
  
  if (badge.success && badge.data) {
    // Gold tier gets 20% off, Silver 10%, Bronze 5%
    const discounts = { 3: 0.20, 2: 0.10, 1: 0.05 };
    return discounts[badge.data.tier] || 0;
  }
  
  return 0;
}

// Award referral badge
async function handleReferral(referrerEmail, referredEmail) {
  await badges.trigger('referral_made', {
    userEmail: referrerEmail,
    metadata: {
      referredEmail,
      referredAt: new Date().toISOString()
    }
  });
}