@imtbl/checkout-sdk 2.0.0-alpha.0

package/dist/types/types/chains.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Enum representing different chain IDs.
+ * @enum {number}
+ * @property {number} IMTBL_ZKEVM_MAINNET - The chain ID for IMTBL ZKEVM Mainnet.
+ * @property {number} IMTBL_ZKEVM_TESTNET - The chain ID for IMTBL ZKEVM Testnet.
+ * @property {number} IMTBL_ZKEVM_DEVNET - The chain ID for IMTBL ZKEVM Devnet.
+ * @property {number} ETHEREUM - The chain ID for Ethereum.
+ * @property {number} SEPOLIA - The chain ID for Sepolia.
+ */
+export declare enum ChainId {
+    IMTBL_ZKEVM_MAINNET = 13371,
+    IMTBL_ZKEVM_TESTNET = 13473,
+    IMTBL_ZKEVM_DEVNET = 15003,
+    ETHEREUM = 1,
+    SEPOLIA = 11155111
+}
+/**
+ * Enum representing different chain names.
+ * @enum {string}
+ * @property {string} IMTBL_ZKEVM_MAINNET - The chain name for IMTBL ZKEVM Mainnet.
+ * @property {string} IMTBL_ZKEVM_TESTNET - The chain name for IMTBL ZKEVM Testnet.
+ * @property {string} IMTBL_ZKEVM_DEVNET - The chain name for IMTBL ZKEVM Devnet.
+ * @property {string} ETHEREUM - The chain name for Ethereum.
+ * @property {string} SEPOLIA - The chain name for Sepolia.
+ */
+export declare enum ChainName {
+    ETHEREUM = "Ethereum",
+    SEPOLIA = "Sepolia",
+    IMTBL_ZKEVM_TESTNET = "Immutable zkEVM Testnet",
+    IMTBL_ZKEVM_DEVNET = "Immutable zkEVM Dev",
+    IMTBL_ZKEVM_MAINNET = "Immutable zkEVM"
+}
+/**
+ * Enum representing different chain slugs.
+ * @enum {string}
+ * @property {string} IMTBL_ZKEVM_MAINNET - The chain slug for IMTBL ZKEVM Mainnet.
+ * @property {string} IMTBL_ZKEVM_TESTNET - The chain slug for IMTBL ZKEVM Testnet.
+ * @property {string} IMTBL_ZKEVM_DEVNET - The chain slug for IMTBL ZKEVM Devnet.
+ * @property {string} ETHEREUM - The chain slug for Ethereum.
+ * @property {string} SEPOLIA - The chain slug for Sepolia.
+ */
+export declare enum ChainSlug {
+    ETHEREUM = "ethereum",
+    SEPOLIA = "sepolia",
+    IMTBL_ZKEVM_MAINNET = "imtbl-zkevm-mainnet",
+    IMTBL_ZKEVM_TESTNET = "imtbl-zkevm-testnet",
+    IMTBL_ZKEVM_DEVNET = "imtbl-zkevm-devnet"
+}

package/dist/types/types/config.d.ts

