@imtbl/sdk 0.30.3 → 0.30.5

package/dist/index.cjs

@@ -3792,7 +3792,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.30.3' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.30.5' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -3852,7 +3852,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.30.3',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.30.5',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4263,7 +4263,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.30.3',
+    sdkVersion: 'ts-immutable-sdk-0.30.5',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -11870,13 +11870,13 @@ function mapFromOpenApiOrder(order) {
             return {
                 type: 'ERC20',
                 contractAddress: item.contract_address,
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         if (item.item_type === 'NATIVE') {
             return {
                 type: 'NATIVE',
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         throw new Error('Buy items must be either ERC20 or NATIVE');
@@ -11924,13 +11924,13 @@ function mapFromOpenApiTrade(trade) {
             return {
                 type: 'ERC20',
                 contractAddress: item.contract_address,
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         if (item.item_type === 'NATIVE') {
             return {
                 type: 'NATIVE',
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         throw new Error('Buy items must be either ERC20 or NATIVE');
@@ -12070,8 +12070,8 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
         switch (buyItem.item_type) {
             case 'NATIVE':
                 return {
-                    startAmount: buyItem.start_amount,
-                    endAmount: buyItem.start_amount,
+                    startAmount: buyItem.amount,
+                    endAmount: buyItem.amount,
                     itemType: ItemType$1.NATIVE,
                     recipient: order.account_address,
                     token: ethers.constants.AddressZero,
@@ -12079,8 +12079,8 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
                 };
             case 'ERC20':
                 return {
-                    startAmount: buyItem.start_amount,
-                    endAmount: buyItem.start_amount,
+                    startAmount: buyItem.amount,
+                    endAmount: buyItem.amount,
                     itemType: ItemType$1.ERC20,
                     recipient: order.account_address,
                     token: buyItem.contract_address || ethers.constants.AddressZero,
@@ -12401,7 +12401,7 @@ class ImmutableApiClient {
                             === ItemType$1.NATIVE
                             ? 'NATIVE'
                             : 'ERC20',
-                        start_amount: orderComponents.consideration[0].startAmount,
+                        amount: orderComponents.consideration[0].startAmount,
                         contract_address: orderComponents.consideration[0].token,
                     },
                 ],
@@ -31315,42 +31315,40 @@ function getTokenContract(address, contractInterface, signerOrProvider) {
 
 const DUMMY_WALLET_ADDRESS = '0x0000000000000000000000000000000000000001';
 const DEFAULT_TOKEN_DECIMALS = 18;
-async function getTokenInfoByAddress(config, tokenAddress, chainId, provider) {
-    if (tokenAddress === 'NATIVE') {
-        return config.networkMap.get(chainId)?.nativeCurrency;
-    }
-    const contract = new ethers.Contract(tokenAddress, JSON.stringify(ERC20ABI), provider);
-    const name = await contract.name();
-    const symbol = await contract.symbol();
-    const decimals = await contract.decimals();
-    return {
-        name,
-        symbol,
-        decimals,
-        address: tokenAddress,
-    };
-}
-async function bridgeToL2GasEstimator(readOnlyProviders, config, isSpendingCapApprovalRequired, tokenAddress) {
+async function bridgeToL2GasEstimator(readOnlyProviders, config, isSpendingCapApprovalRequired) {
     const fromChainId = getL1ChainId(config);
     const toChainId = getL2ChainId(config);
     const gasEstimateTokensConfig = (await config.remote.getConfig('gasEstimateTokens'));
-    const { gasTokenAddress, fromAddress } = gasEstimateTokensConfig[fromChainId].bridgeToL2Addresses;
+    const { fromAddress } = gasEstimateTokensConfig[fromChainId].bridgeToL2Addresses;
     const provider = readOnlyProviders.get(fromChainId);
     if (!provider)
         throw new Error(`Missing JsonRpcProvider for chain id: ${fromChainId}`);
     try {
-        const gasFee = await getBridgeEstimatedGas(provider, isSpendingCapApprovalRequired);
-        gasFee.token = await getTokenInfoByAddress(config, tokenAddress ?? (gasTokenAddress || 'NATIVE'), fromChainId, provider);
-        const tokenBridge = await createBridgeInstance(fromChainId, toChainId, readOnlyProviders, config);
-        const { bridgeFee, bridgeable } = await getBridgeFeeEstimate$1(tokenBridge, fromAddress);
+        let gasFees = {};
+        const getGasFees = async () => {
+            gasFees = await getBridgeEstimatedGas(provider, isSpendingCapApprovalRequired);
+            gasFees.token = config.networkMap.get(fromChainId)?.nativeCurrency;
+        };
+        let bridgeFees = {
+            bridgeFee: {},
+            bridgeable: false,
+        };
+        const getBridgeFees = async () => {
+            const tokenBridge = await createBridgeInstance(fromChainId, toChainId, readOnlyProviders, config);
+            bridgeFees = await getBridgeFeeEstimate$1(tokenBridge, fromAddress);
+        };
+        await Promise.all([
+            getGasFees(),
+            getBridgeFees(),
+        ]);
         return {
             gasEstimateType: GasEstimateType.BRIDGE_TO_L2,
-            gasFee,
+            gasFee: gasFees,
             bridgeFee: {
-                estimatedAmount: bridgeFee?.estimatedAmount,
-                token: bridgeFee?.token,
+                estimatedAmount: bridgeFees.bridgeFee?.estimatedAmount,
+                token: bridgeFees.bridgeFee?.token,
             },
-            bridgeable,
+            bridgeable: bridgeFees.bridgeable,
         };
     }
     catch {
@@ -31406,7 +31404,7 @@ async function swapGasEstimator(config) {
 async function gasEstimator(params, readOnlyProviders, config) {
     switch (params.gasEstimateType) {
         case GasEstimateType.BRIDGE_TO_L2:
-            return await bridgeToL2GasEstimator(readOnlyProviders, config, params.isSpendingCapApprovalRequired, params.tokenAddress);
+            return await bridgeToL2GasEstimator(readOnlyProviders, config, params.isSpendingCapApprovalRequired);
         case GasEstimateType.SWAP:
             return await swapGasEstimator(config);
         default:
@@ -34024,7 +34022,7 @@ async function getItemRequirementsFromRequirements(provider, requirements) {
     return itemRequirements;
 }
 
-const SDK_VERSION_MARKER = '0.30.3';
+const SDK_VERSION_MARKER = '0.30.5';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 

package/dist/index.d.ts

@@ -14949,7 +14949,7 @@ type ERC20Item$1 = {
     /**
      * A string representing the starting price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
      */
-    start_amount: string;
+    amount: string;
 };
 
 type ERC721Item$1 = {
@@ -14975,7 +14975,7 @@ type NativeItem$1 = {
     /**
      * A string representing the starting price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
      */
-    start_amount: string;
+    amount: string;
 };
 
 type Item = (NativeItem$1 | ERC20Item$1 | ERC721Item$1);
@@ -16919,15 +16919,6 @@ interface CheckConnectionResult {
     walletAddress: string;
 }
 
-/**
- * @typedef {string} Address - Represents an Ethereum address.
- */
-type Address = string;
-/**
- * @typedef {Address | 'NATIVE'} FungibleToken - Represents a fungible token, either an ERC20 token address or the native token.
- */
-type FungibleToken = Address | 'NATIVE';
-
 /**
  * An enum representing the type of gas estimate.
  * @enum {string}
@@ -16948,12 +16939,10 @@ 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.
  * @param {boolean} isSpendingCapApprovalRequired - Whether or not spending cap approval is required.
- * @param {FungibleToken | undefined} tokenAddress - The address of the fungible token to use in the transaction.
  */
 interface GasEstimateBridgeToL2Params {
     gasEstimateType: GasEstimateType.BRIDGE_TO_L2;
     isSpendingCapApprovalRequired: boolean;
-    tokenAddress?: FungibleToken;
 }
 /**
  * An interface representing the parameters for a gas estimate swap {@link Checkout.gasEstimate}.

package/dist/index.js

@@ -3770,7 +3770,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.30.3' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.30.5' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -3830,7 +3830,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.30.3',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.30.5',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4241,7 +4241,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.30.3',
+    sdkVersion: 'ts-immutable-sdk-0.30.5',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -11848,13 +11848,13 @@ function mapFromOpenApiOrder(order) {
             return {
                 type: 'ERC20',
                 contractAddress: item.contract_address,
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         if (item.item_type === 'NATIVE') {
             return {
                 type: 'NATIVE',
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         throw new Error('Buy items must be either ERC20 or NATIVE');
@@ -11902,13 +11902,13 @@ function mapFromOpenApiTrade(trade) {
             return {
                 type: 'ERC20',
                 contractAddress: item.contract_address,
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         if (item.item_type === 'NATIVE') {
             return {
                 type: 'NATIVE',
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         throw new Error('Buy items must be either ERC20 or NATIVE');
@@ -12048,8 +12048,8 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
         switch (buyItem.item_type) {
             case 'NATIVE':
                 return {
-                    startAmount: buyItem.start_amount,
-                    endAmount: buyItem.start_amount,
+                    startAmount: buyItem.amount,
+                    endAmount: buyItem.amount,
                     itemType: ItemType$1.NATIVE,
                     recipient: order.account_address,
                     token: constants$1.AddressZero,
@@ -12057,8 +12057,8 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
                 };
             case 'ERC20':
                 return {
-                    startAmount: buyItem.start_amount,
-                    endAmount: buyItem.start_amount,
+                    startAmount: buyItem.amount,
+                    endAmount: buyItem.amount,
                     itemType: ItemType$1.ERC20,
                     recipient: order.account_address,
                     token: buyItem.contract_address || constants$1.AddressZero,
@@ -12379,7 +12379,7 @@ class ImmutableApiClient {
                             === ItemType$1.NATIVE
                             ? 'NATIVE'
                             : 'ERC20',
-                        start_amount: orderComponents.consideration[0].startAmount,
+                        amount: orderComponents.consideration[0].startAmount,
                         contract_address: orderComponents.consideration[0].token,
                     },
                 ],
@@ -31293,42 +31293,40 @@ function getTokenContract(address, contractInterface, signerOrProvider) {
 
 const DUMMY_WALLET_ADDRESS = '0x0000000000000000000000000000000000000001';
 const DEFAULT_TOKEN_DECIMALS = 18;
-async function getTokenInfoByAddress(config, tokenAddress, chainId, provider) {
-    if (tokenAddress === 'NATIVE') {
-        return config.networkMap.get(chainId)?.nativeCurrency;
-    }
-    const contract = new Contract$1(tokenAddress, JSON.stringify(ERC20ABI), provider);
-    const name = await contract.name();
-    const symbol = await contract.symbol();
-    const decimals = await contract.decimals();
-    return {
-        name,
-        symbol,
-        decimals,
-        address: tokenAddress,
-    };
-}
-async function bridgeToL2GasEstimator(readOnlyProviders, config, isSpendingCapApprovalRequired, tokenAddress) {
+async function bridgeToL2GasEstimator(readOnlyProviders, config, isSpendingCapApprovalRequired) {
     const fromChainId = getL1ChainId(config);
     const toChainId = getL2ChainId(config);
     const gasEstimateTokensConfig = (await config.remote.getConfig('gasEstimateTokens'));
-    const { gasTokenAddress, fromAddress } = gasEstimateTokensConfig[fromChainId].bridgeToL2Addresses;
+    const { fromAddress } = gasEstimateTokensConfig[fromChainId].bridgeToL2Addresses;
     const provider = readOnlyProviders.get(fromChainId);
     if (!provider)
         throw new Error(`Missing JsonRpcProvider for chain id: ${fromChainId}`);
     try {
-        const gasFee = await getBridgeEstimatedGas(provider, isSpendingCapApprovalRequired);
-        gasFee.token = await getTokenInfoByAddress(config, tokenAddress ?? (gasTokenAddress || 'NATIVE'), fromChainId, provider);
-        const tokenBridge = await createBridgeInstance(fromChainId, toChainId, readOnlyProviders, config);
-        const { bridgeFee, bridgeable } = await getBridgeFeeEstimate$1(tokenBridge, fromAddress);
+        let gasFees = {};
+        const getGasFees = async () => {
+            gasFees = await getBridgeEstimatedGas(provider, isSpendingCapApprovalRequired);
+            gasFees.token = config.networkMap.get(fromChainId)?.nativeCurrency;
+        };
+        let bridgeFees = {
+            bridgeFee: {},
+            bridgeable: false,
+        };
+        const getBridgeFees = async () => {
+            const tokenBridge = await createBridgeInstance(fromChainId, toChainId, readOnlyProviders, config);
+            bridgeFees = await getBridgeFeeEstimate$1(tokenBridge, fromAddress);
+        };
+        await Promise.all([
+            getGasFees(),
+            getBridgeFees(),
+        ]);
         return {
             gasEstimateType: GasEstimateType.BRIDGE_TO_L2,
-            gasFee,
+            gasFee: gasFees,
             bridgeFee: {
-                estimatedAmount: bridgeFee?.estimatedAmount,
-                token: bridgeFee?.token,
+                estimatedAmount: bridgeFees.bridgeFee?.estimatedAmount,
+                token: bridgeFees.bridgeFee?.token,
             },
-            bridgeable,
+            bridgeable: bridgeFees.bridgeable,
         };
     }
     catch {
@@ -31384,7 +31382,7 @@ async function swapGasEstimator(config) {
 async function gasEstimator(params, readOnlyProviders, config) {
     switch (params.gasEstimateType) {
         case GasEstimateType.BRIDGE_TO_L2:
-            return await bridgeToL2GasEstimator(readOnlyProviders, config, params.isSpendingCapApprovalRequired, params.tokenAddress);
+            return await bridgeToL2GasEstimator(readOnlyProviders, config, params.isSpendingCapApprovalRequired);
         case GasEstimateType.SWAP:
             return await swapGasEstimator(config);
         default:
@@ -34002,7 +34000,7 @@ async function getItemRequirementsFromRequirements(provider, requirements) {
     return itemRequirements;
 }
 
-const SDK_VERSION_MARKER = '0.30.3';
+const SDK_VERSION_MARKER = '0.30.5';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 

package/dist/orderbook.d.ts

@@ -761,7 +761,7 @@ type ERC20Item$1 = {
     /**
      * A string representing the starting price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
      */
-    start_amount: string;
+    amount: string;
 };
 
 type ERC721Item$1 = {
@@ -787,7 +787,7 @@ type NativeItem$1 = {
     /**
      * A string representing the starting price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
      */
-    start_amount: string;
+    amount: string;
 };
 
 type Item = (NativeItem$1 | ERC20Item$1 | ERC721Item$1);

package/dist/orderbook.js

@@ -679,13 +679,13 @@ function mapFromOpenApiOrder(order) {
             return {
                 type: 'ERC20',
                 contractAddress: item.contract_address,
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         if (item.item_type === 'NATIVE') {
             return {
                 type: 'NATIVE',
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         throw new Error('Buy items must be either ERC20 or NATIVE');
@@ -733,13 +733,13 @@ function mapFromOpenApiTrade(trade) {
             return {
                 type: 'ERC20',
                 contractAddress: item.contract_address,
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         if (item.item_type === 'NATIVE') {
             return {
                 type: 'NATIVE',
-                amount: item.start_amount,
+                amount: item.amount,
             };
         }
         throw new Error('Buy items must be either ERC20 or NATIVE');
@@ -879,8 +879,8 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
         switch (buyItem.item_type) {
             case 'NATIVE':
                 return {
-                    startAmount: buyItem.start_amount,
-                    endAmount: buyItem.start_amount,
+                    startAmount: buyItem.amount,
+                    endAmount: buyItem.amount,
                     itemType: ItemType.NATIVE,
                     recipient: order.account_address,
                     token: constants$1.AddressZero,
@@ -888,8 +888,8 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
                 };
             case 'ERC20':
                 return {
-                    startAmount: buyItem.start_amount,
-                    endAmount: buyItem.start_amount,
+                    startAmount: buyItem.amount,
+                    endAmount: buyItem.amount,
                     itemType: ItemType.ERC20,
                     recipient: order.account_address,
                     token: buyItem.contract_address || constants$1.AddressZero,
@@ -1210,7 +1210,7 @@ class ImmutableApiClient {
                             === ItemType.NATIVE
                             ? 'NATIVE'
                             : 'ERC20',
-                        start_amount: orderComponents.consideration[0].startAmount,
+                        amount: orderComponents.consideration[0].startAmount,
                         contract_address: orderComponents.consideration[0].token,
                     },
                 ],

package/dist/passport.js

@@ -2191,7 +2191,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.30.3' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.30.5' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -2247,7 +2247,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.30.3',
+    sdkVersion: 'ts-immutable-sdk-0.30.5',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

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