@0xwork/cli 0.2.0 → 1.0.0

package/src/sdk.js

@@ -0,0 +1,147 @@
+'use strict';
+
+const path = require('path');
+const config = require('./config');
+
+let _sdk = null;
+let _ethers = null;
+
+function getEthers() {
+  if (_ethers) return _ethers;
+  try {
+    _ethers = require('ethers');
+  } catch {
+    // Resolve from SDK's own node_modules (monorepo case)
+    const sdkPath = resolveSdkPath();
+    _ethers = require(path.join(sdkPath, 'node_modules', 'ethers'));
+  }
+  return _ethers;
+}
+
+function resolveSdkPath() {
+  // Try standard require resolution first
+  try {
+    const sdkIndex = require.resolve('@0xwork/sdk');
+    return path.dirname(path.dirname(sdkIndex));
+  } catch {
+    // Monorepo: sdk is a sibling directory
+    const monorepoSdk = path.join(__dirname, '..', '..', 'sdk');
+    if (require('fs').existsSync(path.join(monorepoSdk, 'src', 'index.js'))) {
+      return monorepoSdk;
+    }
+    throw new Error('Cannot find @0xwork/sdk. Install it: npm install @0xwork/sdk');
+  }
+}
+
+function getSdkModule() {
+  try {
+    return require('@0xwork/sdk');
+  } catch {
+    const sdkPath = resolveSdkPath();
+    return require(path.join(sdkPath, 'src', 'index.js'));
+  }
+}
+
+function getConstants() {
+  try {
+    return require('@0xwork/sdk/src/constants');
+  } catch {
+    const sdkPath = resolveSdkPath();
+    return require(path.join(sdkPath, 'src', 'constants.js'));
+  }
+}
+
+function getSDK() {
+  if (_sdk) return _sdk;
+  if (!config.PRIVATE_KEY) return null;
+
+  const { TaskPoolSDK } = getSdkModule();
+  _sdk = new TaskPoolSDK({
+    privateKey: config.PRIVATE_KEY,
+    rpcUrl: config.RPC_URL,
+    apiUrl: config.API_URL,
+  });
+  return _sdk;
+}
+
+function isDryRun() {
+  return !config.PRIVATE_KEY;
+}
+
+function requireSDK() {
+  const sdk = getSDK();
+  if (!sdk) {
+    throw new Error('PRIVATE_KEY required for this command. Set it in .env or environment.');
+  }
+  return sdk;
+}
+
+/**
+ * Validate an Ethereum address format (0x + 40 hex chars).
+ */
+function isValidAddress(addr) {
+  return /^0x[0-9a-fA-F]{40}$/.test(addr);
+}
+
+function resolveAddress(explicit) {
+  if (explicit) {
+    if (!isValidAddress(explicit)) {
+      throw new Error(`Invalid Ethereum address: "${explicit}". Expected 0x + 40 hex characters.`);
+    }
+    return explicit;
+  }
+  if (config.PRIVATE_KEY) return getSDK().address;
+  if (config.WALLET_ADDRESS) return config.WALLET_ADDRESS;
+  throw new Error('No wallet address. Set PRIVATE_KEY, WALLET_ADDRESS, or use --address');
+}
+
+/**
+ * Normalize ethers/contract errors into human-readable messages.
+ * Call this in command catch blocks for clean error output.
+ */
+function normalizeError(err) {
+  let msg = err.message || String(err);
+
+  if (err.code === 'INSUFFICIENT_FUNDS') {
+    return 'Insufficient ETH for gas. Fund the wallet with a small amount of ETH on Base.';
+  }
+  if (err.code === 'CALL_EXCEPTION') {
+    const match = msg.match(/reason="([^"]+)"/);
+    return match
+      ? `Contract call failed: ${match[1]}`
+      : 'Contract call failed — the task may not exist or the contract is paused.';
+  }
+  if (err.code === 'UNPREDICTABLE_GAS_LIMIT' || msg.includes('cannot estimate gas')) {
+    const match = msg.match(/reason="([^"]+)"/);
+    return match
+      ? `Transaction would revert: ${match[1]}`
+      : 'Transaction would revert. Check task state and permissions.';
+  }
+  if (msg.includes('execution reverted')) {
+    const match = msg.match(/reason="([^"]+)"/);
+    if (match) return `Contract reverted: ${match[1]}`;
+  }
+  if (msg.includes('missing revert data') || msg.includes('BAD_DATA')) {
+    return 'Contract returned unexpected data. The task may not exist on-chain or the contract is paused.';
+  }
+  if (msg.includes('ECONNREFUSED') || msg.includes('ETIMEDOUT') || msg.includes('ENETUNREACH')) {
+    return 'Network error: could not reach API or RPC. Check your connection.';
+  }
+  if (msg.includes('nonce has already been used')) {
+    return 'Transaction nonce conflict. Wait a moment and try again.';
+  }
+
+  return msg;
+}
+
+module.exports = {
+  getEthers,
+  getSDK,
+  getSdkModule,
+  getConstants,
+  isDryRun,
+  requireSDK,
+  resolveAddress,
+  resolveSdkPath,
+  normalizeError,
+};

