@luxexchange/api 1.0.0

package/src/clients/conversionTracking/api_pb.ts

@@ -0,0 +1,184 @@
+// Follow up to remove: WEB-5827
+// @generated by protoc-gen-es v1.10.0 with parameter "target=ts"
+// @generated from file conversionproxy/v1/api.proto (package conversionproxy.v1, syntax proto3)
+
+import type {
+  BinaryReadOptions,
+  FieldList,
+  JsonReadOptions,
+  JsonValue,
+  PartialMessage,
+  PlainMessage,
+} from '@bufbuild/protobuf'
+import { Message, proto3 } from '@bufbuild/protobuf'
+
+/**
+ * @generated from message conversionproxy.v1.Header
+ */
+export class Header extends Message<Header> {
+  /**
+   * @generated from field: string key = 1;
+   */
+  key = ''
+
+  /**
+   * @generated from field: string value = 2;
+   */
+  value = ''
+
+  constructor(data?: PartialMessage<Header>) {
+    super()
+    proto3.util.initPartial(data, this)
+  }
+
+  static readonly runtime: typeof proto3 = proto3
+  static readonly typeName = 'conversionproxy.v1.Header'
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: 'key', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: 'value', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+  ])
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Header {
+    return new Header().fromBinary(bytes, options)
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Header {
+    return new Header().fromJson(jsonValue, options)
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Header {
+    return new Header().fromJsonString(jsonString, options)
+  }
+
+  static equals(a: Header | PlainMessage<Header> | undefined, b: Header | PlainMessage<Header> | undefined): boolean {
+    return proto3.util.equals(Header, a, b)
+  }
+}
+
+/**
+ * @generated from message conversionproxy.v1.ProxyRequest
+ */
+export class ProxyRequest extends Message<ProxyRequest> {
+  /**
+   * @generated from field: string requestType = 1;
+   */
+  requestType = ''
+
+  /**
+   * @generated from field: string identifier = 2;
+   */
+  identifier = ''
+
+  /**
+   * @generated from field: string to = 3;
+   */
+  to = ''
+
+  /**
+   * @generated from field: string method = 4;
+   */
+  method = ''
+
+  /**
+   * @generated from field: optional string body = 5;
+   */
+  body?: string
+
+  /**
+   * @generated from field: repeated conversionproxy.v1.Header headers = 6;
+   */
+  headers: Header[] = []
+
+  constructor(data?: PartialMessage<ProxyRequest>) {
+    super()
+    proto3.util.initPartial(data, this)
+  }
+
+  static readonly runtime: typeof proto3 = proto3
+  static readonly typeName = 'conversionproxy.v1.ProxyRequest'
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: 'requestType', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: 'identifier', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: 'to', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 4, name: 'method', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 5, name: 'body', kind: 'scalar', T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 6, name: 'headers', kind: 'message', T: Header, repeated: true },
+  ])
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ProxyRequest {
+    return new ProxyRequest().fromBinary(bytes, options)
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ProxyRequest {
+    return new ProxyRequest().fromJson(jsonValue, options)
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ProxyRequest {
+    return new ProxyRequest().fromJsonString(jsonString, options)
+  }
+
+  static equals(
+    a: ProxyRequest | PlainMessage<ProxyRequest> | undefined,
+    b: ProxyRequest | PlainMessage<ProxyRequest> | undefined,
+  ): boolean {
+    return proto3.util.equals(ProxyRequest, a, b)
+  }
+}
+
+/**
+ * @generated from message conversionproxy.v1.ProxyResponse
+ */
+export class ProxyResponse extends Message<ProxyResponse> {
+  /**
+   * @generated from field: int32 status = 1;
+   */
+  status = 0
+
+  /**
+   * @generated from field: string statusText = 2;
+   */
+  statusText = ''
+
+  /**
+   * @generated from field: string body = 3;
+   */
+  body = ''
+
+  /**
+   * @generated from field: repeated conversionproxy.v1.Header headers = 4;
+   */
+  headers: Header[] = []
+
+  constructor(data?: PartialMessage<ProxyResponse>) {
+    super()
+    proto3.util.initPartial(data, this)
+  }
+
+  static readonly runtime: typeof proto3 = proto3
+  static readonly typeName = 'conversionproxy.v1.ProxyResponse'
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: 'status', kind: 'scalar', T: 5 /* ScalarType.INT32 */ },
+    { no: 2, name: 'statusText', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: 'body', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 4, name: 'headers', kind: 'message', T: Header, repeated: true },
+  ])
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ProxyResponse {
+    return new ProxyResponse().fromBinary(bytes, options)
+  }
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ProxyResponse {
+    return new ProxyResponse().fromJson(jsonValue, options)
+  }
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ProxyResponse {
+    return new ProxyResponse().fromJsonString(jsonString, options)
+  }
+
+  static equals(
+    a: ProxyResponse | PlainMessage<ProxyResponse> | undefined,
+    b: ProxyResponse | PlainMessage<ProxyResponse> | undefined,
+  ): boolean {
+    return proto3.util.equals(ProxyResponse, a, b)
+  }
+}

