Added getExchangeSupportedAssets endpoint (#49)

* Added getExchangeSupportedAssets endpoint
* Bumped version

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## [1.3.10] - 2023-10-31
+### New
+- Added getExchangeSupportedAssets to gets exchange supported tokens
+
 ## [1.3.9] - 2023-10-28
 ### Bug Fixes
 - Upgraded Apollo package dependencies

examples/09-exchange.ts

@@ -9,6 +9,10 @@ async function main(): Promise<void> {
     chainId: Number(process.env.CHAIN_ID),
     projectKey: '', // project key
   });
+
+  const exchangeSupportedAssets = await primeSdk.getExchangeSupportedAssets({ page: 1, limit: 100 });
+  console.log('\x1b[33m%s\x1b[0m', `Found exchange supported assets:`, exchangeSupportedAssets.items.length);
+
   const fromTokenAddress = '0xe3818504c1b32bf1557b16c238b2e01fd3149c17';
   const toTokenAddress = constants.AddressZero;
   const fromAmount = '1000000000000000000';

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherspot/prime-sdk",
-  "version": "1.3.9",
+  "version": "1.3.10",
   "description": "Etherspot Prime (Account Abstraction) SDK",
   "keywords": [
     "ether",

src/sdk/data/classes/index.ts

@@ -21,3 +21,5 @@ export * from './rate-data';
 export * from './token-list-token';
 export * from './token-list';
 export * from './token-lists';
+export * from './token-list-token';
+export * from './paginated-tokens';

src/sdk/data/classes/paginated-tokens.ts

@@ -0,0 +1,8 @@
+import { Type } from 'class-transformer';
+import { PaginationResult } from '../../common/classes/pagination-result';
+import { TokenListToken } from './token-list-token';
+
+export class PaginatedTokens extends PaginationResult<TokenListToken> {
+  @Type(() => TokenListToken)
+  items: TokenListToken[];
+}

src/sdk/data/classes/token-list-token copy.ts

@@ -0,0 +1,8 @@
+export class TokenListToken {
+  address: string;
+  chainId: number;
+  name: string;
+  symbol: string;
+  decimals: number;
+  logoURI: string;
+}

src/sdk/data/data.service.ts

@@ -1,7 +1,7 @@
 import { gql } from '@apollo/client/core';
 import { HeaderNames, ObjectSubject, Service } from '../common';
 import { Route } from '@lifi/sdk';
-import { AccountBalances, AdvanceRoutesLiFi, BridgingQuotes, ExchangeOffer, ExchangeOffers, NftList, RateData, StepTransaction, StepTransactions, TokenList, TokenListToken, TokenLists, Transaction } from './classes';
+import { AccountBalances, AdvanceRoutesLiFi, BridgingQuotes, ExchangeOffer, ExchangeOffers, NftList, PaginatedTokens, RateData, StepTransaction, StepTransactions, TokenList, TokenListToken, TokenLists, Transaction } from './classes';
 import { BigNumber } from 'ethers';
 import { CrossChainServiceProvider, LiFiBridge } from './constants';
 
@@ -154,6 +154,49 @@ export class DataService extends Service {
     return result;
   }
 
+  async getExchangeSupportedAssets(page: number = null, limit: number = null, ChainId: number, account: string): Promise<PaginatedTokens> {
+    const { apiService } = this.services;
+
+    try {
+      const { result } = await apiService.query<{
+        result: PaginatedTokens;
+      }>(
+        gql`
+        query($ChainId: Int, $account: String!, $page: Int, $limit: Int) {
+          result: exchangeSupportedAssets(chainId: $ChainId, account: $account, page: $page, limit: $limit) {
+            items {
+              address
+              name
+              symbol
+              decimals
+              logoURI
+            }
+            currentPage
+            nextPage
+          }
+        }
+      `,
+        {
+          variables: {
+            account,
+            ChainId,
+            page: page || 1,
+            limit: limit || 100,
+          },
+          models: {
+            result: PaginatedTokens,
+          },
+        },
+      );
+
+      return result;
+
+    } catch (error) {
+      console.error(error);
+      return null;
+    }
+  }
+
   async getExchangeOffers(
     fromTokenAddress: string,
     toTokenAddress: string,

src/sdk/dto/get-exchange-supported-assets.dto.ts

@@ -0,0 +1,8 @@
+import { IsOptional, IsPositive } from 'class-validator';
+import { PaginationDto } from './pagination.dto';
+
+export class GetExchangeSupportedAssetsDto extends PaginationDto {
+  @IsOptional()
+  @IsPositive()
+  chainId?: number;
+}

src/sdk/dto/index.ts

@@ -12,3 +12,5 @@ export * from './get-step-transactions-lifi.dto';
 export * from './get-exchange-cross-chain-quote.dto';
 export * from './fetch-exchange-rates.dto';
 export * from './get-token-list.dto';
+export * from './pagination.dto';
+export * from './get-exchange-supported-assets.dto';

src/sdk/dto/pagination.dto.ts

@@ -0,0 +1,14 @@
+import { IsOptional, IsPositive, IsInt, Max } from 'class-validator';
+
+export class PaginationDto {
+  @IsOptional()
+  @IsPositive()
+  @IsInt()
+  page?: number = null;
+
+  @IsOptional()
+  @IsPositive()
+  @IsInt()
+  @Max(100)
+  limit?: number = null;
+}

src/sdk/sdk.ts

@@ -15,8 +15,8 @@ import { getNetworkConfig, Networks, onRamperAllNetworks } from './network/const
 import { UserOperationStruct } from './contracts/account-abstraction/contracts/core/BaseAccount';
 import { EtherspotWalletAPI, HttpRpcClient, VerifyingPaymasterAPI } from './base';
 import { TransactionDetailsForUserOp, TransactionGasInfoForUserOp } from './base/TransactionDetailsForUserOp';
-import { CreateSessionDto, OnRamperDto, GetAccountBalancesDto, GetAdvanceRoutesLiFiDto, GetExchangeCrossChainQuoteDto, GetExchangeOffersDto, GetNftListDto, GetStepTransactionsLiFiDto, GetTransactionDto, SignMessageDto, validateDto, FetchExchangeRatesDto, GetTokenListDto } from './dto';
-import { AccountBalances, AdvanceRoutesLiFi, BridgingQuotes, ExchangeOffer, NftList, StepTransactions, Transaction, Session, RateData, TokenListToken, TokenList } from './';
+import { CreateSessionDto, OnRamperDto, GetAccountBalancesDto, GetAdvanceRoutesLiFiDto, GetExchangeCrossChainQuoteDto, GetExchangeOffersDto, GetNftListDto, GetStepTransactionsLiFiDto, GetTransactionDto, SignMessageDto, validateDto, FetchExchangeRatesDto, GetTokenListDto, GetExchangeSupportedAssetsDto } from './dto';
+import { AccountBalances, AdvanceRoutesLiFi, BridgingQuotes, ExchangeOffer, NftList, StepTransactions, Transaction, Session, RateData, TokenListToken, TokenList, PaginatedTokens } from './';
 import { ZeroDevWalletAPI } from './base/ZeroDevWalletAPI';
 import { SimpleAccountAPI } from './base/SimpleAccountWalletAPI';
 import { ErrorHandler } from './errorHandler/errorHandler.service';
@@ -361,6 +361,21 @@ export class PrimeSdk {
     );
   }
 
+  /**
+ * gets exchange supported tokens
+ * @param dto
+ * @return Promise<PaginatedTokens>
+ */
+  async getExchangeSupportedAssets(dto: GetExchangeSupportedAssetsDto = {}): Promise<PaginatedTokens> {
+    const { page, limit, chainId } = await validateDto(dto, GetExchangeSupportedAssetsDto);
+
+    const account = await this.getCounterFactualAddress();
+
+    const getChainId = chainId ? chainId : this.etherspotWallet.services.walletService.chainId;
+
+    return this.etherspotWallet.services.dataService.getExchangeSupportedAssets(page, limit, getChainId, account);
+  }
+
   /**
  * gets exchange offers
  * @param dto