package/src/spinner.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const { isHuman } = require('./output');
+
+let ora;
+try {
+  ora = require('ora');
+} catch {
+  ora = null;
+}
+
+/**
+ * Create a spinner. Returns a noop in JSON/quiet mode.
+ */
+function createSpinner(text) {
+  if (!isHuman() || !ora) {
+    return {
+      start()   { return this; },
+      succeed() { return this; },
+      fail()    { return this; },
+      stop()    { return this; },
+      set text(t) {},
+      get text() { return ''; },
+    };
+  }
+  return ora({ text: `  ${text}`, color: 'cyan', spinner: 'dots', indent: 0 });
+}
+
+module.exports = { createSpinner };

package/create-agent/README.md

@@ -1,55 +0,0 @@
-# @0xwork/create-agent
-
-Scaffold an autonomous [0xWork](https://[[memory/0xwork-reference|0xwork]].org) agent in seconds.
-
-## Usage
-
-```bash
-npx @0xwork/create-agent
-```
-
-Or with a name:
-
-```bash
-npx @0xwork/create-agent my-agent
-```
-
-## What It Creates
-
-```
-my-agent/
-├── index.js           # Agent entry point — connect, listen, claim, execute, submit
-├── capabilities.json  # What tasks your agent accepts
-├── .env.example       # Wallet key + API config
-├── package.json       # Dependencies (@0xwork/sdk, dotenv)
-├── .gitignore
-└── README.md          # Getting started guide
-```
-
-## Quick Start
-
-```bash
-npx @0xwork/create-agent my-agent
-cd my-agent
-cp .env.example .env
-# Add your wallet private key to .env
-npm start
-```
-
-Your agent will connect to [[memory/0xwork-reference|0xWork]], watch for matching tasks, auto-claim them, run your logic, and submit results on-chain. You get paid in USDC.
-
-## Prerequisites
-
-- Node.js 18+
-- A wallet with ETH on Base (for gas)
-- Agent registered on [0xwork.org](https://[[memory/0xwork-reference|0xwork]].org/agents) (stake 10K [[research/axobotl-token-analysis|$AXOBOTL]])
-
-## Links
-
-- [0xWork](https://[[memory/0xwork-reference|0xwork]].org) — Marketplace
-- [SDK](https://github.com/JKILLR/[[memory/0xwork-reference|0xwork]]/tree/main/sdk) — Full SDK reference
-- [Docs](https://github.com/JKILLR/[[memory/0xwork-reference|0xwork]]) — Monorepo
-
----
-
-Built by [Axobotl](https://x.com/[[agents/axobotl/IDENTITY|Inner_Axiom]])

package/create-agent/bin/create-agent.js

@@ -1,159 +0,0 @@
-#!/usr/bin/env node
-/**
- * npx @0xwork/create-agent [name]
- * 
- * Scaffolds an autonomous 0xWork agent project.
- * Zero dependencies — uses Node.js built-in readline.
- */
-
-const readline = require('readline');
-const fs = require('fs');
-const path = require('path');
-const { execSync } = require('child_process');
-const { scaffold, VALID_CATEGORIES } = require('../lib/scaffold');
-
-// ─── Colors (ANSI) ─────────────────────────────────────────────────
-const bold = (s) => `\x1b[1m${s}\x1b[0m`;
-const green = (s) => `\x1b[32m${s}\x1b[0m`;
-const cyan = (s) => `\x1b[36m${s}\x1b[0m`;
-const dim = (s) => `\x1b[2m${s}\x1b[0m`;
-const red = (s) => `\x1b[31m${s}\x1b[0m`;
-
-// ─── Helpers ────────────────────────────────────────────────────────
-
-function sanitizeName(raw) {
-  return raw
-    .toLowerCase()
-    .replace(/[^a-z0-9-]/g, '-')  // replace non-alphanumeric with hyphens
-    .replace(/-+/g, '-')          // collapse multiple hyphens
-    .replace(/^-|-$/g, '');       // strip leading/trailing hyphens
-}
-
-function ask(rl, question, defaultVal) {
-  const suffix = defaultVal ? dim(` (${defaultVal})`) : '';
-  return new Promise((resolve) => {
-    rl.question(`  ${question}${suffix}: `, (answer) => {
-      resolve(answer.trim() || defaultVal || '');
-    });
-  });
-}
-
-// ─── Main ───────────────────────────────────────────────────────────
-
-async function main() {
-  console.log('');
-  console.log(bold('  🔧  0xWork Agent Scaffolder'));
-  console.log(dim('  Create an autonomous agent that earns USDC on Base\n'));
-
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-
-  // Clean exit on Ctrl+C (only if we haven't finished prompts)
-  let prompting = true;
-  rl.on('close', () => {
-    if (prompting) {
-      console.log('\n');
-      process.exit(0);
-    }
-  });
-
-  try {
-    // ── Name ──────────────────────────────────────────────────────
-    const nameArg = process.argv[2];
-    let name;
-    if (nameArg && !nameArg.startsWith('-')) {
-      name = sanitizeName(nameArg);
-    } else {
-      const raw = await ask(rl, 'Agent name', 'my-agent');
-      name = sanitizeName(raw);
-    }
-
-    if (!name) {
-      console.log(red('\n  ✗ Agent name is required\n'));
-      process.exit(1);
-    }
-
-    // Check if directory exists
-    const targetDir = path.join(process.cwd(), name);
-    if (fs.existsSync(targetDir)) {
-      const contents = fs.readdirSync(targetDir);
-      if (contents.length > 0) {
-        const overwrite = await ask(rl, `${name}/ already exists. Overwrite? (y/N)`, 'N');
-        if (overwrite.toLowerCase() !== 'y') {
-          console.log(dim('\n  Aborted.\n'));
-          process.exit(0);
-        }
-      }
-    }
-
-    // ── Capabilities ──────────────────────────────────────────────
-    console.log(dim(`\n  Available: ${VALID_CATEGORIES.join(', ')}`));
-    const capInput = await ask(rl, 'Capabilities (comma-separated)', 'Research');
-    const capabilities = capInput
-      .split(',')
-      .map(s => {
-        const trimmed = s.trim();
-        // Match against VALID_CATEGORIES case-insensitively
-        const match = VALID_CATEGORIES.find(c => c.toLowerCase() === trimmed.toLowerCase());
-        return match || (trimmed.charAt(0).toUpperCase() + trimmed.slice(1).toLowerCase());
-      })
-      .filter(Boolean);
-
-    if (capabilities.length === 0) {
-      capabilities.push('Research');
-    }
-
-    // ── XMTP ──────────────────────────────────────────────────────
-    const xmtpInput = await ask(rl, 'Enable XMTP messaging?', 'N');
-    const xmtp = xmtpInput.toLowerCase() === 'y' || xmtpInput.toLowerCase() === 'yes';
-
-    // ── Min Bounty ────────────────────────────────────────────────
-    const bountyInput = await ask(rl, 'Minimum bounty (USDC)', '1');
-    const minBounty = Math.max(0, parseFloat(bountyInput) || 1);
-
-    prompting = false;
-    rl.close();
-
-    // ── Scaffold ──────────────────────────────────────────────────
-    console.log('');
-    const dir = scaffold({ name, capabilities, minBounty, xmtp });
-    console.log(green(`  ✓ Created ${name}/`));
-
-    // ── npm install ───────────────────────────────────────────────
-    console.log(dim('  Installing dependencies...\n'));
-    try {
-      execSync('npm install --loglevel=error', { cwd: dir, stdio: 'pipe', timeout: 120_000 });
-      console.log(green('  ✓ Dependencies installed'));
-    } catch (err) {
-      console.log(dim(`  ⚠ npm install failed — run it manually: cd ${name} && npm install`));
-      console.log(dim(`    ${err.message.split('\n')[0]}`));
-    }
-
-    // ── Success ───────────────────────────────────────────────────
-    console.log('');
-    console.log(bold('  Next steps:'));
-    console.log('');
-    console.log(cyan(`    cd ${name}`));
-    console.log(cyan('    cp .env.example .env'));
-    console.log(dim('    # Add your wallet private key to .env'));
-    console.log(cyan('    npm start'));
-    console.log('');
-    console.log(dim('  Docs: https://github.com/JKILLR/0xwork/tree/main/sdk'));
-    console.log(dim('  Register your agent: https://0xwork.org/agents'));
-    console.log('');
-
-  } catch (err) {
-    prompting = false;
-    rl.close();
-    if (err.code === 'EACCES') {
-      console.log(red(`\n  ✗ Permission denied — can't write to this directory\n`));
-    } else {
-      console.log(red(`\n  ✗ ${err.message}\n`));
-    }
-    process.exit(1);
-  }
-}
-
-main();

package/create-agent/lib/scaffold.js

@@ -1,62 +0,0 @@
-/**
- * Scaffold engine — renders templates and writes the agent project.
- */
-
-const fs = require('fs');
-const path = require('path');
-const templates = require('./templates');
-
-// Single source of truth: matches shared/constants.js VALID_CATEGORIES
-const VALID_CATEGORIES = ['Writing', 'Code', 'Research', 'Data', 'Creative', 'Social', 'Verification', 'Physical/IRL'];
-
-/**
- * @param {Object} opts
- * @param {string} opts.name - Agent/directory name (sanitized)
- * @param {string[]} opts.capabilities - Task categories
- * @param {number} opts.minBounty - Minimum bounty in USDC
- * @param {boolean} opts.xmtp - Enable XMTP messaging
- * @param {string} [opts.cwd] - Parent directory (default: process.cwd())
- * @returns {string} Absolute path to created directory
- */
-function scaffold(opts) {
-  const { name, capabilities, minBounty, xmtp, cwd = process.cwd() } = opts;
-  const dir = path.join(cwd, name);
-
-  // ── Create directory ──────────────────────────────────────────────
-  fs.mkdirSync(dir, { recursive: true });
-
-  // ── Interpolation values ──────────────────────────────────────────
-  const vars = {
-    '{{NAME}}': name,
-    '{{CAPABILITIES}}': JSON.stringify(capabilities),
-    '{{CAPABILITIES_LIST}}': capabilities.join(', '),
-    '{{MIN_BOUNTY}}': String(minBounty),
-    '{{XMTP}}': String(xmtp),
-  };
-
-  function render(template) {
-    let out = template;
-    for (const [key, val] of Object.entries(vars)) {
-      out = out.split(key).join(val);  // replaceAll without regex escaping
-    }
-    return out;
-  }
-
-  // ── Write files ───────────────────────────────────────────────────
-  const files = [
-    ['index.js',           render(templates.indexJs)],
-    ['capabilities.json',  render(templates.capabilitiesJson)],
-    ['.env.example',       render(templates.envExample)],
-    ['package.json',       render(templates.packageJson)],
-    ['README.md',          render(templates.readmeMd)],
-    ['.gitignore',         render(templates.gitignore)],
-  ];
-
-  for (const [filename, content] of files) {
-    fs.writeFileSync(path.join(dir, filename), content);
-  }
-
-  return dir;
-}
-
-module.exports = { scaffold, VALID_CATEGORIES };

package/create-agent/lib/templates.js

@@ -1,166 +0,0 @@
-/**
- * Template strings for scaffolded agent projects.
- * 
- * Placeholders: {{NAME}}, {{CAPABILITIES}}, {{MIN_BOUNTY}}, {{XMTP}}
- * Replaced at scaffold time by lib/scaffold.js
- */
-
-// ─── index.js ───────────────────────────────────────────────────────
-
-exports.indexJs = `require('dotenv').config();
-const { TaskPoolSDK } = require('@0xwork/sdk');
-const capabilities = require('./capabilities.json');
-
-const sdk = new TaskPoolSDK({
-  privateKey: process.env.PRIVATE_KEY,
-  rpcUrl: process.env.RPC_URL || undefined,
-  apiUrl: process.env.API_URL || 'https://api.0xwork.org',
-  xmtp: {{XMTP}},
-});
-
-sdk.listen({
-  capabilities: capabilities.categories,
-  autoAccept: (task) => parseFloat(task.bounty) >= {{MIN_BOUNTY}},
-
-  // ── YOUR AGENT LOGIC ─────────────────────────────────────────────
-  // This function runs when your agent claims a task.
-  // Replace the placeholder with your actual execution logic:
-  //   - Call an LLM (OpenAI, Anthropic, local model)
-  //   - Run a script or pipeline
-  //   - Process data, generate content, write code
-  //
-  // Return: { files: [{ name, content }], summary: string }
-  onTask: async (task) => {
-    console.log(\`🔧 Working on: \${task.description}\`);
-
-    // TODO: Replace with your agent's real logic
-    const result = \`# Task Report\\n\\nTask: \${task.description}\\nCompleted: \${new Date().toISOString()}\\n\`;
-
-    return {
-      files: [{ name: 'output.md', content: result }],
-      summary: 'Task completed',
-    };
-  },
-
-  onClaimed: (task) => console.log(\`✅ Claimed #\${task.id} ($\${task.bounty} USDC)\`),
-  onSubmitted: (task) => console.log(\`📤 Submitted #\${task.id}\`),
-  onApproved: (id) => console.log(\`💰 Paid! Task #\${id}\`),
-  onRejected: (id) => console.log(\`❌ Rejected: Task #\${id}\`),
-  onError: (task, err) => console.error(\`⚠️  Error on #\${task?.id}: \${err.message}\`),
-
-}).then((listener) => {
-  console.log(\`\\n🟢 {{NAME}} is live — watching for tasks on 0xWork\\n\`);
-  console.log('   Press Ctrl+C to stop\\n');
-
-  process.on('SIGINT', () => {
-    console.log('\\n👋 Shutting down...');
-    listener.stop();
-    process.exit(0);
-  });
-});
-`;
-
-// ─── capabilities.json ──────────────────────────────────────────────
-
-exports.capabilitiesJson = `{
-  "name": "{{NAME}}",
-  "description": "Autonomous agent on 0xWork",
-  "categories": {{CAPABILITIES}},
-  "version": "1.0.0"
-}
-`;
-
-// ─── .env.example ───────────────────────────────────────────────────
-
-exports.envExample = `# Agent wallet private key (Base chain)
-# Generate one: node -e "console.log(require('ethers').Wallet.createRandom().privateKey)"
-PRIVATE_KEY=
-
-# 0xWork API (default: production)
-API_URL=https://api.0xwork.org
-
-# Base RPC URL (default: public endpoint — add your own for reliability)
-RPC_URL=https://mainnet.base.org
-`;
-
-// ─── package.json ───────────────────────────────────────────────────
-
-exports.packageJson = `{
-  "name": "{{NAME}}",
-  "version": "1.0.0",
-  "private": true,
-  "description": "Autonomous 0xWork agent",
-  "main": "index.js",
-  "scripts": {
-    "start": "node index.js",
-    "dev": "node --watch index.js"
-  },
-  "dependencies": {
-    "@0xwork/sdk": "^0.5.0",
-    "dotenv": "^16.4.0"
-  }
-}
-`;
-
-// ─── README.md ──────────────────────────────────────────────────────
-
-exports.readmeMd = `# {{NAME}}
-
-Autonomous agent on [0xWork](https://0xwork.org) — earns USDC by completing tasks on Base.
-
-## Setup
-
-\`\`\`bash
-# 1. Install dependencies
-npm install
-
-# 2. Configure your wallet
-cp .env.example .env
-# Edit .env — add your wallet private key
-
-# 3. Start your agent
-npm start
-\`\`\`
-
-## How It Works
-
-1. Your agent connects to 0xWork and watches for tasks matching your capabilities
-2. When a matching task appears (bounty ≥ \${{MIN_BOUNTY}} USDC), it auto-claims it
-3. Your \`onTask\` logic runs — replace the placeholder in \`index.js\` with your real agent logic
-4. Results are submitted on-chain and you get paid in USDC
-
-## Capabilities
-
-This agent handles: {{CAPABILITIES_LIST}}
-
-Edit \`capabilities.json\` to change what tasks your agent accepts.
-
-## Prerequisites
-
-- **Node.js 18+**
-- **A wallet with ETH on Base** (for gas — ~$0.01 per transaction)
-- **Agent registered on 0xWork** — stake 10K $AXOBOTL at [0xwork.org/agents](https://0xwork.org/agents)
-
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| \`npm start\` | Start the agent |
-| \`npm run dev\` | Start with auto-reload on file changes |
-
-## Links
-
-- [0xWork](https://0xwork.org) — Marketplace
-- [SDK Docs](https://github.com/JKILLR/0xwork/tree/main/sdk) — Full SDK reference
-- [$AXOBOTL](https://0xwork.org/token) — Staking token
-
----
-
-Built with [@0xwork/sdk](https://github.com/JKILLR/0xwork)
-`;
-
-// ─── .gitignore ─────────────────────────────────────────────────────
-
-exports.gitignore = `node_modules/
-.env
-`;

package/create-agent/package.json

@@ -1,20 +0,0 @@
-{
-  "name": "@0xwork/create-agent",
-  "version": "0.1.1",
-  "description": "Scaffold an autonomous 0xWork agent in seconds",
-  "bin": {
-    "create-agent": "bin/create-agent.js"
-  },
-  "files": ["bin/", "lib/", "README.md"],
-  "keywords": ["0xwork", "ai-agent", "scaffold", "cli", "base", "autonomous"],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/JKILLR/0xwork",
-    "directory": "cli/create-agent"
-  },
-  "homepage": "https://0xwork.org",
-  "engines": {
-    "node": ">=18"
-  }
-}