@@ -0,0 +1,265 @@
+import { Environment, ModuleConfiguration } from '@imtbl/config';
+import { ExchangeOverrides, SecondaryFee } from '@imtbl/dex-sdk';
+import { Passport } from '@imtbl/passport';
+import { TokenInfo } from './tokenInfo';
+import { ChainId } from './chains';
+export interface CheckoutOverrides {
+    environment?: Environment;
+    [key: string]: unknown;
+}
+interface CheckoutFeatureConfiguration {
+    enable: boolean;
+}
+/**
+ * A type representing the on-ramp configurations for the checkout SDK.
+ * @property {boolean} enable - To enable on-ramp feature in Checkout sdk.
+*/
+export interface CheckoutOnRampConfiguration extends CheckoutFeatureConfiguration {
+}
+/**
+ * A type representing the swap configurations for the checkout SDK.
+ * @property {boolean} enable - To enable swap feature in Checkout sdk.
+*/
+export interface CheckoutSwapConfiguration extends CheckoutFeatureConfiguration {
+}
+/**
+ * A type representing the bridge configurations for the checkout SDK.
+ * @property {boolean} enable - To enable bridge feature in Checkout sdk.
+*/
+export interface CheckoutBridgeConfiguration extends CheckoutFeatureConfiguration {
+}
+/**
+ * A type representing checkout SDK configurations.
+ * @property {CheckoutOnRampConfiguration} onRamp - To configure the on-ramp feature.
+ * @property {CheckoutSwapConfiguration} swap - To configure the swap feature.
+ * @property {CheckoutBridgeConfiguration} bridge - To configure the bridge feature.
+ * @property {Passport} passport - To enable passport wallet integration.
+ * @property {string} publishableKey - To identify your integration for tracking and analytics purposes.
+*/
+export interface CheckoutModuleConfiguration extends ModuleConfiguration<CheckoutOverrides> {
+    onRamp?: CheckoutOnRampConfiguration;
+    swap?: CheckoutSwapConfiguration;
+    bridge?: CheckoutBridgeConfiguration;
+    passport?: Passport;
+    publishableKey?: string;
+    environment?: Environment;
+    overrides?: CheckoutOverrides;
+}
+/**
+ * A type representing various remotely defined configurations which are
+ * accessible via the Checkout config and configured based on the Environment.
+ * @property {ConnectConfig} connect
+ * @property {DexConfig} dex
+ * @property {OnRampConfig} onramp
+ * @property {BridgeConfig} bridge
+ * @property {AllowedNetworkConfig[]} allowedNetworks
+ * @property {GasEstimateTokenConfig | undefined} gasEstimateTokens
+ * @property {ImxAddressConfig | undefined} imxAddressMapping
+ * @property {TelemetryConfig | undefined} telemetry
+ * @property {SquidConfig | undefined} squid
+ */
+export type RemoteConfiguration = {
+    /** The config used for the Connect. */
+    connect: ConnectConfig;
+    /** The config used for the DEX. */
+    dex: DexConfig;
+    /** The config used for the OnRamp */
+    onramp: OnRampConfig;
+    /** The config used for the Bridge. */
+    bridge: BridgeConfig;
+    /** The config used for Add Tokens */
+    addTokens: AddTokensConfig;
+    /** An array representing the allowed networks. */
+    allowedNetworks: AllowedNetworkConfig[];
+    /** The config for the tokens used to estimate gas. */
+    gasEstimateTokens?: GasEstimateTokenConfig;
+    /** The IMX address mappings across available networks. */
+    imxAddressMapping?: ImxAddressConfig;
+    /** Telemetry config. */
+    telemetry?: TelemetryConfig;
+    /** Squid config. */
+    squid?: SquidConfig;
+    /** The checkout version info. */
+    checkoutWidgetsVersion: CheckoutWidgetsVersionConfig;
+    /** Risk assessment config. */
+    riskAssessment?: RiskAssessmentConfig;
+};
+/**
+ * A type representing the configuration for the Add Tokens.
+ * @property {TokenInfo[] | undefined} tokens
+ */
+export type AddTokensConfig = {
+    /** A boolean value for enabling/disabling Add Tokens */
+    enabled: boolean;
+};
+/**
+ * A type representing the fee structure for an OnRamp provider
+ * @property {string | undefined} minPercentage
+ * @property {string | undefined} maxPercentage
+ * @property {string | undefined} feePercentage
+ */
+export type OnRampProviderFees = {
+    /** The minimum percentage fee shown if a fee range is provided */
+    minPercentage?: string;
+    /** The maximum percentage fee shown if a fee range is provided */
+    maxPercentage?: string;
+    /** The specific fee percentage shown if there is no range provided */
+    feePercentage?: string;
+};
+/**
+ * A type representing the configuration for the OnRamp for a specific provider.
+ * @property {string} publishableApiKey
+ * @property {TokenInfo[]} tokens
+ * @property {OnRampProviderFees} fees
+ */
+export type OnRampProviderConfig = {
+    /** The on ramp provider publishable api-key */
+    publishableApiKey: string;
+    /** The allowed tokens for the OnRamp provider */
+    tokens: TokenInfo[];
+    /** The on ramp provider transaction fees */
+    fees: OnRampProviderFees;
+};
+export declare enum OnRampProvider {
+    TRANSAK = "201811419111"
+}
+/**
+ * A type representing the configuration for the OnRamp.
+ * @property {OnRampProviderConfig} transak
+ */
+export type OnRampConfig = {
+    /** OnRamp config for Transak provider */
+    [key: string]: OnRampProviderConfig;
+};
+/**
+ * A type representing the configuration for the Connect.
+ * @property {boolean} walletConnect
+ */
+export type ConnectConfig = {
+    /** A boolean value for enabling/disabling WalletConnect */
+    walletConnect: boolean;
+    /** A configuration for injected wallets */
+    injected: {
+        /** List for sorting injected wallets via wallet rdns */
+        priorityWalletRdns: string[];
+        /** List for blocking injected wallets via wallet rdns */
+        blocklistWalletRdns: string[];
+    };
+};
+/**
+ * A type representing the configuration for the DEX.
+ * @property {ExchangeOverrides | undefined} overrides
+ * @property {TokenInfo[] | undefined} tokens
+ */
+export type DexConfig = {
+    /** The DEX overrides. */
+    overrides?: ExchangeOverrides;
+    /** An array of tokens compatible with the DEX. */
+    tokens?: TokenInfo[];
+    /** An array of secondary fees to be applied to swaps */
+    secondaryFees?: SecondaryFee[];
+    /** An array of tokens to be blocked from the DEX */
+    blocklist?: BlockedToken[];
+};
+/**
+ * A type representing a token that is blocked from the DEX.
+ */
+export type BlockedToken = {
+    address: string;
+    symbol: string;
+};
+/**
+ * A type representing the configuration for the Bridge for all the supported chains.
+ */
+export type BridgeConfig = {
+    /** An object containing the bridge configuration per chain */
+    [chainId: string]: BridgeChainConfig;
+};
+/**
+ * A type representing the configuration for the Bridge.
+ * @property {TokenInfo[] | undefined} tokens
+ */
+export type BridgeChainConfig = {
+    /** An array of tokens compatible with the Bridge. */
+    tokens?: TokenInfo[];
+};
+/**
+ * A type representing an allowed network.
+ * @property {number} chainId
+ */
+export type AllowedNetworkConfig = {
+    /** The network chain id. */
+    chainId: number;
+};
+/**
+ * A type representing the IMX address mappings across available networks.
+ * @type {{ [chainId: string]: string }}
+ */
+export type ImxAddressConfig = {
+    [chainId: string]: string;
+};
+/**
+ * A type representing the telemetry configurations.
+ * @property {string} segmentPublishableKey
+ */
+export type TelemetryConfig = {
+    segmentPublishableKey: string;
+};
+/**
+ * A type representing the squid integrator id.
+ * @property {string} integratorId
+ */
+export type SquidConfig = {
+    integratorId: string;
+};
+/**
+ * A type representing the required information to estimate gas for a transaction.
+ * @type {{ [key: string]: { bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig, swapAddresses?: GasEstimateSwapTokenConfig } }}
+ * - A map of addresses for estimating gas keyed by the network chain id.
+ * @property {GasEstimateBridgeToL2TokenConfig | undefined} bridgeToL2Addresses
+ * @property {GasEstimateSwapTokenConfig | undefined} swapAddresses
+ */
+export type GasEstimateTokenConfig = {
+    [key: string]: {
+        /** The type representing the addresses for a bridge to layer 2 gas estimate. */
+        bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig;
+        /** The type representing the addresses for a swap gas estimate */
+        swapAddresses?: GasEstimateSwapTokenConfig;
+    };
+};
+/**
+ * A type representing the config for a bridge to layer 2 gas estimate.
+ * @property {string | 'NATIVE'} gasTokenAddress
+ * @property {string} fromAddress
+ */
+export type GasEstimateBridgeToL2TokenConfig = {
+    /**  The address of the gas token. */
+    gasTokenAddress: string | 'NATIVE';
+    /** The address of the token being bridged. */
+    fromAddress: string;
+};
+/**
+ * A type representing the config for a swap gas estimate.
+ * @property {string} inAddress
+ * @property {string} outAddress
+ */
+export type GasEstimateSwapTokenConfig = {
+    /** The in token address. */
+    inAddress: string;
+    /** The out token address. */
+    outAddress: string;
+};
+/**
+ * A type that represents the tokens configuration for chain.
+ */
+export type ChainTokensConfig = {
+    [key in ChainId]?: TokenInfo[];
+};
+export type CheckoutWidgetsVersionConfig = {
+    compatibleVersionMarkers: string[];
+};
+export type RiskAssessmentConfig = {
+    enabled: boolean;
+    levels: string[];
+};
+export {};

