@pear-protocol/types 2.20.0 → 2.22.0

package/dist/ladder/entities.js

@@ -1,24 +0,0 @@
-import { z } from 'zod';
-import { Connector } from '../connector';
-import { Trigger } from '../trigger';
-import { AttachTriggerMarketCloseList } from '../trigger/payloads';
-import { LadderConfig } from './payloads';
-
-const LadderStatus = z.enum([
-  "ACTIVE",
-  "COMPLETED",
-  "CANCELLED"
-]);
-const Ladder = z.object({
-  id: z.uuid(),
-  connector: Connector,
-  positionKey: z.string(),
-  config: LadderConfig,
-  status: LadderStatus,
-  attachTriggers: AttachTriggerMarketCloseList.optional(),
-  triggers: z.array(Trigger),
-  createdAt: z.string(),
-  updatedAt: z.string()
-});
-
-export { Ladder, LadderStatus };

package/dist/ladder/index.js

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

package/dist/ladder/payloads.js

@@ -1,96 +0,0 @@
-import { z } from 'zod';
-import { ClientIdCode } from '../common/client-id';
-import { RefineMinimumTwoSymbols, RefineUniqueSymbols, RefineWeightingSum, RefineTwoUniqueSymbols, RefineMinimumOneSymbol } from '../common/refinement';
-import { AssetWeight, Side } from '../common/schema';
-import { TradeLegPostOnly } from '../common/trade-legs';
-import { InstrumentId } from '../instrument';
-import { MetricTrack } from '../trigger/common';
-import { AttachTriggerMarketCloseList } from '../trigger/payloads';
-
-const LadderThreshold = z.number().positive({
-  message: "Threshold must be greater than 0"
-});
-const LadderConfig = z.object({
-  thresholdStart: LadderThreshold,
-  thresholdEnd: LadderThreshold,
-  levels: z.int().min(2).max(50),
-  weighting: z.literal("EQUAL").default("EQUAL")
-}).refine((config) => config.thresholdStart !== config.thresholdEnd, {
-  message: "thresholds must differ"
-});
-const PriceSource = z.enum([
-  "mid",
-  "mark"
-], {
-  message: "Price source must be mid or mark"
-});
-const WeightedRatioBasketItem = z.object({
-  symbol: InstrumentId,
-  side: Side,
-  weight: AssetWeight
-});
-const WeightedRatioBasket = z.array(WeightedRatioBasketItem).superRefine(RefineMinimumTwoSymbols).superRefine(RefineUniqueSymbols).superRefine(RefineWeightingSum);
-const LadderRatioOpen = z.object({
-  type: z.literal("ratio"),
-  data: z.object({
-    priceSource: PriceSource,
-    symbol_a: InstrumentId,
-    symbol_b: InstrumentId,
-    track: MetricTrack
-  }).superRefine(RefineTwoUniqueSymbols)
-});
-const LadderPriceOpen = z.object({
-  type: z.literal("price"),
-  data: z.object({
-    priceSource: PriceSource,
-    symbol: InstrumentId,
-    track: MetricTrack
-  })
-});
-const LadderWeightedRatioOpen = z.object({
-  type: z.literal("weighted_ratio"),
-  data: z.object({
-    priceSource: PriceSource,
-    basket: WeightedRatioBasket,
-    track: MetricTrack
-  })
-});
-const LadderConditionOpen = z.discriminatedUnion("type", [
-  LadderRatioOpen,
-  LadderPriceOpen,
-  LadderWeightedRatioOpen
-]);
-const LadderAttachTriggers = AttachTriggerMarketCloseList.superRefine((attachTriggers, ctx) => {
-  attachTriggers.forEach((attachTrigger, index) => {
-    if (attachTrigger.condition.type === "notional" || attachTrigger.condition.type === "notional_trailing") {
-      ctx.addIssue({
-        code: "custom",
-        path: [
-          index,
-          "condition",
-          "type"
-        ],
-        message: "Ladder brackets cannot use notional conditions; use upnl or upnl_bps."
-      });
-    }
-  });
-});
-const CreateLadderMarketOpen = z.object({
-  type: z.literal("MARKET"),
-  intent: z.literal("OPEN"),
-  clientId: ClientIdCode,
-  condition: LadderConditionOpen,
-  config: LadderConfig,
-  attachTriggers: LadderAttachTriggers.optional(),
-  payload: z.object({
-    type: z.literal("MARKET"),
-    legs: z.tuple([
-      TradeLegPostOnly
-    ]).rest(TradeLegPostOnly).superRefine(RefineMinimumOneSymbol).superRefine(RefineUniqueSymbols)
-  })
-}).strict();
-const CreateLadder = z.discriminatedUnion("type", [
-  CreateLadderMarketOpen
-]);
-
-export { CreateLadder, CreateLadderMarketOpen, LadderConditionOpen, LadderConfig };

