@imtbl/sdk 0.27.9 → 0.27.11

package/dist/checkout_sdk.d.ts

@@ -566,7 +566,8 @@ interface ModuleConfiguration<T> {
 }
 
 /**
- * Interface representing an ERC20 token
+ * Type representing an ERC20 token
+ * @property {string} type - The token type, used to discriminate between {@link ERC20} and {@link Native}
  * @property {number} chainId - The chain ID
  * @property {string} address - The token address
  * @property {number} decimals - The token decimals
@@ -582,7 +583,8 @@ type ERC20 = {
     name?: string;
 };
 /**
- * Interface representing a native token
+ * Type representing a native token
+ * @property {string} type - The token type, used to discriminate between {@link ERC20} and {@link Native}
  * @property {number} chainId - The chain ID
  * @property {number} decimals - The token decimals
  * @property {string | undefined} symbol - The token symbol or undefined if it is not available
@@ -595,13 +597,25 @@ type Native = {
     symbol?: string;
     name?: string;
 };
-interface ExchangeOverrides {
+/**
+ * Type representing a token, either an {@link ERC20} or {@link Native}
+ */
+type Coin = ERC20 | Native;
+/**
+ * Type representing the overrides for the {@link Exchange} module
+ * @property {string} rpcURL - The RPC URL for the chain
+ * @property {ExchangeContracts} exchangeContracts - The DEX contract addresses
+ * @property {ERC20[]} commonRoutingTokens - The tokens used to find available pools for a swap
+ * @property {Coin} nativeToken - The native token of the chain
+ * @property {ERC20} wrappedNativeToken - The wrapped native token of the chain
+ */
+type ExchangeOverrides = {
     rpcURL: string;
     exchangeContracts: ExchangeContracts;
     commonRoutingTokens: ERC20[];
-    nativeToken: Native;
+    nativeToken: Coin;
     wrappedNativeToken: ERC20;
-}
+};
 
 /**
  * @typedef {string} Address - Represents an Ethereum address.