fix: export some missing types + more data queries (#64)

* export missing data types
* add snxHolders({addresses}) option
* add accountsFlaggedForLiquidation data query
* add synthHolders data query
* fix SnxHolderParams#addresses type
* fix SnxHoldersParams.addresses option
* more missing exports

package.json

@@ -56,5 +56,8 @@
 		"chokidar": "^3.5.2",
 		"fsevents": "^2.3.2",
 		"watchpack-chokidar2": "^2.0.1"
+	},
+	"dependencies": {
+		"bootstrap": "^5.1.0"
 	}
-}
+}

packages/data/__mocks__/accountsFlaggedForLiquidation.ts

@@ -0,0 +1,17 @@
+export const accountsFlaggedForLiquidationMock = {
+	response: {
+		account: '0x3239f49d5298613eb4dbf99b37ce795f3159dcd3',
+		collateral: '21719769773274085136404',
+		collateralRatio: '502838404148398413',
+		deadline: '1604580918',
+		id: '1604580918-0x3239f49d5298613eb4dbf99b37ce795f3159dcd3',
+		liquidatableNonEscrowSNX: '1738257073391178186056',
+	},
+	formatted: {
+		account: '0x3239f49d5298613eb4dbf99b37ce795f3159dcd3',
+		collateral: 21719.769773274085,
+		collateralRatio: 0.5028384041483984,
+		deadline: 1604580918000,
+		liquidatableNonEscrowSNX: 1738.2570733911782,
+	},
+};

packages/data/__mocks__/index.ts

@@ -13,3 +13,7 @@ export * from './binaryOptionsMarkets';
 export * from './binaryOptionsTransactions';
 export * from './exchangeTotals';
 export * from './dailyTotalActiveStakers';
+export * from './accountsFlaggedForLiquidation';
+export * from './dailyBurned';
+export * from './dailyIssued';
+export * from './synthHolders';

packages/data/__mocks__/synthHolders.ts

@@ -0,0 +1,12 @@
+export const synthHoldersMock = {
+	response: {
+		balanceOf: '90038854631941946067435170',
+		id: '0x6c5024cd4f8a59110119c56f8933403a539555eb-sUSD',
+		synth: 'sUSD',
+	},
+	formatted: {
+		balanceOf: 90038854.63194194,
+		address: '0x6c5024cd4f8a59110119c56f8933403a539555eb',
+		synth: 'sUSD',
+	},
+};

packages/data/__tests__/queries.test.ts

@@ -19,6 +19,8 @@ import {
 	parseBinaryOptionTransactions,
 	parseDailyTotalActiveStakers,
 	parseExchangeTotals,
+	parseAccountsFlaggedForLiquidation,
+	parseSynthHolders,
 } from '../queries';
 import synthetixData, { calculateTimestampForPeriod, PERIOD_IN_HOURS } from '../src';
 import { SynthetixData } from '../src/types';
@@ -39,9 +41,11 @@ import {
 	binaryOptionsTransactionsMock,
 	exchangeTotalsMock,
 	dailyTotalActiveStakersMock,
+	accountsFlaggedForLiquidationMock,
+	dailyBurnedMock,
+	dailyIssuedMock,
+	synthHoldersMock,
 } from '../__mocks__';
-import { dailyBurnedMock } from '../__mocks__/dailyBurned';
-import { dailyIssuedMock } from '../__mocks__/dailyIssued';
 
 describe('@synthetixio/data tests', () => {
 	const randomLargeSNXStaker = '0x042ed37d32b88ab6b1c2e7b8a400dcdc728050bc';
@@ -348,6 +352,15 @@ describe('@synthetixio/data tests', () => {
 			expect(Number(snxHoldersInfo![0].balanceOf)).toBeGreaterThan(0);
 			expect(snxHoldersInfo!.length).toEqual(5);
 		});
+
+		test('should accept addresses prop', async () => {
+			const snxHoldersInfo = await snxData.snxHolders({
+				addresses: ['0x49be88f0fcc3a8393a59d3688480d7d253c37d2a'],
+			});
+			expect(Number(snxHoldersInfo![0].collateral)).toBeGreaterThan(0);
+			expect(Number(snxHoldersInfo![0].balanceOf)).toBeGreaterThan(0);
+			expect(snxHoldersInfo!.length).toEqual(1);
+		});
 	});
 
 	describe('exchangeEntrySettleds query', () => {
@@ -436,4 +449,34 @@ describe('@synthetixio/data tests', () => {
 			expect(total.id).toBeGreaterThanOrEqual(1);
 		});
 	});
