@imtbl/sdk 0.1.6-alpha → 0.1.7-alpha.1

package/dist/checkout_sdk.d.ts

@@ -546,6 +546,23 @@ declare class Web3Provider extends JsonRpcProvider {
     send(method: string, params: Array<any>): Promise<any>;
 }
 
+declare enum Environment {
+    PRODUCTION = "production",
+    SANDBOX = "sandbox"
+}
+declare class ImmutableConfiguration {
+    readonly environment: Environment;
+    readonly apiKey?: string;
+    constructor(options: {
+        environment: Environment;
+        apiKey?: string;
+    });
+}
+interface ModuleConfiguration<T> {
+    baseConfig: ImmutableConfiguration;
+    overrides?: T;
+}
+
 /**
  * Interface representing token information.
  * @property {string} name - The token name.
@@ -599,8 +616,11 @@ interface TokenFilter {
  */
 declare enum ChainId {
     ETHEREUM = 1,
-    GOERLI = 5,
-    POLYGON = 137
+    SEPOLIA = 11155111,
+    IMTBL_ZKEVM_DEVNET = 13373,
+    IMTBL_ZKEVM_TESTNET = 13372,
+    POLYGON_ZKEVM_TESTNET = 1442,
+    POLYGON_ZKEVM = 137
 }
 /**
  * Interface representing the information of a network.
@@ -615,6 +635,25 @@ interface NetworkInfo {
     nativeCurrency: TokenInfo;
     isSupported: boolean;
 }
+/**
+ * Type representing the details of a network.
+ * @property {string} chainIdHex - The hexadecimal ID of the network.
+ * @property {string} chainName - The name of the network.
+ * @property {string[]} rpcUrls - The RPS URLs of the network's node.
+ * @property {TokenInfo} nativeCurrency - The info of the network's native currency.
+ * @property {string[]} [blockExplorerUrls] - The URLs of the network's block explorer.
+ */
+type NetworkDetails = {
+    chainIdHex: string;
+    chainName: string;
+    rpcUrls: string[];
+    nativeCurrency: TokenInfo;
+    blockExplorerUrls?: string[];
+};
+/**
+ * Type representing the mapping between ChainId and NetworkDetails
+ */
+type NetworkMap = Map<ChainId, NetworkDetails>;
 /**
  * Interface representing the parameters for {@link Checkout.switchNetwork}.
  * @property {Web3Provider} provider - The provider to connect to the network.
@@ -708,6 +747,10 @@ interface GetAllBalancesParams {
 interface GetAllBalancesResult {
     balances: GetBalanceResult[];
 }
+interface CheckoutOverrides {
+}
+interface CheckoutModuleConfiguration extends ModuleConfiguration<CheckoutOverrides> {
+}
 /**
  * Enum representing the list of default supported providers.
  */
@@ -827,57 +870,6 @@ declare enum WalletFilterTypes {
     DESKTOP = "desktop",
     MOBILE = "mobile"
 }
-/**
- * Enum representing the types of token filters available.
- */
-declare enum SupportedFiatCurrencies {
-    USD = "USD"
-}
-/**
- * Interface representing the parameters for {@link Checkout.convertTokenToFiat}.
- * @property {BigNumber} amount - The the amount of token we are converting.
- * @property {TokenInfo} token - The token we are converting from.
- * @property {SupportedFiatCurrencies}  fiatSymbol - The fiat currency we are converting to.
- */
-interface ConvertTokensToFiatParams {
-    amounts: {
-        [key: string]: {
-            amount: BigNumber;
-            token: TokenInfo;
-        };
-    };
-    fiatSymbol: SupportedFiatCurrencies;
-}
-/**
- * Interface representing the result of a specific token to fiat conversion.
- * @property {TokenInfo} token - The token that we converted from.
- * @property {string} fiatSymbol - The fiat currency we converted to.
- * @property {number} quotedAt - The unix timestamp for when the quote was generated.
- * @property {number} quote - The quote at the given timestamp.
- * @property {BigNumber} amount - The amount we converted.
- * @property {number} convertedAmount - The converted amount.
- */
-interface TokenToFiatConversionResult extends FiatConversionQuote {
-    token: TokenInfo;
-    fiatSymbol: string;
-    amount: BigNumber;
-    convertedAmount: number;
-}
-/**
- * Interface representing the result of {@link Checkout.convertTokenToFiat}.
- */
-interface ConvertTokensToFiatResult {
-    [key: string]: TokenToFiatConversionResult;
-}
-/**
- * Interface representing the result of a specific token to fiat conversion.
- * @property {number} quotedAt - The unix timestamp for when the quote was generated.
- * @property {number} quote - The quote at the given timestamp.
- */
-interface FiatConversionQuote {
-    quote: number;
-    quotedAt: number;
-}
 /**
  * The different types of errors that can be returned by the checkout process.
  */
