@imtbl/sdk 0.1.9-alpha → 0.1.9-alpha.2

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference path="global.d.ts" />
 /// <reference types="node" />
-import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration as BlockchainDataModuleConfiguration$1, ProviderConfiguration as ProviderConfiguration$1 } from 'config';
+import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration as BlockchainDataModuleConfiguration$1, ProviderConfiguration as ProviderConfiguration$1, ExchangeContracts } from 'config';
 import { OrderbookModuleConfiguration } from 'config/config';
 import { ListingResult, ListListingsResult } from 'openapi/sdk';
 import { ListListingsParams, PrepareListingParams, PrepareListingResponse, CreateListingParams, FulfillOrderResponse, CancelOrderResponse as CancelOrderResponse$1 } from 'types';
@@ -1003,6 +1003,25 @@ interface NFT {
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ * @type NFTMetadataAttributeValue
+ * The metadata trait value
+ * @export
+ */
+type NFTMetadataAttributeValue = boolean | number | string;
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
 /**
  *
  * @export
@@ -1016,11 +1035,11 @@ interface NFTMetadataAttribute {
      */
     'trait_type': string;
     /**
-     * The metadata trait value
-     * @type {string}
+     *
+     * @type {NFTMetadataAttributeValue}
      * @memberof NFTMetadataAttribute
      */
-    'value': string;
+    'value': NFTMetadataAttributeValue;
 }
 
 /**
@@ -12804,7 +12823,7 @@ declare class Orderbook {
      * the unsigned approval transaction, the typed order message for signing and
      * the order components that can be submitted to `createListing` with a signature.
      */
-    prepareListing({ offerer, listingItem, considerationItem, orderExpiry, }: PrepareListingParams): Promise<PrepareListingResponse>;
+    prepareListing({ makerAddress, sell, buy, orderExpiry, }: PrepareListingParams): Promise<PrepareListingResponse>;
     /**
      * Create an order
      * @param {CreateListingParams} createListingParams - create an order with the given params.
@@ -12819,7 +12838,7 @@ declare class Orderbook {
      * @param {string} fulfillerAddress - The address of the account fulfilling the order.
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
-    fulfillOrder(listingId: string, fulfillerAddress: string): Promise<FulfillOrderResponse>;
+    fulfillOrder(listingId: string, takerAddress: string): Promise<FulfillOrderResponse>;
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
      * the account that created them.
@@ -12841,6 +12860,20 @@ type Address = string;
  */
 type FungibleToken = Address | 'NATIVE';
 
+type TokenInfo$1 = {
+    chainId: number;
+    address: string;
+    decimals: number;
+    symbol?: string;
+    name?: string;
+};
+interface ExchangeOverrides {
+    rpcURL: string;
+    exchangeContracts: ExchangeContracts;
+    commonRoutingTokens: TokenInfo$1[];
+    nativeToken: TokenInfo$1;
+}
+
 /**
  * Enum representing the supported chains with their corresponding IDs.
  */
@@ -12920,12 +12953,6 @@ interface NetworkInfo {
     nativeCurrency: TokenInfo;
     isSupported: boolean;
 }
-/**
- * Enum representing the list of default supported providers.
- */
-declare enum ConnectionProviders {
-    METAMASK = "metamask"
-}
 interface ConnectParams {
     provider: Web3Provider;
 }
@@ -13010,6 +13037,10 @@ interface TokenAmountEstimate {
     estimatedAmount?: BigNumber;
     token?: TokenInfo;
 }
+declare const CHECKOUT_API_BASE_URL: {
+    sandbox: string;
+    production: string;
+};
 /**
  * Object mapping the list of supported networks with the corresponding RPC urls.
  */
