@pear-protocol/types 1.18.0 → 1.19.0

package/dist/users/entities.d.ts

@@ -15,3 +15,9 @@ export declare const UserProfile: z.ZodObject<{
 }, z.core.$strip>;
 export type UserPreferences = z.infer<typeof UserPreferences>;
 export type UserProfile = z.infer<typeof UserProfile>;
+export declare const ReferralReferee: z.ZodObject<{
+    address: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
+    referredAt: z.ZodOptional<z.ZodNumber>;
+    tradeCount: z.ZodNumber;
+}, z.core.$strip>;
+export type ReferralReferee = z.infer<typeof ReferralReferee>;

package/dist/users/entities.js

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { EthereumAddress } from '../common/address';
 
 const UserPreferences = z.object({
   slippageToleranceBps: z.int().describe("User slippage preference in basis points")
@@ -11,5 +12,10 @@ const UserProfile = z.object({
   email: z.string().nullable().describe("Linked email address (for email provider)"),
   emailVerified: z.boolean().describe("Whether the email is verified")
 }).describe("User profile of the authenticated user");
+const ReferralReferee = z.object({
+  address: EthereumAddress.optional().describe("Linked EVM wallet address when the referee has one"),
+  referredAt: z.number().int().nonnegative().optional().describe("V3 attribution time in epoch milliseconds; not the original legacy on-chain referral time"),
+  tradeCount: z.number().int().nonnegative().describe("Distinct Pear executions with at least one real confirmed fill")
+});
 
-export { UserPreferences, UserProfile };
+export { ReferralReferee, UserPreferences, UserProfile };

package/dist/users/index.d.ts

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

package/dist/users/index.js

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

package/dist/users/queries.d.ts

@@ -0,0 +1,8 @@
+/** Query contracts for authenticated referral history. */
+import { z } from 'zod';
+export declare const ReferralRefereeListParams: z.ZodObject<{
+    cursor: z.ZodOptional<z.ZodString>;
+    limit: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<number>>>;
+}, z.core.$strip>;
+export type ReferralRefereeListParamsInput = z.input<typeof ReferralRefereeListParams>;
+export type ReferralRefereeListParams = z.output<typeof ReferralRefereeListParams>;

package/dist/users/queries.js

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { CursorFindParams } from '../common/request';
+
+const ReferralRefereeListParams = CursorFindParams.extend({
+  limit: z.coerce.number().int().positive().max(100).optional().default(20)
+});
+
+export { ReferralRefereeListParams };

package/dist/users/response.d.ts

@@ -28,6 +28,17 @@ export declare const UpdateUserDisplayNameResponse: z.ZodObject<{
 export type UpdateUserDisplayNameResponse = z.infer<typeof UpdateUserDisplayNameResponse>;
 export declare const ReferralStatusResponse: z.ZodObject<{
     ownedCodes: z.ZodArray<z.ZodString>;
-    referrerUserId: z.ZodOptional<z.ZodUUID>;
+    referrerCode: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type ReferralStatusResponse = z.infer<typeof ReferralStatusResponse>;
+export declare const ReferralRefereeListResponse: z.ZodObject<{
+    limit: z.ZodNumber;
+    nextCursor: z.ZodOptional<z.ZodString>;
+    count: z.ZodNumber;
+    referees: z.ZodArray<z.ZodObject<{
+        address: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
+        referredAt: z.ZodOptional<z.ZodNumber>;
+        tradeCount: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ReferralRefereeListResponse = z.infer<typeof ReferralRefereeListResponse>;

package/dist/users/response.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
-import { UserPreferences, UserProfile } from './entities';
+import { CursorResponse } from '../common/response';
+import { UserPreferences, UserProfile, ReferralReferee } from './entities';
 
 const ProfileResponse = z.object({
   profile: UserProfile,
@@ -13,7 +14,11 @@ const UpdateUserDisplayNameResponse = z.object({
 });
 const ReferralStatusResponse = z.object({
   ownedCodes: z.array(z.string()).describe("Exact case-sensitive referral codes owned by the authenticated user"),
-  referrerUserId: z.uuid().optional().describe("User that permanently referred the authenticated user")
+  referrerCode: z.string().optional().describe("Exact case-sensitive code owned by the permanent referrer")
+});
+const ReferralRefereeListResponse = CursorResponse.extend({
+  count: z.number().int().nonnegative().describe("Total V3 users permanently bound to the authenticated referrer"),
+  referees: z.array(ReferralReferee)
 });
 
-export { ProfileResponse, ReferralStatusResponse, UpdateUserDisplayNameResponse, UpdateUserPreferencesResponse };
+export { ProfileResponse, ReferralRefereeListResponse, ReferralStatusResponse, UpdateUserDisplayNameResponse, UpdateUserPreferencesResponse };

package/package.json

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