@pear-protocol/types 2.9.0 → 2.11.0

package/dist/vaults/responses.js

@@ -0,0 +1,375 @@
+import { z } from 'zod';
+import { EthereumAddress } from '../common/address';
+import { Vault, VaultStatus, BulkSnapshotPoint, SparklinePoint, Activity, NavBucketPoint, NavSnapshot, VaultEvent } from './entities';
+import { NavStatsWindow } from './queries';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+const VaultResponse = z.object({
+  vault: Vault
+});
+const VaultListResponse = z.object({
+  vaults: z.array(Vault)
+});
+const CreatedVaultCompleted = z.object({
+  success: z.literal(true),
+  vaultAddress: EthereumAddress,
+  agentAddress: EthereumAddress,
+  ownerAddress: EthereumAddress,
+  status: VaultStatus,
+  maxWithdrawalPeriodDays: z.number().int(),
+  txHash: z.string()
+});
+const CreatedVaultInProgress = z.object({
+  success: z.literal(false),
+  status: z.literal("in_progress"),
+  activityId: z.string()
+});
+const CreatedVaultResult = z.discriminatedUnion("success", [
+  CreatedVaultCompleted,
+  CreatedVaultInProgress
+]);
+const CreatedVaultResponse = z.object({
+  result: CreatedVaultResult
+});
+const SetTraderCompleted = z.object({
+  success: z.literal(true),
+  vault: Vault
+});
+const SetTraderInProgress = z.object({
+  success: z.literal(false),
+  status: z.literal("in_progress"),
+  activityId: z.string()
+});
+const SetTraderResult = z.discriminatedUnion("success", [
+  SetTraderCompleted,
+  SetTraderInProgress
+]);
+const SetTraderResponse = z.object({
+  result: SetTraderResult
+});
+const UpdateVaultMetadataCompleted = z.object({
+  success: z.literal(true),
+  vault: Vault
+});
+const UpdateVaultMetadataInProgress = z.object({
+  success: z.literal(false),
+  status: z.literal("in_progress"),
+  activityId: z.string()
+});
+const UpdateVaultMetadataResult = z.discriminatedUnion("success", [
+  UpdateVaultMetadataCompleted,
+  UpdateVaultMetadataInProgress
+]);
+const UpdateVaultMetadataResponse = z.object({
+  result: UpdateVaultMetadataResult
+});
+const BulkSnapshotsResponse = z.object({
+  snapshots: z.record(z.string(), z.array(BulkSnapshotPoint))
+});
+const InvestorEntry = z.object({
+  address: z.string(),
+  depositAmount: z.string(),
+  shares: z.string(),
+  currentValue: z.string()
+});
+const VaultStatsResponse = z.object({
+  tvl: z.string(),
+  totalSupply: z.string(),
+  sharePrice: z.string(),
+  withdrawalFeeBps: z.number(),
+  leaderInvestment: z.object({
+    depositAmount: z.string(),
+    currentValue: z.string(),
+    shares: z.string(),
+    percentageOfTVL: z.number()
+  }),
+  totalPnl: z.number(),
+  totalPnlPercentage: z.number().nullable(),
+  thirtyDayPnl: z.number(),
+  apr: z.number().nullable(),
+  maxDrawdown: z.number().nullable(),
+  // Recorded traded volume (USD) from the confirmed fills ledger; omitted when the vault has no trading account mapping.
+  tradedVolume: z.number().optional(),
+  winRate: z.number().nullable(),
+  profitFactor: z.number().nullable(),
+  unrealizedPnl: z.number(),
+  userStats: z.object({
+    allTimePnl: z.number(),
+    depositAmount: z.string(),
+    currentValue: z.string(),
+    shares: z.string(),
+    unrealizedPnl: z.number()
+  }).optional(),
+  investors: z.array(InvestorEntry)
+});
+const VaultOverviewResponse = z.object({
+  items: z.array(z.object({
+    vaultAddress: EthereumAddress,
+    agentAddress: EthereumAddress,
+    leaderAddress: EthereumAddress,
+    name: z.string().nullable(),
+    imageUrl: z.string().nullable(),
+    latest: z.object({
+      tvl: z.string(),
+      sharePrice: z.string(),
+      accountValue: z.string().nullable(),
+      openInterest: z.string().nullable(),
+      unrealizedPnl: z.string().nullable(),
+      cumulativeRealizedPnl: z.string().nullable(),
+      investorCount: z.number(),
+      createdAt: z.string()
+    }).nullable(),
+    sparkline: z.array(SparklinePoint)
+  })),
+  page: z.number(),
+  pageSize: z.number(),
+  total: z.number()
+});
+const VaultInvestmentsResponse = z.object({
+  totals: z.object({
+    totalInvested: z.number(),
+    totalCurrentValue: z.number(),
+    totalPnl: z.number(),
+    totalUnrealizedPnl: z.number()
+  }),
+  investments: z.array(z.object({
+    vaultAddress: EthereumAddress,
+    name: z.string().nullable(),
+    imageUrl: z.string().nullable(),
+    isLeader: z.boolean(),
+    depositAmount: z.string(),
+    currentValue: z.string(),
+    allTimePnl: z.number(),
+    unrealizedPnl: z.number(),
+    shares: z.string()
+  })),
+  partial: z.boolean(),
+  failedVaults: z.array(z.object({
+    vaultAddress: EthereumAddress,
+    name: z.string().nullable(),
+    reason: z.string()
+  }))
+});
+const ActivityResponse = z.object({
+  vaultAddress: z.string(),
+  activity: z.array(Activity)
+});
+const ActivityItemResponse = z.object({
+  activity: Activity
+});
+const AgentBalancesResponse = z.object({
+  agentAddress: z.string(),
+  spot: z.record(z.string(), z.string()),
+  perp: z.object({
+    accountValue: z.string(),
+    withdrawable: z.string()
+  })
+});
+const AgentApproveSent = z.object({
+  success: z.literal(true),
+  transactionHash: z.string(),
+  tokenAddress: z.string(),
+  spender: z.string(),
+  amount: z.string()
+});
+const AgentApproveSkipped = z.object({
+  success: z.literal(false),
+  status: z.literal("already_approved"),
+  tokenAddress: z.string(),
+  spender: z.string(),
+  allowance: z.string()
+});
+const AgentApproveResult = z.discriminatedUnion("success", [
+  AgentApproveSent,
+  AgentApproveSkipped
+]);
+const AgentApproveResponse = z.object({
+  result: AgentApproveResult
+});
+const UnifiedAccountResponse = z.object({
+  success: z.boolean(),
+  agentAddress: z.string()
+});
+const NavRangeResponse = z.object({
+  points: z.array(NavBucketPoint)
+});
+const NavStatsResponse = z.object({
+  window: NavStatsWindow,
+  samples: z.number().int().nonnegative(),
+  returnPct: z.number().nullable(),
+  sharePriceMin: z.string().nullable(),
+  sharePriceMax: z.string().nullable(),
+  sharePriceFirst: z.string().nullable(),
+  sharePriceLast: z.string().nullable()
+});
+const NavSnapshotResponse = z.object({
+  snapshot: NavSnapshot
+});
+const WithdrawCompleted = z.object({
+  success: z.literal(true),
+  amount: z.string(),
+  token: z.string(),
+  tokenId: z.string(),
+  destination: z.string(),
+  vaultAddress: z.string(),
+  activityId: z.string(),
+  bridgeStatus: z.string(),
+  bridgeSettleMs: z.number(),
+  transferTxHash: z.string()
+});
+const WithdrawInProgress = z.object({
+  success: z.literal(false),
+  status: z.literal("in_progress"),
+  amount: z.string(),
+  token: z.string(),
+  tokenId: z.string(),
+  destination: z.string(),
+  vaultAddress: z.string(),
+  activityId: z.string()
+});
+const WithdrawToEvmResult = z.discriminatedUnion("success", [
+  WithdrawCompleted,
+  WithdrawInProgress
+]);
+const WithdrawToEvmResponse = z.object({
+  result: WithdrawToEvmResult
+});
+const VaultEventListResponse = z.object({
+  events: z.array(VaultEvent)
+});
+const VaultRequestIssue = z.object({
+  path: z.string(),
+  message: z.string(),
+  code: z.string()
+});
+const createRefusal = /* @__PURE__ */ __name((code) => z.object({
+  error: z.literal(code),
+  details: z.string().optional()
+}), "createRefusal");
+const VaultServiceError = z.discriminatedUnion("error", [
+  // Authentication and authorization.
+  z.object({
+    error: z.literal("UNAUTHORIZED"),
+    reason: z.string()
+  }),
+  z.object({
+    error: z.literal("NOT_OWNER"),
+    vaultAddress: z.string()
+  }),
+  // Request validation.
+  z.object({
+    error: z.literal("INVALID_REQUEST"),
+    issues: z.array(VaultRequestIssue)
+  }),
+  // Lookups.
+  z.object({
+    error: z.literal("VAULT_NOT_FOUND"),
+    vaultAddress: z.string()
+  }),
+  z.object({
+    error: z.literal("VAULT_TRADE_ACCOUNT_UNAVAILABLE"),
+    vaultAddress: z.string()
+  }),
+  z.object({
+    error: z.literal("ACTIVITY_NOT_FOUND"),
+    activityId: z.string()
+  }),
+  z.object({
+    error: z.literal("NAV_UNAVAILABLE"),
+    vaultAddress: z.string()
+  }),
+  // Admission ceilings.
+  z.object({
+    error: z.literal("RATE_LIMITED"),
+    reason: z.string(),
+    retryAfterSeconds: z.number()
+  }),
+  z.object({
+    error: z.literal("VAULT_CREATE_CEILING"),
+    retryAfterSeconds: z.number()
+  }),
+  // Provider failures; `incidentId` correlates the response with the full server-side log line.
+  z.object({
+    error: z.literal("HL_SET_ABSTRACTION_FAILED"),
+    incidentId: z.string()
+  }),
+  // On-chain reads and workflow-answered refusals.
+  z.object({
+    error: z.literal("EVM_OPERATION_FAILED"),
+    vaultAddress: z.string(),
+    reason: z.string()
+  }),
+  z.object({
+    error: z.literal("HL_APPROVE_AGENT_FAILED"),
+    vaultAddress: z.string()
+  }),
+  // Create-vault refusals translated from the workflow's terminal reasons.
+  createRefusal("DEPLOYER_NOT_WHITELISTED"),
+  createRefusal("INVALID_CONFIG"),
+  createRefusal("CONFIG_DISABLED"),
+  createRefusal("AGENT_ALREADY_ASSIGNED"),
+  createRefusal("EMPTY_NAME"),
+  createRefusal("INVALID_ADDRESS"),
+  createRefusal("DEPLOY_REVERTED"),
+  createRefusal("VAULT_EVENT_MISSING"),
+  createRefusal("DEPLOYER_INSUFFICIENT_FUNDS"),
+  // Ambiguous post-dispatch outcomes; `activityId` anchors a support lookup.
+  z.object({
+    error: z.literal("CREATE_VAULT_OPERATION_FAILED"),
+    activityId: z.string()
+  }),
+  z.object({
+    error: z.literal("SET_TRADER_OPERATION_FAILED"),
+    activityId: z.string()
+  }),
+  z.object({
+    error: z.literal("UPDATE_METADATA_OPERATION_FAILED"),
+    activityId: z.string()
+  }),
+  z.object({
+    error: z.literal("VAULT_NOT_FOUND_AFTER_SET_TRADER"),
+    activityId: z.string()
+  }),
+  // Bridge withdraw family.
+  z.object({
+    error: z.literal("UNSUPPORTED_TOKEN"),
+    reason: z.string()
+  }),
+  z.object({
+    error: z.literal("WITHDRAW_IN_PROGRESS"),
+    activityId: z.string()
+  }),
+  z.object({
+    error: z.literal("BRIDGE_OPERATION_FAILED"),
+    activityId: z.string()
+  }),
+  z.object({
+    error: z.literal("BRIDGE_SEND_REJECTED"),
+    activityId: z.string()
+  }),
+  z.object({
+    error: z.literal("BRIDGE_VAULT_NOT_FOUND"),
+    activityId: z.string()
+  }),
+  z.object({
+    error: z.literal("BRIDGE_INVALID_AMOUNT"),
+    activityId: z.string()
+  }),
+  z.object({
+    error: z.literal("BRIDGE_NONCE_EXPIRED"),
+    activityId: z.string()
+  }),
+  // Custody refusals: Privy refused to sign the action, so the venue never saw it.
+  createRefusal("CUSTODY_REFUSED"),
+  z.object({
+    error: z.literal("SET_TRADER_CUSTODY_REFUSED"),
+    vaultAddress: z.string()
+  }),
+  z.object({
+    error: z.literal("BRIDGE_CUSTODY_REFUSED"),
+    activityId: z.string()
+  })
+]);
+
+export { ActivityItemResponse, ActivityResponse, AgentApproveResponse, AgentApproveResult, AgentBalancesResponse, BulkSnapshotsResponse, CreatedVaultResponse, CreatedVaultResult, NavRangeResponse, NavSnapshotResponse, NavStatsResponse, SetTraderResponse, SetTraderResult, UnifiedAccountResponse, UpdateVaultMetadataResponse, UpdateVaultMetadataResult, VaultEventListResponse, VaultInvestmentsResponse, VaultListResponse, VaultOverviewResponse, VaultRequestIssue, VaultResponse, VaultServiceError, VaultStatsResponse, WithdrawToEvmResponse, WithdrawToEvmResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/types",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "description": "Pear Protocol Types definitions",
   "private": false,
   "type": "module",