package/dist/types/types/connect.d.ts

@@ -0,0 +1,34 @@
+import { Eip1193Provider } from 'ethers';
+import { WrappedBrowserProvider } from './provider';
+/**
+ * Interface representing the params of {@link Checkout.connect}.
+ * @property {WrappedBrowserProvider | Eip1193Provider} provider - The provider used to connect to the network.
+ * @property {boolean | undefined} requestWalletPermissions - A boolean that will trigger a permission request for wallet connection.
+ */
+export interface ConnectParams {
+    provider: WrappedBrowserProvider | Eip1193Provider;
+    requestWalletPermissions?: boolean;
+}
+/**
+ * Interface representing the result of {@link Checkout.connect}.
+ * @property {WrappedBrowserProvider} provider - The provider used to connect to the network.
+ */
+export interface ConnectResult {
+    provider: WrappedBrowserProvider;
+}
+/**
+ * Interface representing the params of {@link Checkout.checkIsWalletConnected}.
+ * @property {WrappedBrowserProvider | Eip1193Provider} provider - The provider used to connect to the network.
+ */
+export interface CheckConnectionParams {
+    provider: WrappedBrowserProvider | Eip1193Provider;
+}
+/**
+ * Interface representing the result of {@link Checkout.checkIsWalletConnected}.
+ * @property {boolean} isConnected - A boolean indicating the connection status of the Web3 provider.
+ * @property {string} walletAddress - The wallet address used to check the connection.
+ */
+export interface CheckConnectionResult {
+    isConnected: boolean;
+    walletAddress: string;
+}

