@pear-protocol/types 1.25.1 → 1.26.0

package/dist/auth/payloads.d.ts

@@ -18,6 +18,9 @@ export declare const LinkWalletRequest: z.ZodObject<{
 export declare const StartXLinkRequest: z.ZodObject<{
     returnTo: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+export declare const SetXVisibilityRequest: z.ZodObject<{
+    xHidden: z.ZodBoolean;
+}, z.core.$strip>;
 export declare const StartXLoginRequest: z.ZodObject<{
     returnTo: z.ZodOptional<z.ZodString>;
     handoffId: z.ZodString;
@@ -83,6 +86,7 @@ export type EmailRegisterRequest = z.infer<typeof EmailRegisterRequest>;
 export type LinkEmailRequest = z.infer<typeof LinkEmailRequest>;
 export type LinkWalletRequest = z.infer<typeof LinkWalletRequest>;
 export type StartXLinkRequest = z.infer<typeof StartXLinkRequest>;
+export type SetXVisibilityRequest = z.infer<typeof SetXVisibilityRequest>;
 export type StartXLoginRequest = z.infer<typeof StartXLoginRequest>;
 export type ExchangeXLoginRequest = z.infer<typeof ExchangeXLoginRequest>;
 export type EmailLoginRequest = z.infer<typeof EmailLoginRequest>;

package/dist/auth/payloads.js

@@ -24,6 +24,9 @@ const LinkWalletRequest = z.object({
 const StartXLinkRequest = z.object({
   returnTo: z.string().optional().describe("Page to send the browser back to once the link finishes, normally the page the user is on. Must be on the calling origin; defaults to that origin.")
 }).describe("Start of the X account link flow");
+const SetXVisibilityRequest = z.object({
+  xHidden: z.boolean().describe("True to withhold the linked X account from the leaderboard, false to publish it. The wanted state rather than a flip, so a retry lands on the same result and two tabs cannot disagree. Named to match `xHidden` on the user profile - one name for one value.")
+}).describe("Leaderboard visibility of the X account");
 const PkceValue = z.string().regex(/^[A-Za-z0-9_-]{43}$/, "Must be 43 base64url characters");
 const StartXLoginRequest = z.object({
   returnTo: z.string().optional().describe("Page to send the browser back to once the sign-in finishes, normally the page the user is on. Must be on the calling origin; defaults to that origin. Any fragment is dropped - the flow returns its ticket there."),
@@ -78,4 +81,4 @@ const OauthInteractionConfirmRequest = z.object({
   scopes: z.array(z.string()).default([]).describe("The scope set the user granted at consent (opaque to the AS; empty resolves to the read-only fail-safe)")
 }).describe("Consent confirmation body \u2014 the granted scope set");
 
-export { ChangePasswordRequest, EmailLoginRequest, EmailRegisterRequest, ExchangeXLoginRequest, ForgotPasswordRequest, LinkEmailRequest, LinkWalletRequest, LoginRequest, LogoutRequest, OauthInteractionConfirmRequest, RefreshTokenRequest, RequestNonceRequest, ResendVerificationForRegisterRequest, ResetPasswordRequest, StartXLinkRequest, StartXLoginRequest, VerifyEmailRequest, WalletLoginRequest };
+export { ChangePasswordRequest, EmailLoginRequest, EmailRegisterRequest, ExchangeXLoginRequest, ForgotPasswordRequest, LinkEmailRequest, LinkWalletRequest, LoginRequest, LogoutRequest, OauthInteractionConfirmRequest, RefreshTokenRequest, RequestNonceRequest, ResendVerificationForRegisterRequest, ResetPasswordRequest, SetXVisibilityRequest, StartXLinkRequest, StartXLoginRequest, VerifyEmailRequest, WalletLoginRequest };

package/dist/auth/response.d.ts

@@ -54,6 +54,9 @@ export declare const LinkWalletResponse: z.ZodVoid;
 export declare const StartXLinkResponse: z.ZodObject<{
     authorizeUrl: z.ZodString;
 }, z.core.$strip>;
+export declare const SetXVisibilityResponse: z.ZodObject<{
+    xHidden: z.ZodBoolean;
+}, z.core.$strip>;
 export declare const DisconnectXResponse: z.ZodVoid;
 export declare const StartXLoginResponse: z.ZodObject<{
     authorizeUrl: z.ZodString;
@@ -137,6 +140,7 @@ export type RegisterEmailResponse = z.infer<typeof RegisterEmailResponse>;
 export type LinkEmailResponse = z.infer<typeof LinkEmailResponse>;
 export type LinkWalletResponse = z.infer<typeof LinkWalletResponse>;
 export type StartXLinkResponse = z.infer<typeof StartXLinkResponse>;
+export type SetXVisibilityResponse = z.infer<typeof SetXVisibilityResponse>;
 export type DisconnectXResponse = z.infer<typeof DisconnectXResponse>;
 export type StartXLoginResponse = z.infer<typeof StartXLoginResponse>;
 export type MeResponse = z.infer<typeof MeResponse>;

package/dist/auth/response.js

@@ -37,6 +37,9 @@ const LinkWalletResponse = z.void().describe("Successful wallet link response");
 const StartXLinkResponse = z.object({
   authorizeUrl: z.string().describe("X authorization URL to send the browser to. Expires with the flow's state.")
 }).describe("Start of the X account link flow");
+const SetXVisibilityResponse = z.object({
+  xHidden: z.boolean().describe("The stored state, read back from the write: true when the leaderboard withholds the X account. A confirmation of what was asked for, not a value the caller could not otherwise know.")
+}).describe("Leaderboard visibility of the X account after the write");
 const DisconnectXResponse = z.void().describe("Successful X account disconnect response");
 const StartXLoginResponse = z.object({
   authorizeUrl: z.string().describe("X authorization URL to send the browser to. Expires with the flow's state.")
@@ -76,4 +79,4 @@ const OauthInteractionRedirectResponse = z.object({
   returnTo: z.string().describe("Provider URL to redirect the browser back to")
 }).describe("OAuth interaction redirect target after login/confirm/abort");
 
-export { ChangePasswordResponse, DisconnectXResponse, ForgotPasswordResponse, LinkEmailResponse, LinkWalletResponse, LoginResponse, LogoutResponse, MeResponse, OauthGrant, OauthGrantsResponse, OauthInteractionClient, OauthInteractionDetailsResponse, OauthInteractionRedirectResponse, RefreshSessionResponse, RefreshTokenResponse, RegisterEmailResponse, RequestNonceResponse, ResendVerificationResponse, ResetPasswordResponse, StartXLinkResponse, StartXLoginResponse, VerifyEmailResponse };
+export { ChangePasswordResponse, DisconnectXResponse, ForgotPasswordResponse, LinkEmailResponse, LinkWalletResponse, LoginResponse, LogoutResponse, MeResponse, OauthGrant, OauthGrantsResponse, OauthInteractionClient, OauthInteractionDetailsResponse, OauthInteractionRedirectResponse, RefreshSessionResponse, RefreshTokenResponse, RegisterEmailResponse, RequestNonceResponse, ResendVerificationResponse, ResetPasswordResponse, SetXVisibilityResponse, StartXLinkResponse, StartXLoginResponse, VerifyEmailResponse };

package/dist/common/schema.d.ts

@@ -1,5 +1,12 @@
 import z from 'zod';
 export declare const UnsignedDecimalString: z.ZodString;
+/**
+ * Decimal string with an OPTIONAL sign ("0.8", "+0.8", "-0.1115").
+ * Sits between UnsignedDecimalString (no sign allowed) and SignedDecimalString
+ * (sign required): use it for wire fields that historically shipped unsigned but
+ * must now also carry negative values, so existing clients keep parsing.
+ */
+export declare const DecimalString: z.ZodString;
 export declare const SignedDecimalString: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
 export declare const Side: z.ZodEnum<{
     BUY: "BUY";

package/dist/common/schema.js

@@ -1,6 +1,7 @@
 import z from 'zod';
 
 const UnsignedDecimalString = z.string().regex(/^\d+(\.\d+)?$/, "Must be a valid decimal string");
+const DecimalString = z.string().regex(/^[+-]?\d+(\.\d+)?$/, "Must be a valid decimal string");
 const SignedDecimalString = z.string().regex(/^[+-]\d+(\.\d+)?$/, "Must be a valid signed decimal string").transform((val) => val);
 const Side = z.enum([
   "BUY",
@@ -14,4 +15,4 @@ const AssetWeight = z.number().positive({
   message: "Weight must be less than 1"
 });
 
-export { AssetWeight, Side, SignedDecimalString, UnsignedDecimalString };
+export { AssetWeight, DecimalString, Side, SignedDecimalString, UnsignedDecimalString };

package/dist/misc/payloads.d.ts

@@ -31,3 +31,20 @@ export declare const CreateAuthTokenParams: z.ZodObject<{
     ttlSeconds: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export type CreateAuthTokenParams = z.output<typeof CreateAuthTokenParams>;
+export declare const PrepareLighterFastWithdrawParams: z.ZodObject<{
+    accountIndex: z.ZodNumber;
+    toAddress: z.ZodString;
+    amount: z.ZodNumber;
+    apiKeyIndex: z.ZodNumber;
+    apiPrivateKey: z.ZodString;
+}, z.core.$strip>;
+export type PrepareLighterFastWithdrawParams = z.output<typeof PrepareLighterFastWithdrawParams>;
+export declare const SubmitLighterFastWithdrawParams: z.ZodObject<{
+    accountIndex: z.ZodNumber;
+    toAddress: z.ZodString;
+    apiKeyIndex: z.ZodNumber;
+    apiPrivateKey: z.ZodString;
+    txInfo: z.ZodString;
+    l1Signature: z.ZodString;
+}, z.core.$strip>;
+export type SubmitLighterFastWithdrawParams = z.output<typeof SubmitLighterFastWithdrawParams>;

package/dist/misc/payloads.js

@@ -27,5 +27,20 @@ const CreateAuthTokenParams = z.object({
   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()
+});
 
-export { CreateAuthTokenParams, CreateLighterApiKeyParams, PrepareApproveIntegratorParams, SubmitApproveIntegratorParams, SubmitChangePubKeyParams };
+export { CreateAuthTokenParams, CreateLighterApiKeyParams, PrepareApproveIntegratorParams, PrepareLighterFastWithdrawParams, SubmitApproveIntegratorParams, SubmitChangePubKeyParams, SubmitLighterFastWithdrawParams };

package/dist/misc/responses.d.ts

@@ -24,3 +24,12 @@ export declare const CreateAuthTokenResult: z.ZodObject<{
     token: z.ZodString;
 }, z.core.$strip>;
 export type CreateAuthTokenResult = z.output<typeof CreateAuthTokenResult>;
+export declare const PrepareLighterFastWithdrawResult: z.ZodObject<{
+    messageToSign: z.ZodString;
+    txInfo: z.ZodString;
+}, z.core.$strip>;
+export type PrepareLighterFastWithdrawResult = z.output<typeof PrepareLighterFastWithdrawResult>;
+export declare const SubmitLighterFastWithdrawResult: z.ZodObject<{
+    txHash: z.ZodString;
+}, z.core.$strip>;
+export type SubmitLighterFastWithdrawResult = z.output<typeof SubmitLighterFastWithdrawResult>;

package/dist/misc/responses.js

@@ -20,5 +20,12 @@ const SubmitApproveIntegratorResult = z.object({
 const CreateAuthTokenResult = z.object({
   token: z.string()
 });
+const PrepareLighterFastWithdrawResult = z.object({
+  messageToSign: z.string(),
+  txInfo: z.string()
+});
+const SubmitLighterFastWithdrawResult = z.object({
+  txHash: z.string()
+});
 
-export { CreateApiKeyWithMessageResult, CreateAuthTokenResult, PrepareApproveIntegratorResult, SubmitApproveIntegratorResult, SubmitChangePubKeyResult };
+export { CreateApiKeyWithMessageResult, CreateAuthTokenResult, PrepareApproveIntegratorResult, PrepareLighterFastWithdrawResult, SubmitApproveIntegratorResult, SubmitChangePubKeyResult, SubmitLighterFastWithdrawResult };

package/dist/statistics/entities.js

@@ -8,9 +8,13 @@ const LeaderboardRow = z.object({
   // Address for Hyperliquid/Lighter, exchange account UID for CEXes.
   exchangeIdentifier: z.string(),
   connector: Connector,
+  // Every fill inside the window, whatever period its position began in — so unlike the
+  // money fields below, this can report trading whose fees and PnL belong to another window.
   volume: z.string(),
+  // Positions the window watched open, as are the fees and the return beside them.
   grossRealizedPnl: z.string(),
-  // Zero on a ranged board — unrealized PnL is only meaningful as of now.
+  // Zero once the window has closed — unrealized PnL is a value as of now, so only a window
+  // that still contains now can report it. A window ending in the future does.
   grossUpnl: z.string(),
   // Net funding carry over the range, signed: negative when the trader paid to hold.
   // Account-level, so a client-scoped board reports the account's whole carry —
@@ -25,13 +29,22 @@ const LeaderboardRow = z.object({
   // Every position is weighted equally, so a small winner counts as much as a large one —
   // this is a measure of the trader's decisions, not of the dollars those decisions moved.
   //
-  // Each position is measured against the size it opened with. An open position contributes
-  // its unrealized PnL, a closed one what it realized after fees.
+  // One formula on every position: (realized + unrealized - fees paid) over the size it
+  // opened with. A closed position holds nothing, so its unrealized half is zero and this
+  // reduces to what the trader kept; a partly reduced open position counts both the profit
+  // it banked and the worth of what it still holds. Only fees of fills that happened are
+  // charged, so a running position never pays for the exit it has not made.
+  //
+  // Measured only where the window holds both the position's open and the moment the
+  // measurement is taken at: now for a running position, the closing fill for a finished
+  // one. A position that closed after the window ended is therefore left out — the window
+  // holds only part of what it realized, and part of a return is not a return.
   //
   // Absent when the board could measure none of the account's positions — never "0", which
   // would claim a break-even trader. An account reaches the board with nothing measurable
-  // when its only activity in scope is a fill on a position opened before startDate, or when
-  // none of its positions recorded an opening size.
+  // when its only trading in the window closed positions opened before it, when a closed
+  // window left its open positions unpriced, when every position it opened in the window
+  // closed after it, or when a position recorded no opening size.
   roi: z.string().optional(),
   // The trader's linked X account. Absent for an account whose owner has connected no X
   // account, and absent for an anonymous caller: the board itself is public, but pairing a

package/dist/statistics/queries.js

@@ -59,9 +59,17 @@ const LeaderboardQueryParams = z.object({
   // walk is independent, so selecting a subset leaves every remaining walk complete.
   asset: AssetArray.optional(),
   sortBy: LeaderboardSortBy.default("totalNetPnl"),
+  // Inclusive, and it scopes the money without scoping the trading. Volume and totalTrades
+  // count every fill inside the window, whatever period its position began in. Realized
+  // PnL, unrealized PnL, the fees behind them and roi count only for a position whose
+  // opening fill lands at or after this, so an exit is never booked — nor its fee charged —
+  // against an entry the window never saw. Volume is therefore additive across two adjacent
+  // windows and PnL is not, and a row can report volume beside no fees at all.
   startDate: UnixSeconds.optional(),
-  // Absent endDate means the live board: unrealized PnL is included. Any
-  // endDate at all yields a settled, reproducible board with no unrealized.
+  // Exclusive. Unrealized PnL is included whenever the window still contains now — an
+  // absent endDate, or one that has not yet arrived. Only a window that has already closed
+  // is settled and reproducible, and only there is unrealized PnL omitted: it is a value as
+  // of now, and now is outside such a window.
   endDate: UnixSeconds.optional(),
   limit: z.coerce.number().int().positive().max(LEADERBOARD_MAX_LIMIT).default(LEADERBOARD_MAX_LIMIT)
 }).refine((data) => !data.startDate || !data.endDate || data.startDate < data.endDate, {

package/dist/sync/payloads.js

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { RefineMinimumOneKeyValuePair } from '../common/refinement';
-import { UnsignedDecimalString, Side, SignedDecimalString } from '../common/schema';
+import { UnsignedDecimalString, DecimalString, Side, SignedDecimalString } from '../common/schema';
 import { Connector } from '../connector';
 import { InstrumentId } from '../instrument';
 import { PositionClosedReason, PositionStatus, PositionOrigin } from '../position/entities';
@@ -10,6 +10,7 @@ const MsTimestamp = z.number().int().positive().describe("Unix timestamp in mill
 const LiquidationMark = z.object({
   mark: UnsignedDecimalString
 }).nullable();
+const TradeFee = DecimalString;
 const OriginalFillRef = z.object({
   exchangeFillId: ExchangeFillId,
   quantity: UnsignedDecimalString
@@ -24,7 +25,7 @@ const UnknownExternalFill = z.object({
   side: Side,
   reduceOnly: z.boolean(),
   timestamp: MsTimestamp,
-  tradeFee: UnsignedDecimalString,
+  tradeFee: TradeFee,
   builderFee: UnsignedDecimalString,
   liquidation: LiquidationMark
 });
@@ -37,7 +38,7 @@ const ConfirmableExternalFill = z.object({
   symbol: InstrumentId,
   quantity: UnsignedDecimalString,
   timestamp: MsTimestamp,
-  tradeFee: UnsignedDecimalString,
+  tradeFee: TradeFee,
   builderFee: UnsignedDecimalString
 });
 const ReconcileReplacementExternalFill = z.object({
@@ -50,7 +51,7 @@ const ReconcileReplacementExternalFill = z.object({
   side: Side,
   reduceOnly: z.boolean(),
   timestamp: MsTimestamp,
-  tradeFee: UnsignedDecimalString,
+  tradeFee: TradeFee,
   builderFee: UnsignedDecimalString,
   liquidation: LiquidationMark
 });
@@ -89,7 +90,7 @@ const ApplicableFill = z.object({
   reduceOnly: z.boolean(),
   synthetic: z.boolean(),
   isExternal: z.boolean(),
-  tradeFee: UnsignedDecimalString,
+  tradeFee: TradeFee,
   builderFee: UnsignedDecimalString,
   closedReason: PositionClosedReason.optional().describe("e.g. NETTED for a synthetic close fill"),
   liquidation: LiquidationMark.optional(),

package/dist/users/entities.d.ts

@@ -15,6 +15,7 @@ export declare const UserProfile: z.ZodObject<{
     xHandle: z.ZodNullable<z.ZodString>;
     xName: z.ZodNullable<z.ZodString>;
     xAvatarUrl: z.ZodNullable<z.ZodString>;
+    xHidden: z.ZodBoolean;
 }, z.core.$strip>;
 export type UserPreferences = z.infer<typeof UserPreferences>;
 export type UserProfile = z.infer<typeof UserProfile>;

package/dist/users/entities.js

@@ -18,7 +18,11 @@ const UserProfile = z.object({
   // conventions inside one object costs more than following its neighbours.
   xHandle: z.string().nullable().describe('Linked X handle, without the leading "@" (for x provider)'),
   xName: z.string().nullable().describe("Linked X display name"),
-  xAvatarUrl: z.string().nullable().describe("Linked X avatar URL")
+  xAvatarUrl: z.string().nullable().describe("Linked X avatar URL"),
+  // A plain boolean rather than nullable, matching `emailVerified` above: this is the
+  // owner's own setting, which is known whether or not an X account is linked. With none
+  // linked it describes what would happen once one is.
+  xHidden: z.boolean().describe("Whether the leaderboard withholds the linked X account")
 }).describe("User profile of the authenticated user");
 const ReferralReferee = z.object({
   address: EthereumAddress.optional().describe("Linked EVM wallet address when the referee has one"),

package/dist/users/response.d.ts

@@ -13,6 +13,7 @@ export declare const ProfileResponse: z.ZodObject<{
         xHandle: z.ZodNullable<z.ZodString>;
         xName: z.ZodNullable<z.ZodString>;
         xAvatarUrl: z.ZodNullable<z.ZodString>;
+        xHidden: z.ZodBoolean;
     }, z.core.$strip>;
     preferences: z.ZodObject<{
         slippageToleranceBps: z.ZodInt;

package/package.json

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