@trust-ethos/cli 0.0.5

package/dist/lib/api/echo-client.d.ts

@@ -0,0 +1,624 @@
+import { type ParsedIdentifier } from '../validation/userkey.js';
+export interface EthosUser {
+    id: number;
+    profileId: number | null;
+    displayName: string;
+    username: string | null;
+    avatarUrl: string | null;
+    description: string | null;
+    score: number;
+    status: string;
+    userkeys: string[];
+    xpTotal: number;
+    xpStreakDays: number;
+    influenceFactor: number;
+    influenceFactorPercentile: number;
+    links?: {
+        profile: string;
+        scoreBreakdown: string;
+    };
+    stats?: {
+        review: {
+            received: {
+                negative: number;
+                neutral: number;
+                positive: number;
+            };
+        };
+        vouch: {
+            given: {
+                amountWeiTotal: string;
+                count: number;
+            };
+            received: {
+                amountWeiTotal: string;
+                count: number;
+            };
+        };
+    };
+}
+export interface SearchResult {
+    values: EthosUser[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+export interface Season {
+    id: number;
+    name: string;
+    startDate: string;
+    endDate?: string;
+    week?: number;
+}
+export interface SeasonsResponse {
+    seasons: Season[];
+    currentSeason: Season;
+}
+export interface ActivityAuthor {
+    userkey: string;
+    profileId: number | null;
+    name: string;
+    username: string | null;
+    avatar: string | null;
+    score: number;
+}
+export interface Activity {
+    type: 'review' | 'vouch' | 'unvouch';
+    timestamp: number;
+    data: {
+        id: number;
+        comment?: string;
+        score?: 'positive' | 'neutral' | 'negative';
+        metadata?: string;
+    };
+    author: ActivityAuthor;
+    subject: ActivityAuthor;
+    link: string;
+}
+export type ActivityType = 'review' | 'vouch';
+export interface Review {
+    type: 'review';
+    data: {
+        id: number;
+        authorProfileId: number;
+        author: string;
+        subject: string;
+        score: 'positive' | 'neutral' | 'negative';
+        comment: string;
+        metadata: string;
+        createdAt: number;
+        archived: boolean;
+    };
+    votes: {
+        upvotes: number;
+        downvotes: number;
+    };
+    replySummary: {
+        count: number;
+        participated: boolean;
+    };
+    timestamp: number;
+    author: ActivityAuthor;
+    subject: ActivityAuthor;
+    authorUser?: EthosUser;
+    subjectUser?: EthosUser;
+    link: string;
+}
+export interface Slash {
+    id: number;
+    authorProfileId: number;
+    subject: null | number;
+    createdAt: number;
+    duration: number;
+    closedAt: number;
+    cancelledAt: number;
+    amount: number;
+    slashType: string;
+    comment: string;
+    metadata?: string;
+    attestationDetails?: {
+        service: string;
+        account: string;
+    };
+}
+export interface SlashesResponse {
+    ok: boolean;
+    data: {
+        values: Slash[];
+        total: number;
+        limit: number;
+        offset: number;
+    };
+}
+export type BrokerPostType = 'SELL' | 'BUY' | 'HIRE' | 'FOR_HIRE' | 'BOUNTY';
+export type BrokerPostLevel = 'BASIC' | 'PREMIUM';
+export type BrokerPostStatus = 'OPEN' | 'COMPLETED' | 'CLOSED' | 'EXPIRED';
+export type BrokerSortBy = 'newest' | 'score' | 'top' | 'expiresAt' | 'hot';
+export interface BrokerPostAuthor {
+    profileId: number;
+    username?: string;
+    displayName?: string;
+    avatarUrl?: string;
+    score: number;
+}
+export interface BrokerPost {
+    id: number;
+    type: BrokerPostType;
+    level: BrokerPostLevel;
+    status: BrokerPostStatus;
+    title: string;
+    description: string;
+    tags: string[];
+    expiresAt: string | null;
+    createdAt: string;
+    author: BrokerPostAuthor;
+    votes: {
+        upvotes: number;
+        downvotes: number;
+    };
+    replyCount: number;
+}
+export interface BrokerListParams {
+    type?: BrokerPostType;
+    search?: string;
+    sortBy?: BrokerSortBy;
+    minScore?: number;
+    limit?: number;
+    offset?: number;
+}
+export interface BrokerListResponse {
+    values: BrokerPost[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+export interface ProjectChain {
+    id: number;
+    name: string;
+    logoUrl?: string;
+}
+export interface ProjectVotes {
+    bullish: {
+        total: number;
+        percentage: number;
+    };
+    bearish: {
+        total: number;
+        percentage: number;
+    };
+    all: {
+        totalVoters: number;
+        totalVotes: number;
+    };
+}
+export interface Project {
+    id: number;
+    userkey: string;
+    status: 'ACTIVE' | 'PENDING' | 'ARCHIVED';
+    description: string;
+    bannerImageUrl?: string;
+    isPromoted?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    user: EthosUser;
+    categories?: string[];
+    chains?: ProjectChain[];
+    votes?: ProjectVotes;
+}
+export interface ProjectVoter {
+    user: EthosUser;
+    bullishCount: number;
+    bearishCount: number;
+    totalVotes: number;
+    firstVoteAt: string;
+    lastVoteAt: string;
+    bullishReasons: string[];
+    bearishReasons: string[];
+}
+export interface ProjectListResponse {
+    projects: Project[];
+    total: number;
+}
+export interface ProjectVotersTotals {
+    totalVoters: number;
+    totalBullishVoters: number;
+    totalBearishVoters: number;
+    totalBullishVotes: number;
+    totalBearishVotes: number;
+}
+export interface ProjectVotersResponse {
+    values: ProjectVoter[];
+    total: number;
+    limit: number;
+    offset: number;
+    totals: ProjectVotersTotals;
+}
+export interface MarketUser {
+    profileId: number;
+    displayName: string;
+    username: string | null;
+    avatarUrl: string | null;
+    score: number;
+}
+export interface MarketStats {
+    marketCapWei: string;
+    marketCapChange24hWei?: string;
+    marketCapChange24hPercent?: number;
+    volumeTotalWei: string;
+    volume24hWei?: string;
+    priceChange24hPercent?: number;
+}
+export interface Market {
+    id: number;
+    creatorAddress: string;
+    positivePrice: string;
+    negativePrice: string;
+    trustVotes: number;
+    distrustVotes: number;
+    createdAt: string;
+    updatedAt: string;
+    basePrice: string;
+    user: MarketUser;
+    stats: MarketStats;
+}
+export interface MarketHolder {
+    actorAddress: string;
+    marketId: number;
+    voteType: 'trust' | 'distrust';
+    total: string;
+    user: MarketUser;
+}
+export type MarketOrderBy = 'marketCapWei' | 'volumeTotalWei' | 'volume24hWei' | 'trustRatio' | 'distrustRatio' | 'score' | 'createdAt' | 'priceChange24hPercent' | 'marketCapChange24hPercent' | 'scoreDifferential';
+export interface MarketListParams {
+    limit?: number;
+    offset?: number;
+    orderBy?: MarketOrderBy;
+    orderDirection?: 'asc' | 'desc';
+    filterQuery?: string;
+}
+export interface MarketListResponse {
+    values: Market[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+export interface FeaturedMarket {
+    type: 'top-volume' | 'undervalued' | 'rugging' | string;
+    market: Market;
+}
+export type FeaturedMarketsResponse = FeaturedMarket[];
+export interface MarketHoldersResponse {
+    values: MarketHolder[];
+    total: number;
+}
+export interface MarketUserByTwitter {
+    profileId: number;
+    twitterUsername: string;
+    twitterName: string;
+    twitterUserId: string;
+    walletAddress: string;
+    avatarUrl: string;
+}
+export interface NFT {
+    tokenId: string;
+    name: string | null;
+    description?: string;
+    imageUrl: string | null;
+    contractAddress: string;
+    contractName?: string;
+}
+export interface NftsResponse {
+    values: NFT[];
+    total: number;
+    limit?: number;
+    offset?: number;
+}
+export interface ValidatorListing {
+    orderHash: string;
+    tokenId: string;
+    name: string | null;
+    imageUrl: string | null;
+    priceWei: string;
+    priceEth: string;
+    currency: string;
+    seller: string;
+    openseaUrl: string;
+}
+export interface ValidatorListingsResponse {
+    values: ValidatorListing[];
+    total: number;
+    limit?: number;
+    offset?: number;
+}
+export interface AuctionBuyer {
+    displayName?: string;
+    username?: string | null;
+}
+export interface Auction {
+    id: number;
+    nftTokenId: number;
+    nftContract: string;
+    creatorAddress: string;
+    startPrice: string;
+    reservePrice: string;
+    duration: number;
+    startTime: string;
+    status: 'PENDING' | 'ENABLED' | 'ENDED' | 'SOLD';
+    buyerAddress: string | null;
+    pricePaid: string | null;
+    soldTime: string | null;
+    createdAt: string;
+    buyerUser?: AuctionBuyer | null;
+}
+export interface AuctionsResponse {
+    values: Auction[];
+    total: number;
+}
+export interface Invitation {
+    id: number;
+    senderProfileId: number;
+    recipientAddress: string;
+    status: 'INVITED' | 'ACCEPTED';
+    recipientScoreImpact: {
+        value: number;
+        impact: string;
+    };
+    senderScoreImpact: {
+        value: number;
+        impact: string;
+    };
+    dateInvited: string;
+    dateAccepted: string | null;
+}
+export interface InvitationWithUser {
+    invitation: Invitation;
+    invitedUser: EthosUser;
+}
+export interface InvitationsResponse {
+    values: InvitationWithUser[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+export interface Validator {
+    tokenId: string;
+    name: string;
+    imageUrl: string;
+    ownerAddress: string;
+    ownerProfileId: number;
+    ownerDisplayName: string;
+    ownerUsername: string | null;
+    ownerAvatarUrl: string | null;
+    currentXp: number;
+    remainingCapacity: number;
+    xpCap: number;
+    isFull: boolean;
+}
+export type ScoreLevel = 'untrusted' | 'questionable' | 'neutral' | 'reputable' | 'exemplary';
+export interface ScoreResponse {
+    score: number;
+    level: ScoreLevel;
+}
+export interface ScoreBreakdownElement {
+    element: {
+        name: string;
+        type: string;
+        range?: {
+            min: number;
+            max: number;
+        };
+    };
+    raw: number;
+    weighted: number;
+    error: boolean;
+}
+export interface ScoreBreakdownResponse {
+    ok: boolean;
+    data: {
+        score: number;
+        elements: Record<string, ScoreBreakdownElement>;
+        metadata: Record<string, unknown>;
+        errors: string[];
+    };
+}
+export interface ScoreStatus {
+    status: 'idle' | 'queued' | 'calculating';
+    isQueued: boolean;
+    isCalculating: boolean;
+    isPending: boolean;
+}
+export interface VouchUser {
+    id?: number;
+    profileId?: number | null;
+    displayName?: string;
+    username?: string | null;
+    avatarUrl?: string | null;
+    score?: number;
+    userkeys?: string[];
+}
+export interface Vouch {
+    id: number;
+    authorProfileId: number;
+    subjectProfileId: number;
+    subjectAddress: string | null;
+    balance: string;
+    comment: string;
+    metadata: string;
+    archived: boolean;
+    mutualId: number | null;
+    deposited: string;
+    staked: string;
+    withdrawn: string;
+    unhealthy: boolean;
+    authorAddress: string;
+    activityCheckpoints: {
+        vouchedAt: number;
+        unvouchedAt: number;
+        unhealthyAt: number;
+    };
+    attestationDetails?: {
+        service: string;
+        account: string;
+    } | null;
+    authorUser?: VouchUser | null;
+    subjectUser?: VouchUser | null;
+}
+export interface VouchesResponse {
+    values: Vouch[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+export interface VouchQueryParams {
+    ids?: number[];
+    subjectUserkeys?: string[];
+    authorProfileIds?: number[];
+    subjectProfileIds?: number[];
+    archived?: boolean;
+    limit?: number;
+    offset?: number;
+}
+export type VoteType = 'review' | 'vouch' | 'slash';
+export interface VoteUser {
+    id: number;
+    profileId: number;
+    displayName: string;
+    username: string | null;
+    avatarUrl: string | null;
+    score: number;
+}
+export interface Vote {
+    isUpvote: boolean;
+    isArchived: boolean;
+    voter: number;
+    targetContract: string;
+    targetId: string;
+    createdAt: number;
+    weight: number;
+    user: VoteUser;
+}
+export interface VotesResponse {
+    values: Vote[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+export interface VoteStats {
+    userVote: {
+        isUpvote: boolean;
+    } | null;
+    counts: {
+        upvotes: number;
+        downvotes: number;
+    };
+    weights: {
+        weightedUpvotes: number;
+        weightedDownvotes: number;
+        upvotePercentage: number;
+        downvotePercentage: number;
+    };
+}
+export declare class EchoClient {
+    private baseUrl;
+    private debug;
+    constructor();
+    private log;
+    private request;
+    getUserByTwitter(username: string): Promise<EthosUser>;
+    getUserByAddress(address: string): Promise<EthosUser>;
+    getUserByProfileId(profileId: string): Promise<EthosUser>;
+    searchUsers(query: string, limit?: number): Promise<SearchResult>;
+    resolveUser(identifier: string): Promise<EthosUser>;
+    resolveUserFromParsed(parsed: ParsedIdentifier): Promise<EthosUser>;
+    private resolveEnsUser;
+    getXpTotal(userkey: string): Promise<number>;
+    getSeasons(): Promise<SeasonsResponse>;
+    getLeaderboardRank(userkey: string): Promise<number>;
+    getXpBySeason(userkey: string, seasonId: number): Promise<number>;
+    getActivities(userkey: string, types?: ActivityType[], limit?: number): Promise<Activity[]>;
+    getPrimaryUserkey(user: EthosUser): string | null;
+    /** @deprecated Use resolveUser instead */
+    getUserByUsername(username: string): Promise<EthosUser>;
+    /** @deprecated Use getXpTotal instead */
+    getTotalXp(userkey: string): Promise<number>;
+    getSlashes(params?: {
+        author?: string;
+        subject?: string;
+        status?: 'open' | 'closed';
+        limit?: number;
+        offset?: number;
+    }): Promise<SlashesResponse>;
+    getSlashRoles(slashId: number, profileIds: number[]): Promise<Record<number, string>>;
+    getBrokerPosts(params?: BrokerListParams): Promise<BrokerListResponse>;
+    getBrokerPost(id: number): Promise<BrokerPost>;
+    getBrokerPostsByAuthor(profileId: number, params?: {
+        type?: BrokerPostType;
+        limit?: number;
+    }): Promise<BrokerListResponse>;
+    getProjects(params?: {
+        status?: string[];
+        limit?: number;
+        offset?: number;
+    }): Promise<ProjectListResponse>;
+    getProjectDetails(projectId: number): Promise<Project>;
+    getProjectByUsername(username: string): Promise<Project>;
+    getProjectVoters(projectId: number, params?: {
+        limit?: number;
+        offset?: number;
+        sentiment?: 'bullish' | 'bearish';
+    }): Promise<ProjectVotersResponse>;
+    getProjectTeam(projectId: number): Promise<EthosUser[]>;
+    getNftsForUser(userkey: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<NftsResponse>;
+    checkValidatorOwnership(userkey: string): Promise<NFT[]>;
+    getValidatorListings(params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<ValidatorListingsResponse>;
+    getAuctions(params?: {
+        limit?: number;
+        offset?: number;
+        status?: string;
+    }): Promise<AuctionsResponse>;
+    getActiveAuction(): Promise<Auction | null>;
+    getAuction(auctionId: number): Promise<Auction>;
+    getMarkets(params?: MarketListParams): Promise<MarketListResponse>;
+    getFeaturedMarkets(): Promise<FeaturedMarketsResponse>;
+    getMarketInfo(profileId: number): Promise<Market>;
+    getMarketHolders(profileId: number, params?: {
+        limit?: number;
+    }): Promise<MarketHoldersResponse>;
+    getMarketByTwitter(username: string): Promise<MarketUserByTwitter>;
+    getScoreBreakdownByUserkey(userkey: string): Promise<ScoreBreakdownResponse>;
+    getScoreBreakdownByAddress(address: string): Promise<ScoreBreakdownResponse>;
+    convertScoreToLevel(score: number): ScoreLevel;
+    getScoreStatus(userkey: string): Promise<ScoreStatus>;
+    getVouches(params?: VouchQueryParams): Promise<VouchesResponse>;
+    getMutualVouchers(viewerProfileId: number, targetProfileId: number, params?: {
+        limit?: number;
+    }): Promise<{
+        values: VouchUser[];
+        total: number;
+    }>;
+    getVotes(activityId: number, type: VoteType, params?: {
+        isUpvote?: boolean;
+        limit?: number;
+        offset?: number;
+    }): Promise<VotesResponse>;
+    getVoteStats(activityId: number, type: VoteType): Promise<VoteStats>;
+    getValidators(): Promise<Validator[]>;
+    getValidatorByTokenId(tokenId: string): Promise<Validator | null>;
+    getReview(reviewId: number): Promise<Review>;
+    getReviewsForUser(userkey: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<Activity[]>;
+    getInvitations(params?: {
+        senderProfileId?: number;
+        status?: 'INVITED' | 'ACCEPTED';
+        limit?: number;
+        offset?: number;
+    }): Promise<InvitationsResponse>;
+}