package/src/clients/conversionTracking/index.ts

@@ -0,0 +1,4 @@
+// eslint-disable-next-line check-file/no-index
+export { ConversionProxyService } from '@luxfi/api/src/clients/conversionTracking/api_connect'
+export { Header, ProxyRequest, ProxyResponse } from '@luxfi/api/src/clients/conversionTracking/api_pb'
+export { proxy } from '@luxfi/api/src/clients/conversionTracking/api-ConversionProxyService_connectquery'

package/src/clients/data/createDataServiceApiClient.ts

@@ -0,0 +1,101 @@
+import type { FetchClient } from '@luxfi/api/src/clients/base/types'
+import { logger } from '@luxfi/utilities/src/logger/logger'
+
+export const DATA_SERVICE_API_PATHS = {
+  report: '/SubmitReport',
+}
+
+export interface DataServiceApiClientContext {
+  fetchClient: FetchClient
+}
+
+export interface DataServiceApiClient {
+  submitTokenReport: (params: SubmitTokenReportParams) => Promise<void>
+}
+
+export function createDataServiceApiClient(ctx: DataServiceApiClientContext): DataServiceApiClient {
+  const { fetchClient } = ctx
+  return {
+    submitTokenReport: (params: SubmitTokenReportParams) => submitTokenReport({ ...params, fetchClient }),
+  }
+}
+
+/**
+ * Defines the types of events that can be reported for a token.
+ */
+export enum TokenReportEventType {
+  // Reported when a token/NFT is spam but not marked as such.
+  FalseNegative = 'TOKEN_REPORT_EVENT_TYPE_FALSE_NEGATIVE',
+  // Reported when a token/NFT is marked as spam but is not.
+  FalsePositive = 'TOKEN_REPORT_EVENT_TYPE_FALSE_POSITIVE',
+}
+
+export enum ReportAssetType {
+  Token = 'Token',
+  NFT = 'NFT',
+}
+
+interface SubmitReportRequestBody {
+  chainId: number
+  address: string
+  event: TokenReportEventType
+  details: string
+}
+
+interface SubmitTokenReportParams {
+  chainId: number
+  address: string
+  event: TokenReportEventType
+  assetType: ReportAssetType
+}
+
+interface SubmitReportResponse {
+  success: boolean
+}
+
+const ASSET_TO_REPORT_STRING = {
+  [ReportAssetType.Token]: 'User reported as a spam token',
+  [ReportAssetType.NFT]: 'User reported as a spam NFT',
+}
+
+/**
+ * Submits a report about a token (e.g., marking spam or correcting a false spam flag).
+ * @param chainId The chain ID where the token resides.
+ * @param address The address of the token contract.
+ * @param event The type of report event (FalseNegative or FalsePositive).
+ */
+async function submitTokenReport({
+  chainId,
+  address,
+  event,
+  assetType,
+  fetchClient,
+}: SubmitTokenReportParams & { fetchClient: FetchClient }): Promise<void> {
+  const requestBody: SubmitReportRequestBody = {
+    chainId,
+    address,
+    event,
+    details: ASSET_TO_REPORT_STRING[assetType],
+  }
+
+  try {
+    logger.debug('DataApiClient', 'submitTokenReport', `Submitting report: ${JSON.stringify(requestBody)}`)
+
+    const responseData = await fetchClient.post<SubmitReportResponse>(DATA_SERVICE_API_PATHS.report, {
+      body: JSON.stringify(requestBody),
+    })
+
+    if (!responseData.success) {
+      throw new Error('API Error: Report submission indicated failure')
+    }
+
+    logger.debug('DataApiClient', 'submitTokenReport', 'Report submitted successfully')
+  } catch (error) {
+    logger.error(error, {
+      tags: { file: 'createDataServiceApiClient.ts', function: 'submitTokenReport' },
+      extra: { url: `${fetchClient.context().baseUrl}${DATA_SERVICE_API_PATHS.report}`, requestBody },
+    })
+    // Re-throw the error caught from createApiClient or handle it
+    throw error
+  }
+}

