[OTE-762] Affiliates comlink affiliate info

indexer/packages/postgres/__tests__/helpers/constants.ts

@@ -75,6 +75,7 @@ export const blockedAddress: string = 'dydx1f9k5qldwmqrnwy8hcgp4fw6heuvszt35egvt
 export const vaultAddress: string = 'dydx1c0m5x87llaunl5sgv3q5vd7j5uha26d2q2r2q0';
 
 // ============== Subaccounts ==============
+export const defaultWalletAddress: string = 'defaultWalletAddress';
 
 export const defaultSubaccount: SubaccountCreateObject = {
   address: defaultAddress,
@@ -97,6 +98,14 @@ export const defaultSubaccount3: SubaccountCreateObject = {
   updatedAtHeight: createdHeight,
 };
 
+// defaultWalletAddress belongs to defaultWallet2 and is different from defaultAddress
+export const defaultSubaccountDefaultWalletAddress: SubaccountCreateObject = {
+  address: defaultWalletAddress,
+  subaccountNumber: 0,
+  updatedAt: createdDateTime.toISO(),
+  updatedAtHeight: createdHeight,
+};
+
 export const defaultSubaccountWithAlternateAddress: SubaccountCreateObject = {
   address: defaultAddress2,
   subaccountNumber: 0,
@@ -125,8 +134,6 @@ export const isolatedSubaccount2: SubaccountCreateObject = {
   updatedAtHeight: createdHeight,
 };
 
-export const defaultWalletAddress: string = 'defaultWalletAddress';
-
 export const defaultSubaccountId: string = SubaccountTable.uuid(
   defaultAddress,
   defaultSubaccount.subaccountNumber,
@@ -139,6 +146,10 @@ export const defaultSubaccountId3: string = SubaccountTable.uuid(
   defaultAddress,
   defaultSubaccount3.subaccountNumber,
 );
+export const defaultSubaccountIdDefaultWalletAddress: string = SubaccountTable.uuid(
+  defaultWalletAddress,
+  defaultSubaccountDefaultWalletAddress.subaccountNumber,
+);
 export const defaultSubaccountIdWithAlternateAddress: string = SubaccountTable.uuid(
   defaultAddress2,
   defaultSubaccountWithAlternateAddress.subaccountNumber,
@@ -906,6 +917,17 @@ export const duplicatedSubaccountUsername: SubaccountUsernamesCreateObject = {
   subaccountId: defaultSubaccountId3,
 };
 
+// defaultWalletAddress belongs to defaultWallet2 and is different from defaultAddress
+export const subaccountUsernameWithDefaultWalletAddress: SubaccountUsernamesCreateObject = {
+  username: 'EvilRaisin11',
+  subaccountId: defaultSubaccountIdDefaultWalletAddress,
+};
+
+export const subaccountUsernameWithAlternativeAddress: SubaccountUsernamesCreateObject = {
+  username: 'HonestRaisin32',
+  subaccountId: defaultSubaccountIdWithAlternateAddress,
+};
+
 // ============== Leaderboard pnl Data ==============
 
 export const defaultLeaderboardPnlOneDay: LeaderboardPnlCreateObject = {
@@ -963,24 +985,38 @@ export const defaultKV2: PersistentCacheCreateObject = {
 
 export const defaultAffiliateInfo: AffiliateInfoCreateObject = {
   address: defaultAddress,
-  affiliateEarnings: '10.00',
+  affiliateEarnings: '10',
   referredMakerTrades: 10,
   referredTakerTrades: 20,
-  totalReferredFees: '10.00',
+  totalReferredFees: '10',
   totalReferredUsers: 5,
-  referredNetProtocolEarnings: '20.00',
+  referredNetProtocolEarnings: '20',
   firstReferralBlockHeight: '1',
+  referredTotalVolume: '1000',
 };
 
-export const defaultAffiliateInfo1: AffiliateInfoCreateObject = {
-  address: defaultAddress2,
-  affiliateEarnings: '11.00',
+export const defaultAffiliateInfo2: AffiliateInfoCreateObject = {
+  address: defaultWalletAddress,
+  affiliateEarnings: '11',
   referredMakerTrades: 11,
   referredTakerTrades: 21,
-  totalReferredFees: '11.00',
+  totalReferredFees: '11',
   totalReferredUsers: 5,
-  referredNetProtocolEarnings: '21.00',
+  referredNetProtocolEarnings: '21',
   firstReferralBlockHeight: '11',
+  referredTotalVolume: '1000',
+};
+
+export const defaultAffiliateInfo3: AffiliateInfoCreateObject = {
+  address: defaultAddress2,
+  affiliateEarnings: '12',
+  referredMakerTrades: 12,
+  referredTakerTrades: 22,
+  totalReferredFees: '12',
+  totalReferredUsers: 10,
+  referredNetProtocolEarnings: '22',
+  firstReferralBlockHeight: '12',
+  referredTotalVolume: '1111111',
 };
 
 // ==============  Tokens  =============

indexer/packages/postgres/__tests__/stores/affiliate-info-table.test.ts

@@ -1,6 +1,6 @@
 import { AffiliateInfoFromDatabase } from '../../src/types';
 import { clearData, migrate, teardown } from '../../src/helpers/db-helpers';
-import { defaultAffiliateInfo, defaultAffiliateInfo1 } from '../helpers/constants';
+import { defaultAffiliateInfo, defaultAffiliateInfo2 } from '../helpers/constants';
 import * as AffiliateInfoTable from '../../src/stores/affiliate-info-table';
 
 describe('Affiliate info store', () => {
@@ -32,15 +32,15 @@ describe('Affiliate info store', () => {
     );
     expect(info).toEqual(expect.objectContaining(defaultAffiliateInfo));
 
-    await AffiliateInfoTable.upsert(defaultAffiliateInfo1);
-    info = await AffiliateInfoTable.findById(defaultAffiliateInfo1.address);
-    expect(info).toEqual(expect.objectContaining(defaultAffiliateInfo1));
+    await AffiliateInfoTable.upsert(defaultAffiliateInfo2);
+    info = await AffiliateInfoTable.findById(defaultAffiliateInfo2.address);
+    expect(info).toEqual(expect.objectContaining(defaultAffiliateInfo2));
   });
 
   it('Successfully finds all affiliate infos', async () => {
     await Promise.all([
       AffiliateInfoTable.create(defaultAffiliateInfo),
-      AffiliateInfoTable.create(defaultAffiliateInfo1),
+      AffiliateInfoTable.create(defaultAffiliateInfo2),
     ]);
 
     const infos: AffiliateInfoFromDatabase[] = await AffiliateInfoTable.findAll(
@@ -52,7 +52,7 @@ describe('Affiliate info store', () => {
     expect(infos.length).toEqual(2);
     expect(infos).toEqual(expect.arrayContaining([
       expect.objectContaining(defaultAffiliateInfo),
-      expect.objectContaining(defaultAffiliateInfo1),
+      expect.objectContaining(defaultAffiliateInfo2),
     ]));
   });
 
@@ -65,4 +65,100 @@ describe('Affiliate info store', () => {
 
     expect(info).toEqual(expect.objectContaining(defaultAffiliateInfo));
   });
+
+  describe('paginatedFindWithAddressFilter', () => {
+    beforeEach(async () => {
+      await migrate();
+      for (let i = 0; i < 10; i++) {
+        await AffiliateInfoTable.create({
+          ...defaultAffiliateInfo,
+          address: `address_${i}`,
+          affiliateEarnings: i.toString(),
+        });
+      }
+    });
+
+    it('Successfully filters by address', async () => {
+      // eslint-disable-next-line max-len
+      const infos: AffiliateInfoFromDatabase[] | undefined = await AffiliateInfoTable.paginatedFindWithAddressFilter(
+        ['address_0'],
+        0,
+        10,
+        false,
+      );
+      expect(infos).toBeDefined();
+      expect(infos!.length).toEqual(1);
+      expect(infos![0]).toEqual(expect.objectContaining({
+        ...defaultAffiliateInfo,
+        address: 'address_0',
+        affiliateEarnings: '0',
+      }));
+    });
+
+    it('Successfully sorts by affiliate earning', async () => {
+      // eslint-disable-next-line max-len
+      const infos: AffiliateInfoFromDatabase[] | undefined = await AffiliateInfoTable.paginatedFindWithAddressFilter(
+        [],
+        0,
+        10,
+        true,
+      );
+      expect(infos).toBeDefined();
+      expect(infos!.length).toEqual(10);
+      expect(infos![0]).toEqual(expect.objectContaining({
+        ...defaultAffiliateInfo,
+        address: 'address_9',
+        affiliateEarnings: '9',
+      }));
+      expect(infos![9]).toEqual(expect.objectContaining({
+        ...defaultAffiliateInfo,
+        address: 'address_0',
+        affiliateEarnings: '0',
+      }));
+    });
+
+    it('Successfully uses offset and limit', async () => {
+      // eslint-disable-next-line max-len
+      const infos: AffiliateInfoFromDatabase[] | undefined = await AffiliateInfoTable.paginatedFindWithAddressFilter(
+        [],
+        5,
+        2,
+        false,
+      );
+      expect(infos).toBeDefined();
+      expect(infos!.length).toEqual(2);
+      expect(infos![0]).toEqual(expect.objectContaining({
+        ...defaultAffiliateInfo,
+        address: 'address_5',
+        affiliateEarnings: '5',
+      }));
+      expect(infos![1]).toEqual(expect.objectContaining({
+        ...defaultAffiliateInfo,
+        address: 'address_6',
+        affiliateEarnings: '6',
+      }));
+    });
+
+    it('Successfully filters, sorts, offsets, and limits', async () => {
+      // eslint-disable-next-line max-len
+      const infos: AffiliateInfoFromDatabase[] | undefined = await AffiliateInfoTable.paginatedFindWithAddressFilter(
+        [],
+        3,
+        2,
+        true,
+      );
+      expect(infos).toBeDefined();
+      expect(infos!.length).toEqual(2);
+      expect(infos![0]).toEqual(expect.objectContaining({
+        ...defaultAffiliateInfo,
+        address: 'address_6',
+        affiliateEarnings: '6',
+      }));
+      expect(infos![1]).toEqual(expect.objectContaining({
+        ...defaultAffiliateInfo,
+        address: 'address_5',
+        affiliateEarnings: '5',
+      }));
+    });
+  });
 });

indexer/packages/postgres/__tests__/stores/subaccount-usernames-table.test.ts

@@ -1,11 +1,16 @@
 import { SubaccountFromDatabase, SubaccountUsernamesFromDatabase, SubaccountsWithoutUsernamesResult } from '../../src/types';
 import * as SubaccountUsernamesTable from '../../src/stores/subaccount-usernames-table';
+import * as WalletTable from '../../src/stores/wallet-table';
 import * as SubaccountsTable from '../../src/stores/subaccount-table';
 import { clearData, migrate, teardown } from '../../src/helpers/db-helpers';
 import {
   defaultSubaccountUsername,
   defaultSubaccountUsername2,
+  defaultSubaccountWithAlternateAddress,
+  defaultWallet,
+  defaultWallet2,
   duplicatedSubaccountUsername,
+  subaccountUsernameWithAlternativeAddress,
 } from '../helpers/constants';
 import { seedData } from '../helpers/mock-generators';
 
@@ -80,4 +85,24 @@ describe('SubaccountUsernames store', () => {
     SubaccountUsernamesTable.getSubaccountsWithoutUsernames();
     expect(subaccountIds.length).toEqual(subaccountLength - 1);
   });
+
+  it('Get username using address', async () => {
+    await Promise.all([
+      // Add two usernames for defaultWallet
+      SubaccountUsernamesTable.create(defaultSubaccountUsername),
+      SubaccountUsernamesTable.create(defaultSubaccountUsername2),
+      // Add one username for alternativeWallet
+      WalletTable.create(defaultWallet2),
+      SubaccountsTable.create(defaultSubaccountWithAlternateAddress),
+      SubaccountUsernamesTable.create(subaccountUsernameWithAlternativeAddress),
+    ]);
+
+    // Should only get username for defaultWallet's subaccount 0
+    const usernames = await SubaccountUsernamesTable.findByAddress([defaultWallet.address]);
+    expect(usernames.length).toEqual(1);
+    expect(usernames[0]).toEqual(expect.objectContaining({
+      address: defaultWallet.address,
+      username: defaultSubaccountUsername.username,
+    }));
+  });
 });

indexer/packages/postgres/src/db/migrations/migration_files/20240913142157_change_affiliate_info_decimal_precision_and_add_total_referred_volume.ts

@@ -0,0 +1,22 @@
+import * as Knex from 'knex';
+
+export async function up(knex: Knex): Promise<void> {
+  return knex.schema.alterTable('affiliate_info', (table) => {
+    // null indicates variable precision whereas not specifying will result in 8,2 precision,scale
+    table.decimal('affiliateEarnings', null).alter();
+    table.decimal('totalReferredFees', null).alter();
+    table.decimal('referredNetProtocolEarnings', null).alter();
+
+    table.decimal('referredTotalVolume', null).notNullable();
+  });
+}
+
+export async function down(knex: Knex): Promise<void> {
+  return knex.schema.alterTable('affiliate_info', (table) => {
+    table.decimal('affiliateEarnings').alter();
+    table.decimal('totalReferredFees').alter();
+    table.decimal('referredNetProtocolEarnings').alter();
+
+    table.dropColumn('referredTotalVolume');
+  });
+}

indexer/packages/postgres/src/index.ts

@@ -20,6 +20,7 @@ export { default as SubaccountUsernamesModel } from './models/subaccount-usernam
 export { default as LeaderboardPnlModel } from './models/leaderboard-pnl-model';
 export { default as PersistentCacheModel } from './models/persistent-cache-model';
 export { default as AffiliateReferredUsersModel } from './models/affiliate-referred-users-model';
+export { default as AffiliateInfoModel } from './models/affiliate-info-model';
 
 export * as AssetTable from './stores/asset-table';
 export * as AssetPositionTable from './stores/asset-position-table';
@@ -48,6 +49,7 @@ export * as SubaccountUsernamesTable from './stores/subaccount-usernames-table';
 export * as PersistentCacheTable from './stores/persistent-cache-table';
 export * as AffiliateReferredUsersTable from './stores/affiliate-referred-users-table';
 export * as FirebaseNotificationTokenTable from './stores/firebase-notification-token-table';
+export * as AffiliateInfoTable from './stores/affiliate-info-table';
 
 export * as perpetualMarketRefresher from './loops/perpetual-market-refresher';
 export * as assetRefresher from './loops/asset-refresher';

indexer/packages/postgres/src/models/affiliate-info-model.ts

@@ -23,6 +23,7 @@ export default class AffiliateInfoModel extends BaseModel {
         'totalReferredUsers',
         'referredNetProtocolEarnings',
         'firstReferralBlockHeight',
+        'referredTotalVolume',
       ],
       properties: {
         address: { type: 'string' },
@@ -33,6 +34,7 @@ export default class AffiliateInfoModel extends BaseModel {
         totalReferredUsers: { type: 'int' },
         referredNetProtocolEarnings: { type: 'string', pattern: NonNegativeNumericPattern },
         firstReferralBlockHeight: { type: 'string', pattern: NonNegativeNumericPattern },
+        referredTotalVolume: { type: 'string', pattern: NonNegativeNumericPattern },
       },
     };
   }
@@ -53,6 +55,7 @@ export default class AffiliateInfoModel extends BaseModel {
       totalReferredUsers: 'int',
       referredNetProtocolEarnings: 'string',
       firstReferralBlockHeight: 'string',
+      referredTotalVolume: 'string',
     };
   }
 
@@ -73,4 +76,6 @@ export default class AffiliateInfoModel extends BaseModel {
   referredNetProtocolEarnings!: string;
 
   firstReferralBlockHeight!: string;
+
+  referredTotalVolume!: string;
 }

indexer/packages/postgres/src/stores/affiliate-info-table.ts

@@ -80,6 +80,7 @@ export async function upsert(
   // should only ever be one AffiliateInfo
   return AffiliateInfos[0];
 }
+
 export async function findById(
   address: string,
   options: Options = DEFAULT_POSTGRES_OPTIONS,
@@ -92,3 +93,32 @@ export async function findById(
     .findById(address)
     .returning('*');
 }
+
+export async function paginatedFindWithAddressFilter(
+  addressFilter: string[],
+  offset: number,
+  limit: number,
+  sortByAffiliateEarning: boolean,
+  options: Options = DEFAULT_POSTGRES_OPTIONS,
+): Promise<AffiliateInfoFromDatabase[] | undefined> {
+  let baseQuery: QueryBuilder<AffiliateInfoModel> = setupBaseQuery<AffiliateInfoModel>(
+    AffiliateInfoModel,
+    options,
+  );
+
+  // Apply address filter if provided
+  if (addressFilter.length > 0) {
+    baseQuery = baseQuery.whereIn(AffiliateInfoColumns.address, addressFilter);
+  }
+
+  // Sorting by affiliate earnings or default sorting by address
+  if (sortByAffiliateEarning) {
+    baseQuery = baseQuery.orderBy(AffiliateInfoColumns.affiliateEarnings, Ordering.DESC);
+  }
+
+  // Apply pagination using offset and limit
+  baseQuery = baseQuery.offset(offset).limit(limit);
+
+  // Returning all fields
+  return baseQuery.returning('*');
+}