@pear-protocol/types 2.11.0 → 2.12.1

package/dist/copy/responses.d.ts

@@ -0,0 +1,332 @@
+import { z } from 'zod';
+/** Current relationship only; NONE does not imply that the account has no positions. */
+export declare const CopyStateResponse: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    state: z.ZodLiteral<"NONE">;
+}, z.core.$strip>, z.ZodObject<{
+    state: z.ZodLiteral<"ACTIVE">;
+    subscription: z.ZodObject<{
+        id: z.ZodUUID;
+        leaderTradeAccountId: z.ZodUUID;
+        followerTradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>;
+        sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+        }, z.core.$strip>], "mode">;
+        createdAt: z.ZodString;
+        endedAt: z.ZodOptional<z.ZodString>;
+        status: z.ZodLiteral<"ACTIVE">;
+    }, z.core.$strip>;
+}, z.core.$strip>], "state">;
+export type CopyStateResponse = z.output<typeof CopyStateResponse>;
+/** All current follower accounts, including accounts without X. */
+export declare const CopyFollowersResponse: z.ZodObject<{
+    followers: z.ZodArray<z.ZodObject<{
+        tradeAccountId: z.ZodUUID;
+        status: z.ZodLiteral<"ACTIVE">;
+        followedAt: z.ZodString;
+        xUserId: z.ZodOptional<z.ZodString>;
+        xHandle: z.ZodOptional<z.ZodString>;
+        xName: z.ZodOptional<z.ZodString>;
+        xAvatarUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    followerCount: z.ZodNumber;
+}, z.core.$strip>;
+export type CopyFollowersResponse = z.output<typeof CopyFollowersResponse>;
+export declare const CopySubscriptionResponse: z.ZodObject<{
+    subscription: z.ZodObject<{
+        id: z.ZodUUID;
+        leaderTradeAccountId: z.ZodUUID;
+        followerTradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>;
+        status: z.ZodEnum<{
+            ACTIVE: "ACTIVE";
+            ENDED: "ENDED";
+        }>;
+        sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+        }, z.core.$strip>], "mode">;
+        createdAt: z.ZodString;
+        endedAt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type CopySubscriptionResponse = z.output<typeof CopySubscriptionResponse>;
+/** Stopping returns the committed subscription. */
+export declare const EndCopySubscriptionResponse: z.ZodObject<{
+    subscription: z.ZodObject<{
+        id: z.ZodUUID;
+        leaderTradeAccountId: z.ZodUUID;
+        followerTradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>;
+        status: z.ZodEnum<{
+            ACTIVE: "ACTIVE";
+            ENDED: "ENDED";
+        }>;
+        sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+        }, z.core.$strip>], "mode">;
+        createdAt: z.ZodString;
+        endedAt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type EndCopySubscriptionResponse = z.output<typeof EndCopySubscriptionResponse>;
+/** The result of each existing position entry attempted at subscription start. */
+export declare const CopyJoinResult: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    leaderPositionId: z.ZodUUID;
+    outcome: z.ZodLiteral<"COPIED">;
+    positionId: z.ZodUUID;
+}, z.core.$strip>, z.ZodObject<{
+    leaderPositionId: z.ZodUUID;
+    outcome: z.ZodLiteral<"PARTIAL">;
+    positionId: z.ZodUUID;
+    reason: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    leaderPositionId: z.ZodUUID;
+    outcome: z.ZodLiteral<"SKIPPED">;
+    reason: z.ZodEnum<{
+        SUBSCRIPTION_NOT_ACTIVE: "SUBSCRIPTION_NOT_ACTIVE";
+        POSITION_EXCLUDED: "POSITION_EXCLUDED";
+        INCLUDED_IN_JOIN: "INCLUDED_IN_JOIN";
+        VENUE_MISMATCH: "VENUE_MISMATCH";
+        BELOW_VENUE_MINIMUM: "BELOW_VENUE_MINIMUM";
+        PAIR_ALREADY_ENTERED: "PAIR_ALREADY_ENTERED";
+        ENTRY_EXPIRED: "ENTRY_EXPIRED";
+        FOLLOWER_LEG_ABSENT: "FOLLOWER_LEG_ABSENT";
+        LEADER_LEG_REOPENED: "LEADER_LEG_REOPENED";
+        NO_FOLLOWER_DELTA: "NO_FOLLOWER_DELTA";
+        LEADER_EQUITY_UNREADABLE: "LEADER_EQUITY_UNREADABLE";
+        FOLLOWER_EQUITY_UNREADABLE: "FOLLOWER_EQUITY_UNREADABLE";
+        PRICE_UNAVAILABLE: "PRICE_UNAVAILABLE";
+        LEVERAGE_NOT_APPLIED: "LEVERAGE_NOT_APPLIED";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
+    leaderPositionId: z.ZodUUID;
+    outcome: z.ZodLiteral<"FAILED">;
+    reason: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    leaderPositionId: z.ZodUUID;
+    outcome: z.ZodLiteral<"UNCONFIRMED">;
+}, z.core.$strip>], "outcome">;
+export type CopyJoinResult = z.output<typeof CopyJoinResult>;
+export declare const CreateCopySubscriptionResponse: z.ZodObject<{
+    subscription: z.ZodObject<{
+        id: z.ZodUUID;
+        leaderTradeAccountId: z.ZodUUID;
+        followerTradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>;
+        status: z.ZodEnum<{
+            ACTIVE: "ACTIVE";
+            ENDED: "ENDED";
+        }>;
+        sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+        }, z.core.$strip>], "mode">;
+        createdAt: z.ZodString;
+        endedAt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    joinResults: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        leaderPositionId: z.ZodUUID;
+        outcome: z.ZodLiteral<"COPIED">;
+        positionId: z.ZodUUID;
+    }, z.core.$strip>, z.ZodObject<{
+        leaderPositionId: z.ZodUUID;
+        outcome: z.ZodLiteral<"PARTIAL">;
+        positionId: z.ZodUUID;
+        reason: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        leaderPositionId: z.ZodUUID;
+        outcome: z.ZodLiteral<"SKIPPED">;
+        reason: z.ZodEnum<{
+            SUBSCRIPTION_NOT_ACTIVE: "SUBSCRIPTION_NOT_ACTIVE";
+            POSITION_EXCLUDED: "POSITION_EXCLUDED";
+            INCLUDED_IN_JOIN: "INCLUDED_IN_JOIN";
+            VENUE_MISMATCH: "VENUE_MISMATCH";
+            BELOW_VENUE_MINIMUM: "BELOW_VENUE_MINIMUM";
+            PAIR_ALREADY_ENTERED: "PAIR_ALREADY_ENTERED";
+            ENTRY_EXPIRED: "ENTRY_EXPIRED";
+            FOLLOWER_LEG_ABSENT: "FOLLOWER_LEG_ABSENT";
+            LEADER_LEG_REOPENED: "LEADER_LEG_REOPENED";
+            NO_FOLLOWER_DELTA: "NO_FOLLOWER_DELTA";
+            LEADER_EQUITY_UNREADABLE: "LEADER_EQUITY_UNREADABLE";
+            FOLLOWER_EQUITY_UNREADABLE: "FOLLOWER_EQUITY_UNREADABLE";
+            PRICE_UNAVAILABLE: "PRICE_UNAVAILABLE";
+            LEVERAGE_NOT_APPLIED: "LEVERAGE_NOT_APPLIED";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        leaderPositionId: z.ZodUUID;
+        outcome: z.ZodLiteral<"FAILED">;
+        reason: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        leaderPositionId: z.ZodUUID;
+        outcome: z.ZodLiteral<"UNCONFIRMED">;
+    }, z.core.$strip>], "outcome">>;
+}, z.core.$strip>;
+export type CreateCopySubscriptionResponse = z.output<typeof CreateCopySubscriptionResponse>;
+export declare const CopySubscriptionListResponse: z.ZodObject<{
+    subscriptions: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        leaderTradeAccountId: z.ZodUUID;
+        followerTradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
+        }>;
+        status: z.ZodEnum<{
+            ACTIVE: "ACTIVE";
+            ENDED: "ENDED";
+        }>;
+        sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+        }, z.core.$strip>], "mode">;
+        createdAt: z.ZodString;
+        endedAt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type CopySubscriptionListResponse = z.output<typeof CopySubscriptionListResponse>;
+export declare const CopyActivityListResponse: z.ZodObject<{
+    activities: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        leaderAction: z.ZodEnum<{
+            OPEN: "OPEN";
+            ADJUST: "ADJUST";
+            CLOSE: "CLOSE";
+            REVERSE: "REVERSE";
+        }>;
+        executionSource: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            origin: z.ZodLiteral<"DIRECT">;
+        }, z.core.$strip>, z.ZodObject<{
+            origin: z.ZodLiteral<"SCHEDULE">;
+            scheduleId: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            origin: z.ZodLiteral<"TRIGGER">;
+            triggerId: z.ZodString;
+            triggerIntent: z.ZodEnum<{
+                OPEN: "OPEN";
+                ADJUST: "ADJUST";
+                CLOSE: "CLOSE";
+            }>;
+            bracketType: z.ZodOptional<z.ZodString>;
+            ladderId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            origin: z.ZodLiteral<"AUTO_REBALANCE">;
+            configId: z.ZodString;
+        }, z.core.$strip>], "origin">>;
+        state: z.ZodEnum<{
+            RECORDED: "RECORDED";
+            DISPATCHED: "DISPATCHED";
+            SETTLED: "SETTLED";
+        }>;
+        outcome: z.ZodOptional<z.ZodEnum<{
+            COPIED: "COPIED";
+            PARTIAL: "PARTIAL";
+            SKIPPED: "SKIPPED";
+            FAILED: "FAILED";
+        }>>;
+        skipReason: z.ZodOptional<z.ZodEnum<{
+            SUBSCRIPTION_NOT_ACTIVE: "SUBSCRIPTION_NOT_ACTIVE";
+            POSITION_EXCLUDED: "POSITION_EXCLUDED";
+            INCLUDED_IN_JOIN: "INCLUDED_IN_JOIN";
+            VENUE_MISMATCH: "VENUE_MISMATCH";
+            BELOW_VENUE_MINIMUM: "BELOW_VENUE_MINIMUM";
+            PAIR_ALREADY_ENTERED: "PAIR_ALREADY_ENTERED";
+            ENTRY_EXPIRED: "ENTRY_EXPIRED";
+            FOLLOWER_LEG_ABSENT: "FOLLOWER_LEG_ABSENT";
+            LEADER_LEG_REOPENED: "LEADER_LEG_REOPENED";
+            NO_FOLLOWER_DELTA: "NO_FOLLOWER_DELTA";
+            LEADER_EQUITY_UNREADABLE: "LEADER_EQUITY_UNREADABLE";
+            FOLLOWER_EQUITY_UNREADABLE: "FOLLOWER_EQUITY_UNREADABLE";
+            PRICE_UNAVAILABLE: "PRICE_UNAVAILABLE";
+            LEVERAGE_NOT_APPLIED: "LEVERAGE_NOT_APPLIED";
+        }>>;
+        failureReason: z.ZodOptional<z.ZodString>;
+        followerLegs: z.ZodArray<z.ZodObject<{
+            symbol: z.ZodString;
+            targetQuantity: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+            deltaQuantity: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        }, z.core.$strip>>;
+        leaderEquityFraction: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type CopyActivityListResponse = z.output<typeof CopyActivityListResponse>;
+/** Operational state of the PostgreSQL copy consumer exposed through the gateway health route. */
+export declare const CopyHealthResponse: z.ZodObject<{
+    status: z.ZodEnum<{
+        ok: "ok";
+        degraded: "degraded";
+    }>;
+    consumerRunning: z.ZodBoolean;
+    acceptanceBlocked: z.ZodOptional<z.ZodBoolean>;
+    outbox: z.ZodOptional<z.ZodObject<{
+        pending: z.ZodNumber;
+        failed: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type CopyHealthResponse = z.output<typeof CopyHealthResponse>;
+/** Lifetime follower accounts, combining repeat subscriptions to the selected leader. */
+export declare const CopyFollowerStats: z.ZodObject<{
+    tradeAccountId: z.ZodUUID;
+    xUserId: z.ZodOptional<z.ZodString>;
+    xHandle: z.ZodOptional<z.ZodString>;
+    xName: z.ZodOptional<z.ZodString>;
+    xAvatarUrl: z.ZodOptional<z.ZodString>;
+    status: z.ZodEnum<{
+        ACTIVE: "ACTIVE";
+        ENDED: "ENDED";
+    }>;
+    copiedTrades: z.ZodNumber;
+    copiedVolumeUsd: z.ZodString;
+}, z.core.$strip>;
+export type CopyFollowerStats = z.output<typeof CopyFollowerStats>;
+/** Owner-only copy totals from tagged history; date filters apply only to trades and volume. */
+export declare const CopyStatsResponse: z.ZodObject<{
+    currentFollowerCount: z.ZodNumber;
+    lifetimeFollowerCount: z.ZodNumber;
+    copiedTrades: z.ZodNumber;
+    copiedVolumeUsd: z.ZodString;
+    followers: z.ZodArray<z.ZodObject<{
+        tradeAccountId: z.ZodUUID;
+        xUserId: z.ZodOptional<z.ZodString>;
+        xHandle: z.ZodOptional<z.ZodString>;
+        xName: z.ZodOptional<z.ZodString>;
+        xAvatarUrl: z.ZodOptional<z.ZodString>;
+        status: z.ZodEnum<{
+            ACTIVE: "ACTIVE";
+            ENDED: "ENDED";
+        }>;
+        copiedTrades: z.ZodNumber;
+        copiedVolumeUsd: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type CopyStatsResponse = z.output<typeof CopyStatsResponse>;

package/dist/copy/responses.js

@@ -0,0 +1,91 @@
+import { z } from 'zod';
+import { UnsignedDecimalString } from '../common/schema';
+import { CopySubscription, CopyFollower, CopySkipReason, CopyActivity, CopySubscriptionStatus } from './entities';
+
+const CopyStateResponse = z.discriminatedUnion("state", [
+  z.object({
+    state: z.literal("NONE")
+  }),
+  z.object({
+    state: z.literal("ACTIVE"),
+    subscription: CopySubscription.extend({
+      status: z.literal("ACTIVE")
+    })
+  })
+]);
+const CopyFollowersResponse = z.object({
+  followers: z.array(CopyFollower),
+  followerCount: z.number().int().nonnegative()
+});
+const CopySubscriptionResponse = z.object({
+  subscription: CopySubscription
+});
+const EndCopySubscriptionResponse = CopySubscriptionResponse;
+const CopyJoinResult = z.discriminatedUnion("outcome", [
+  z.object({
+    leaderPositionId: z.uuid(),
+    outcome: z.literal("COPIED"),
+    positionId: z.uuid()
+  }),
+  z.object({
+    leaderPositionId: z.uuid(),
+    outcome: z.literal("PARTIAL"),
+    positionId: z.uuid(),
+    reason: z.string()
+  }),
+  z.object({
+    leaderPositionId: z.uuid(),
+    outcome: z.literal("SKIPPED"),
+    reason: CopySkipReason
+  }),
+  z.object({
+    leaderPositionId: z.uuid(),
+    outcome: z.literal("FAILED"),
+    reason: z.string()
+  }),
+  z.object({
+    leaderPositionId: z.uuid(),
+    outcome: z.literal("UNCONFIRMED")
+  })
+]);
+const CreateCopySubscriptionResponse = CopySubscriptionResponse.extend({
+  joinResults: z.array(CopyJoinResult)
+});
+const CopySubscriptionListResponse = z.object({
+  subscriptions: z.array(CopySubscription)
+});
+const CopyActivityListResponse = z.object({
+  activities: z.array(CopyActivity)
+});
+const CopyHealthResponse = z.object({
+  status: z.enum([
+    "ok",
+    "degraded"
+  ]),
+  consumerRunning: z.boolean(),
+  acceptanceBlocked: z.boolean().optional(),
+  outbox: z.object({
+    pending: z.number().int().nonnegative(),
+    failed: z.number().int().nonnegative()
+  }).optional()
+});
+const CopyFollowerStats = CopyFollower.pick({
+  tradeAccountId: true,
+  xUserId: true,
+  xHandle: true,
+  xName: true,
+  xAvatarUrl: true
+}).extend({
+  status: CopySubscriptionStatus,
+  copiedTrades: z.number().int().nonnegative(),
+  copiedVolumeUsd: UnsignedDecimalString
+});
+const CopyStatsResponse = z.object({
+  currentFollowerCount: z.number().int().nonnegative(),
+  lifetimeFollowerCount: z.number().int().nonnegative(),
+  copiedTrades: z.number().int().nonnegative(),
+  copiedVolumeUsd: UnsignedDecimalString,
+  followers: z.array(CopyFollowerStats)
+});
+
+export { CopyActivityListResponse, CopyFollowerStats, CopyFollowersResponse, CopyHealthResponse, CopyJoinResult, CopyStateResponse, CopyStatsResponse, CopySubscriptionListResponse, CopySubscriptionResponse, CreateCopySubscriptionResponse, EndCopySubscriptionResponse };