package/src/clients/dataApi/createDataApiServiceClient.ts

@@ -0,0 +1,29 @@
+import { type PartialMessage } from '@bufbuild/protobuf'
+import { type PromiseClient } from '@connectrpc/connect'
+import { type DataApiService } from '@uniswap/client-data-api/dist/data/v1/api_connect'
+import type {
+  GetPortfolioRequest,
+  GetPortfolioResponse,
+  ListTopPoolsRequest,
+  ListTopPoolsResponse,
+  ListTopTokensRequest,
+  ListTopTokensResponse,
+} from '@uniswap/client-data-api/dist/data/v1/api_pb'
+
+export interface DataApiServiceClientContext {
+  rpcClient: PromiseClient<typeof DataApiService>
+}
+
+export interface DataApiServiceClient {
+  getPortfolio: (params: PartialMessage<GetPortfolioRequest>) => Promise<GetPortfolioResponse>
+  listTopTokens: (params: PartialMessage<ListTopTokensRequest>) => Promise<ListTopTokensResponse>
+  listTopPools: (params: PartialMessage<ListTopPoolsRequest>) => Promise<ListTopPoolsResponse>
+}
+
+export function createDataApiServiceClient({ rpcClient }: DataApiServiceClientContext): DataApiServiceClient {
+  return {
+    getPortfolio: (params): Promise<GetPortfolioResponse> => rpcClient.getPortfolio(params),
+    listTopTokens: (params): Promise<ListTopTokensResponse> => rpcClient.listTopTokens(params),
+    listTopPools: (params): Promise<ListTopPoolsResponse> => rpcClient.listTopPools(params),
+  }
+}

package/src/clients/dataApi/getGetPortfolioQueryOptions.test.ts