@@ -13154,10 +13185,10 @@ type CreateProviderResult = {
 };
 /**
  * Interface representing a wallet filter to be used in {@link GetWalletAllowListParams}.
- * @property {ConnectionProviders} connectionProvider - The connection provider to filter wallets by.
+ * @property {WalletProviderName} connectionProvider - The connection provider to filter wallets by.
  */
 interface WalletFilter {
-    providerName: WalletProviderName;
+    walletProvider: WalletProviderName;
 }
 /**
  * Interface representing the parameters for {@link Checkout.getWalletAllowList}.
@@ -13170,13 +13201,13 @@ interface GetWalletAllowListParams {
 }
 /**
  * Interface representing information about a wallet used in {@link GetWalletAllowListResult}.
- * @property {ConnectionProviders} connectionProvider - The connection provider for the wallet.
+ * @property {WalletProviderName} connectionProvider - The connection provider for the wallet.
  * @property {string} name - The name of the wallet.
  * @property {string} description - A description of the wallet.
  * @property {string} icon - The URL/data:image of an icon for the wallet.
  */
 interface WalletInfo {
-    providerName: WalletProviderName;
+    walletProvider: WalletProviderName;
     name: string;
     description: string;
     icon: string;
@@ -13228,9 +13259,42 @@ type ErrorType = {
         [key: string]: string;
     };
 };
+type AllowedNetworkConfig = {
+    chainId: number;
+};
+type GasEstimateBridgeToL2TokenConfig = {
+    gasTokenAddress: string | 'NATIVE';
+    fromAddress: string;
+};
+type GasEstimateSwapTokenConfig = {
+    inAddress: string;
+    outAddress: string;
+};
+type GasEstimateTokenConfig = {
+    [key: string]: {
+        bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig;
+        swapAddresses?: GasEstimateSwapTokenConfig;
+    };
+};
+type DexConfig = {
+    overrides?: ExchangeOverrides;
+};
+type RemoteConfiguration = {
+    dex: DexConfig;
+    allowedNetworks: AllowedNetworkConfig[];
+    gasEstimateTokens?: GasEstimateTokenConfig;
+};
+type RemoteConfigParams = {
+    environment: Environment;
+};
+declare class RemoteConfigFetcher {
+    constructor(params: RemoteConfigParams);
+    get(key?: keyof RemoteConfiguration): Promise<RemoteConfiguration | RemoteConfiguration[keyof RemoteConfiguration] | undefined>;
+}
 declare class CheckoutConfiguration {
     readonly environment: Environment;
     readonly networkMap: NetworkMap;
+    readonly remoteConfigFetcher: RemoteConfigFetcher;
     constructor(config: CheckoutModuleConfiguration);
 }
 declare class Checkout {
@@ -27795,11 +27859,11 @@ declare enum ConnectEventType {
 }
 /**
  * Type representing a Connect Widget event with type SUCCESS.
- * @property {ConnectionProviders} providerPreference - The user's preferred connection provider.
+ * @property {WalletProviderName} walletProvider - The user's preferred connection provider.
  */
 type ConnectionSuccess = {
     provider: Web3Provider;
-    providerName: WalletProviderName | undefined;
+    walletProvider: WalletProviderName | undefined;
 };
 /**
  * Type representing a Connect Widget event with type FAILURE.
@@ -27816,10 +27880,10 @@ declare enum OrchestrationEventType {
     REQUEST_ONRAMP = "request-onramp"
 }
 type RequestConnectEvent = {
-    providerPreference: string;
+    walletProvider: string;
 };
 type RequestWalletEvent = {
-    providerPreference: string;
+    walletProvider: string;
 };
 type RequestSwapEvent = {
     fromTokenAddress: string;
@@ -27924,17 +27988,15 @@ declare global {
 }
 /**
  * Props for the Connect Widget component
- * @property {string} providerPreference - The preferred wallet provider to connect to.
  * @property {string} theme - The theme to use.
  * @property {string} environment - The environment configuration
  */
 interface ImtblConnectProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    walletProvider?: string;
     widgetConfig?: string;
 }
 /**
  * Props for the Wallet Widget component
- * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} walletProvider - The preferred wallet provider to connect to.
  * @property {string} theme - The theme to use.
  * @property {string} environment - The environment configuration
  */
