@imtbl/sdk 0.42.1 → 0.44.0

package/dist/checkout.d.ts

@@ -10888,8 +10888,10 @@ type SellOrder = {
     sellToken: SellToken;
     /** the token info of the price of the item */
     buyToken: BuyToken;
-    /** option array of makerFees to be applied to the listing */
+    /** optional array of makerFees to be applied to the listing */
     makerFees?: OrderFee[];
+    /** optional order expiry date. Default order expiry to 2 years from now */
+    orderExpiry?: Date;
 };
 /**
  * Represents the token that the item can be bought with once listed for sale.
@@ -12703,7 +12705,7 @@ declare enum SaleEventType {
  */
 type SaleSuccess = {
     /** Chosen payment method */
-    paymentMethod: string | undefined;
+    paymentMethod: SalePaymentTypes | undefined;
     /** The executed transactions */
     transactions: {
         method: string;
@@ -12723,7 +12725,7 @@ type SaleFailed = {
     /** The timestamp of the failed swap. */
     timestamp: number;
     /** Chosen payment method */
-    paymentMethod: string | undefined;
+    paymentMethod: SalePaymentTypes | undefined;
     /** The executed transactions */
     transactions: {
         method: string;
@@ -12735,7 +12737,7 @@ type SaleFailed = {
  * @property {Object} transactions
  */
 type SaleTransactionSuccess = {
-    paymentMethod: string | undefined;
+    paymentMethod: SalePaymentTypes | undefined;
     /** The executed transactions */
     transactions: {
         method: string;
@@ -12748,8 +12750,15 @@ type SaleTransactionSuccess = {
  */
 type SalePaymentMethod = {
     /** Chosen payment method */
-    paymentMethod: string | undefined;
+    paymentMethod: SalePaymentTypes | undefined;
 };
+/**
+ * Enum representing Sale Widget available payment types.
+ */
+declare enum SalePaymentTypes {
+    CRYPTO = "crypto",
+    FIAT = "fiat"
+}
 
 /**
  * Enum of possible Bridge Widget event types.
@@ -12958,10 +12967,14 @@ type OnRampWidgetParams = {
 type SaleWidgetParams = {
     /** The total price to pay for the items in the sale */
     amount?: string;
+    /** Environment id from Immutable Hub */
     environmentId?: string;
+    /** Contract address of the token accepted for payments */
     fromTokenAddress?: string;
     /** The list of products to be purchased */
     items?: SaleItem[];
+    /** The name of the NFT collection on sale */
+    collectionName?: string;
     /** The wallet provider name to default to if no web3Provider is passed */
     walletProviderName?: WalletProviderName;
     /** The language to use for the sales widget */
@@ -13505,4 +13518,13 @@ type ErrorType = {
     };
 };
 
-export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeTransactionSent, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyParams, BuyResult, BuyResultFailed, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CancelParams, CancelResult, CancelResultFailed, CancelResultSuccess, ChainId, ChainName, ChainSlug, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutBridgeConfiguration, CheckoutConfiguration, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutOnRampConfiguration, CheckoutStatus, CheckoutSwapConfiguration, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectResult, ConnectTargetLayer, ConnectWidgetConfiguration, ConnectWidgetParams, ConnectionFailed, ConnectionSuccess, CreateProviderParams, CreateProviderResult, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, Fee, FeePercentage, FeeToken, FeeType, FiatRampParams, FulfillmentTransaction, FundingItem, FundingRoute, FundingStep, FundingStepType, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetTokenInfoParams, GetWalletAllowListParams, GetWalletAllowListResult, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, IWidgetsFactory, ItemBalance, ItemType, LanguageChanged, NativeItemRequirement, NetworkFilter, NetworkFilterTypes, NetworkInfo, NoRouteOptions, NoRoutesFound, OnRampEventType, OnRampFailed, OnRampFundingStep, OnRampProviderFees, OnRampSuccess, OnRampWidgetParams, OnrampWidgetConfiguration, OrchestrationEvent, OrchestrationEventData, OrchestrationEventType, OrderFee, ProviderEvent, ProviderEventType, ProviderUpdated, RemoteConfiguration, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, RoutesFound, RoutingOutcome, RoutingOutcomeType, SaleEventType, SaleFailed, SaleItem, SalePaymentMethod, SaleSuccess, SaleTransactionSuccess, SaleWidgetConfiguration, SaleWidgetParams, SellOrder, SellParams, SellResult, SellResultFailed, SellResultInsufficientFunds, SellResultSuccess, SellToken, SemanticVersion, SendTransactionParams, SendTransactionResult, SmartCheckoutInsufficient, SmartCheckoutParams, SmartCheckoutResult, SmartCheckoutRouter, SmartCheckoutSufficient, SwapEventType, SwapFailed, SwapFundingStep, SwapRejected, SwapSuccess, SwapWidgetConfiguration, SwapWidgetParams, SwitchNetworkParams, SwitchNetworkResult, TokenAmountEstimate, TokenBalance, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, TransactionRequirement, WalletDisconnect, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitch, WalletProviderName, WalletWidgetConfiguration, WalletWidgetParams, Widget, WidgetConfiguration, WidgetConfigurations, WidgetEvent, WidgetEventData, WidgetEventTypes, WidgetLanguage, WidgetParameters, WidgetProperties, WidgetTheme, WidgetType };
+declare class BlockExplorerService {
+    /**
+     * getTransationLink returns the link to the transaction on blockscout
+     * @param hash transaction hash
+     * @returns link to the transaction on blockscout
+     */
+    static getTransactionLink(chainId: ChainId, hash: string): string | undefined;
+}
+
+export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BlockExplorerService, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeTransactionSent, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyParams, BuyResult, BuyResultFailed, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CancelParams, CancelResult, CancelResultFailed, CancelResultSuccess, ChainId, ChainName, ChainSlug, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutBridgeConfiguration, CheckoutConfiguration, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutOnRampConfiguration, CheckoutStatus, CheckoutSwapConfiguration, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectResult, ConnectTargetLayer, ConnectWidgetConfiguration, ConnectWidgetParams, ConnectionFailed, ConnectionSuccess, CreateProviderParams, CreateProviderResult, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, Fee, FeePercentage, FeeToken, FeeType, FiatRampParams, FulfillmentTransaction, FundingItem, FundingRoute, FundingStep, FundingStepType, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetTokenInfoParams, GetWalletAllowListParams, GetWalletAllowListResult, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, IWidgetsFactory, ItemBalance, ItemType, LanguageChanged, NativeItemRequirement, NetworkFilter, NetworkFilterTypes, NetworkInfo, NoRouteOptions, NoRoutesFound, OnRampEventType, OnRampFailed, OnRampFundingStep, OnRampProviderFees, OnRampSuccess, OnRampWidgetParams, OnrampWidgetConfiguration, OrchestrationEvent, OrchestrationEventData, OrchestrationEventType, OrderFee, ProviderEvent, ProviderEventType, ProviderUpdated, RemoteConfiguration, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, RoutesFound, RoutingOutcome, RoutingOutcomeType, SaleEventType, SaleFailed, SaleItem, SalePaymentMethod, SalePaymentTypes, SaleSuccess, SaleTransactionSuccess, SaleWidgetConfiguration, SaleWidgetParams, SellOrder, SellParams, SellResult, SellResultFailed, SellResultInsufficientFunds, SellResultSuccess, SellToken, SemanticVersion, SendTransactionParams, SendTransactionResult, SmartCheckoutInsufficient, SmartCheckoutParams, SmartCheckoutResult, SmartCheckoutRouter, SmartCheckoutSufficient, SwapEventType, SwapFailed, SwapFundingStep, SwapRejected, SwapSuccess, SwapWidgetConfiguration, SwapWidgetParams, SwitchNetworkParams, SwitchNetworkResult, TokenAmountEstimate, TokenBalance, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, TransactionRequirement, WalletDisconnect, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitch, WalletProviderName, WalletWidgetConfiguration, WalletWidgetParams, Widget, WidgetConfiguration, WidgetConfigurations, WidgetEvent, WidgetEventData, WidgetEventTypes, WidgetLanguage, WidgetParameters, WidgetProperties, WidgetTheme, WidgetType };

package/dist/checkout.js

@@ -25921,7 +25921,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.42.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.44.0',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -26406,6 +26406,14 @@ var SaleEventType;
     SaleEventType["LANGUAGE_CHANGED"] = "language-changed";
     SaleEventType["PAYMENT_METHOD"] = "payment-method";
 })(SaleEventType || (SaleEventType = {}));
+/**
+ * Enum representing Sale Widget available payment types.
+ */
+var SalePaymentTypes;
+(function (SalePaymentTypes) {
+    SalePaymentTypes["CRYPTO"] = "crypto";
+    SalePaymentTypes["FIAT"] = "fiat";
+})(SalePaymentTypes || (SalePaymentTypes = {}));
 
 /**
  * Enum of possible Bridge Widget event types.
@@ -27272,7 +27280,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.42.1';
+const SDK_VERSION_MARKER = '0.44.0';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -30540,7 +30548,7 @@ const sell = async (config, provider, orders) => {
     if (orders.length === 0) {
         throw new CheckoutError('No orders were provided to the orders array. Please provide at least one order.', CheckoutErrorType.PREPARE_ORDER_LISTING_ERROR);
     }
-    const { buyToken, sellToken, makerFees } = orders[0];
+    const { buyToken, sellToken, makerFees, orderExpiry, } = orders[0];
     let decimals = 18;
     if (buyToken.type === ItemType.ERC20) {
         // get this from the allowed list
@@ -30561,6 +30569,7 @@ const sell = async (config, provider, orders) => {
                 contractAddress: sellToken.collectionAddress,
                 tokenId: sellToken.id,
             },
+            orderExpiry,
         }));
     }
     catch (err) {
@@ -31152,4 +31161,18 @@ class Checkout {
     }
 }
 
-export { BridgeEventType, ChainId, ChainName, ChainSlug, Checkout, CheckoutConfiguration, CheckoutErrorType, CheckoutStatus, ConnectEventType, ConnectTargetLayer, ExchangeType, FeeType, FundingStepType, GasEstimateType, GasTokenType, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, ItemType, NetworkFilterTypes, OnRampEventType, OrchestrationEventType, ProviderEventType, RoutingOutcomeType, SaleEventType, SwapEventType, TokenFilterTypes, TransactionOrGasType, WalletEventType, WalletFilterTypes, WalletProviderName, WidgetTheme, WidgetType };
+class BlockExplorerService {
+    /**
+     * getTransationLink returns the link to the transaction on blockscout
+     * @param hash transaction hash
+     * @returns link to the transaction on blockscout
+     */
+    static getTransactionLink(chainId, hash) {
+        const url = BLOCKSCOUT_CHAIN_URL_MAP?.[chainId]?.url;
+        if (!url || !hash)
+            return undefined;
+        return `${url}/tx/${hash}`;
+    }
+}
+
+export { BlockExplorerService, BridgeEventType, ChainId, ChainName, ChainSlug, Checkout, CheckoutConfiguration, CheckoutErrorType, CheckoutStatus, ConnectEventType, ConnectTargetLayer, ExchangeType, FeeType, FundingStepType, GasEstimateType, GasTokenType, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, ItemType, NetworkFilterTypes, OnRampEventType, OrchestrationEventType, ProviderEventType, RoutingOutcomeType, SaleEventType, SalePaymentTypes, SwapEventType, TokenFilterTypes, TransactionOrGasType, WalletEventType, WalletFilterTypes, WalletProviderName, WidgetTheme, WidgetType };

package/dist/immutablex_client.js

@@ -17,7 +17,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.42.1',
+    sdkVersion: 'ts-immutable-sdk-0.44.0',
 });
 /**
  * Sets `sdkVersion` at the time of build