package/dist/ladder/queries.js

@@ -1,12 +0,0 @@
-import { z } from 'zod';
-import { normalizeArray, CursorFindParams } from '../common';
-import { Connector } from '../connector';
-import { LadderStatus } from './entities';
-
-const StatusArray = z.preprocess((arg) => normalizeArray(arg), z.array(LadderStatus));
-const LadderListParams = CursorFindParams.extend({
-  connector: Connector.optional(),
-  status: StatusArray.optional()
-});
-
-export { LadderListParams };

package/dist/ladder/responses.js

@@ -1,18 +0,0 @@
-import { z } from 'zod';
-import { CursorResponse } from '../common';
-import { Ladder } from './entities';
-
-const CreateLadderResponse = z.object({
-  ladder: Ladder
-});
-const LadderResponse = z.object({
-  ladder: Ladder
-});
-const LadderListResponse = CursorResponse.extend({
-  ladders: z.array(Ladder)
-});
-const CancelLadderResponse = z.object({
-  id: z.uuid()
-});
-
-export { CancelLadderResponse, CreateLadderResponse, LadderListResponse, LadderResponse };

package/dist/leverage/index.js

@@ -1,2 +0,0 @@
-export * from './payloads';
-export * from './response';

package/dist/leverage/payloads.js

@@ -1,14 +0,0 @@
-import { z } from 'zod';
-import { InstrumentId } from '../instrument/entities';
-
-const MarginMode = z.enum([
-  "cross",
-  "isolated"
-]);
-const SetLeverage = z.object({
-  symbol: InstrumentId,
-  leverage: z.int().positive(),
-  marginMode: MarginMode.optional()
-});
-
-export { MarginMode, SetLeverage };

package/dist/leverage/response.js

@@ -1,5 +0,0 @@
-import { z } from 'zod';
-
-const SetLeverageResponse = z.object({});
-
-export { SetLeverageResponse };

package/dist/margin/index.js

@@ -1,2 +0,0 @@
-export * from './payloads';
-export * from './response';

package/dist/margin/payloads.js

@@ -1,20 +0,0 @@
-import { z } from 'zod';
-import { SignedDecimalString } from '../common/schema';
-import { InstrumentId } from '../instrument/entities';
-
-const AdjustIsolatedMargin = z.object({
-  symbol: InstrumentId,
-  /**
-  * Signed margin movement in USD: `"+50"` adds 50 to the position, `"-50"` removes 50 from it.
-  * The sign is required, so a movement can never mean the opposite of what was intended.
-  */
-  amount: SignedDecimalString.refine((amount) => Number(amount) !== 0, "Amount must not be zero"),
-  /**
-  * Optional caller-supplied idempotency key, scoped to the trade account. A retry carrying the
-  * same key attaches to the first attempt and receives its outcome instead of moving the margin
-  * again. Omitted, the server mints one; either way it is returned as `adjustmentId`.
-  */
-  idempotencyKey: z.string().min(1).max(128).optional()
-});
-
-export { AdjustIsolatedMargin };

package/dist/margin/response.js

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-
-const AdjustIsolatedMarginResponse = z.object({
-  /**
-  * The caller's `idempotencyKey` when supplied, otherwise a server-minted UUID. Reusing it as the
-  * request key replays this movement's outcome.
-  */
-  adjustmentId: z.string().min(1).max(128)
-});
-
-export { AdjustIsolatedMarginResponse };

package/dist/market/entities.js