@@ -0,0 +1,122 @@
+import type { GetPortfolioResponse } from '@uniswap/client-data-api/dist/data/v1/api_pb'
+import type { DataApiServiceClient } from '@luxexchange/api/src/clients/dataApi/createDataApiServiceClient'
+import { getGetPortfolioQueryOptions } from '@luxexchange/api/src/clients/dataApi/getGetPortfolioQueryOptions'
+import { ReactQueryCacheKey } from '@luxfi/utilities/src/reactQuery/cache'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+
+describe('getGetPortfolioQueryOptions', () => {
+  let mockClient: DataApiServiceClient
+
+  const createMockResponse = (): GetPortfolioResponse => ({ portfolio: undefined }) as unknown as GetPortfolioResponse
+
+  beforeEach(() => {
+    mockClient = {
+      getPortfolio: vi.fn().mockResolvedValue(createMockResponse()),
+      listTopTokens: vi.fn(),
+      listTopPools: vi.fn(),
+    }
+  })
+
+  describe('queryKey', () => {
+    it('uses GetPortfolio cache key and address key for evmAddress only', () => {
+      const options = getGetPortfolioQueryOptions(mockClient, {
+        input: { evmAddress: '0xabc', chainIds: [1] },
+      })
+      expect(options.queryKey).toEqual([
+        ReactQueryCacheKey.GetPortfolio,
+        { evmAddress: '0xabc' },
+        expect.objectContaining({ chainIds: [1] }),
+      ])
+    })
+
+    it('uses GetPortfolio cache key and address key for svmAddress only', () => {
+      const options = getGetPortfolioQueryOptions(mockClient, {
+        input: { svmAddress: 'solana-address', chainIds: [1] },
+      })
+      expect(options.queryKey).toEqual([
+        ReactQueryCacheKey.GetPortfolio,
+        { svmAddress: 'solana-address' },
+        expect.objectContaining({ chainIds: [1] }),
+      ])
+    })
+
+    it('includes both evmAddress and svmAddress in address key when provided', () => {
+      const options = getGetPortfolioQueryOptions(mockClient, {
+        input: { evmAddress: '0xabc', svmAddress: 'solana', chainIds: [1] },
+      })
+      expect(options.queryKey[0]).toBe(ReactQueryCacheKey.GetPortfolio)
+      expect(options.queryKey[1]).toEqual({ evmAddress: '0xabc', svmAddress: 'solana' })
+    })
+
+    it('sorts chainIds in query key for stable cache key', () => {
+      const options = getGetPortfolioQueryOptions(mockClient, {
+        input: { evmAddress: '0xabc', chainIds: [3, 1, 2] },
+      })
+      const cacheInputs = options.queryKey[2] as { chainIds?: number[] }
+      expect(cacheInputs['chainIds']).toEqual([1, 2, 3])
+    })
+
+    it('produces same query key for same logical input regardless of chainIds order', () => {
+      const options1 = getGetPortfolioQueryOptions(mockClient, {
+        input: { evmAddress: '0xabc', chainIds: [3, 1, 2] },
+      })
+      const options2 = getGetPortfolioQueryOptions(mockClient, {
+        input: { evmAddress: '0xabc', chainIds: [2, 1, 3] },
+      })
+      expect(options1.queryKey).toEqual(options2.queryKey)
+    })
+  })
+
+  describe('queryFn', () => {
+    it('returns undefined when input is undefined', async () => {
+      const options = getGetPortfolioQueryOptions(mockClient, {})
+      const result = await options.queryFn?.({ queryKey: options.queryKey } as unknown as Parameters<
+        NonNullable<typeof options.queryFn>
+      >[0])
+      expect(result).toBeUndefined()
+      expect(mockClient.getPortfolio).not.toHaveBeenCalled()
+    })
+
+    it('calls client.getPortfolio with transformed input (walletAccount) and returns response', async () => {
+      const options = getGetPortfolioQueryOptions(mockClient, {
+        input: { evmAddress: '0x123', chainIds: [1] },
+      })
+      const result = await options.queryFn?.({ queryKey: options.queryKey } as unknown as Parameters<
+        NonNullable<typeof options.queryFn>
+      >[0])
+      expect(mockClient.getPortfolio).toHaveBeenCalledTimes(1)
+      const callArg = (mockClient.getPortfolio as ReturnType<typeof vi.fn>).mock.calls[0][0]
+      expect(callArg).toHaveProperty('walletAccount')
+      expect(callArg.walletAccount).toHaveProperty('platformAddresses')
+      expect(callArg.walletAccount.platformAddresses).toHaveLength(1)
+      expect(callArg.walletAccount.platformAddresses[0]).toMatchObject({ address: '0x123' })
+      expect(callArg).toMatchObject({ chainIds: [1] })
+      expect(result).toEqual(createMockResponse())
+    })
+
+    it('includes svmAddress in walletAccount when provided', async () => {
+      const options = getGetPortfolioQueryOptions(mockClient, {
+        input: { svmAddress: 'svm-addr', chainIds: [1] },
+      })
+      await options.queryFn?.({ queryKey: options.queryKey } as unknown as Parameters<
+        NonNullable<typeof options.queryFn>
+      >[0])
+      const callArg = (mockClient.getPortfolio as ReturnType<typeof vi.fn>).mock.calls[0][0]
+      const svmEntry = callArg.walletAccount.platformAddresses.find(
+        (p: { address: string }) => p.address === 'svm-addr',
+      )
+      expect(svmEntry).toBeDefined()
+    })
+  })
+
+  describe('options', () => {
+    it('placeholderData returns previous data', () => {
+      const options = getGetPortfolioQueryOptions(mockClient, { input: { evmAddress: '0x' } })
+      expect(options.placeholderData).toBeDefined()
+      const prev = createMockResponse()
+      expect(
+        (options.placeholderData as (prev: GetPortfolioResponse | undefined) => GetPortfolioResponse | undefined)(prev),
+      ).toBe(prev)
+    })
+  })
+})