package/dist/types/types/eip1193.d.ts

@@ -0,0 +1,47 @@
+import { Address } from '@imtbl/bridge-sdk';
+export interface EIP1193Provider extends BaseEIP1193Provider, PassportEIP1193Provider, MetaMaskEIP1193Provider, WalletConnectEIP1193Provider {
+}
+export interface BaseEIP1193Provider {
+    request(args: EIP1193RequestArguments): Promise<unknown>;
+    on<TEvent extends keyof EIP1193EventMap>(event: TEvent, listener: EIP1193EventMap[TEvent]): void;
+    removeListener<TEvent extends keyof EIP1193EventMap>(event: TEvent, listener: EIP1193EventMap[TEvent]): void;
+}
+export interface PassportEIP1193Provider {
+    isPassport?: boolean;
+}
+export interface MetaMaskEIP1193Provider {
+    isMetaMask?: boolean;
+}
+export interface WalletConnectEIP1193Provider {
+    isWalletConnect?: boolean;
+}
+interface EIP1193RequestArguments {
+    readonly method: string;
+    readonly params?: readonly unknown[] | object;
+}
+/**
+ * Errors
+ */
+export declare class ProviderRpcError extends Error {
+    code: number;
+    details: string;
+    constructor(code: number, message: string);
+}
+/**
+ *  Provider Events
+ */
+export type ProviderConnectInfo = {
+    chainId: string;
+};
+export type ProviderMessage = {
+    type: string;
+    data: unknown;
+};
+export type EIP1193EventMap = {
+    accountsChanged(accounts: Address[]): void;
+    chainChanged(chainId: string): void;
+    connect(connectInfo: ProviderConnectInfo): void;
+    disconnect(error: ProviderRpcError): void;
+    message(message: ProviderMessage): void;
+};
+export {};

