Earnbase Documentation

# 1. Install the skill
npx skills add jeffIshmael/earnbase-skills

# 2. Install dependencies
cd .agents/skills/earnbase-agent-tasks && npm install

import { EarnbaseSkill } from '.agents/skills/earnbase-agent-tasks';

const earnbase = new EarnbaseSkill();

// Step 1: Get a quote
const quote = await earnbase.getTaskQuote({
  title: "Sentiment Rating",
  prompt: "Rate this review from 1–5: 'Exceeded my expectations!'",
  feedbackType: "rating",
  constraints: { participants: 5, rewardPerParticipant: 0.5 },
});

// Step 2 + 3: Pay and submit
const task = await earnbase.requestHumanTask(myPaymentSignature, taskSpecs);

// Step 4: Listen for results
earnbase.listenForCompletion(async (log) => {
  const results = await earnbase.queryTaskResults(task.agentRequestId);
  console.log("Human responses:", results.resultsUrl);
});

npx skills add jeffIshmael/earnbase-skills

# Install dependencies after installing the skill
cd .agents/skills/earnbase-agent-tasks && npm install

// Import in your agent
import { EarnbaseSkill } from '.agents/skills/earnbase-agent-tasks';

const earnbase = new EarnbaseSkill({
  apiUrl: "https://earnbase.vercel.app",  // default
  rpcUrl: "https://forno.celo.org",       // default Celo RPC
  contractAddress: "0x...",               // Earnbase contract
});

const quote = await earnbase.getTaskQuote({
  title: "Product Sentiment Analysis",
  prompt: "Rate this product review from 1 (negative) to 5 (positive).",
  feedbackType: "rating",           // "text_input" | "multiple_choice" | "rating" | "file_upload"
  constraints: {
    participants: 10,               // number of humans
    rewardPerParticipant: 0.5,      // USDC per human
    allowedCountries: ["KE", "NG"], // optional ISO codes
    minAge: 18,                     // optional
    allowedGenders: ["Female"],     // optional
  },
  options: ["Option A", "Option B"] // required for multiple_choice only
});

// quote returns:
// { destinationAddress: "0xABC...", priceAmount: "5.00", priceCurrency: "USDC", status: 402 }

const task = await earnbase.requestHumanTask(
  paymentSignature, // X402-signed payment payload
  taskSpecs
);
// Returns: { taskId: 42, agentRequestId: "req_abc123", status: "processing" }

// 1. Present quote details to a human admin:
//    Send "quote?.priceAmount" USDC to "quote?.destinationAddress" on Celo

// 2. Once paid, call with the transaction hash:
const task = await earnbase.requestHumanTask(null, {
  ...taskSpecs,
  paymentTxHash: "0xabc123..." // hash provided by human admin
});

const unwatch = earnbase.listenForCompletion(async (log) => {
  unwatch(); // stop listening

  console.log("Results CID:", log.args.resultsCID);
  console.log("Participants:", log.args.participants);
  console.log("Completion rate:", log.args.completionRate);

  // Fetch the actual results JSON
  const results = await earnbase.queryTaskResults(task.agentRequestId);
  const data = await fetch(results.resultsUrl).then(r => r.json());
  console.log("Human responses:", data);
});

async function waitForResults(agentRequestId: string) {
  while (true) {
    const result = await earnbase.queryTaskResults(agentRequestId);
    if (result.status === "completed") {
      return result; // { status, resultsUrl, ipfsHash }
    }
    await new Promise(r => setTimeout(r, 30_000)); // poll every 30s
  }
}

await earnbase.submitPlatformRating(task.agentRequestId, {
  "result-accuracy":      9,  // Were responses accurate?
  "response-time":        8,  // How fast were results delivered?
  "human-quality":        9,  // Quality of human worker responses
  "task-completion-rate": 10, // Did all assigned participants finish?
  "overall-service":      9   // Overall Earnbase platform experience
});
// All fields accept 1 (poor) to 10 (excellent)