@@ -1,52 +0,0 @@
-import { z } from 'zod';
-import { Side } from '../common/schema';
-import { Connector } from '../connector';
-import { InstrumentTradeability, InstrumentId } from '../instrument';
-
-const Market = z.object({
-  connector: Connector,
-  instrumentId: InstrumentId,
-  displaySymbol: z.string(),
-  base: z.string(),
-  quote: z.string(),
-  price: z.string(),
-  volume24h: z.string(),
-  change24h: z.string(),
-  openInterest: z.string(),
-  fundingRate: z.string(),
-  tradeability: InstrumentTradeability,
-  updatedAt: z.number()
-});
-const BasketMarketLeg = z.object({
-  id: InstrumentId,
-  symbol: z.string().min(1),
-  side: Side
-});
-const BasketMarket = z.object({
-  connector: Connector,
-  basketKey: z.string(),
-  displaySymbol: z.string(),
-  legs: z.array(BasketMarketLeg),
-  price: z.string(),
-  priceChange24h: z.string(),
-  weightRatio: z.string(),
-  weightRatioChange24h: z.string(),
-  netFunding: z.string(),
-  volume24h: z.string(),
-  openInterest: z.string(),
-  tradeability: InstrumentTradeability,
-  updatedAt: z.number(),
-  hasMaterializedStats: z.boolean()
-});
-const MarketBasketPositionCounts = z.object({
-  basketKey: z.string(),
-  opened: z.number(),
-  traders: z.number()
-});
-const MarketTotals = z.object({
-  markets: z.number(),
-  volume24h: z.string(),
-  openInterest: z.string()
-});
-
-export { BasketMarket, Market, MarketBasketPositionCounts, MarketTotals };

package/dist/market/index.js

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

package/dist/market/payloads.js

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-import { Connector } from '../connector';
-
-const MARKET_BASKET_POSITION_COUNTS_MAX_BASKETS = 500;
-const BasketKey = z.string().regex(/^[0-9a-f]{64}$/, "A basket key is 64 lowercase hex characters \u2014 see deriveBasketKey in @pear-protocol/utils");
-const MarketBasketPositionCountsPayload = z.object({
-  connector: z.array(Connector).min(1, "Name at least one connector, or omit the field for every venue").optional().describe("Absent means every connector, summed"),
-  basketKeys: z.array(BasketKey).min(1, "At least one basket key is required").max(MARKET_BASKET_POSITION_COUNTS_MAX_BASKETS, "Too many basket keys in one request").describe("Canonical basket keys, as /markets/baskets reports them")
-});
-
-export { MARKET_BASKET_POSITION_COUNTS_MAX_BASKETS, MarketBasketPositionCountsPayload };

package/dist/market/queries.js

@@ -1,19 +0,0 @@
-import { z } from 'zod';
-import { Connector } from '../connector';
-import { InstrumentScope } from '../instrument';
-
-const MarketsQueryParams = z.object({
-  connector: Connector,
-  // Markets are connector-scoped so the API can return one exchange's live view
-  // without mixing instruments that have different ids, liquidity, or stats feeds.
-  scope: InstrumentScope.default("tradable")
-});
-const MarketBasketsQueryParams = z.object({
-  connector: Connector,
-  scope: InstrumentScope.default("tradable"),
-  search: z.string().trim().max(128).optional(),
-  limit: z.coerce.number().int().min(1).max(1e3).default(500),
-  offset: z.coerce.number().int().min(0).default(0)
-});
-
-export { MarketBasketsQueryParams, MarketsQueryParams };

package/dist/market/responses.js

@@ -1,18 +0,0 @@
-import { z } from 'zod';
-import { MarketTotals, Market, BasketMarket, MarketBasketPositionCounts } from './entities';
-
-const MarketsResponse = z.object({
-  markets: z.array(Market),
-  totals: MarketTotals
-});
-const MarketBasketsResponse = z.object({
-  limit: z.number(),
-  offset: z.number(),
-  count: z.number(),
-  markets: z.array(BasketMarket)
-});
-const MarketBasketPositionCountsResponse = z.object({
-  counts: z.array(MarketBasketPositionCounts)
-});
-
-export { MarketBasketPositionCountsResponse, MarketBasketsResponse, MarketsResponse };

package/dist/misc/index.js

@@ -1,2 +0,0 @@
-export * from './payloads';
-export * from './responses';

package/dist/misc/payloads.js

