Developer Documentation

// Initialize the FavOS Protocol SDK
import { FavOSProtocol } from '@favos/sdk';

// Configure with your API keys
const favos = new FavOSProtocol({
  apiKey: 'YOUR_API_KEY',
  environment: 'testnet', // or 'mainnet'
});

// Create a new Idea
const idea = await favos.ideas.create({
  title: 'My Awesome Project',
  description: 'A community-owned platform for creators',
  tags: ['#web3', '@creator-economy', '+platform'],
});

// Add an IF, THEN condition (Milestone)
const milestone = await favos.milestones.create({
  ideaId: idea.id,
  condition: {
    type: 'VOTE_COUNT',
    target: 100,
    deadline: '2025-09-01T00:00:00Z',
  },
  reward: {
    // On success, release funds to the creator
    distribution: [
      { recipient: 'CREATOR', percentage: 70 },
      { recipient: 'REFERRERS', percentage: 20 },
      { recipient: 'PROTOCOL', percentage: 10 },
    ],
  },
});

// Start a Pre-Sell campaign
const campaign = await favos.campaigns.create({
  ideaId: idea.id,
  milestoneId: milestone.id,
  pricing: {
    type: 'BONDING_CURVE',
    startPrice: '10',
    maxPrice: '50',
  },
  tokenizedRewards: true,
});

// Example of fund distribution
// This is used as an example for the fund-distribution-example section
const distribution = await favos.funds.distribute({
  milestoneId: milestone.id,
  distribution: milestone.reward.distribution,
});

// Listen for milestone updates
favos.milestones.on('completed', (milestone) => {
  console.log('Milestone completed!', milestone);
  console.log('Funds distribution initiated');
});

// This marks the end of the SDK example section
// and the fund-distribution-example anchor point
document.getElementById('fund-distribution-example');