+
+	describe('accountsFlaggedForLiquidation query', () => {
+		test('should parse the response correctly', () => {
+			const parsedOutput = parseAccountsFlaggedForLiquidation(
+				accountsFlaggedForLiquidationMock.response
+			);
+			expect(accountsFlaggedForLiquidationMock.formatted).toEqual(parsedOutput);
+		});
+
+		test('should accept fiter options', async () => {
+			const accounts = await snxData.accountsFlaggedForLiquidation({ max: 100 });
+			expect(accounts.length).toBeGreaterThanOrEqual(1);
+			const account = accounts[0]!;
+			expect(account.deadline).toBeGreaterThanOrEqual(1);
+		});
+	});
+
+	describe('synthHolders query', () => {
+		test('should parse the response correctly', () => {
+			const parsedOutput = parseSynthHolders(synthHoldersMock.response);
+			expect(synthHoldersMock.formatted).toEqual(parsedOutput);
+		});
+
+		test('should accept fiter options', async () => {
+			const holders = await snxData.synthHolders({ max: 100 });
+			expect(holders.length).toBeGreaterThanOrEqual(1);
+			const holder = holders[0]!;
+			expect(holder.balanceOf).toBeGreaterThanOrEqual(1);
+		});
+	});
 });

packages/data/queries/accountsFlaggedForLiquidation/index.ts

@@ -0,0 +1,2 @@
+export * from './query';
+export * from './parse';

packages/data/queries/accountsFlaggedForLiquidation/parse.ts

@@ -0,0 +1,17 @@
+import { AccountFlaggedForLiquidation as UnformattedAccountFlaggedForLiquidation } from '../../generated/graphql';
+import { AccountFlaggedForLiquidation } from '../../src/types';
+import { formatEther, formatTimestamp } from '../../src/utils';
+
+export const parseAccountsFlaggedForLiquidation = ({
+	deadline,
+	account,
+	collateralRatio,
+	liquidatableNonEscrowSNX,
+	collateral,
+}: UnformattedAccountFlaggedForLiquidation): AccountFlaggedForLiquidation => ({
+	deadline: formatTimestamp(deadline),
+	account,
+	collateral: Number(formatEther(collateral)),
+	collateralRatio: Number(formatEther(collateralRatio)),
+	liquidatableNonEscrowSNX: Number(formatEther(liquidatableNonEscrowSNX)),
+});

packages/data/queries/accountsFlaggedForLiquidation/query.ts

@@ -0,0 +1,32 @@
+import { gql } from 'graphql-request';
+import { AccountsFlaggedForLiquidationParams } from '../../src/types';
+import { createGQLWhereString, createGQLBlockNumberString } from '../../src/utils';
+
+export const createAccountsFlaggedForLiquidationQuery = (
+	params?: AccountsFlaggedForLiquidationParams
+): string => {
+	const whereString = createGQLWhereString(
+		Object.entries({
+			account: (params?.account ?? null) != null ? 'account' : null,
+			deadline_gte: (params?.minTimestamp ?? null) != null ? 'minTimestamp' : null,
+			deadline_lte: (params?.maxTimestamp ?? null) != null ? 'maxTimestamp' : null,
+		})
+	);
+
+	return gql`
+		query accountFlaggedForLiquidations($max: Int, $account: String, $minTimestamp: Int, $maxTimestamp: Int) {
+			accountFlaggedForLiquidations(
+				first: $max${createGQLBlockNumberString(params?.blockNumber ?? null)}
+				where: ${whereString}
+				orderBy: deadline
+				orderDirection: asc
+			) {
+				deadline
+				account
+				collateralRatio
+				liquidatableNonEscrowSNX
+				collateral
+			}
+		}
+	`;
+};

packages/data/queries/exchangeTotals/query.ts