@@ -892,10 +884,7 @@ declare enum CheckoutErrorType {
     PROVIDER_REQUEST_MISSING_ERROR = "PROVIDER_REQUEST_MISSING_ERROR",
     PROVIDER_REQUEST_FAILED_ERROR = "PROVIDER_REQUEST_FAILED_ERROR",
     USER_REJECTED_REQUEST_ERROR = "USER_REJECTED_REQUEST_ERROR",
-    TRANSACTION_ERROR = "TRANSACTION_ERROR",
-    FIAT_CONVERSION_ERROR = "FIAT_CONVERSION_ERROR",
-    TOKEN_NOT_SUPPORTED_ERROR = "TOKEN_NOT_SUPPORTED_ERROR",
-    FIAT_CURRENCY_NOT_SUPPORTED_ERROR = "FIAT_CURRENCY_NOT_SUPPORTED_ERROR"
+    TRANSACTION_ERROR = "TRANSACTION_ERROR"
 }
 /**
  * The type signature for an error.
@@ -908,9 +897,17 @@ type ErrorType = {
         [key: string]: string;
     };
 };
+declare class CheckoutConfiguration {
+    readonly environment: Environment;
+    readonly networkMap: NetworkMap;
+    constructor(config: CheckoutModuleConfiguration);
+}
 declare class Checkout {
+    readonly config: CheckoutConfiguration;
+    constructor(config?: CheckoutModuleConfiguration);
     /**
-     * Check if a wallet is connected to the current application without requesting permission from the wallet and hence triggering a connect popup.
+     * Check if a wallet is connected to the current application
+     * without requesting permission from the wallet and hence triggering a connect popup.
      * @param {CheckConnectionParams} params - The necessary data required to verify a wallet connection status.
      * @returns Wallet connection status details.
      * @throws {@link ErrorType}
@@ -931,14 +928,17 @@ declare class Checkout {
      */
     switchNetwork(params: SwitchNetworkParams): Promise<SwitchNetworkResult>;
     /**
-     * Fetch the balance of the native token of the current connected network or, if a contract address is provided, it will return the balance of that ERC20 token. For example, if the wallet is connected to the Ethereum Mainnet then the function gets the wallet ETH L1 balance.
+     * Fetch the balance of the native token of the current connected network or,
+     * if a contract address is provided, it will return the balance of that ERC20 token. For example,
+     * if the wallet is connected to the Ethereum Mainnet then the function gets the wallet ETH L1 balance.
      * @param {GetBalanceParams} params - The necessary data required to fetch the wallet balance.
      * @returns Native token balance for the given wallet.
      * @throws {@link ErrorType}
      */
     getBalance(params: GetBalanceParams): Promise<GetBalanceResult>;
     /**
-     * Fetch all available balances (ERC20 & Native) of the current connected network of the given wallet. It will loop through the list of allowed tokens and check for balance on each one.
+     * Fetch all available balances (ERC20 & Native) of the current connected network of the given wallet.
+     * It will loop through the list of allowed tokens and check for balance on each one.
      * @param {GetAllBalancesParams} params - The necessary data required to fetch all the wallet balances.
      * @returns List of tokens balance for the given wallet.
      * @throws {@link ErrorType}
@@ -983,4 +983,4 @@ declare class Checkout {
     getNetworkInfo(params: GetNetworkParams): Promise<NetworkInfo>;
 }
 
-export { ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, ConnectParams, ConnectResult, ConnectionProviders, ConvertTokensToFiatParams, ConvertTokensToFiatResult, ErrorType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, NetworkFilter, NetworkFilterTypes, NetworkInfo, SendTransactionParams, SendTransactionResult, SupportedFiatCurrencies, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, TokenToFiatConversionResult, Transaction, WalletFilter, WalletFilterTypes, WalletInfo };
+export { ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, ConnectParams, ConnectResult, ConnectionProviders, ErrorType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, NetworkFilter, NetworkFilterTypes, NetworkInfo, SendTransactionParams, SendTransactionResult, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, Transaction, WalletFilter, WalletFilterTypes, WalletInfo };