feat(ChainSymbol): make work with ChainSymbol in string way (return s…

…till ChainSymbol)

src/__tests__/index.test.ts

@@ -83,7 +83,7 @@ describe("SDK", () => {
 
     const sourceChainToken: TokenWithChainDetails = {
       ...basicTokenInfoWithChainDetails,
-      chainSymbol: "GRL",
+      chainSymbol: "GRL" as ChainSymbol,
       decimals: 18,
       feeShare: "0",
     };
@@ -134,7 +134,7 @@ describe("SDK", () => {
     const scope: nock.Scope = nock("http://localhost");
     const sourceChainToken: TokenWithChainDetails = {
       ...basicTokenInfoWithChainDetails,
-      chainSymbol: "GRL",
+      chainSymbol: "GRL" as ChainSymbol,
       decimals: 6,
       feeShare: "0",
     };
@@ -194,7 +194,7 @@ describe("SDK", () => {
     const scope: nock.Scope = nock("http://localhost");
     const sourceChainToken: TokenWithChainDetails = {
       ...basicTokenInfoWithChainDetails,
-      chainSymbol: "GRL",
+      chainSymbol: "GRL" as ChainSymbol,
       decimals: 18,
       feeShare: "0.003",
     };
@@ -613,7 +613,7 @@ describe("SDK", () => {
     const grlChainToken: TokenWithChainDetails = {
       ...basicTokenInfoWithChainDetails,
       allbridgeChainId: 2,
-      chainSymbol: "GRL",
+      chainSymbol: "GRL" as ChainSymbol,
       bridgeAddress: "0xba285A8F52601EabCc769706FcBDe2645aa0AF18",
       tokenAddress: "0xDdaC3cb57DEa3fBEFF4997d78215535Eb5787117",
       decimals: 18,
@@ -622,7 +622,7 @@ describe("SDK", () => {
     const grlChainToken2: TokenWithChainDetails = {
       ...basicTokenInfoWithChainDetails,
       allbridgeChainId: 2,
-      chainSymbol: "GRL",
+      chainSymbol: "GRL" as ChainSymbol,
       bridgeAddress: "0xba285A8F52601EabCc769706FcBDe2645aa0AF18",
       tokenAddress: "0xC7DBC4A896b34B7a10ddA2ef72052145A9122F43",
       decimals: 18,

src/__tests__/mock/utils.ts

@@ -1,6 +1,6 @@
 import nock, { Body, RequestBodyMatcher } from "nock";
 import { Chains } from "../../chains";
-import { ChainType } from "../../chains/chain.enums";
+import { ChainSymbol, ChainType } from "../../chains/chain.enums";
 import { PoolInfo, TokenWithChainDetails } from "../../tokens-info";
 
 export function getRequestBodyMatcher(expectedBody: any): RequestBodyMatcher {
@@ -9,7 +9,7 @@ export function getRequestBodyMatcher(expectedBody: any): RequestBodyMatcher {
 export function initChainsWithTestnet() {
   Chains.addChainsProperties({
     GRL: {
-      chainSymbol: "GRL",
+      chainSymbol: "GRL" as ChainSymbol,
       chainId: "0x5",
       name: "Goerli",
       chainType: ChainType.EVM,

src/__tests__/services/bridge/evm/index.test.ts

@@ -1,7 +1,7 @@
 import Web3 from "web3";
 import { Messenger } from "../../../../client/core-api/core-api.model";
 import { AllbridgeCoreClientWithPoolInfo } from "../../../../client/core-api/core-client-base";
-import { FeePaymentMethod, SendParams, TokenWithChainDetails } from "../../../../models";
+import { ChainSymbol, FeePaymentMethod, SendParams, TokenWithChainDetails } from "../../../../models";
 import { NodeRpcUrlsConfig } from "../../../../services";
 import { EvmBridgeService } from "../../../../services/bridge/evm";
 import { ChainDetailsMapWithFlags } from "../../../../tokens-info";
@@ -42,14 +42,14 @@ describe("EvmBridge", () => {
         sourceToken: {
           bridgeAddress: bridgeAddress,
           allbridgeChainId: 2,
-          chainSymbol: "GRL",
+          chainSymbol: "GRL" as ChainSymbol,
           decimals: 18,
           tokenAddress: "0xc7dbc4a896b34b7a10dda2ef72052145a9122f43",
         } as TokenWithChainDetails,
         fromAccountAddress: from,
         destinationToken: {
           allbridgeChainId: 4,
-          chainSymbol: "GRL",
+          chainSymbol: "GRL" as ChainSymbol,
           decimals: 18,
           tokenAddress: "0xb10388f04f8331b59a02732cc1b6ac0d7045574b",
         } as TokenWithChainDetails,

src/chains/models.ts

@@ -1,4 +1,4 @@
-import { ChainType } from "./chain.enums";
+import { ChainSymbol, ChainType } from "./chain.enums";
 
 /**
  * Contains blockchain's basic information
@@ -7,7 +7,7 @@ export interface BasicChainProperties {
   /**
    * The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: {@link ChainSymbol}.
    */
-  chainSymbol: string;
+  chainSymbol: ChainSymbol;
   /**
    * Common Blockchain Id</br>
    * A 0x-prefixed hexadecimal string</br>
@@ -23,3 +23,9 @@ export interface BasicChainProperties {
    */
   chainType: ChainType;
 }
+export interface AdditionalBasicChainProperties extends Omit<BasicChainProperties, "chainSymbol"> {
+  /**
+   * The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: {@link ChainSymbol}.
+   */
+  chainSymbol: string;
+}

src/client/core-api/core-api-mapper.ts

@@ -1,4 +1,5 @@
 import { Chains } from "../../chains";
+import { ChainSymbol } from "../../chains/chain.enums";
 import {
   ChainDetails,
   ChainDetailsMap,
@@ -75,7 +76,7 @@ function mapMessengerKeyDtoToMessenger(dto: MessengerKeyDTO): Messenger | null {
 
 function mapTransferTimeFromDto(dto: TransferTimeDTO): TransferTime {
   return Object.entries(dto).reduce<TransferTime>((result, [key, value]) => {
-    result[key] = mapMessengerTransferTimeFromDto(value);
+    result[key as ChainSymbol] = mapMessengerTransferTimeFromDto(value);
     return result;
   }, {});
 }

src/client/core-api/core-api.model.ts

@@ -1,3 +1,4 @@
+import { ChainSymbol } from "../../chains/chain.enums";
 import { PoolInfo } from "../../tokens-info";
 
 export type ChainDetailsResponse = Record<string, ChainDetailsDTO>;
@@ -97,8 +98,8 @@ export interface CheckAddressResponse {
 export interface TransferStatusResponse {
   txId: string;
 
-  sourceChainSymbol: string;
-  destinationChainSymbol: string;
+  sourceChainSymbol: ChainSymbol;
+  destinationChainSymbol: ChainSymbol;
 
   sendAmount: string;
   sendAmountFormatted: number;
@@ -155,8 +156,8 @@ export interface BridgeTransaction {
   isClaimable?: boolean;
 }
 
-export type PoolInfoResponse = Record<string, PoolInfo>;
-export type PendingInfoResponse = Record<string, TokenPendingInfoDTO>;
+export type PoolInfoResponse = Record<ChainSymbol, PoolInfo>;
+export type PendingInfoResponse = Partial<Record<ChainSymbol, TokenPendingInfoDTO>>;
 export type TokenPendingInfoDTO = Record<string, PendingInfoDTO>;
 
 export interface PendingInfoDTO {

src/index.ts

@@ -1,5 +1,5 @@
 import { BigSource } from "big.js";
-import { BasicChainProperties } from "./chains/models";
+import { AdditionalBasicChainProperties } from "./chains/models";
 import { mainnet } from "./configs";
 import {
   AmountFormat,
@@ -65,7 +65,7 @@ export interface AllbridgeCoreSdkOptions {
    * @Internal
    * Optional additional properties to merge with the default properties.
    */
-  additionalChainsProperties?: Record<string, BasicChainProperties>;
+  additionalChainsProperties?: Record<string, AdditionalBasicChainProperties>;
 }
 
 /**

src/models/index.ts

@@ -50,7 +50,7 @@ export { SrbUtils, TrustLineParams } from "../utils/srb";
 export { SolUtils } from "../utils/sol";
 export * from "../exceptions";
 export { ChainSymbol, ChainType } from "../chains/chain.enums";
-export { BasicChainProperties } from "../chains/models";
+export { AdditionalBasicChainProperties, BasicChainProperties } from "../chains/models";
 
 export enum FeePaymentMethod {
   /**

src/services/index.ts

@@ -14,7 +14,7 @@ import { AllbridgeCoreClientImpl } from "../client/core-api/core-client-base";
 import { AllbridgeCoreClientFiltered, AllbridgeCoreClientFilteredImpl } from "../client/core-api/core-client-filtered";
 import { AllbridgeCoreClientPoolInfoCaching } from "../client/core-api/core-client-pool-info-caching";
 import { mainnet } from "../configs";
-import { AllbridgeCoreSdkOptions, NodeRpcUrls, SdkError } from "../index";
+import { AllbridgeCoreSdkOptions, BasicChainProperties, NodeRpcUrls, SdkError } from "../index";
 import {
   AmountFormat,
   AmountFormatted,
@@ -81,7 +81,7 @@ export class AllbridgeCoreSdkService {
   pool: LiquidityPoolService;
 
   constructor(nodeRpcUrlsConfig: NodeRpcUrlsConfig, params: AllbridgeCoreSdkOptions = mainnet) {
-    Chains.addChainsProperties(params.additionalChainsProperties);
+    Chains.addChainsProperties(params.additionalChainsProperties as Record<string, BasicChainProperties>);
     const apiClient = new ApiClientImpl(params);
     const apiClientCaching = new ApiClientCaching(apiClient);
     const coreClient = new AllbridgeCoreClientImpl(apiClientCaching);

src/tokens-info/tokens-info.model.ts

@@ -1,3 +1,4 @@
+import { ChainSymbol } from "../chains/chain.enums";
 import { BasicChainProperties } from "../chains/models";
 import { Messenger } from "../client/core-api/core-api.model";
 
@@ -175,10 +176,12 @@ export interface PoolInfo {
  * Type representing transfer times for various blockchain chains.
  *
  * @typedef {Record<string, MessengerTransferTime>} TransferTime
- * @property {string} chainSymbol - The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: {@link ChainSymbol}.
+ * @property {chain} chainSymbol
  * @property {MessengerTransferTime} transferTime - The average transfer time details for the specified chain.
  */
-export type TransferTime = Record<string, MessengerTransferTime>;
+export type TransferTime = {
+  [chain in ChainSymbol]?: MessengerTransferTime;
+};
 
 /**
  * Contains Avg transaction time withing different messenger protocols