package/dist/types/types/eip6963.d.ts

@@ -0,0 +1,29 @@
+import { EIP1193Provider } from './eip1193';
+/**
+ * Event detail from the `eip6963:announceProvider` event.
+ */
+export interface EIP6963ProviderDetail {
+    info: EIP6963ProviderInfo;
+    provider: EIP1193Provider;
+}
+/**
+ * Metadata of the EIP-1193 Provider.
+ */
+export interface EIP6963ProviderInfo {
+    icon: `data:image/${string}`;
+    name: string;
+    rdns: string;
+    uuid: string;
+}
+/**
+ * Event type to announce an EIP-1193 Provider.
+ */
+export interface EIP6963AnnounceProviderEvent extends CustomEvent<EIP6963ProviderDetail> {
+    type: 'eip6963:announceProvider';
+}
+/**
+ * Event type to request EIP-1193 Providers.
+ */
+export interface EIP6963RequestProviderEvent extends Event {
+    type: 'eip6963:requestProvider';
+}

package/dist/types/types/fees.d.ts

@@ -0,0 +1,10 @@
+export interface OrderFee {
+    amount: FeeToken | FeePercentage;
+    recipient: string;
+}
+export interface FeeToken {
+    token: string;
+}
+export interface FeePercentage {
+    percentageDecimal: number;
+}

package/dist/types/types/fiatRamp.d.ts

@@ -0,0 +1,25 @@
+import { Eip1193Provider } from 'ethers';
+import { WrappedBrowserProvider } from './provider';
+/**
+ * An enum representing the type of exchange.
+ * @enum {string}
+ * @property {string} ONRAMP - The exchange type for transacting.
+ */
+export declare enum ExchangeType {
+    ONRAMP = "onramp"
+}
+/**
+ * Interface representing the result of {@link Checkout.createFiatRampUrl}.
+ * @property {ExchangeType} exchangeType - The ExchangeType specified.
+ * @property {WrappedBrowserProvider | Eip1193Provider} browserProvider - The WrappedBrowserProvider used to exchange.
+ * @property {string | undefined} tokenAmount - The token amount specified as input.
+ * @property {string | undefined} tokenAddress - The token address specified as input.
+ * @property {Passport | undefined} passport - The Passport instance specified as input.
+ */
+export interface FiatRampParams {
+    exchangeType: ExchangeType;
+    browserProvider: WrappedBrowserProvider | Eip1193Provider;
+    tokenAmount?: string;
+    tokenAddress?: string;
+    passport?: any;
+}

package/dist/types/types/gasEstimate.d.ts