@@ -1,99 +0,0 @@
-import { z } from 'zod';
-import { EthereumAddress } from '../common/address';
-
-const CreateLighterApiKeyParams = z.object({
-  accountIndex: z.number(),
-  apiKeyIndex: z.number()
-});
-const SubmitChangePubKeyParams = z.object({
-  l1Signature: z.string(),
-  txInfo: z.string(),
-  accountIndex: z.number(),
-  apiKeyIndex: z.number()
-});
-const PrepareApproveIntegratorParams = z.object({
-  accountIndex: z.number(),
-  apiKeyIndex: z.number(),
-  apiPrivateKey: z.string()
-});
-const SubmitApproveIntegratorParams = z.object({
-  l1Signature: z.string(),
-  txInfo: z.string(),
-  accountIndex: z.number(),
-  apiKeyIndex: z.number()
-});
-const CreateAuthTokenParams = z.object({
-  accountIndex: z.number(),
-  apiKeyIndex: z.number(),
-  apiPrivateKey: z.string(),
-  ttlSeconds: z.number().optional()
-});
-const PrepareLighterFastWithdrawParams = z.object({
-  accountIndex: z.number().int().nonnegative().max(Number.MAX_SAFE_INTEGER),
-  toAddress: z.string().regex(/^0x[0-9a-fA-F]{40}$/),
-  amount: z.number().int().min(4e6).max(Number.MAX_SAFE_INTEGER),
-  apiKeyIndex: z.number().int().nonnegative().max(254),
-  apiPrivateKey: z.string()
-});
-const SubmitLighterFastWithdrawParams = z.object({
-  accountIndex: z.number().int().nonnegative().max(Number.MAX_SAFE_INTEGER),
-  toAddress: z.string().regex(/^0x[0-9a-fA-F]{40}$/),
-  apiKeyIndex: z.number().int().nonnegative().max(254),
-  apiPrivateKey: z.string(),
-  txInfo: z.string(),
-  l1Signature: z.string()
-});
-const CreateLighterSubAccountParams = z.object({
-  accountIndex: z.number().int().nonnegative().max(Number.MAX_SAFE_INTEGER),
-  apiKeyIndex: z.number().int().nonnegative().max(254),
-  apiPrivateKey: z.string()
-});
-const TransferLighterSubAccountParams = z.object({
-  /**
-  * L1 address that owns both accounts; the transfer is refused unless Lighter agrees.
-  * Validate the Ethereum address and normalize its representation at the request boundary.
-  */
-  l1Address: EthereumAddress,
-  fromAccountIndex: z.number().int().nonnegative().max(Number.MAX_SAFE_INTEGER),
-  toAccountIndex: z.number().int().nonnegative().max(Number.MAX_SAFE_INTEGER),
-  amount: z.number().int().positive().max(Number.MAX_SAFE_INTEGER),
-  apiKeyIndex: z.number().int().nonnegative().max(254),
-  apiPrivateKey: z.string()
-});
-const SetLighterSubAccountMetadataParams = z.object({
-  mainAccountIndex: z.number().int().nonnegative().max(Number.MAX_SAFE_INTEGER),
-  subAccountIndex: z.number().int().nonnegative().max(Number.MAX_SAFE_INTEGER),
-  apiKeyIndex: z.number().int().nonnegative().max(254),
-  apiPrivateKey: z.string(),
-  name: z.string().min(1),
-  description: z.string().optional()
-});
-const LighterAccountTier = z.enum([
-  "standard",
-  "plus",
-  "premium"
-]);
-const ChangeLighterAccountTierParams = z.object({
-  accountIndex: z.number().int().nonnegative().max(Number.MAX_SAFE_INTEGER),
-  apiKeyIndex: z.number().int().nonnegative().max(254),
-  apiPrivateKey: z.string(),
-  tier: LighterAccountTier
-});
-const CreateLighterUdaParams = z.object({
-  walletAddress: z.string().regex(/^0x[0-9a-fA-F]{40}$/),
-  market: z.enum([
-    "perps",
-    "spot"
-  ]),
-  asset: z.enum([
-    "USDC",
-    "ETH"
-  ]),
-  // Targets a sub-account; absent credits the wallet's master account index.
-  accountIndex: z.number().int().nonnegative().max(Number.MAX_SAFE_INTEGER).optional()
-});
-const ListLighterUdaDepositsParams = z.object({
-  walletAddress: z.string().regex(/^0x[0-9a-fA-F]{40}$/)
-});
-
-export { ChangeLighterAccountTierParams, CreateAuthTokenParams, CreateLighterApiKeyParams, CreateLighterSubAccountParams, CreateLighterUdaParams, LighterAccountTier, ListLighterUdaDepositsParams, PrepareApproveIntegratorParams, PrepareLighterFastWithdrawParams, SetLighterSubAccountMetadataParams, SubmitApproveIntegratorParams, SubmitChangePubKeyParams, SubmitLighterFastWithdrawParams, TransferLighterSubAccountParams };

