@xpr-agents/sdk 0.1.0

package/dist/EscrowRegistry.d.ts

@@ -0,0 +1,253 @@
+import { JsonRpc, ProtonSession, TransactionResult, PaginatedResult } from './types';
+export interface Job {
+    id: number;
+    client: string;
+    agent: string;
+    title: string;
+    description: string;
+    deliverables: string[];
+    amount: number;
+    symbol: string;
+    funded_amount: number;
+    released_amount: number;
+    state: JobState;
+    deadline: number;
+    arbitrator: string;
+    job_hash: string;
+    created_at: number;
+    updated_at: number;
+}
+export interface JobRaw {
+    id: string;
+    client: string;
+    agent: string;
+    title: string;
+    description: string;
+    deliverables: string;
+    amount: string;
+    symbol: string;
+    funded_amount: string;
+    released_amount: string;
+    state: number;
+    deadline: string;
+    arbitrator: string;
+    job_hash: string;
+    created_at: string;
+    updated_at: string;
+}
+export type JobState = 'created' | 'funded' | 'accepted' | 'inprogress' | 'delivered' | 'disputed' | 'completed' | 'refunded' | 'arbitrated';
+export interface Milestone {
+    id: number;
+    job_id: number;
+    title: string;
+    description: string;
+    amount: number;
+    order: number;
+    state: MilestoneState;
+    evidence_uri: string;
+    submitted_at: number;
+    approved_at: number;
+}
+export interface MilestoneRaw {
+    id: string;
+    job_id: string;
+    title: string;
+    description: string;
+    amount: string;
+    order: number;
+    state: number;
+    evidence_uri: string;
+    submitted_at: string;
+    approved_at: string;
+}
+export type MilestoneState = 'pending' | 'submitted' | 'approved' | 'disputed';
+export interface EscrowDispute {
+    id: number;
+    job_id: number;
+    raised_by: string;
+    reason: string;
+    evidence_uri: string;
+    client_amount: number;
+    agent_amount: number;
+    resolution: DisputeResolution;
+    resolver: string;
+    resolution_notes: string;
+    created_at: number;
+    resolved_at: number;
+}
+export type DisputeResolution = 'pending' | 'client_wins' | 'agent_wins' | 'split';
+export interface Arbitrator {
+    account: string;
+    stake: number;
+    fee_percent: number;
+    total_cases: number;
+    successful_cases: number;
+    active_disputes: number;
+    active: boolean;
+}
+export interface CreateJobData {
+    agent: string;
+    title: string;
+    description: string;
+    deliverables: string[];
+    amount: number;
+    symbol?: string;
+    deadline?: number;
+    arbitrator?: string;
+    job_hash?: string;
+}
+export interface AddMilestoneData {
+    job_id: number;
+    title: string;
+    description: string;
+    amount: number;
+    order: number;
+}
+export interface JobListOptions {
+    limit?: number;
+    cursor?: string;
+    state?: JobState;
+}
+export declare class EscrowRegistry {
+    private rpc;
+    private session;
+    private contract;
+    constructor(rpc: JsonRpc, session?: ProtonSession, contract?: string);
+    /**
+     * Get a job by ID
+     */
+    getJob(id: number): Promise<Job | null>;
+    /**
+     * List jobs for a client
+     */
+    listJobsByClient(client: string, options?: JobListOptions): Promise<PaginatedResult<Job>>;
+    /**
+     * List jobs for an agent
+     */
+    listJobsByAgent(agent: string, options?: JobListOptions): Promise<PaginatedResult<Job>>;
+    /**
+     * Get milestones for a job
+     */
+    getJobMilestones(jobId: number): Promise<Milestone[]>;
+    /**
+     * Get dispute for a job
+     */
+    getJobDispute(jobId: number): Promise<EscrowDispute | null>;
+    /**
+     * List available arbitrators
+     */
+    listArbitrators(): Promise<Arbitrator[]>;
+    /**
+     * Create a new job
+     */
+    createJob(data: CreateJobData): Promise<TransactionResult>;
+    /**
+     * Fund a job
+     */
+    fundJob(jobId: number, amount: string): Promise<TransactionResult>;
+    /**
+     * Accept a job (as agent)
+     */
+    acceptJob(jobId: number): Promise<TransactionResult>;
+    /**
+     * Start working on a job (as agent)
+     */
+    startJob(jobId: number): Promise<TransactionResult>;
+    /**
+     * Deliver a job (as agent)
+     */
+    deliverJob(jobId: number, evidenceUri: string): Promise<TransactionResult>;
+    /**
+     * Approve delivery (as client)
+     */
+    approveDelivery(jobId: number): Promise<TransactionResult>;
+    /**
+     * Add a milestone to a job
+     */
+    addMilestone(data: AddMilestoneData): Promise<TransactionResult>;
+    /**
+     * Submit a milestone (as agent)
+     */
+    submitMilestone(milestoneId: number, evidenceUri: string): Promise<TransactionResult>;
+    /**
+     * Approve a milestone (as client)
+     */
+    approveMilestone(milestoneId: number): Promise<TransactionResult>;
+    /**
+     * Raise a dispute
+     */
+    raiseDispute(jobId: number, reason: string, evidenceUri?: string): Promise<TransactionResult>;
+    /**
+     * Cancel a job (as client)
+     */
+    cancelJob(jobId: number): Promise<TransactionResult>;
+    /**
+     * Claim timeout (refund or auto-approve)
+     */
+    claimTimeout(jobId: number): Promise<TransactionResult>;
+    /**
+     * Claim acceptance timeout refund (as client)
+     */
+    claimAcceptanceTimeout(jobId: number): Promise<TransactionResult>;
+    /**
+     * Register as an arbitrator
+     */
+    registerArbitrator(feePercent: number): Promise<TransactionResult>;
+    /**
+     * Stake XPR as arbitrator (via token transfer)
+     *
+     * @param amount - Amount string (e.g., "1000.0000 XPR")
+     */
+    stakeArbitrator(amount: string): Promise<TransactionResult>;
+    /**
+     * Arbitrate a dispute
+     *
+     * @param disputeId - The dispute to resolve
+     * @param clientPercent - Percentage of remaining funds to give to client (0-100)
+     * @param resolutionNotes - Explanation of the resolution
+     */
+    arbitrate(disputeId: number, clientPercent: number, resolutionNotes: string): Promise<TransactionResult>;
+    /**
+     * Resolve a dispute after timeout (owner-only fallback).
+     * Can only be called after 14 days since dispute creation.
+     *
+     * @param disputeId - The dispute to resolve
+     * @param clientPercent - Percentage of remaining funds to give to client (0-100)
+     * @param resolutionNotes - Explanation of the resolution
+     */
+    resolveTimeout(disputeId: number, clientPercent: number, resolutionNotes: string): Promise<TransactionResult>;
+    /**
+     * Activate arbitrator (must have sufficient stake)
+     */
+    activateArbitrator(): Promise<TransactionResult>;
+    /**
+     * Deactivate arbitrator (stop accepting new cases)
+     */
+    deactivateArbitrator(): Promise<TransactionResult>;
+    /**
+     * Request to unstake arbitrator funds (7-day delay).
+     * Must be deactivated and have no pending disputes first.
+     *
+     * @param amount - Amount to unstake in smallest units (e.g., 10000 = 1.0000 XPR)
+     */
+    unstakeArbitrator(amount: number): Promise<TransactionResult>;
+    /**
+     * Withdraw unstaked arbitrator funds (after 7-day delay)
+     */
+    withdrawArbitratorStake(): Promise<TransactionResult>;
+    /**
+     * Cancel a pending unstake request (returns funds to active stake)
+     */
+    cancelArbitratorUnstake(): Promise<TransactionResult>;
+    /**
+     * Clean up completed jobs (permissionless)
+     */
+    cleanJobs(maxAge: number, maxDelete: number): Promise<TransactionResult>;
+    /**
+     * Clean up resolved disputes (permissionless)
+     */
+    cleanDisputes(maxAge: number, maxDelete: number): Promise<TransactionResult>;
+    private requireSession;
+    private parseJob;
+    private parseMilestone;
+}