@@ -5,6 +5,7 @@ import { createGQLBlockNumberString } from '../../src/utils';
 export const ENTITY_MAP: Record<string, string> = {
 	'1d': 'dailyTotals',
 	'15m': 'fifteenMinuteTotals',
+	all: 'totals',
 };
 
 export const createExchangeTotalsQuery = (params: ExchangeTotalsParams): string => {

packages/data/queries/index.ts

@@ -34,3 +34,8 @@ export {
 	parseExchangeTotals,
 	getExchangeTotalsQueryResponseAttr,
 } from './exchangeTotals';
+export {
+	createAccountsFlaggedForLiquidationQuery,
+	parseAccountsFlaggedForLiquidation,
+} from './accountsFlaggedForLiquidation';
+export { createSynthHoldersQuery, parseSynthHolders } from './synthHolders';

packages/data/queries/snxHolders/snxHolders.ts

@@ -14,11 +14,12 @@ export const createSnxHolderQuery = (params?: SnxHolderParams): string => {
 				(params?.autoGeneratedPaginationField ?? null) != null
 					? 'autoGeneratedPaginationField'
 					: null,
+			id_in: (params?.addresses ?? null) != null ? 'addresses' : null,
 		})
 	);
 
 	return gql`
-		query snxholders($autoGeneratedPaginationField: Int, $max: Int, $minCollateral: Int, $minClaims: Int, $minMints: Int, $maxCollateral: Int, $address: String) {
+		query snxholders($autoGeneratedPaginationField: Int, $max: Int, $minCollateral: Int, $minClaims: Int, $minMints: Int, $maxCollateral: Int, $addresses: [String]) {
 			snxholders(
 				first: $max${createGQLBlockNumberString(params?.blockNumber ?? null)}
 				where: ${whereString}

packages/data/queries/synthHolders/index.ts

@@ -0,0 +1,2 @@
+export * from './query';
+export * from './parse';

packages/data/queries/synthHolders/parse.ts

@@ -0,0 +1,13 @@
+import { SynthHolder as UnformattedSynthHolder } from '../../generated/graphql';
+import { SynthHolder } from '../../src/types';
+import { formatEther } from '../../src/utils';
+
+export const parseSynthHolders = ({
+	id,
+	synth,
+	balanceOf,
+}: UnformattedSynthHolder): SynthHolder => ({
+	address: id.split('-')[0],
+	synth,
+	balanceOf: Number(formatEther(balanceOf)),
+});

packages/data/queries/synthHolders/query.ts

@@ -0,0 +1,27 @@
+import { gql } from 'graphql-request';
+import { SynthHolderParams } from '../../src/types';
+import { createGQLWhereString, createGQLBlockNumberString } from '../../src/utils';
+
+export const createSynthHoldersQuery = (params?: SynthHolderParams): string => {
+	const whereString = createGQLWhereString(
+		Object.entries({
+			id: (params?.id ?? null) != null ? 'id' : null,
+			synth: (params?.synth ?? null) != null ? 'synth' : null,
+		})
+	);
+
+	return gql`
+		query synthHolders($max: Int, $id: String, $synth: String) {
+			synthHolders(
+				first: $max${createGQLBlockNumberString(params?.blockNumber ?? null)}
+				where: ${whereString}
+				orderBy: balanceOf
+				orderDirection: desc
+			) {
+				id
+        synth
+        balanceOf
+			}
+		}
+	`;
+};

packages/data/src/index.ts

@@ -31,6 +31,10 @@ import {
 	DailyTotalActiveStakersParams,
 	ExchangeTotals,
 	ExchangeTotalsParams,
+	AccountsFlaggedForLiquidationParams,
+	AccountFlaggedForLiquidation,
+	SynthHolderParams,
+	SynthHolder,
 } from './types';
 import {
 	Synthetix,
@@ -301,10 +305,47 @@ const synthetixData = ({ networkId }: { networkId: NetworkId }) => ({
 			? response.totalDailyActiveStakers.map(queries.parseDailyTotalActiveStakers)
 			: null;
 	},
+	accountsFlaggedForLiquidation: async (
+		params?: AccountsFlaggedForLiquidationParams
+	): Promise<AccountFlaggedForLiquidation[] | null> => {
+		const response = await getData({
+			params,
+			queryMethod: queries.createAccountsFlaggedForLiquidationQuery,
+			networkId,
+			endpoints: {
+				[NetworkId.Mainnet]: l1Endpoints.liquidations,
+			},
+		});
+		return response != null
+			? response.accountFlaggedForLiquidations.map(queries.parseAccountsFlaggedForLiquidation)
+			: null;
+	},
+	synthHolders: async (params?: SynthHolderParams): Promise<SynthHolder[] | null> => {
+		const response = await getData({
+			params,
+			queryMethod: queries.createSynthHoldersQuery,
+			networkId,
+			endpoints: {
+				[NetworkId.Mainnet]: l1Endpoints.snx,
+			},
+		});
+		return response != null ? response.synthHolders.map(queries.parseSynthHolders) : null;
+	},
 });
 
 type SynthetixData = ReturnType<typeof synthetixData>;
 
 export { Period, PERIOD_IN_HOURS, calculateTimestampForPeriod, l1Endpoints, l2Endpoints };
-export type { SynthetixData };
+export type {
+	SynthetixData,
+	SynthExchangeExpanded,
+	ExchangeTotals,
+	OptionsMarket,
+	OptionsTransaction,
+	DailyTotalActiveStakers,
+	AccountFlaggedForLiquidation,
+	SynthHolder,
+	DailyIssued,
+	DailyBurned,
+};
 export default synthetixData;

packages/data/src/types.ts

@@ -56,6 +56,7 @@ export type SnxHolderParams = {
 	address?: string;
 	minMints?: number;
 	minClaims?: number;
+	addresses?: string[];
 } & BaseQueryParams;
 
 export type RateUpdateQueryParams = {
@@ -91,6 +92,17 @@ export type ExchangeTotalsParams = {
 	timeSeries: string;
 } & BaseQueryParams;
 
+export type AccountsFlaggedForLiquidationParams = {
+	account?: string;
+	minTimestamp?: number;
+	maxTimestamp?: number;
+} & BaseQueryParams;
+
+export type SynthHolderParams = {
+	id?: string;
+	synth?: string;
+} & BaseQueryParams;
+
 /**
  * Shorts have many relationships between entities although we are not taking advantage
  * of all of them so we are removing the types we don't use
@@ -142,3 +154,17 @@ export type ExchangeTotals = {
 	exchangeUSDTally: number;
 	totalFeesGeneratedInUSD: number;
 };
+
+export type AccountFlaggedForLiquidation = {
+	deadline: number;
+	account: string;
+	collateral: number;
+	collateralRatio: number;
+	liquidatableNonEscrowSNX: number;
+};
+
+export type SynthHolder = {
+	address: string;
+	synth: string;
+	balanceOf: number;
+};