package/src/clients/dataApi/getGetPortfolioQueryOptions.ts

@@ -0,0 +1,76 @@
+import { type PartialMessage } from '@bufbuild/protobuf'
+import { queryOptions } from '@tanstack/react-query'
+import type { GetPortfolioRequest, GetPortfolioResponse } from '@uniswap/client-data-api/dist/data/v1/api_pb'
+import { type DataApiServiceClient } from '@luxexchange/api/src/clients/dataApi/createDataApiServiceClient'
+import { transformInput, type WithoutWalletAccount } from '@luxexchange/api/src/connectRpc/utils'
+import { ReactQueryCacheKey } from '@luxfi/utilities/src/reactQuery/cache'
+import { type QueryOptionsResult } from '@luxfi/utilities/src/reactQuery/queryOptions'
+
+/**
+ * Sorts `chainIds` in a query cache inputs object so that the same logical input
+ * produces a stable cache key regardless of array order.
+ */
+function isNumberArray(arr: unknown): arr is number[] {
+  return Array.isArray(arr) && arr.every((id): id is number => typeof id === 'number')
+}
+
+function sortQueryCacheInputs(inputs: Record<string, unknown>): Record<string, unknown> {
+  const result = { ...inputs }
+  if (isNumberArray(result['chainIds'])) {
+    result['chainIds'] = [...result['chainIds']].sort((a, b) => a - b)
+  }
+  return result
+}
+
+/** Input used to build queryKey and queryFn. Config (enabled, refetchInterval, select) is applied by the caller. */
+export type GetPortfolioQueryParams = {
+  input?: WithoutWalletAccount<PartialMessage<GetPortfolioRequest>> & {
+    evmAddress?: string
+    svmAddress?: string
+  }
+}
+
+type GetPortfolioQueryKey = readonly [
+  ReactQueryCacheKey.GetPortfolio,
+  { evmAddress?: string; svmAddress?: string },
+  Record<string, unknown>,
+]
+
+/**
+ * Returns React Query options for DataApiService GetPortfolio (queryKey, queryFn, placeholderData only).
+ * Callers should merge in config (enabled, refetchInterval, select) when building the final options.
+ *
+ * @example
+ * const client = createDataApiServiceClient({ rpcClient: createPromiseClient(DataApiService, transport) })
+ * const baseOptions = getGetPortfolioQueryOptions(client, { input: { evmAddress, chainIds } })
+ * const { data } = useQuery({ ...baseOptions, enabled, select })
+ */
+export function getGetPortfolioQueryOptions(
+  client: DataApiServiceClient,
+  { input }: GetPortfolioQueryParams,
+): QueryOptionsResult<GetPortfolioResponse | undefined, Error, GetPortfolioResponse | undefined, GetPortfolioQueryKey> {
+  const transformedInput = transformInput(input)
+
+  const { modifier: _modifier, walletAccount: _walletAccount, ...queryCacheInputs } = transformedInput ?? {}
+
+  const queryCacheInputsSorted = sortQueryCacheInputs(queryCacheInputs)
+
+  const addressKey = {
+    ...(input?.evmAddress && { evmAddress: input.evmAddress }),
+    ...(input?.svmAddress && { svmAddress: input.svmAddress }),
+  }
+
+  return queryOptions({
+    queryKey: [ReactQueryCacheKey.GetPortfolio, addressKey, queryCacheInputsSorted] as const,
+    queryFn: async (): Promise<GetPortfolioResponse | undefined> => {
+      if (!transformedInput) {
+        return undefined
+      }
+      const response: GetPortfolioResponse = await client.getPortfolio(
+        transformedInput as PartialMessage<GetPortfolioRequest>,
+      )
+      return response
+    },
+    placeholderData: (prev: GetPortfolioResponse | undefined) => prev,
+  })
+}