@@ -27944,7 +28006,7 @@ interface ImtblWalletProps extends React.DetailedHTMLProps<React.HTMLAttributes<
 }
 /**
  * Props for the Swap Widget component
- * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} walletProvider - The preferred wallet provider to connect to.
  * @property {string} theme - The theme to use.
  * @property {string} environment - The environment configuration
  * @property {string} amount - The amount to swap.
@@ -27960,18 +28022,16 @@ interface ImtblSwapProps extends React.DetailedHTMLProps<React.HTMLAttributes<HT
 }
 /**
  * Props for the Bridge Widget component
- * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} walletProvider - The preferred wallet provider to connect to.
  * @property {string} theme - The theme to use.
  * @property {string} environment - The environment configuration
  * @property {string} fromContractAddress - The contract address of the source token.
- * @property {string} fromNetwork - The network of the source token.
  * @property {string} amount - The amount to bridge.
  */
 interface ImtblBridgeProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     walletProvider?: string;
     widgetConfig?: string;
     fromContractAddress: string;
-    fromNetwork: string;
     amount: string;
 }
 /**
@@ -27981,9 +28041,7 @@ declare enum Network {
     ETHEREUM = "Ethereum",
     SEPOLIA = "Sepolia",
     IMTBL_ZKEVM_TESTNET = "Immutable zkEVM Testnet",
-    IMTBL_ZKEVM_DEVNET = "Immutable zkEVM Devnet",
-    POLYGON_ZKEVM_TESTNET = "Polygon zkEVM Testnet",
-    POLYGON_ZKEVM = "Polygon zkEVM"
+    IMTBL_ZKEVM_DEVNET = "Immutable zkEVM Devnet"
 }
 /**
  * Enum representing the themes for the Checkout widgets.
@@ -28002,10 +28060,35 @@ declare enum CheckoutWidgetTagNames {
     SWAP = "imtbl-swap",
     BRIDGE = "imtbl-bridge"
 }
+/**
+ * Represents the version of the Checkout Widgets to use defaults to (0.1.9-alpha)
+ * @property {number} major - The major version of the widgets, must specify a major version even if it is 0, otherwise version defaults to (0.1.9-alpha)
+ * @property {number} minor - The minor version of the widgets, leaving this blank will pickup all new minor versions released
+ * @property {number} patch - The patch version of the widgets, leaving this blank will pickup all new patch versions released
+ * @property {string} prerelease - The prerelease version of the widgets, can only be 'alpha' or 'beta', will be used in preference of build if it is also specified. Do not use in production.
+ * @property {number} build - The build version of the widgets, this should not be used in production and will only be used for rare cases when a specific testing is required
+ *
+ * @example
+ * { major: 0 } - use default version 0.1.9-alpha
+ *
+ * { major: 1 } - use version 1.x.x, pickup all new minor and patch versions released
+ *
+ * { major: 1, minor: 1 } - use version 1.1.x, pickup all new patch versions released
+ *
+ * { major: 1, minor: 2, patch: 3 } - use version 1.2.3 specifically
+ */
+type SemanticVersion = {
+    major: number;
+    minor?: number;
+    patch?: number;
+    prerelease?: 'alpha' | 'beta';
+    build?: number;
+};
 /**
  * Represents the configuration options for the Checkout Widgets.
  * @property {WidgetTheme} theme - The theme of the Checkout Widget (default: "DARK")
  * @property {Environment} environment - The environment configuration (default: "SANDBOX")
+ * @property {SemanticVersion} version - The version of the checkout widgets js file to use (default: "0.1.0")
  * @property {boolean} isOnRampEnabled - Enable on-ramp top-up method (default: "true")
  * @property {boolean} isSwapEnabled - Enable swap top-up method (default: "true")
  * @property {boolean} isBridgeEnabled - Enable bridge top-up method (default: "true")
@@ -28013,6 +28096,7 @@ declare enum CheckoutWidgetTagNames {
 type CheckoutWidgetsConfig = {
     theme?: WidgetTheme;
     environment?: Environment;
+    version?: SemanticVersion;
     isOnRampEnabled?: boolean;
     isSwapEnabled?: boolean;
     isBridgeEnabled?: boolean;
@@ -28023,13 +28107,12 @@ type CheckoutWidgetsConfig = {
  * (default: "metamask").
  * @property {string} fromContractAddress - The contract address to send tokens from.
  * @property {string} amount - The amount of tokens to send.
- * @property {Network} fromNetwork - The network to send tokens from.
  */
 interface BridgeReactProps {
     walletProvider?: WalletProviderName;
+    provider?: Web3Provider;
     fromContractAddress?: string;
     amount?: string;
-    fromNetwork?: Network;
 }
 /**
  * A React functional component that renders the Checkout Bridge Widget.
@@ -28037,20 +28120,11 @@ interface BridgeReactProps {
  * @returns {JSX.Element} - The rendered Bridge Widget component.
  */
 declare function BridgeReact(props: BridgeReactProps): JSX.Element;
