@allbridge/bridge-core-sdk 3.35.0-alpha.2 → 3.35.1

package/dist/src/client/core-api/core-api.model.d.ts

@@ -17,6 +17,9 @@ export interface ChainDetailsDTO {
     oftBridgeAddress?: string;
     abrPayer?: AbrPayerChainInfoDTO;
     swapAddress: string;
+    /**
+     * @deprecated Do not use.
+     */
     yieldAddress?: string;
     transferTime: TransferTimeDTO;
     txCostAmount: TxCostAmountDTO;
@@ -55,6 +58,9 @@ export interface TokenDTO {
     cctpV2Address?: string;
     cctpFeeShare?: string;
     cctpV2FeeShare?: string;
+    /**
+     * @deprecated Do not use.
+     */
     yieldId?: number;
     xReserve?: XReserveDTO;
     flags: {
@@ -102,17 +108,44 @@ export interface TxCostAmountDTO {
 export type MessengerTransferTimeDTO = {
     [messenger in MessengerKeyDTO]: number | null;
 };
+/**
+ * Bridging protocol used for a transfer.
+ * Only {@link ActiveMessenger} values are supported.
+ */
 export declare enum Messenger {
     /** @deprecated Do not use. */
     ALLBRIDGE = 1,
     /** @deprecated Do not use. */
     WORMHOLE = 2,
+    /**
+     * Circle CCTP.
+     * Route is supported when `cctpAddress` is defined on both source and destination tokens.
+     */
     CCTP = 3,
+    /**
+     * Circle CCTP V2.
+     * Route is supported when `cctpV2Address` is defined on both source and destination tokens.
+     */
     CCTP_V2 = 4,
+    /**
+     * LayerZero OFT.
+     * Route is supported when source and destination tokens have the same `oftId`
+     * and `oftBridgeAddress` is defined on both chains.
+     */
     OFT = 5,
+    /**
+     * xReserve.
+     * Route is supported when `xReserve` is defined on both source and destination tokens.
+     */
     X_RESERVE = 6
 }
+/**
+ * @deprecated Do not use.
+ */
 export type LegacyMessenger = Messenger.ALLBRIDGE | Messenger.WORMHOLE;
+/**
+ * Messengers supported for transfers: {@link Messenger.CCTP}, {@link Messenger.CCTP_V2}, {@link Messenger.OFT}, {@link Messenger.X_RESERVE}
+ */
 export type ActiveMessenger = Exclude<Messenger, LegacyMessenger>;
 export interface ReceiveTransactionCostRequest {
     sourceChainId: number;

package/dist/src/client/core-api/core-api.model.js

@@ -18,15 +18,36 @@ export var MessengerKeyDTO;
     MessengerKeyDTO["OFT"] = "oft";
     MessengerKeyDTO["X_RESERVE"] = "xReserve";
 })(MessengerKeyDTO || (MessengerKeyDTO = {}));
+/**
+ * Bridging protocol used for a transfer.
+ * Only {@link ActiveMessenger} values are supported.
+ */
 export var Messenger;
 (function (Messenger) {
     /** @deprecated Do not use. */
     Messenger[Messenger["ALLBRIDGE"] = 1] = "ALLBRIDGE";
     /** @deprecated Do not use. */
     Messenger[Messenger["WORMHOLE"] = 2] = "WORMHOLE";
+    /**
+     * Circle CCTP.
+     * Route is supported when `cctpAddress` is defined on both source and destination tokens.
+     */
     Messenger[Messenger["CCTP"] = 3] = "CCTP";
+    /**
+     * Circle CCTP V2.
+     * Route is supported when `cctpV2Address` is defined on both source and destination tokens.
+     */
     Messenger[Messenger["CCTP_V2"] = 4] = "CCTP_V2";
+    /**
+     * LayerZero OFT.
+     * Route is supported when source and destination tokens have the same `oftId`
+     * and `oftBridgeAddress` is defined on both chains.
+     */
     Messenger[Messenger["OFT"] = 5] = "OFT";
+    /**
+     * xReserve.
+     * Route is supported when `xReserve` is defined on both source and destination tokens.
+     */
     Messenger[Messenger["X_RESERVE"] = 6] = "X_RESERVE";
 })(Messenger || (Messenger = {}));
 //# sourceMappingURL=core-api.model.js.map

package/dist/src/client/core-api/core-api.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"core-api.model.js","sourceRoot":"","sources":["../../../../src/client/core-api/core-api.model.ts"],"names":[],"mappings":"AA6BA,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,0BAAS,CAAA;IACT,oCAAmB,CAAA;IACnB,wCAAuB,CAAA;IACvB,gDAA+B,CAAA;IAC/B,sDAAqC,CAAA;IACrC,kFAAiE,CAAA;AACnE,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB;AAuDD,MAAM,CAAN,IAAY,eASX;AATD,WAAY,eAAe;IACzB,8BAA8B;IAC9B,0CAAuB,CAAA;IACvB,8BAA8B;IAC9B,wCAAqB,CAAA;IACrB,gCAAa,CAAA;IACb,qCAAkB,CAAA;IAClB,8BAAW,CAAA;IACX,yCAAsB,CAAA;AACxB,CAAC,EATW,eAAe,KAAf,eAAe,QAS1B;AAkBD,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,8BAA8B;IAC9B,mDAAa,CAAA;IACb,8BAA8B;IAC9B,iDAAY,CAAA;IACZ,yCAAQ,CAAA;IACR,+CAAW,CAAA;IACX,uCAAO,CAAA;IACP,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,KAAT,SAAS,QASpB","sourcesContent":["import { ChainSymbol } from \"../../chains/chain.enums\";\nimport { PoolInfo, SuiAddresses } from \"../../tokens-info\";\n\nexport type ChainDetailsResponse = Record<string, ChainDetailsDTO>;\n\nexport interface AbrPayerChainInfoDTO {\n  payerAddress: string;\n  tokenAddress: string;\n  tokenDecimals: number;\n  payerAvailability: AbrPayerAvailabilityTypeDTO;\n}\n\nexport interface ChainDetailsDTO {\n  tokens: TokenDTO[];\n  chainId: number;\n  bridgeId?: string;\n  paddingUtilId?: string;\n  /** @deprecated Do not use. */\n  bridgeAddress: string;\n  oftBridgeAddress?: string;\n  abrPayer?: AbrPayerChainInfoDTO;\n  swapAddress: string;\n  yieldAddress?: string;\n  transferTime: TransferTimeDTO;\n  txCostAmount: TxCostAmountDTO;\n  confirmations: number;\n  suiAddresses?: SuiAddresses;\n}\n\nexport enum AddressStatus {\n  OK = \"OK\",\n  INVALID = \"INVALID\",\n  FORBIDDEN = \"FORBIDDEN\",\n  UNINITIALIZED = \"UNINITIALIZED\",\n  CONTRACT_ADDRESS = \"CONTRACT_ADDRESS\",\n  WRONG_ASSOCIATED_ACCOUNT_OWNER = \"WRONG_ASSOCIATED_ACCOUNT_OWNER\",\n}\n\nexport interface TokenDTO {\n  symbol: string;\n  name: string;\n  decimals: number;\n  /** @deprecated Do not use. */\n  poolAddress: string;\n  tokenAddress: string;\n  /** @deprecated Do not use. */\n  poolInfo: PoolInfoDTO;\n  oftId?: string;\n  /** @deprecated Do not use. */\n  feeShare: string;\n  /** @deprecated Do not use. */\n  apr: string;\n  /** @deprecated Do not use. */\n  apr7d: string;\n  /** @deprecated Do not use. */\n  apr30d: string;\n  /** @deprecated Do not use. */\n  lpRate: string;\n  cctpAddress?: string;\n  cctpV2Address?: string;\n  cctpFeeShare?: string;\n  cctpV2FeeShare?: string;\n  yieldId?: number;\n  xReserve?: XReserveDTO;\n  flags: {\n    swap: boolean;\n    /** @deprecated Do not use. */\n    pool: boolean;\n  };\n}\n\nexport interface XReserveDTO {\n  bridgeAddress: string;\n  feeConst: string;\n  feeShare: string;\n  protocolAddress?: string;\n}\n\n/**\n * @deprecated Do not use.\n */\nexport interface PoolInfoDTO {\n  aValue: string;\n  dValue: string;\n  tokenBalance: string;\n  vUsdBalance: string;\n  totalLpAmount: string;\n  accRewardPerShareP: string;\n  p: number;\n}\n\nexport enum MessengerKeyDTO {\n  /** @deprecated Do not use. */\n  ALLBRIDGE = \"allbridge\",\n  /** @deprecated Do not use. */\n  WORMHOLE = \"wormhole\",\n  CCTP = \"cctp\",\n  CCTP_V2 = \"cctpV2\",\n  OFT = \"oft\",\n  X_RESERVE = \"xReserve\",\n}\n\nexport type AbrPayerAvailabilityKeyDTO = (typeof MessengerKeyDTO)[keyof typeof MessengerKeyDTO];\n\nexport type AbrPayerAvailabilityTypeDTO = Partial<Record<AbrPayerAvailabilityKeyDTO, boolean>>;\n\nexport type TransferTimeDTO = Record<string, MessengerTransferTimeDTO>;\n\nexport interface TxCostAmountDTO {\n  maxAmount: string;\n  swap: string;\n  transfer: string;\n}\n\nexport type MessengerTransferTimeDTO = {\n  [messenger in MessengerKeyDTO]: number | null;\n};\n\nexport enum Messenger {\n  /** @deprecated Do not use. */\n  ALLBRIDGE = 1,\n  /** @deprecated Do not use. */\n  WORMHOLE = 2,\n  CCTP = 3,\n  CCTP_V2 = 4,\n  OFT = 5,\n  X_RESERVE = 6,\n}\n\nexport type LegacyMessenger = Messenger.ALLBRIDGE | Messenger.WORMHOLE;\nexport type ActiveMessenger = Exclude<Messenger, LegacyMessenger>;\n\nexport interface ReceiveTransactionCostRequest {\n  sourceChainId: number;\n  destinationChainId: number;\n  messenger: Messenger;\n  sourceToken?: string;\n}\n\nexport interface ReceiveTransactionCostResponse {\n  exchangeRate: string;\n  fee: string;\n  sourceNativeTokenPrice: string;\n  abrExchangeRate?: string;\n  adminFeeShareWithExtras?: string;\n}\n\nexport interface GasBalanceResponse {\n  gasBalance: string | null;\n  status: AddressStatus;\n}\n\nexport interface CheckAddressResponse {\n  gasBalance: string | null;\n  status: AddressStatus;\n}\n\nexport interface TransferStatusResponse {\n  txId: string;\n\n  sourceChainSymbol: ChainSymbol;\n  destinationChainSymbol: ChainSymbol;\n\n  sendAmount: string;\n  sendAmountFormatted: number;\n\n  stableFee: string;\n  stableFeeFormatted: number;\n\n  sourceTokenAddress: string;\n  destinationTokenAddress: string;\n\n  originSourceTokenAddress?: string;\n  originDestinationTokenAddress?: string;\n\n  senderAddress: string;\n  recipientAddress: string;\n\n  signaturesCount: number;\n  signaturesNeeded: number;\n\n  send: BridgeTransaction;\n  receive?: BridgeTransaction;\n\n  responseTime?: number;\n}\n\nexport interface BridgeTransaction {\n  txId: string;\n\n  sourceChainId: number;\n  destinationChainId: number;\n\n  fee: string;\n  feeFormatted: number;\n\n  stableFee: string;\n  stableFeeFormatted: number;\n\n  amount: string;\n  amountFormatted: number;\n  virtualAmount: string;\n\n  bridgeContract: string;\n  sender: string;\n  recipient: string;\n\n  sourceTokenAddress: string;\n  destinationTokenAddress: string;\n\n  originSourceTokenAddress?: string;\n  originDestinationTokenAddress?: string;\n\n  hash: string;\n\n  messenger: Messenger;\n\n  blockTime: number;\n  blockId: string;\n\n  confirmations: number;\n  confirmationsNeeded: number;\n\n  isClaimable?: boolean;\n}\n\n/**\n * @deprecated Do not use.\n */\nexport type PoolInfoResponse = Record<string, PoolInfo>;\n/**\n * @deprecated Do not use.\n */\nexport type PendingInfoResponse = Partial<Record<string, TokenPendingInfoDTO>>;\n/**\n * @deprecated Do not use.\n */\nexport type TokenPendingInfoDTO = Record<string, PendingInfoDTO>;\n\n/**\n * @deprecated Do not use.\n */\nexport interface PendingInfoDTO {\n  pendingTxs: number;\n  totalSentAmount: string;\n}\n"]}
+{"version":3,"file":"core-api.model.js","sourceRoot":"","sources":["../../../../src/client/core-api/core-api.model.ts"],"names":[],"mappings":"AAgCA,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,0BAAS,CAAA;IACT,oCAAmB,CAAA;IACnB,wCAAuB,CAAA;IACvB,gDAA+B,CAAA;IAC/B,sDAAqC,CAAA;IACrC,kFAAiE,CAAA;AACnE,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB;AA0DD,MAAM,CAAN,IAAY,eASX;AATD,WAAY,eAAe;IACzB,8BAA8B;IAC9B,0CAAuB,CAAA;IACvB,8BAA8B;IAC9B,wCAAqB,CAAA;IACrB,gCAAa,CAAA;IACb,qCAAkB,CAAA;IAClB,8BAAW,CAAA;IACX,yCAAsB,CAAA;AACxB,CAAC,EATW,eAAe,KAAf,eAAe,QAS1B;AAkBD;;;GAGG;AACH,MAAM,CAAN,IAAY,SA0BX;AA1BD,WAAY,SAAS;IACnB,8BAA8B;IAC9B,mDAAa,CAAA;IACb,8BAA8B;IAC9B,iDAAY,CAAA;IACZ;;;OAGG;IACH,yCAAQ,CAAA;IACR;;;OAGG;IACH,+CAAW,CAAA;IACX;;;;OAIG;IACH,uCAAO,CAAA;IACP;;;OAGG;IACH,mDAAa,CAAA;AACf,CAAC,EA1BW,SAAS,KAAT,SAAS,QA0BpB","sourcesContent":["import { ChainSymbol } from \"../../chains/chain.enums\";\nimport { PoolInfo, SuiAddresses } from \"../../tokens-info\";\n\nexport type ChainDetailsResponse = Record<string, ChainDetailsDTO>;\n\nexport interface AbrPayerChainInfoDTO {\n  payerAddress: string;\n  tokenAddress: string;\n  tokenDecimals: number;\n  payerAvailability: AbrPayerAvailabilityTypeDTO;\n}\n\nexport interface ChainDetailsDTO {\n  tokens: TokenDTO[];\n  chainId: number;\n  bridgeId?: string;\n  paddingUtilId?: string;\n  /** @deprecated Do not use. */\n  bridgeAddress: string;\n  oftBridgeAddress?: string;\n  abrPayer?: AbrPayerChainInfoDTO;\n  swapAddress: string;\n  /**\n   * @deprecated Do not use.\n   */\n  yieldAddress?: string;\n  transferTime: TransferTimeDTO;\n  txCostAmount: TxCostAmountDTO;\n  confirmations: number;\n  suiAddresses?: SuiAddresses;\n}\n\nexport enum AddressStatus {\n  OK = \"OK\",\n  INVALID = \"INVALID\",\n  FORBIDDEN = \"FORBIDDEN\",\n  UNINITIALIZED = \"UNINITIALIZED\",\n  CONTRACT_ADDRESS = \"CONTRACT_ADDRESS\",\n  WRONG_ASSOCIATED_ACCOUNT_OWNER = \"WRONG_ASSOCIATED_ACCOUNT_OWNER\",\n}\n\nexport interface TokenDTO {\n  symbol: string;\n  name: string;\n  decimals: number;\n  /** @deprecated Do not use. */\n  poolAddress: string;\n  tokenAddress: string;\n  /** @deprecated Do not use. */\n  poolInfo: PoolInfoDTO;\n  oftId?: string;\n  /** @deprecated Do not use. */\n  feeShare: string;\n  /** @deprecated Do not use. */\n  apr: string;\n  /** @deprecated Do not use. */\n  apr7d: string;\n  /** @deprecated Do not use. */\n  apr30d: string;\n  /** @deprecated Do not use. */\n  lpRate: string;\n  cctpAddress?: string;\n  cctpV2Address?: string;\n  cctpFeeShare?: string;\n  cctpV2FeeShare?: string;\n  /**\n   * @deprecated Do not use.\n   */\n  yieldId?: number;\n  xReserve?: XReserveDTO;\n  flags: {\n    swap: boolean;\n    /** @deprecated Do not use. */\n    pool: boolean;\n  };\n}\n\nexport interface XReserveDTO {\n  bridgeAddress: string;\n  feeConst: string;\n  feeShare: string;\n  protocolAddress?: string;\n}\n\n/**\n * @deprecated Do not use.\n */\nexport interface PoolInfoDTO {\n  aValue: string;\n  dValue: string;\n  tokenBalance: string;\n  vUsdBalance: string;\n  totalLpAmount: string;\n  accRewardPerShareP: string;\n  p: number;\n}\n\nexport enum MessengerKeyDTO {\n  /** @deprecated Do not use. */\n  ALLBRIDGE = \"allbridge\",\n  /** @deprecated Do not use. */\n  WORMHOLE = \"wormhole\",\n  CCTP = \"cctp\",\n  CCTP_V2 = \"cctpV2\",\n  OFT = \"oft\",\n  X_RESERVE = \"xReserve\",\n}\n\nexport type AbrPayerAvailabilityKeyDTO = (typeof MessengerKeyDTO)[keyof typeof MessengerKeyDTO];\n\nexport type AbrPayerAvailabilityTypeDTO = Partial<Record<AbrPayerAvailabilityKeyDTO, boolean>>;\n\nexport type TransferTimeDTO = Record<string, MessengerTransferTimeDTO>;\n\nexport interface TxCostAmountDTO {\n  maxAmount: string;\n  swap: string;\n  transfer: string;\n}\n\nexport type MessengerTransferTimeDTO = {\n  [messenger in MessengerKeyDTO]: number | null;\n};\n\n/**\n * Bridging protocol used for a transfer.\n * Only {@link ActiveMessenger} values are supported.\n */\nexport enum Messenger {\n  /** @deprecated Do not use. */\n  ALLBRIDGE = 1,\n  /** @deprecated Do not use. */\n  WORMHOLE = 2,\n  /**\n   * Circle CCTP.\n   * Route is supported when `cctpAddress` is defined on both source and destination tokens.\n   */\n  CCTP = 3,\n  /**\n   * Circle CCTP V2.\n   * Route is supported when `cctpV2Address` is defined on both source and destination tokens.\n   */\n  CCTP_V2 = 4,\n  /**\n   * LayerZero OFT.\n   * Route is supported when source and destination tokens have the same `oftId`\n   * and `oftBridgeAddress` is defined on both chains.\n   */\n  OFT = 5,\n  /**\n   * xReserve.\n   * Route is supported when `xReserve` is defined on both source and destination tokens.\n   */\n  X_RESERVE = 6,\n}\n\n/**\n * @deprecated Do not use.\n */\nexport type LegacyMessenger = Messenger.ALLBRIDGE | Messenger.WORMHOLE;\n/**\n * Messengers supported for transfers: {@link Messenger.CCTP}, {@link Messenger.CCTP_V2}, {@link Messenger.OFT}, {@link Messenger.X_RESERVE}\n */\nexport type ActiveMessenger = Exclude<Messenger, LegacyMessenger>;\n\nexport interface ReceiveTransactionCostRequest {\n  sourceChainId: number;\n  destinationChainId: number;\n  messenger: Messenger;\n  sourceToken?: string;\n}\n\nexport interface ReceiveTransactionCostResponse {\n  exchangeRate: string;\n  fee: string;\n  sourceNativeTokenPrice: string;\n  abrExchangeRate?: string;\n  adminFeeShareWithExtras?: string;\n}\n\nexport interface GasBalanceResponse {\n  gasBalance: string | null;\n  status: AddressStatus;\n}\n\nexport interface CheckAddressResponse {\n  gasBalance: string | null;\n  status: AddressStatus;\n}\n\nexport interface TransferStatusResponse {\n  txId: string;\n\n  sourceChainSymbol: ChainSymbol;\n  destinationChainSymbol: ChainSymbol;\n\n  sendAmount: string;\n  sendAmountFormatted: number;\n\n  stableFee: string;\n  stableFeeFormatted: number;\n\n  sourceTokenAddress: string;\n  destinationTokenAddress: string;\n\n  originSourceTokenAddress?: string;\n  originDestinationTokenAddress?: string;\n\n  senderAddress: string;\n  recipientAddress: string;\n\n  signaturesCount: number;\n  signaturesNeeded: number;\n\n  send: BridgeTransaction;\n  receive?: BridgeTransaction;\n\n  responseTime?: number;\n}\n\nexport interface BridgeTransaction {\n  txId: string;\n\n  sourceChainId: number;\n  destinationChainId: number;\n\n  fee: string;\n  feeFormatted: number;\n\n  stableFee: string;\n  stableFeeFormatted: number;\n\n  amount: string;\n  amountFormatted: number;\n  virtualAmount: string;\n\n  bridgeContract: string;\n  sender: string;\n  recipient: string;\n\n  sourceTokenAddress: string;\n  destinationTokenAddress: string;\n\n  originSourceTokenAddress?: string;\n  originDestinationTokenAddress?: string;\n\n  hash: string;\n\n  messenger: Messenger;\n\n  blockTime: number;\n  blockId: string;\n\n  confirmations: number;\n  confirmationsNeeded: number;\n\n  isClaimable?: boolean;\n}\n\n/**\n * @deprecated Do not use.\n */\nexport type PoolInfoResponse = Record<string, PoolInfo>;\n/**\n * @deprecated Do not use.\n */\nexport type PendingInfoResponse = Partial<Record<string, TokenPendingInfoDTO>>;\n/**\n * @deprecated Do not use.\n */\nexport type TokenPendingInfoDTO = Record<string, PendingInfoDTO>;\n\n/**\n * @deprecated Do not use.\n */\nexport interface PendingInfoDTO {\n  pendingTxs: number;\n  totalSentAmount: string;\n}\n"]}

package/dist/src/exceptions/exceptions.d.ts

@@ -53,6 +53,9 @@ export declare class CCTPDoesNotSupportedError extends SdkRootError {
 export declare class OFTDoesNotSupportedError extends SdkRootError {
     constructor(message?: string);
 }
+/**
+ * @deprecated Do not use.
+ */
 export declare class YieldDoesNotSupportedError extends SdkRootError {
     constructor(message?: string);
 }
@@ -77,6 +80,9 @@ export declare enum ErrorCode {
     NODE_RPC_URL_NOT_INITIALIZED_ERROR = "NodeRpcUrlNotInitializedError",
     CCTP_DOES_NOT_SUPPORTED_ERROR = "CCTPDoesNotSupportedError",
     OFT_DOES_NOT_SUPPORTED_ERROR = "OFTDoesNotSupportedError",
+    /**
+     * @deprecated Do not use.
+     */
     YIELD_DOES_NOT_SUPPORTED_ERROR = "YieldDoesNotSupportedError",
     TX_TOO_LARGE = "TxTooLargeError"
 }

package/dist/src/exceptions/exceptions.js

@@ -88,6 +88,9 @@ export class OFTDoesNotSupportedError extends SdkRootError {
         super(ErrorCode.OFT_DOES_NOT_SUPPORTED_ERROR, message);
     }
 }
+/**
+ * @deprecated Do not use.
+ */
 export class YieldDoesNotSupportedError extends SdkRootError {
     constructor(message) {
         super(ErrorCode.YIELD_DOES_NOT_SUPPORTED_ERROR, message);
@@ -117,6 +120,9 @@ export var ErrorCode;
     ErrorCode["NODE_RPC_URL_NOT_INITIALIZED_ERROR"] = "NodeRpcUrlNotInitializedError";
     ErrorCode["CCTP_DOES_NOT_SUPPORTED_ERROR"] = "CCTPDoesNotSupportedError";
     ErrorCode["OFT_DOES_NOT_SUPPORTED_ERROR"] = "OFTDoesNotSupportedError";
+    /**
+     * @deprecated Do not use.
+     */
     ErrorCode["YIELD_DOES_NOT_SUPPORTED_ERROR"] = "YieldDoesNotSupportedError";
     ErrorCode["TX_TOO_LARGE"] = "TxTooLargeError";
 })(ErrorCode || (ErrorCode = {}));

package/dist/src/exceptions/exceptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"exceptions.js","sourceRoot":"","sources":["../../../src/exceptions/exceptions.ts"],"names":[],"mappings":"AAAA,MAAM,OAAgB,YAAa,SAAQ,KAAK;IACvC,SAAS,CAAY;IAE5B,YAAsB,IAAe,EAAE,OAAgB;QACrD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;CACF;AAED,MAAM,OAAO,QAAS,SAAQ,YAAY;IACxC,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAClD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,8BAA+B,SAAQ,YAAY;IAC9D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,iCAAiC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF;AAED,MAAM,OAAO,+BAAgC,SAAQ,YAAY;IAC/D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,YAAY;IAC3D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,8BAA8B,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IACvD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,YAAY;IAC9C,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,6BAA8B,SAAQ,YAAY;IAC7D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,YAAY;IAC5D,YAAY,OAAe,EAAE,UAAkB,EAAE,gBAAwB;QACvE,KAAK,CACH,SAAS,CAAC,+BAA+B,EACzC,aAAa,OAAO,eAAe,UAAU,6BAA6B,gBAAgB,GAAG,CAC9F,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF;AAED,MAAM,OAAO,6BAA8B,SAAQ,YAAY;IAC7D,YAAY,WAAmB;QAC7B,KAAK,CAAC,SAAS,CAAC,kCAAkC,EAAE,cAAc,WAAW,gCAAgC,CAAC,CAAC;IACjH,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,YAAY;IACzD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF;AAED,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IACxD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED,MAAM,OAAO,0BAA2B,SAAQ,YAAY;IAC1D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,8BAA8B,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,YAAY;IAC/C;QACE,KAAK,CACH,SAAS,CAAC,YAAY,EACtB,iHAAiH,CAClH,CAAC;IACJ,CAAC;CACF;AAED,MAAM,CAAN,IAAY,SAoBX;AApBD,WAAY,SAAS;IACnB,mCAAsB,CAAA;IACtB,wDAA2C,CAAA;IAC3C,6DAAgD,CAAA;IAChD,8BAA8B;IAC9B,iFAAoE,CAAA;IACpE,2CAA8B,CAAA;IAC9B,qFAAwE,CAAA;IACxE,2EAA8D,CAAA;IAC9D,mEAAsD,CAAA;IACtD,8CAAiC,CAAA;IACjC,gDAAmC,CAAA;IACnC,iFAAoE,CAAA;IACpE,6EAAgE,CAAA;IAChE,2CAA8B,CAAA;IAC9B,iFAAoE,CAAA;IACpE,wEAA2D,CAAA;IAC3D,sEAAyD,CAAA;IACzD,0EAA6D,CAAA;IAC7D,6CAAgC,CAAA;AAClC,CAAC,EApBW,SAAS,KAAT,SAAS,QAoBpB","sourcesContent":["export abstract class SdkRootError extends Error {\n  public errorCode: ErrorCode;\n\n  protected constructor(code: ErrorCode, message?: string) {\n    super(message);\n    this.errorCode = code;\n  }\n}\n\nexport class SdkError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.SDK_ERROR, message);\n  }\n}\n\nexport class InvalidAmountError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INVALID_AMOUNT_ERROR, message);\n  }\n}\n\nexport class AmountNotEnoughError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.AMOUNT_NOT_ENOUGH_ERROR, message);\n  }\n}\n\n/**\n * @deprecated Do not use.\n */\nexport class InsufficientPoolLiquidityError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INSUFFICIENT_POOL_LIQUIDITY_ERROR, message);\n  }\n}\n\nexport class JupiterError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.JUPITER_ERROR, message);\n  }\n}\n\nexport class InvalidGasFeePaymentOptionError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INVALID_GAS_FEE_PAYMENT_OPTION_ERROR, message);\n  }\n}\n\nexport class InvalidMessengerOptionError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INVALID_MESSENGER_OPTION_ERROR, message);\n  }\n}\n\nexport class MethodNotSupportedError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.METHOD_NOT_SUPPORTED_ERROR, message);\n  }\n}\n\nexport class VerifyTxError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.VERIFY_TX_ERROR, message);\n  }\n}\n\nexport class InvalidTxError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INVALID_TX_ERROR, message);\n  }\n}\n\nexport class ExtraGasMaxLimitExceededError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.EXTRA_GAS_MAX_LIMIT_EXCEEDED_ERROR, message);\n  }\n}\n\nexport class ArgumentInvalidDecimalsError extends SdkRootError {\n  constructor(argName: string, decimalsIs: number, decimalsRequired: number) {\n    super(\n      ErrorCode.ARGUMENT_INVALID_DECIMALS_ERROR,\n      `Argument '${argName}' decimals '${decimalsIs}' cannot be greater than '${decimalsRequired}'`\n    );\n  }\n}\n\nexport class TimeoutError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.TIMEOUT_ERROR, message);\n  }\n}\n\nexport class NodeRpcUrlNotInitializedError extends SdkRootError {\n  constructor(chainSymbol: string) {\n    super(ErrorCode.NODE_RPC_URL_NOT_INITIALIZED_ERROR, `For chain '${chainSymbol}' Node RPC URL not initialized`);\n  }\n}\n\nexport class CCTPDoesNotSupportedError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.CCTP_DOES_NOT_SUPPORTED_ERROR, message);\n  }\n}\n\nexport class OFTDoesNotSupportedError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.OFT_DOES_NOT_SUPPORTED_ERROR, message);\n  }\n}\n\nexport class YieldDoesNotSupportedError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.YIELD_DOES_NOT_SUPPORTED_ERROR, message);\n  }\n}\n\nexport class TxTooLargeError extends SdkRootError {\n  constructor() {\n    super(\n      ErrorCode.TX_TOO_LARGE,\n      \"Transaction too large: try again later or switch to another messenger or pay relayer fee in native gas currency\"\n    );\n  }\n}\n\nexport enum ErrorCode {\n  SDK_ERROR = \"SdkError\",\n  INVALID_AMOUNT_ERROR = \"InvalidAmountError\",\n  AMOUNT_NOT_ENOUGH_ERROR = \"AmountNotEnoughError\",\n  /** @deprecated Do not use. */\n  INSUFFICIENT_POOL_LIQUIDITY_ERROR = \"InsufficientPoolLiquidityError\",\n  JUPITER_ERROR = \"JupiterError\",\n  INVALID_GAS_FEE_PAYMENT_OPTION_ERROR = \"InvalidGasFeePaymentOptionError\",\n  INVALID_MESSENGER_OPTION_ERROR = \"InvalidMessengerOptionError\",\n  METHOD_NOT_SUPPORTED_ERROR = \"MethodNotSupportedError\",\n  VERIFY_TX_ERROR = \"VerifyTxError\",\n  INVALID_TX_ERROR = \"InvalidTxError\",\n  EXTRA_GAS_MAX_LIMIT_EXCEEDED_ERROR = \"ExtraGasMaxLimitExceededError\",\n  ARGUMENT_INVALID_DECIMALS_ERROR = \"ArgumentInvalidDecimalsError\",\n  TIMEOUT_ERROR = \"TimeoutError\",\n  NODE_RPC_URL_NOT_INITIALIZED_ERROR = \"NodeRpcUrlNotInitializedError\",\n  CCTP_DOES_NOT_SUPPORTED_ERROR = \"CCTPDoesNotSupportedError\",\n  OFT_DOES_NOT_SUPPORTED_ERROR = \"OFTDoesNotSupportedError\",\n  YIELD_DOES_NOT_SUPPORTED_ERROR = \"YieldDoesNotSupportedError\",\n  TX_TOO_LARGE = \"TxTooLargeError\",\n}\n"]}
+{"version":3,"file":"exceptions.js","sourceRoot":"","sources":["../../../src/exceptions/exceptions.ts"],"names":[],"mappings":"AAAA,MAAM,OAAgB,YAAa,SAAQ,KAAK;IACvC,SAAS,CAAY;IAE5B,YAAsB,IAAe,EAAE,OAAgB;QACrD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;CACF;AAED,MAAM,OAAO,QAAS,SAAQ,YAAY;IACxC,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAClD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,8BAA+B,SAAQ,YAAY;IAC9D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,iCAAiC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF;AAED,MAAM,OAAO,+BAAgC,SAAQ,YAAY;IAC/D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,YAAY;IAC3D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,8BAA8B,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IACvD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,YAAY;IAC9C,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,6BAA8B,SAAQ,YAAY;IAC7D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,YAAY;IAC5D,YAAY,OAAe,EAAE,UAAkB,EAAE,gBAAwB;QACvE,KAAK,CACH,SAAS,CAAC,+BAA+B,EACzC,aAAa,OAAO,eAAe,UAAU,6BAA6B,gBAAgB,GAAG,CAC9F,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF;AAED,MAAM,OAAO,6BAA8B,SAAQ,YAAY;IAC7D,YAAY,WAAmB;QAC7B,KAAK,CAAC,SAAS,CAAC,kCAAkC,EAAE,cAAc,WAAW,gCAAgC,CAAC,CAAC;IACjH,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,YAAY;IACzD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF;AAED,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IACxD,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,YAAY;IAC1D,YAAY,OAAgB;QAC1B,KAAK,CAAC,SAAS,CAAC,8BAA8B,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,YAAY;IAC/C;QACE,KAAK,CACH,SAAS,CAAC,YAAY,EACtB,iHAAiH,CAClH,CAAC;IACJ,CAAC;CACF;AAED,MAAM,CAAN,IAAY,SAuBX;AAvBD,WAAY,SAAS;IACnB,mCAAsB,CAAA;IACtB,wDAA2C,CAAA;IAC3C,6DAAgD,CAAA;IAChD,8BAA8B;IAC9B,iFAAoE,CAAA;IACpE,2CAA8B,CAAA;IAC9B,qFAAwE,CAAA;IACxE,2EAA8D,CAAA;IAC9D,mEAAsD,CAAA;IACtD,8CAAiC,CAAA;IACjC,gDAAmC,CAAA;IACnC,iFAAoE,CAAA;IACpE,6EAAgE,CAAA;IAChE,2CAA8B,CAAA;IAC9B,iFAAoE,CAAA;IACpE,wEAA2D,CAAA;IAC3D,sEAAyD,CAAA;IACzD;;OAEG;IACH,0EAA6D,CAAA;IAC7D,6CAAgC,CAAA;AAClC,CAAC,EAvBW,SAAS,KAAT,SAAS,QAuBpB","sourcesContent":["export abstract class SdkRootError extends Error {\n  public errorCode: ErrorCode;\n\n  protected constructor(code: ErrorCode, message?: string) {\n    super(message);\n    this.errorCode = code;\n  }\n}\n\nexport class SdkError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.SDK_ERROR, message);\n  }\n}\n\nexport class InvalidAmountError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INVALID_AMOUNT_ERROR, message);\n  }\n}\n\nexport class AmountNotEnoughError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.AMOUNT_NOT_ENOUGH_ERROR, message);\n  }\n}\n\n/**\n * @deprecated Do not use.\n */\nexport class InsufficientPoolLiquidityError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INSUFFICIENT_POOL_LIQUIDITY_ERROR, message);\n  }\n}\n\nexport class JupiterError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.JUPITER_ERROR, message);\n  }\n}\n\nexport class InvalidGasFeePaymentOptionError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INVALID_GAS_FEE_PAYMENT_OPTION_ERROR, message);\n  }\n}\n\nexport class InvalidMessengerOptionError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INVALID_MESSENGER_OPTION_ERROR, message);\n  }\n}\n\nexport class MethodNotSupportedError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.METHOD_NOT_SUPPORTED_ERROR, message);\n  }\n}\n\nexport class VerifyTxError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.VERIFY_TX_ERROR, message);\n  }\n}\n\nexport class InvalidTxError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.INVALID_TX_ERROR, message);\n  }\n}\n\nexport class ExtraGasMaxLimitExceededError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.EXTRA_GAS_MAX_LIMIT_EXCEEDED_ERROR, message);\n  }\n}\n\nexport class ArgumentInvalidDecimalsError extends SdkRootError {\n  constructor(argName: string, decimalsIs: number, decimalsRequired: number) {\n    super(\n      ErrorCode.ARGUMENT_INVALID_DECIMALS_ERROR,\n      `Argument '${argName}' decimals '${decimalsIs}' cannot be greater than '${decimalsRequired}'`\n    );\n  }\n}\n\nexport class TimeoutError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.TIMEOUT_ERROR, message);\n  }\n}\n\nexport class NodeRpcUrlNotInitializedError extends SdkRootError {\n  constructor(chainSymbol: string) {\n    super(ErrorCode.NODE_RPC_URL_NOT_INITIALIZED_ERROR, `For chain '${chainSymbol}' Node RPC URL not initialized`);\n  }\n}\n\nexport class CCTPDoesNotSupportedError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.CCTP_DOES_NOT_SUPPORTED_ERROR, message);\n  }\n}\n\nexport class OFTDoesNotSupportedError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.OFT_DOES_NOT_SUPPORTED_ERROR, message);\n  }\n}\n\n/**\n * @deprecated Do not use.\n */\nexport class YieldDoesNotSupportedError extends SdkRootError {\n  constructor(message?: string) {\n    super(ErrorCode.YIELD_DOES_NOT_SUPPORTED_ERROR, message);\n  }\n}\n\nexport class TxTooLargeError extends SdkRootError {\n  constructor() {\n    super(\n      ErrorCode.TX_TOO_LARGE,\n      \"Transaction too large: try again later or switch to another messenger or pay relayer fee in native gas currency\"\n    );\n  }\n}\n\nexport enum ErrorCode {\n  SDK_ERROR = \"SdkError\",\n  INVALID_AMOUNT_ERROR = \"InvalidAmountError\",\n  AMOUNT_NOT_ENOUGH_ERROR = \"AmountNotEnoughError\",\n  /** @deprecated Do not use. */\n  INSUFFICIENT_POOL_LIQUIDITY_ERROR = \"InsufficientPoolLiquidityError\",\n  JUPITER_ERROR = \"JupiterError\",\n  INVALID_GAS_FEE_PAYMENT_OPTION_ERROR = \"InvalidGasFeePaymentOptionError\",\n  INVALID_MESSENGER_OPTION_ERROR = \"InvalidMessengerOptionError\",\n  METHOD_NOT_SUPPORTED_ERROR = \"MethodNotSupportedError\",\n  VERIFY_TX_ERROR = \"VerifyTxError\",\n  INVALID_TX_ERROR = \"InvalidTxError\",\n  EXTRA_GAS_MAX_LIMIT_EXCEEDED_ERROR = \"ExtraGasMaxLimitExceededError\",\n  ARGUMENT_INVALID_DECIMALS_ERROR = \"ArgumentInvalidDecimalsError\",\n  TIMEOUT_ERROR = \"TimeoutError\",\n  NODE_RPC_URL_NOT_INITIALIZED_ERROR = \"NodeRpcUrlNotInitializedError\",\n  CCTP_DOES_NOT_SUPPORTED_ERROR = \"CCTPDoesNotSupportedError\",\n  OFT_DOES_NOT_SUPPORTED_ERROR = \"OFTDoesNotSupportedError\",\n  /**\n   * @deprecated Do not use.\n   */\n  YIELD_DOES_NOT_SUPPORTED_ERROR = \"YieldDoesNotSupportedError\",\n  TX_TOO_LARGE = \"TxTooLargeError\",\n}\n"]}

package/dist/src/index.d.ts

@@ -51,6 +51,10 @@ export interface AllbridgeCoreSdkOptions {
      * @deprecated Do not use.
      */
     tronJsonRpc?: string;
+    /**
+     * Solana CCTP / CCTP V2 program ids and CCTP domains, see {@link CctpParams}.
+     * Required for transfers with {@link Messenger.CCTP} and {@link Messenger.CCTP_V2} from Solana.
+     */
     cctpParams: CctpParams;
     /**
      * The number of seconds that pool information taken from the chain will be cached.
@@ -92,6 +96,9 @@ export declare class AllbridgeCoreSdk {
      * @deprecated Do not use.
      */
     pool: LiquidityPoolService;
+    /**
+     * @deprecated Do not use.
+     */
     yield: YieldService;
     utils: Utils;
     private service;
@@ -104,38 +111,57 @@ export declare class AllbridgeCoreSdk {
      */
     constructor(nodeUrls: NodeUrlsConfig | NodeRpcUrls, params?: AllbridgeCoreSdkOptions);
     /**
-     * Returns {@link ChainDetailsMap} containing a list of supported tokens groped by chain.
-     *
-     * @param type - A string value which specifies ChainDetailsMap to retrieve.
-     *               Can be either 'swap' for send or 'pool' for liquidity pools setup.
-     *               Defaults to 'swap'.
+     * Returns {@link ChainDetailsMap} containing a list of tokens for liquidity pools operations grouped by chain.
+     * @param type - 'pool'
+     * @deprecated Do not use.
      */
-    /** @deprecated Do not use. */
     chainDetailsMap(type: "pool"): Promise<ChainDetailsMap>;
+    /**
+     * Returns {@link ChainDetailsMap} containing a list of supported tokens grouped by chain.
+     * @param type - Optional. 'swap' (tokens to send) is the only supported value and the default.
+     */
     chainDetailsMap(type?: "swap"): Promise<ChainDetailsMap>;
+    /**
+     * Returns {@link ChainDetailsMap} containing a list of supported tokens grouped by chain.
+     * @param type - 'swap' for tokens to send. The 'pool' value (liquidity pools setup) is deprecated. Do not use.
+     */
     chainDetailsMap(type: "swap" | "pool"): Promise<ChainDetailsMap>;
+    /**
+     * Returns a list of {@link TokenWithChainDetails | tokens} for liquidity pools operations.
+     * @param type - 'pool'
+     * @deprecated Do not use.
+     */
+    tokens(type: "pool"): Promise<TokenWithChainDetails[]>;
     /**
      * Returns a list of supported {@link TokenWithChainDetails | tokens}.
-     *
-     * @param type - A string value which specifies a set of tokens to retrieve.
-     *               Can be either 'swap' for tokens to send or 'pool' for liquidity pools operations.
-     *               Defaults to 'swap'.
+     * @param type - Optional. 'swap' (tokens to send) is the only supported value and the default.
      * @returns A promise that resolves to an array of {@link TokenWithChainDetails}.
      */
-    /** @deprecated Do not use. */
-    tokens(type: "pool"): Promise<TokenWithChainDetails[]>;
     tokens(type?: "swap"): Promise<TokenWithChainDetails[]>;
+    /**
+     * Returns a list of supported {@link TokenWithChainDetails | tokens}.
+     * @param type - 'swap' for tokens to send. The 'pool' value (liquidity pools operations) is deprecated. Do not use.
+     * @returns A promise that resolves to an array of {@link TokenWithChainDetails}.
+     */
     tokens(type: "swap" | "pool"): Promise<TokenWithChainDetails[]>;
     /**
-     * Returns a list of supported {@link TokenWithChainDetails | tokens} on the selected chain.
+     * Returns a list of {@link TokenWithChainDetails | tokens} for liquidity pools operations on the selected chain.
      * @param chainSymbol - The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: {@link ChainSymbol}.
-     * @param type - A string value which specifies a set of tokens to retrieve.
-     *               Can be either 'swap' for tokens to send or 'pool' for liquidity pools operations.
-     *               Defaults to 'swap'.
+     * @param type - 'pool'
+     * @deprecated Do not use.
      */
-    /** @deprecated Do not use. */
     tokensByChain(chainSymbol: string, type: "pool"): Promise<TokenWithChainDetails[]>;
+    /**
+     * Returns a list of supported {@link TokenWithChainDetails | tokens} on the selected chain.
+     * @param chainSymbol - The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: {@link ChainSymbol}.
+     * @param type - Optional. 'swap' (tokens to send) is the only supported value and the default.
+     */
     tokensByChain(chainSymbol: string, type?: "swap"): Promise<TokenWithChainDetails[]>;
+    /**
+     * Returns a list of supported {@link TokenWithChainDetails | tokens} on the selected chain.
+     * @param chainSymbol - The symbol of the chain representing one of the supported blockchain networks (e.g., "ETH" for Ethereum). For more details, see: {@link ChainSymbol}.
+     * @param type - 'swap' for tokens to send. The 'pool' value (liquidity pools operations) is deprecated. Do not use.
+     */
     tokensByChain(chainSymbol: string, type: "swap" | "pool"): Promise<TokenWithChainDetails[]>;
     /**
      * Fetches information about tokens transfer by chosen chainSymbol and transaction Id from the Allbridge Core API.
@@ -209,8 +235,7 @@ export declare class AllbridgeCoreSdk {
      * @param destinationChainToken selected token on the destination chain
      * @param messenger
      *
-     * @Deprecated Use {@link getGasFeeOptions} and separately call one of:
-     * {@link getAmountToBeReceived}, {@link getAmountToBeReceivedFromChain}, or {@link getAmountToBeReceivedFromPools}.
+     * @deprecated Use {@link getGasFeeOptions} and {@link getAmountToBeReceived}.
      */
     getAmountToBeReceivedAndGasFeeOptions(amountToSendFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger): Promise<AmountsAndGasFeeOptions>;
     /**
@@ -221,19 +246,27 @@ export declare class AllbridgeCoreSdk {
      * @param destinationChainToken selected token on the destination chain
      * @param messenger
      *
-     * @Deprecated Use {@link getGasFeeOptions} and separately call one of:
-     * {@link getAmountToSend}, {@link getAmountToSendFromChain}, or {@link getAmountToSendFromPools}.
+     * @deprecated Use {@link getGasFeeOptions} and {@link getAmountToSend}.
      */
     getAmountToSendAndGasFeeOptions(amountToBeReceivedFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger): Promise<AmountsAndGasFeeOptions>;
     /**
-     * Calculates the amount of tokens to be received as a result of transfer.
+     * Calculates the amount of tokens to be received as a result of transfer through a legacy messenger.
      * @param amountToSendFloat the amount of tokens that will be sent
      * @param sourceChainToken selected token on the source chain
      * @param destinationChainToken selected token on the destination chain
-     * @param messenger selected messenger
+     * @param messenger {@link LegacyMessenger}
+     * @deprecated Do not use.
      */
-    /** @deprecated Do not use. */
     getAmountToBeReceived(amountToSendFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: LegacyMessenger): Promise<string>;
+    /**
+     * Calculates the amount of tokens to be received as a result of transfer
+     * after applying the fee of the selected messenger.
+     * @param amountToSendFloat the amount of tokens that will be sent
+     * @param sourceChainToken selected token on the source chain
+     * @param destinationChainToken selected token on the destination chain
+     * @param messenger selected messenger, see {@link ActiveMessenger}
+     * @throws CCTPDoesNotSupportedError, OFTDoesNotSupportedError or SdkError if the route is not supported by the messenger
+     */
     getAmountToBeReceived(amountToSendFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: ActiveMessenger): Promise<string>;
     /**
      * Calculates the amount of tokens to be received as a result of transfer based on actual blockchain pool state.
@@ -243,8 +276,8 @@ export declare class AllbridgeCoreSdk {
      * @param messenger selected messenger
      * @param sourceProvider Optional. source chain Provider
      * @param destinationProvider Optional. destination chain Provider
+     * @deprecated Do not use.
      */
-    /** @deprecated Do not use. */
     getAmountToBeReceivedFromChain(amountToSendFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger, sourceProvider?: Provider, destinationProvider?: Provider): Promise<string>;
     /**
      * Calculates the amount of tokens to be received as a result of transfer based on passed pool state.
@@ -254,18 +287,27 @@ export declare class AllbridgeCoreSdk {
      * @param sourcePool source token pool state
      * @param destinationPool destination token pool state
      * @param messenger selected messenger
+     * @deprecated Do not use.
      */
-    /** @deprecated Do not use. */
     getAmountToBeReceivedFromPools(amountToSendFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, sourcePool: PoolInfo, destinationPool: PoolInfo, messenger: Exclude<Messenger, Messenger.OFT>): string;
     /**
-     * Calculates the amount of tokens to send based on requested tokens amount be received as a result of transfer.
+     * Calculates the amount of tokens to send based on requested tokens amount be received as a result of transfer through a legacy messenger.
      * @param amountToBeReceivedFloat the amount of tokens that should be received
      * @param sourceChainToken selected token on the source chain
      * @param destinationChainToken selected token on the destination chain
-     * @param messenger selected messenger
+     * @param messenger {@link LegacyMessenger}
+     * @deprecated Do not use.
      */
-    /** @deprecated Do not use. */
     getAmountToSend(amountToBeReceivedFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: LegacyMessenger): Promise<string>;
+    /**
+     * Calculates the amount of tokens to send based on requested tokens amount be received as a result of transfer
+     * after applying the fee of the selected messenger.
+     * @param amountToBeReceivedFloat the amount of tokens that should be received
+     * @param sourceChainToken selected token on the source chain
+     * @param destinationChainToken selected token on the destination chain
+     * @param messenger selected messenger, see {@link ActiveMessenger}
+     * @throws CCTPDoesNotSupportedError, OFTDoesNotSupportedError or SdkError if the route is not supported by the messenger
+     */
     getAmountToSend(amountToBeReceivedFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: ActiveMessenger): Promise<string>;
     /**
      * Calculates the amount of tokens to send based on requested tokens amount be received as a result of transfer based on actual blockchain pool state.
@@ -275,8 +317,8 @@ export declare class AllbridgeCoreSdk {
      * @param messenger selected messenger
      * @param sourceProvider Optional. source chain Provider
      * @param destinationProvider Optional. destination chain Provider
+     * @deprecated Do not use.
      */
-    /** @deprecated Do not use. */
     getAmountToSendFromChain(amountToBeReceivedFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger, sourceProvider?: Provider, destinationProvider?: Provider): Promise<string>;
     /**
      * Calculates the amount of tokens to send based on requested tokens amount be received as a result of transfer based on passed pool state.
@@ -286,14 +328,14 @@ export declare class AllbridgeCoreSdk {
      * @param sourcePool source token pool state
      * @param destinationPool destination token pool state
      * @param messenger selected messenger
+     * @deprecated Do not use.
      */
-    /** @deprecated Do not use. */
     getAmountToSendFromPools(amountToBeReceivedFloat: BigSource, sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, sourcePool: PoolInfo, destinationPool: PoolInfo, messenger: Exclude<Messenger, Messenger.OFT>): string;
     /**
      * Fetches possible ways to pay the transfer gas fee.
      * @param sourceChainToken selected token on the source chain
      * @param destinationChainToken selected token on the destination chain
-     * @param messenger
+     * @param messenger selected messenger, see {@link ActiveMessenger}
      * @returns {@link GasFeeOptions}
      */
     getGasFeeOptions(sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger): Promise<GasFeeOptions>;
@@ -301,7 +343,7 @@ export declare class AllbridgeCoreSdk {
      * Gets the average time in ms to complete a transfer for given tokens and messenger.
      * @param sourceChainToken selected token on the source chain.
      * @param destinationChainToken selected token on the destination chain.
-     * @param messenger
+     * @param messenger selected messenger, see {@link ActiveMessenger}
      * @returns Average transfer time in milliseconds or null if a given combination of tokens and messenger is not supported.
      */
     getAverageTransferTime(sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: Messenger): number | null;
@@ -328,15 +370,22 @@ export declare class AllbridgeCoreSdk {
      * @returns aprPercentageView
      */
     aprInPercents(apr: string): string;
+    /**
+     * Get possible limit of extra gas amount for a legacy messenger.
+     * @param sourceChainToken selected token on the source chain
+     * @param destinationChainToken selected token on the destination chain
+     * @param messenger {@link LegacyMessenger}
+     * @deprecated Do not use.
+     */
+    getExtraGasMaxLimits(sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: LegacyMessenger): Promise<ExtraGasMaxLimitResponse>;
     /**
      * Get possible limit of extra gas amount.
+     * For {@link Messenger.X_RESERVE} extra gas is not supported and zero limits are returned.
      * @param sourceChainToken selected token on the source chain
      * @param destinationChainToken selected token on the destination chain
-     * @param messenger selected Messenger
+     * @param messenger selected messenger, see {@link ActiveMessenger}
      * @returns {@link ExtraGasMaxLimitResponse}
      */
-    /** @deprecated Do not use. */
-    getExtraGasMaxLimits(sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: LegacyMessenger): Promise<ExtraGasMaxLimitResponse>;
     getExtraGasMaxLimits(sourceChainToken: TokenWithChainDetails, destinationChainToken: TokenWithChainDetails, messenger: ActiveMessenger): Promise<ExtraGasMaxLimitResponse>;
     /**
      * @deprecated Do not use.
@@ -354,14 +403,14 @@ export declare class AllbridgeCoreSdk {
      */
     getAmountFromVUsd(vUsdAmount: string, destToken: TokenWithChainDetails): Promise<AmountFormatted>;
     /**
-     * @deprecated Use {@link getSendAmountDetails}
+     * @deprecated Do not use.
      * @param amountInTokenPrecision
      * @param sourceToken
      * @param destToken
      */
     swapAndBridgeFeeCalculation(amountInTokenPrecision: string, sourceToken: TokenWithChainDetails, destToken: TokenWithChainDetails): Promise<SwapAndBridgeCalculationData>;
     /**
-     * @deprecated Use {@link getAmountToBeReceived} and then {@link getSendAmountDetails}
+     * @deprecated Do not use.
      * @param amountInTokenPrecision
      * @param sourceToken
      * @param destToken

package/dist/src/index.js

@@ -17,6 +17,9 @@ export class AllbridgeCoreSdk {
      * @deprecated Do not use.
      */
     pool;
+    /**
+     * @deprecated Do not use.
+     */
     yield;
     utils;
     service;
@@ -139,8 +142,7 @@ export class AllbridgeCoreSdk {
      * @param destinationChainToken selected token on the destination chain
      * @param messenger
      *
-     * @Deprecated Use {@link getGasFeeOptions} and separately call one of:
-     * {@link getAmountToBeReceived}, {@link getAmountToBeReceivedFromChain}, or {@link getAmountToBeReceivedFromPools}.
+     * @deprecated Use {@link getGasFeeOptions} and {@link getAmountToBeReceived}.
      */
     async getAmountToBeReceivedAndGasFeeOptions(amountToSendFloat, sourceChainToken, destinationChainToken, messenger) {
         return this.service.getAmountToBeReceivedAndGasFeeOptions(amountToSendFloat, sourceChainToken, destinationChainToken, messenger);
@@ -153,8 +155,7 @@ export class AllbridgeCoreSdk {
      * @param destinationChainToken selected token on the destination chain
      * @param messenger
      *
-     * @Deprecated Use {@link getGasFeeOptions} and separately call one of:
-     * {@link getAmountToSend}, {@link getAmountToSendFromChain}, or {@link getAmountToSendFromPools}.
+     * @deprecated Use {@link getGasFeeOptions} and {@link getAmountToSend}.
      */
     async getAmountToSendAndGasFeeOptions(amountToBeReceivedFloat, sourceChainToken, destinationChainToken, messenger) {
         return this.service.getAmountToSendAndGasFeeOptions(amountToBeReceivedFloat, sourceChainToken, destinationChainToken, messenger);
@@ -215,7 +216,7 @@ export class AllbridgeCoreSdk {
      * Fetches possible ways to pay the transfer gas fee.
      * @param sourceChainToken selected token on the source chain
      * @param destinationChainToken selected token on the destination chain
-     * @param messenger
+     * @param messenger selected messenger, see {@link ActiveMessenger}
      * @returns {@link GasFeeOptions}
      */
     async getGasFeeOptions(sourceChainToken, destinationChainToken, messenger) {
@@ -225,7 +226,7 @@ export class AllbridgeCoreSdk {
      * Gets the average time in ms to complete a transfer for given tokens and messenger.
      * @param sourceChainToken selected token on the source chain.
      * @param destinationChainToken selected token on the destination chain.
-     * @param messenger
+     * @param messenger selected messenger, see {@link ActiveMessenger}
      * @returns Average transfer time in milliseconds or null if a given combination of tokens and messenger is not supported.
      */
     getAverageTransferTime(sourceChainToken, destinationChainToken, messenger) {
@@ -283,7 +284,7 @@ export class AllbridgeCoreSdk {
         return this.service.getAmountFromVUsd(vUsdAmount, destToken);
     }
     /**
-     * @deprecated Use {@link getSendAmountDetails}
+     * @deprecated Do not use.
      * @param amountInTokenPrecision
      * @param sourceToken
      * @param destToken
@@ -292,7 +293,7 @@ export class AllbridgeCoreSdk {
         return this.service.swapAndBridgeFeeCalculation(amountInTokenPrecision, sourceToken, destToken);
     }
     /**
-     * @deprecated Use {@link getAmountToBeReceived} and then {@link getSendAmountDetails}
+     * @deprecated Do not use.
      * @param amountInTokenPrecision
      * @param sourceToken
      * @param destToken