@imtbl/sdk 0.42.1 → 0.44.0

package/dist/index.cjs

@@ -10641,7 +10641,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.42.1' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.44.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -10713,7 +10713,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
@@ -11152,7 +11152,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
@@ -41071,6 +41071,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.
@@ -41937,7 +41945,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.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;
 
@@ -45205,7 +45213,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
@@ -45226,6 +45234,7 @@ const sell = async (config, provider, orders) => {
                 contractAddress: sellToken.collectionAddress,
                 tokenId: sellToken.id,
             },
+            orderExpiry,
         }));
     }
     catch (err) {
@@ -45817,8 +45826,23 @@ class Checkout {
     }
 }
 
+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}`;
+    }
+}
+
 var checkout = /*#__PURE__*/Object.freeze({
     __proto__: null,
+    BlockExplorerService: BlockExplorerService,
     get BridgeEventType () { return BridgeEventType; },
     get ChainId () { return ChainId; },
     get ChainName () { return ChainName; },
@@ -45843,6 +45867,7 @@ var checkout = /*#__PURE__*/Object.freeze({
     get ProviderEventType () { return ProviderEventType; },
     get RoutingOutcomeType () { return RoutingOutcomeType; },
     get SaleEventType () { return SaleEventType; },
+    get SalePaymentTypes () { return SalePaymentTypes; },
     get SwapEventType () { return SwapEventType; },
     get TokenFilterTypes () { return TokenFilterTypes; },
     get TransactionOrGasType () { return TransactionOrGasType; },

package/dist/index.d.ts

@@ -17202,8 +17202,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.
@@ -18633,7 +18635,7 @@ declare enum SaleEventType {
  */
 type SaleSuccess = {
     /** Chosen payment method */
-    paymentMethod: string | undefined;
+    paymentMethod: SalePaymentTypes | undefined;
     /** The executed transactions */
     transactions: {
         method: string;
@@ -18653,7 +18655,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;
@@ -18665,7 +18667,7 @@ type SaleFailed = {
  * @property {Object} transactions
  */
 type SaleTransactionSuccess = {
-    paymentMethod: string | undefined;
+    paymentMethod: SalePaymentTypes | undefined;
     /** The executed transactions */
     transactions: {
         method: string;
@@ -18678,8 +18680,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.
@@ -18888,10 +18897,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 */
@@ -19435,9 +19448,20 @@ type ErrorType = {
     };
 };
 
+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;
+}
+
 type checkout_d_AllowedNetworkConfig = AllowedNetworkConfig;
 type checkout_d_AvailableRoutingOptions = AvailableRoutingOptions;
 type checkout_d_BalanceDelta = BalanceDelta;
+type checkout_d_BlockExplorerService = BlockExplorerService;
+declare const checkout_d_BlockExplorerService: typeof BlockExplorerService;
 type checkout_d_BridgeEventType = BridgeEventType;
 declare const checkout_d_BridgeEventType: typeof BridgeEventType;
 type checkout_d_BridgeFailed = BridgeFailed;
@@ -19577,6 +19601,8 @@ declare const checkout_d_SaleEventType: typeof SaleEventType;
 type checkout_d_SaleFailed = SaleFailed;
 type checkout_d_SaleItem = SaleItem;
 type checkout_d_SalePaymentMethod = SalePaymentMethod;
+type checkout_d_SalePaymentTypes = SalePaymentTypes;
+declare const checkout_d_SalePaymentTypes: typeof SalePaymentTypes;
 type checkout_d_SaleSuccess = SaleSuccess;
 type checkout_d_SaleTransactionSuccess = SaleTransactionSuccess;
 type checkout_d_SaleWidgetConfiguration = SaleWidgetConfiguration;
@@ -19645,6 +19671,7 @@ declare namespace checkout_d {
     checkout_d_AllowedNetworkConfig as AllowedNetworkConfig,
     checkout_d_AvailableRoutingOptions as AvailableRoutingOptions,
     checkout_d_BalanceDelta as BalanceDelta,
+    checkout_d_BlockExplorerService as BlockExplorerService,
     checkout_d_BridgeEventType as BridgeEventType,
     checkout_d_BridgeFailed as BridgeFailed,
     checkout_d_BridgeFundingStep as BridgeFundingStep,
@@ -19761,6 +19788,7 @@ declare namespace checkout_d {
     checkout_d_SaleFailed as SaleFailed,
     checkout_d_SaleItem as SaleItem,
     checkout_d_SalePaymentMethod as SalePaymentMethod,
+    checkout_d_SalePaymentTypes as SalePaymentTypes,
     checkout_d_SaleSuccess as SaleSuccess,
     checkout_d_SaleTransactionSuccess as SaleTransactionSuccess,
     checkout_d_SaleWidgetConfiguration as SaleWidgetConfiguration,

package/dist/index.js

@@ -10619,7 +10619,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.42.1' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.44.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -10691,7 +10691,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
@@ -11130,7 +11130,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
@@ -41049,6 +41049,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.
@@ -41915,7 +41923,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;
 
@@ -45183,7 +45191,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
@@ -45204,6 +45212,7 @@ const sell = async (config, provider, orders) => {
                 contractAddress: sellToken.collectionAddress,
                 tokenId: sellToken.id,
             },
+            orderExpiry,
         }));
     }
     catch (err) {
@@ -45795,8 +45804,23 @@ class Checkout {
     }
 }
 
+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}`;
+    }
+}
+
 var checkout = /*#__PURE__*/Object.freeze({
     __proto__: null,
+    BlockExplorerService: BlockExplorerService,
     get BridgeEventType () { return BridgeEventType; },
     get ChainId () { return ChainId; },
     get ChainName () { return ChainName; },
@@ -45821,6 +45845,7 @@ var checkout = /*#__PURE__*/Object.freeze({
     get ProviderEventType () { return ProviderEventType; },
     get RoutingOutcomeType () { return RoutingOutcomeType; },
     get SaleEventType () { return SaleEventType; },
+    get SalePaymentTypes () { return SalePaymentTypes; },
     get SwapEventType () { return SwapEventType; },
     get TokenFilterTypes () { return TokenFilterTypes; },
     get TransactionOrGasType () { return TransactionOrGasType; },

package/dist/passport.js

@@ -8724,7 +8724,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.42.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.44.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -8792,7 +8792,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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.42.1",
+  "version": "0.44.0",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",