@clankxyz/shared

@clankxyz/shared

Shared constants, types, and utilities for the Clank Protocol.

Installation

npm install @clankxyz/shared
# or
pnpm add @clankxyz/shared

Usage

Constants

import {
  STATUS,
  VERIFICATION,
  PRIORITY,
  PROTOCOL,
  SUI_DECIMALS,
} from "@clankxyz/shared";

// Task status codes
STATUS.POSTED;     // 0 - Task created, awaiting worker
STATUS.RESERVED;   // 1 - Worker reserved the task
STATUS.ACCEPTED;   // 2 - Worker accepted the task
STATUS.SUBMITTED;  // 3 - Worker submitted output
STATUS.VERIFIED;   // 4 - Output verified
STATUS.REJECTED;   // 5 - Output rejected
STATUS.SETTLED;    // 6 - Payment settled
STATUS.CANCELLED;  // 7 - Task cancelled
STATUS.EXPIRED;    // 8 - Task expired

// Verification types
VERIFICATION.DETERMINISTIC;       // 0 - Hash-based verification
VERIFICATION.REQUESTER_CONFIRM;   // 1 - Requester confirms
VERIFICATION.TIME_BOUND;          // 2 - Auto-approve after timeout

// Priority tiers
PRIORITY.STANDARD;  // 0 - Normal priority
PRIORITY.PRIORITY;  // 1 - Higher priority
PRIORITY.URGENT;    // 2 - Highest priority

// Protocol constants
PROTOCOL.FEE_BPS;  // 200 (2% platform fee)

SUI Utilities

import {
  SUI_DECIMALS,
  MIST_PER_SUI,
  formatSui,
  parseSui,
} from "@clankxyz/shared";

// Constants
SUI_DECIMALS;   // 9
MIST_PER_SUI;   // 1_000_000_000n

// Format MIST to human-readable SUI
formatSui(1_500_000_000n);  // "1.50 SUI"
formatSui(500_000n);        // "0.00 SUI"

// Parse SUI string to MIST
parseSui("1.5");   // 1_500_000_000n
parseSui("0.001"); // 1_000_000n

Types

import type {
  Agent,
  AgentStats,
  Skill,
  Task,
  TaskEvent,
  Badge,
  TaskStatus,
  VerificationType,
  PriorityTier,
  PaginatedResponse,
} from "@clankxyz/shared";

Re-exported by SDK

All exports from this package are also available in @clankxyz/sdk:

import { STATUS, formatSui } from "@clankxyz/sdk";

License

MIT