-/**
- * Interface representing the props for the Connect Widget component.
- * @property {string} providerPreference - The preferred provider for the Connect Widget
- * (default: "metamask").
- */
-interface ConnectReactProps {
-    walletProvider?: string;
-}
 /**
  * A React functional component that renders the Checkout Connect Widget.
- * @param {ConnectReactProps} props - The props for the Connect Widget component.
  * @returns {JSX.Element} - The rendered Connect Widget component.
  */
-declare function ConnectReact(props: ConnectReactProps): JSX.Element;
+declare function ConnectReact(): JSX.Element;
 /**
  * Interface representing the props for the Swap Widget component.
  * @property {string} walletProvider - The preferred provider for the Swap Widget (default: "metamask"}).
@@ -28060,6 +28134,7 @@ declare function ConnectReact(props: ConnectReactProps): JSX.Element;
  */
 interface SwapReactProps {
     walletProvider?: WalletProviderName;
+    provider?: Web3Provider;
     fromContractAddress?: string;
     amount?: string;
     toContractAddress?: string;
@@ -28072,11 +28147,12 @@ interface SwapReactProps {
 declare function SwapReact(props: SwapReactProps): JSX.Element;
 /**
  * Interface representing the props for the Wallet Widget component.
- * @property {string} providerPreference - The preferred provider for the Wallet Widget
+ * @property {string} walletProvider - The preferred provider for the Wallet Widget
  * (default: "metamask").
  */
 interface WalletReactProps {
     walletProvider?: WalletProviderName;
+    provider?: Web3Provider;
 }
 /**
  * A React functional component that renders the Checkout Wallet Widget.
@@ -28084,6 +28160,15 @@ interface WalletReactProps {
  * @returns {JSX.Element} - The rendered Wallet Widget component.
  */
 declare function WalletReact(props: WalletReactProps): JSX$1.Element;
+declare const DEFAULT_CHECKOUT_VERSION = "0.1.9-alpha";
+/**
+ * Checking for valid version numbers input.
+ * 0 is a valid value for major, minor and/or patch
+ * The current release process only includes the checkout script in 'alpha' builds
+ * so we must append '-alpha' to valid versions in order to load the script properly.
+ * This may change in the future depending on the relase process.
+ */
+declare function validateAndBuildVersion(version: SemanticVersion | undefined): string;
 /**
  * CheckoutWidgets allows to inject the Checkout Widgets into your application.
  * @param {CheckoutWidgetsConfig|undefined} config - Checkout Widget global configurations.
@@ -28094,12 +28179,6 @@ declare function CheckoutWidgets(config?: CheckoutWidgetsConfig): void;
  * @param {CheckoutWidgetsConfig} config - new Checkout Widget global configurations.
  */
 declare function UpdateConfig(config: CheckoutWidgetsConfig): void;
-/**
- * SetProvider allows to set the provider for an existing Checkout Widgets instance.
- * @param {CheckoutWidgetTagNames} tagName - target Checkout Widget widget.
- * @param {Web3Provider} provider - the provider to connect to the blockchain network.
- */
-declare function SetProvider(tagName: CheckoutWidgetTagNames, provider: Web3Provider | null): void;
 
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
@@ -28301,27 +28380,27 @@ declare class ERC721PermissionedMintable {
     /**
      * @returns a populated transaction for the setApprovalForAll contract function
      */
-    setApprovalForAll(operator: PromiseOrValue<string>, approved: PromiseOrValue<boolean>, overrides?: Overrides & {
+    populateSetApprovalForAll(operator: PromiseOrValue<string>, approved: PromiseOrValue<boolean>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the setBaseURI contract function
      */
-    setBaseURI(baseURI_: PromiseOrValue<string>, overrides?: Overrides & {
+    populateSetBaseURI(baseURI_: PromiseOrValue<string>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the setContractURI contract function
      */
-    setContractURI(_contractURI: PromiseOrValue<string>, overrides?: Overrides & {
+    populateSetContractURI(_contractURI: PromiseOrValue<string>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the setRoyaltyAllowlistRegistry contract function
      */
-    setRoyaltyAllowlistRegistry(_royaltyAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
+    populateSetRoyaltyAllowlistRegistry(_royaltyAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
 }
 
-export { APIError, BlockchainData, BlockchainDataModuleConfiguration, BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectReact, ConnectReactProps, ConnectResult, ConnectionFailed, ConnectionProviders, ConnectionSuccess, ERC20, ERC721PermissionedMintable, Environment, ErrorType, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateType, GenericIMXProvider, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, IMTBLWidgetEvents, IMXProvider, ImmutableConfiguration, ImmutableXClient, ImtblBridgeProps, ImtblConnectProps, ImtblSwapProps, ImtblWalletProps, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, MetaMaskIMXProvider, ModuleConfiguration, Network, NetworkFilter, NetworkFilterTypes, NetworkInfo, OrchestrationEventType, Orderbook, Passport, PassportError, PassportModuleConfiguration, ProviderConfiguration, RPC_URL_MAP, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, SendTransactionParams, SendTransactionResult, SetProvider, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapRejected, SwapSuccess, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, UpdateConfig, WalletDisconnectWalletEvent, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitchEvent, WalletProviderName, WalletReact, WalletReactProps, WidgetEvent, WidgetTheme, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey, module };
+export { APIError, BlockchainData, BlockchainDataModuleConfiguration, BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, CHECKOUT_API_BASE_URL, ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectReact, ConnectResult, ConnectionFailed, ConnectionSuccess, DEFAULT_CHECKOUT_VERSION, ERC20, ERC721PermissionedMintable, Environment, ErrorType, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateType, GenericIMXProvider, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, IMTBLWidgetEvents, IMXProvider, ImmutableConfiguration, ImmutableXClient, ImtblBridgeProps, ImtblConnectProps, ImtblSwapProps, ImtblWalletProps, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, MetaMaskIMXProvider, ModuleConfiguration, Network, NetworkFilter, NetworkFilterTypes, NetworkInfo, Networks, OrchestrationEventType, Orderbook, Passport, PassportError, PassportModuleConfiguration, PassportOverrides, ProviderConfiguration, RPC_URL_MAP, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, SemanticVersion, SendTransactionParams, SendTransactionResult, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapRejected, SwapSuccess, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, UpdateConfig, UserProfile, WalletDisconnectWalletEvent, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitchEvent, WalletProviderName, WalletReact, WalletReactProps, WidgetEvent, WidgetTheme, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey, module, validateAndBuildVersion };