@@ -0,0 +1,64 @@
+import { BridgeFeeResponse } from '@imtbl/bridge-sdk';
+import { TokenInfo } from './tokenInfo';
+/**
+ * An enum representing the type of gas estimate.
+ * @enum {string}
+ * @property {string} BRIDGE_TO_L2 - The gas estimate type for a bridge to L2 transaction.
+ * @property {string} SWAP - The gas estimate type for a swap transaction.
+ */
+export declare enum GasEstimateType {
+    BRIDGE_TO_L2 = "BRIDGE_TO_L2",
+    SWAP = "SWAP"
+}
+/**
+ * Represents the parameters for estimating gas usage, which can be either
+ * GasEstimateBridgeToL2Params or GasEstimateSwapParams {@link Checkout.gasEstimate}.
+ * @typedef {GasEstimateBridgeToL2Params | GasEstimateSwapParams} GasEstimateParams
+ */
+export type GasEstimateParams = GasEstimateBridgeToL2Params | GasEstimateSwapParams;
+/**
+ * An interface representing the parameters for estimating gas for a bridge to L2 transaction {@link Checkout.gasEstimate}.
+ * @param {GasEstimateType.BRIDGE_TO_L2} gasEstimateType - The type of gas estimate.
+ */
+export interface GasEstimateBridgeToL2Params {
+    gasEstimateType: GasEstimateType.BRIDGE_TO_L2;
+}
+/**
+ * An interface representing the parameters for a gas estimate swap {@link Checkout.gasEstimate}.
+ * @interface
+ * @property {GasEstimateType.SWAP} gasEstimateType - The type of gas estimate, which is always "swap".
+ */
+export interface GasEstimateSwapParams {
+    gasEstimateType: GasEstimateType.SWAP;
+}
+/**
+ * An interface representing the result of a gas estimate for a swap transaction {@link Checkout.gasEstimate}.
+ * @interface GasEstimateSwapResult
+ * @property {GasEstimateType.SWAP} gasEstimateType - The type of gas estimate, which is always "SWAP".
+ * @property {TokenAmountEstimate} fees - The estimated gas fee for the swap transaction.
+ */
+export interface GasEstimateSwapResult {
+    gasEstimateType: GasEstimateType.SWAP;
+    fees: TokenAmountEstimate;
+}
+/**
+ * An interface representing the result of a gas estimate for a bridge to L2 transaction {@link Checkout.gasEstimate}.
+ * @interface GasEstimateBridgeToL2Result
+ * @property {GasEstimateType.BRIDGE_TO_L2} gasEstimateType - The type of gas estimate.
+ * @property {BridgeFeeResponse} fees - The estimated fees for the transaction.
+ * @property {TokenInfo | undefined} token - The gas token information.
+ */
+export interface GasEstimateBridgeToL2Result {
+    gasEstimateType: GasEstimateType.BRIDGE_TO_L2;
+    fees: BridgeFeeResponse;
+    token?: TokenInfo;
+}
+/**
+ * An interface representing the estimated fees.
+ * @property {bigint} totalFees - The estimated fees for the transaction.
+ * @property {TokenInfo | undefined} token - The gas token information.
+ */
+export interface TokenAmountEstimate {
+    totalFees?: bigint;
+    token?: TokenInfo;
+}

package/dist/types/types/index.d.ts

@@ -0,0 +1,20 @@
+export * from './balances';
+export * from './buy';
+export * from './cancel';
+export * from './chains';
+export * from './config';
+export * from './connect';
+export * from './eip1193';
+export * from './eip6963';
+export * from './fees';
+export * from './gasEstimate';
+export * from './network';
+export * from './networkInfo';
+export * from './sell';
+export * from './token';
+export * from './tokenInfo';
+export * from './transaction';
+export * from './wallet';
+export * from './provider';
+export * from './smartCheckout';
+export * from './fiatRamp';

package/dist/types/types/network.d.ts

@@ -0,0 +1,77 @@
+import { Eip1193Provider } from 'ethers';
+import { ChainId } from './chains';
+import { NetworkInfo } from './networkInfo';
+import { TokenInfo } from './tokenInfo';
+import { WrappedBrowserProvider } from './provider';
+/**
+ * Interface representing the parameters for {@link Checkout.addNetwork}.
+ * @property {WrappedBrowserProvider} provider - The provider to connect to the network.
+ * @property {ChainId} chainId - The ID of the network to add. We only support adding Immutable zkEVM and Immutable zkEVM Testnet.
+ */
+export interface AddNetworkParams {
+    provider: WrappedBrowserProvider | Eip1193Provider;
+    chainId: ChainId;
+}
+/**
+ * Interface representing the parameters for {@link Checkout.switchNetwork}.
+ * @property {WrappedBrowserProvider | Eip1193Provider} provider - The provider to connect to the network.
+ * @property {ChainId} chainId - The ID of the network to switch to.
+ */
+export interface SwitchNetworkParams {
+    provider: WrappedBrowserProvider | Eip1193Provider;
+    chainId: ChainId;
+}
+/**
+ * Represents the result of switching the network in a Web3 application {@link Checkout.switchNetwork}.
+ * @interface SwitchNetworkResult
+ * @property {NetworkInfo} network - The information about the switched network.
+ * @property {WrappedBrowserProvider} provider - The Web3 provider for the switched network.
+ */
+export interface SwitchNetworkResult {
+    network: NetworkInfo;
+    provider: WrappedBrowserProvider;
+}
+/**
+ * * Interface representing the parameters for {@link Checkout.getNetworkInfo}.
+ * @property {BrowserProvider} provider - The provider to connect to the network.
+ */
+export interface GetNetworkParams {
+    provider: WrappedBrowserProvider | Eip1193Provider;
+}
+/**
+ * * Interface representing the parameters for {@link Checkout.getNetworkAllowList}.
+ * @property {NetworkFilterTypes} type - The type of allow list filter to apply.
+ * @property {NetworkFilter[]} [exclude] - The list of networks to exclude from the allow list.
+ */
+export interface GetNetworkAllowListParams {
+    type: NetworkFilterTypes;
+    exclude?: NetworkFilter[];
+}
+/**
+ * Interface representing the result of {@link Checkout.getNetworkAllowList}.
+ * @property {NetworkInfo[]} networks - The list of allowed networks.
+ */
+export interface GetNetworkAllowListResult {
+    networks: NetworkInfo[];
+}
+/**
+ * Enum representing the types of filters that can be applied to get the allow list of networks.
+ */
+export declare enum NetworkFilterTypes {
+    ALL = "all"
+}
+/**
+ * Interface representing a filter for filtering a specific network.
+ * @property {ChainId} chainId - The ID of the network to allow or disallow.
+ */
+export interface NetworkFilter {
+    chainId: ChainId;
+}
+export type NetworkDetails = {
+    chainIdHex: string;
+    chainName: string;
+    rpcUrls: string[];
+    nativeCurrency: TokenInfo;
+    blockExplorerUrls?: string[];
+};
+export type NetworkMap = Map<ChainId, NetworkDetails>;