package/dist/misc/responses.js

@@ -1,85 +0,0 @@
-import { z } from 'zod';
-import { LighterAccountTier } from './payloads';
-
-const CreateApiKeyWithMessageResult = z.object({
-  privateKey: z.string(),
-  publicKey: z.string(),
-  apiKeyIndex: z.number(),
-  messageToSign: z.string(),
-  txInfo: z.string()
-});
-const SubmitChangePubKeyResult = z.object({
-  txHash: z.string()
-});
-const PrepareApproveIntegratorResult = z.object({
-  messageToSign: z.string(),
-  txInfo: z.string()
-});
-const SubmitApproveIntegratorResult = z.object({
-  txHash: z.string()
-});
-const CreateAuthTokenResult = z.object({
-  token: z.string()
-});
-const PrepareLighterFastWithdrawResult = z.object({
-  messageToSign: z.string(),
-  txInfo: z.string(),
-  // Integer USDC units Lighter charges on top of the amount, quoted for this exact transfer.
-  fee: z.number().int().nonnegative(),
-  // Integer USDC units the account could still move when the transfer was signed.
-  availableBalance: z.number().int().nonnegative()
-});
-const SubmitLighterFastWithdrawResult = z.object({
-  txHash: z.string()
-});
-const CreateLighterSubAccountResult = z.object({
-  txHash: z.string()
-});
-const TransferLighterSubAccountResult = z.object({
-  txHash: z.string()
-});
-const ChangeLighterAccountTierResult = z.object({
-  // The tier Lighter accepted. Its own acknowledgement names no tier, so this echoes the request.
-  tier: LighterAccountTier
-});
-const LighterUdaResolution = z.object({
-  toChainId: z.string(),
-  toTokenAddress: z.string(),
-  actionType: z.string(),
-  recipientAddr: z.string(),
-  userId: z.string()
-});
-const CreateLighterUdaResult = z.object({
-  uda: z.discriminatedUnion("status", [
-    z.object({
-      status: z.literal("blocked")
-    }),
-    z.object({
-      status: z.literal("served"),
-      depositAddr: z.string(),
-      resolved: LighterUdaResolution,
-      // Absent rather than blank on a chain family the bridge does not currently serve.
-      solanaAddr: z.string().min(1).optional(),
-      tronAddr: z.string().min(1).optional(),
-      btcAddrSegwit: z.string().min(1).optional()
-    })
-  ])
-});
-const LighterUdaTransaction = z.object({
-  fromChainId: z.string(),
-  fromTokenAddress: z.string(),
-  fromAmountBaseUnit: z.string(),
-  toChainId: z.string(),
-  toTokenAddress: z.string(),
-  // Failed bridge transactions can stop before Fun.xyz assigns a transaction hash.
-  txHash: z.string().optional(),
-  // A transaction the bridge has only just detected can arrive before it stamps a creation time.
-  createdTimeMs: z.number().optional(),
-  status: z.string(),
-  depositAddr: z.string()
-});
-const ListLighterUdaDepositsResult = z.object({
-  transactions: z.array(LighterUdaTransaction)
-});
-
-export { ChangeLighterAccountTierResult, CreateApiKeyWithMessageResult, CreateAuthTokenResult, CreateLighterSubAccountResult, CreateLighterUdaResult, LighterUdaResolution, LighterUdaTransaction, ListLighterUdaDepositsResult, PrepareApproveIntegratorResult, PrepareLighterFastWithdrawResult, SubmitApproveIntegratorResult, SubmitChangePubKeyResult, SubmitLighterFastWithdrawResult, TransferLighterSubAccountResult };