@pear-protocol/types 2.21.0 → 2.22.0

package/dist/trade/entities.js

@@ -1,101 +0,0 @@
-import { z } from 'zod';
-import { SignedDecimalString, UnsignedDecimalString } from '../common/schema';
-import { Connector } from '../connector';
-import { FillStatus } from '../fill';
-import { InstrumentId } from '../instrument';
-
-const TradePositionState = z.object({
-  signedQuantity: SignedDecimalString,
-  basis: z.discriminatedUnion("kind", [
-    z.object({
-      kind: z.literal("FLAT")
-    }),
-    z.object({
-      kind: z.literal("PRICED"),
-      entryPrice: UnsignedDecimalString
-    }),
-    z.object({
-      kind: z.literal("UNPRICED")
-    })
-  ])
-});
-const TradeRealization = z.discriminatedUnion("kind", [
-  z.object({
-    kind: z.literal("PRICED"),
-    quantity: UnsignedDecimalString,
-    entryPrice: UnsignedDecimalString,
-    exitPrice: UnsignedDecimalString,
-    grossPnl: SignedDecimalString
-  }),
-  z.object({
-    kind: z.literal("UNPRICED"),
-    quantity: UnsignedDecimalString
-  })
-]);
-const TradePositionEffect = z.discriminatedUnion("kind", [
-  z.object({
-    kind: z.literal("OPEN"),
-    openedQuantity: UnsignedDecimalString
-  }),
-  z.object({
-    kind: z.literal("INCREASE"),
-    increasedQuantity: UnsignedDecimalString
-  }),
-  z.object({
-    kind: z.literal("REDUCE"),
-    reducedQuantity: UnsignedDecimalString,
-    realization: TradeRealization
-  }),
-  z.object({
-    kind: z.literal("CLOSE"),
-    reducedQuantity: UnsignedDecimalString,
-    realization: TradeRealization
-  }),
-  z.object({
-    kind: z.literal("FLIP"),
-    reducedQuantity: UnsignedDecimalString,
-    openedQuantity: UnsignedDecimalString,
-    realization: TradeRealization
-  })
-]);
-const TradeFill = z.object({
-  id: z.uuid(),
-  positionId: z.uuid(),
-  symbol: InstrumentId,
-  connector: Connector,
-  side: z.enum([
-    "BUY",
-    "SELL"
-  ]),
-  quantity: UnsignedDecimalString,
-  price: UnsignedDecimalString,
-  /** Fee polarity is a charge: `+` is paid, `-` is a rebate — the opposite of `grossPnl`/`netCashflow`, where `+` is a gain. */
-  tradeFee: SignedDecimalString.optional(),
-  /** Same polarity as `tradeFee`: `+` is a charge paid to Pear. */
-  pearFee: SignedDecimalString.optional(),
-  /** Microsecond-precision UTC instant, rendered exactly like the group's `at`. */
-  timestamp: z.iso.datetime(),
-  /** RECONCILED rows are superseded and never listed, so only these two states can appear. */
-  settlement: FillStatus.extract([
-    "PROVISIONAL",
-    "CONFIRMED"
-  ]),
-  executionId: z.uuid().optional(),
-  positionEffect: TradePositionEffect,
-  basisBefore: TradePositionState,
-  basisAfter: TradePositionState
-});
-const TradeGroup = z.object({
-  id: z.string().regex(/^(execution|fill):[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/),
-  executionId: z.uuid().optional(),
-  scheduleId: z.uuid().optional(),
-  triggerId: z.uuid().optional(),
-  connector: Connector,
-  /** Earliest fill instant in the group at microsecond precision; the cursor key. */
-  at: z.iso.datetime(),
-  /** Priced realized PnL minus every fee in the group; `+` is a gain. */
-  netCashflow: SignedDecimalString,
-  trades: z.array(TradeFill)
-});
-
-export { TradeFill, TradeGroup, TradePositionEffect, TradePositionState, TradeRealization };

package/dist/trade/index.js

@@ -1,4 +0,0 @@
-export * from './entities';
-export * from './payloads';
-export * from './queries';
-export * from './responses';

package/dist/trade/payloads.js

@@ -1,84 +0,0 @@
-import { z } from 'zod';
-import { ClientIdCode } from '../common/client-id';
-import { RefineMinimumOneSymbol, RefineUniqueSymbols } from '../common/refinement';
-import { TradeLegPostOnlyWithMaxImpactPrice, TradeLegWithMaxImpactPrice } from '../common/trade-legs';
-import { AttachTriggerMarketClose } from '../trigger';
-
-const CreateMarketOpen = z.object({
-  type: z.literal("MARKET"),
-  /**
-  * Requested legs
-  */
-  legs: z.tuple([
-    TradeLegPostOnlyWithMaxImpactPrice
-  ]).rest(TradeLegPostOnlyWithMaxImpactPrice).superRefine(RefineMinimumOneSymbol).superRefine(RefineUniqueSymbols).describe("Array of legs to make up the exposure"),
-  /**
-  * Optional absolute deadline (epoch ms); the engine refuses to plan the open after this time.
-  * The floor rejects an epoch-seconds timestamp sent by mistake, which would always be expired.
-  */
-  expiresAt: z.number().int().min(1e12).optional(),
-  /**
-  * Close trigger to attach to the execution
-  */
-  trigger: AttachTriggerMarketClose.optional(),
-  /**
-  * Attribution route code (client_ids.code)
-  */
-  clientId: ClientIdCode
-});
-const CreateMarketAdjust = z.object({
-  type: z.literal("MARKET"),
-  /**
-  * Requested legs
-  */
-  legs: z.tuple([
-    TradeLegWithMaxImpactPrice
-  ]).rest(TradeLegWithMaxImpactPrice).superRefine(RefineMinimumOneSymbol).superRefine(RefineUniqueSymbols).describe("Array of legs to modify the position"),
-  /**
-  * Optional absolute deadline (epoch ms); the engine refuses to plan the adjust after this time.
-  * The floor rejects an epoch-seconds timestamp sent by mistake, which would always be expired.
-  */
-  expiresAt: z.number().int().min(1e12).optional(),
-  /**
-  * Attribution route code (client_ids.code)
-  */
-  clientId: ClientIdCode
-});
-const CreateMarketClose = z.object({
-  type: z.literal("MARKET"),
-  /**
-  * Attribution route code (client_ids.code)
-  */
-  clientId: ClientIdCode
-});
-const CreateMarketReverse = z.object({
-  type: z.literal("MARKET"),
-  /**
-  * Attribution route code (client_ids.code)
-  */
-  clientId: ClientIdCode
-});
-const CreateMarketCloseAll = z.object({
-  type: z.literal("MARKET"),
-  /**
-  * Attribution route code (client_ids.code)
-  */
-  clientId: ClientIdCode
-});
-const CreateTradeOpen = z.discriminatedUnion("type", [
-  CreateMarketOpen
-]);
-const CreateTradeAdjust = z.discriminatedUnion("type", [
-  CreateMarketAdjust
-]);
-const CreateTradeClose = z.discriminatedUnion("type", [
-  CreateMarketClose
-]);
-const CreateTradeReverse = z.discriminatedUnion("type", [
-  CreateMarketReverse
-]);
-const CreateTradeCloseAll = z.discriminatedUnion("type", [
-  CreateMarketCloseAll
-]);
-
-export { CreateMarketAdjust, CreateMarketClose, CreateMarketCloseAll, CreateMarketOpen, CreateMarketReverse, CreateTradeAdjust, CreateTradeClose, CreateTradeCloseAll, CreateTradeOpen, CreateTradeReverse };

package/dist/trade/queries.js

@@ -1,9 +0,0 @@
-import { z } from 'zod';
-import { CursorFindParams } from '../common';
-
-const TradeListParams = CursorFindParams.extend({
-  /** Groups contain every fill in an execution, so keep pages bounded. */
-  limit: z.coerce.number().int().positive().max(100).optional().default(20)
-});
-
-export { TradeListParams };

package/dist/trade/responses.js

@@ -1,25 +0,0 @@
-import { z } from 'zod';
-import { CursorResponse } from '../common';
-import { Execution } from '../execution/entities';
-import { TradeGroup } from './entities';
-
-const CreateTradeOpenResponse = z.object({
-  execution: Execution
-});
-const CreateTradeAdjustResponse = z.object({
-  execution: Execution
-});
-const CreateTradeCloseResponse = z.object({
-  execution: Execution
-});
-const CreateTradeReverseResponse = z.object({
-  execution: Execution
-});
-const CreateTradeCloseAllResponse = z.object({
-  executions: z.array(Execution)
-});
-const TradeListResponse = CursorResponse.extend({
-  groups: z.array(TradeGroup)
-});
-
-export { CreateTradeAdjustResponse, CreateTradeCloseAllResponse, CreateTradeCloseResponse, CreateTradeOpenResponse, CreateTradeReverseResponse, TradeListResponse };

package/dist/trade-accounts/entities.js

@@ -1,61 +0,0 @@
-import { z } from 'zod';
-
-const HyperliquidMetadata = z.object({
-  agentWalletAddress: z.string(),
-  isSubaccount: z.boolean(),
-  mainAccountAddress: z.string()
-});
-const LighterMetadata = z.object({
-  l1_address: z.string(),
-  isSubaccount: z.boolean()
-});
-const commonFields = {
-  id: z.uuid().describe("Trade account UUID"),
-  alias: z.string().describe("User-defined trade account alias"),
-  kind: z.enum([
-    "eoa",
-    "vault"
-  ]).describe("Whether the account trades an EOA or a Pear vault"),
-  exchangeIdentifier: z.string().describe("User identifier on the exchange"),
-  createdAt: z.string().describe("Creation timestamp (ISO 8601)"),
-  updatedAt: z.string().describe("Last update timestamp (ISO 8601)"),
-  deletedAt: z.string().describe("Deletion timestamp (ISO 8601)").optional()
-};
-const NoConnectorMetadata = z.never().optional();
-const HyperliquidTradeAccount = z.object({
-  ...commonFields,
-  connector: z.literal("hyperliquid").describe("Exchange connector type"),
-  metadata: HyperliquidMetadata.optional().describe("Connector-specific metadata")
-});
-const LighterTradeAccount = z.object({
-  ...commonFields,
-  connector: z.literal("lighter").describe("Exchange connector type"),
-  metadata: LighterMetadata.optional().describe("Connector-specific metadata")
-});
-const BinanceTradeAccount = z.object({
-  ...commonFields,
-  connector: z.literal("binance").describe("Exchange connector type"),
-  metadata: NoConnectorMetadata.describe("Connector-specific metadata")
-});
-const BybitTradeAccount = z.object({
-  ...commonFields,
-  connector: z.literal("bybit").describe("Exchange connector type"),
-  metadata: NoConnectorMetadata.describe("Connector-specific metadata")
-});
-const OkxTradeAccount = z.object({
-  ...commonFields,
-  connector: z.literal("okx").describe("Exchange connector type"),
-  metadata: NoConnectorMetadata.describe("Connector-specific metadata")
-});
-const TradeAccount = z.discriminatedUnion("connector", [
-  HyperliquidTradeAccount,
-  LighterTradeAccount,
-  LighterTradeAccount.extend({
-    connector: z.literal("lighter_rhc")
-  }),
-  BinanceTradeAccount,
-  BybitTradeAccount,
-  OkxTradeAccount
-]);
-
-export { TradeAccount };

package/dist/trade-accounts/index.js

@@ -1,4 +0,0 @@
-export * from './entities';
-export * from './payloads';
-export * from './queries';
-export * from './response';

package/dist/trade-accounts/payloads.js

@@ -1,132 +0,0 @@
-import { z } from 'zod';
-import { EthereumAddress } from '../common/address';
-import { HexString } from '../common/hex-string';
-
-const CreateHyperliquidCredentials = z.object({
-  signer_key: HexString
-});
-const CreateHyperliquidMetadata = z.object({
-  agentWalletAddress: EthereumAddress,
-  isSubaccount: z.boolean(),
-  mainAccountAddress: EthereumAddress
-});
-const BinanceApiKeyPair = z.object({
-  api_key: z.string().min(1, "API key is required"),
-  api_secret: z.string().min(1, "API secret is required")
-});
-const CreateBinanceCredentials = z.object({
-  read: BinanceApiKeyPair,
-  write: BinanceApiKeyPair
-});
-const CreateBybitCredentials = z.object({
-  api_key: z.string().min(1, "API key is required"),
-  api_secret: z.string().min(1, "API secret is required")
-});
-const CreateOkxCredentials = z.object({
-  api_key: z.string().min(1, "API key is required"),
-  api_secret: z.string().min(1, "API secret is required"),
-  api_pass: z.string().min(1, "API passphrase is required")
-});
-const CreateLighterCredentials = z.object({
-  api_private_key: z.string().min(1, "API private key is required"),
-  api_key_index: z.number().int().min(4, "API key slots 0-3 are reserved; use 4-254").max(254, "API key index must be <= 254")
-});
-const CreateLighterMetadata = z.object({
-  l1_address: EthereumAddress
-});
-const AccountAlias = z.string().min(1, "Alias is required").max(100, "Alias must be 100 characters or less");
-const CreateHyperliquidAccount = z.object({
-  connector: z.literal("hyperliquid"),
-  alias: AccountAlias,
-  exchangeIdentifier: EthereumAddress,
-  credentials: CreateHyperliquidCredentials,
-  metadata: CreateHyperliquidMetadata
-});
-const CreateBinanceAccount = z.object({
-  connector: z.literal("binance"),
-  alias: AccountAlias,
-  credentials: CreateBinanceCredentials,
-  metadata: z.void({}).transform(() => void 0)
-});
-const CreateBybitAccount = z.object({
-  connector: z.literal("bybit"),
-  alias: AccountAlias,
-  credentials: CreateBybitCredentials,
-  metadata: z.void({}).transform(() => void 0)
-});
-const CreateOkxAccount = z.object({
-  connector: z.literal("okx"),
-  alias: AccountAlias,
-  credentials: CreateOkxCredentials,
-  metadata: z.void({}).transform(() => void 0)
-});
-const CreateLighterAccount = z.object({
-  connector: z.literal("lighter"),
-  alias: AccountAlias,
-  exchangeIdentifier: z.string().regex(/^\d+$/, "Exchange identifier must be the numeric Lighter account index"),
-  credentials: CreateLighterCredentials,
-  metadata: CreateLighterMetadata
-});
-const CreateLighterRhcAccount = CreateLighterAccount.extend({
-  connector: z.literal("lighter_rhc")
-});
-const UpdateHyperliquidAccount = z.object({
-  connector: z.literal("hyperliquid"),
-  alias: AccountAlias.optional(),
-  credentials: CreateHyperliquidCredentials.optional(),
-  metadata: CreateHyperliquidMetadata.optional()
-});
-const UpdateBinanceAccount = z.object({
-  connector: z.literal("binance"),
-  alias: AccountAlias.optional(),
-  credentials: CreateBinanceCredentials.optional(),
-  metadata: z.void({}).transform(() => void 0)
-});
-const UpdateBybitAccount = z.object({
-  connector: z.literal("bybit"),
-  alias: AccountAlias.optional(),
-  credentials: CreateBybitCredentials.optional(),
-  metadata: z.void({}).transform(() => void 0)
-});
-const UpdateOkxAccount = z.object({
-  connector: z.literal("okx"),
-  alias: AccountAlias.optional(),
-  credentials: CreateOkxCredentials.optional(),
-  metadata: z.void({}).transform(() => void 0)
-});
-const UpdateLighterAccount = z.object({
-  connector: z.literal("lighter"),
-  alias: AccountAlias.optional(),
-  credentials: CreateLighterCredentials.optional(),
-  metadata: CreateLighterMetadata.optional()
-});
-const UpdateLighterRhcAccount = UpdateLighterAccount.extend({
-  connector: z.literal("lighter_rhc")
-});
-const CreateTradeAccount = z.discriminatedUnion("connector", [
-  CreateHyperliquidAccount,
-  CreateBinanceAccount,
-  CreateBybitAccount,
-  CreateOkxAccount,
-  CreateLighterAccount,
-  CreateLighterRhcAccount
-]);
-const CreateVaultTradeAccount = z.object({
-  vaultAddress: EthereumAddress,
-  alias: AccountAlias,
-  /**
-  * Optional caller-supplied key. Reusing it attaches a transport retry to the first attempt;
-  * omitting it starts a new create attempt.
-  */
-  idempotencyKey: z.string().min(1).max(128).optional()
-});
-const UpdateTradeAccount = z.discriminatedUnion("connector", [
-  UpdateHyperliquidAccount,
-  UpdateBinanceAccount,
-  UpdateBybitAccount,
-  UpdateOkxAccount,
-  UpdateLighterAccount,
-  UpdateLighterRhcAccount
-]);
-
-export { CreateTradeAccount, CreateVaultTradeAccount, UpdateTradeAccount };

package/dist/trade-accounts/queries.js

@@ -1,7 +0,0 @@
-import { z } from 'zod';
-
-const TradeAccountListParams = z.object({
-  includeDeleted: z.coerce.boolean().optional().default(false)
-});
-
-export { TradeAccountListParams };

package/dist/trade-accounts/response.js

@@ -1,79 +0,0 @@
-import { z } from 'zod';
-import { TradeAccount } from './entities';
-
-const TradeAccountResponse = z.object({
-  account: TradeAccount
-});
-const TradeAccountListResponse = z.object({
-  accounts: z.array(TradeAccount)
-});
-const VaultTradeAccountStatus = z.discriminatedUnion("exists", [
-  z.object({
-    exists: z.literal(false)
-  }),
-  z.object({
-    exists: z.literal(true),
-    tradeAccountId: z.string(),
-    account: TradeAccount
-  })
-]);
-const VaultTradeAccountStatusResponse = z.object({
-  status: VaultTradeAccountStatus
-});
-const HyperliquidCredentialsResponse = z.object({
-  connector: z.literal("hyperliquid"),
-  account: TradeAccount,
-  credentials: z.object({
-    signer_key: z.string()
-  })
-});
-const BinanceApiKeyPairResponse = z.object({
-  api_key: z.string(),
-  api_secret: z.string()
-});
-const BinanceCredentialsResponse = z.object({
-  connector: z.literal("binance"),
-  account: TradeAccount,
-  credentials: z.object({
-    read: BinanceApiKeyPairResponse,
-    write: BinanceApiKeyPairResponse
-  })
-});
-const BybitCredentialsResponse = z.object({
-  connector: z.literal("bybit"),
-  account: TradeAccount,
-  credentials: z.object({
-    api_key: z.string(),
-    api_secret: z.string()
-  })
-});
-const OkxCredentialsResponse = z.object({
-  connector: z.literal("okx"),
-  account: TradeAccount,
-  credentials: z.object({
-    api_key: z.string(),
-    api_secret: z.string(),
-    api_pass: z.string()
-  })
-});
-const LighterCredentialsResponse = z.object({
-  connector: z.literal("lighter"),
-  account: TradeAccount,
-  credentials: z.object({
-    api_private_key: z.string(),
-    api_key_index: z.number()
-  })
-});
-const LighterRhcCredentialsResponse = LighterCredentialsResponse.extend({
-  connector: z.literal("lighter_rhc")
-});
-const ExchangeCredentialsResponse = z.discriminatedUnion("connector", [
-  HyperliquidCredentialsResponse,
-  BinanceCredentialsResponse,
-  BybitCredentialsResponse,
-  OkxCredentialsResponse,
-  LighterCredentialsResponse,
-  LighterRhcCredentialsResponse
-]);
-
-export { ExchangeCredentialsResponse, TradeAccountListResponse, TradeAccountResponse, VaultTradeAccountStatus, VaultTradeAccountStatusResponse };

package/dist/traders/index.js

@@ -1,2 +0,0 @@
-export * from './performance';
-export * from './public';

package/dist/traders/performance.js

@@ -1,21 +0,0 @@
-import { z } from 'zod';
-import { SignedDecimalString } from '../common/schema';
-
-const TraderPerformanceQuery = z.object({
-  range: z.enum([
-    "24h",
-    "7d",
-    "30d"
-  ]).default("24h")
-}).strict();
-const TraderPerformancePoint = z.object({
-  at: z.string().datetime(),
-  equityUsd: SignedDecimalString.optional(),
-  pnlUsd: SignedDecimalString.optional(),
-  roiPercent: SignedDecimalString.optional()
-});
-const TraderPerformanceResponse = z.object({
-  points: z.array(TraderPerformancePoint)
-});
-
-export { TraderPerformancePoint, TraderPerformanceQuery, TraderPerformanceResponse };