package/dist/types/types/networkInfo.d.ts

@@ -0,0 +1,15 @@
+import { TokenInfo } from './tokenInfo';
+/**
+ * Represents information about a network.
+ * @interface NetworkInfo
+ * @property {string} name - The name of the network.
+ * @property {bigint} chainId - The chain ID of the network.
+ * @property {TokenInfo} nativeCurrency - Information about the native currency of the network.
+ * @property {boolean} isSupported - Indicates whether the network is supported.
+ */
+export interface NetworkInfo {
+    name: string;
+    chainId: bigint;
+    nativeCurrency: TokenInfo;
+    isSupported: boolean;
+}

package/dist/types/types/provider.d.ts

@@ -0,0 +1,45 @@
+import { BrowserProvider, BrowserProviderOptions, Eip1193Provider as EthersEip1193Provider, Networkish } from 'ethers';
+import { EIP1193Provider } from './eip1193';
+/**
+ * Enum representing the names of different wallet providers.
+ */
+export declare enum WalletProviderName {
+    PASSPORT = "passport",
+    METAMASK = "metamask",
+    WALLETCONNECT = "walletconnect"
+}
+/**
+ * Enum representing the rdns of injected wallet providers.
+ */
+export declare enum WalletProviderRdns {
+    PASSPORT = "com.immutable.passport",
+    METAMASK = "io.metamask",
+    WALLETCONNECT = "walletconnect"
+}
+/**
+ * Interface for the parameters required to create a wallet provider {@link Checkout.createProvider}.
+ * @interface CreateProviderParams
+ * @property {WalletProviderName} walletProviderName - The wallet provider name to create a provider for.
+ */
+export interface CreateProviderParams {
+    walletProviderName: WalletProviderName;
+}
+/**
+ * Represents the result of creating a Web3 provider {@link Checkout.createProvider}.
+ * @property {WrappedBrowserProvider} provider - The created Browser provider.
+ * @property {WalletProviderName} walletProviderName - The wallet provider name of the provider that was created.
+ */
+export type CreateProviderResult = {
+    provider: WrappedBrowserProvider;
+    walletProviderName: WalletProviderName;
+};
+export type ValidateProviderOptions = {
+    allowMistmatchedChainId: boolean;
+    allowUnsupportedProvider: boolean;
+};
+export declare const validateProviderDefaults: ValidateProviderOptions;
+export declare class WrappedBrowserProvider extends BrowserProvider {
+    #private;
+    ethereumProvider: EIP1193Provider | undefined;
+    constructor(ethereum: EthersEip1193Provider, network?: Networkish, _options?: BrowserProviderOptions);
+}