@imtbl/sdk 1.23.2 → 1.24.0-alpha

package/dist/index.cjs

@@ -180,7 +180,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.23.2';
+const SDK_VERSION$1 = '1.24.0-alpha';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -13731,7 +13731,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$2 = { 'x-sdk-version': 'ts-immutable-sdk-1.23.2' };
+const defaultHeaders$2 = { 'x-sdk-version': 'ts-immutable-sdk-1.24.0-alpha' };
 const createConfig$1 = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -13803,7 +13803,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders$1 = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.23.2',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.24.0-alpha',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -14277,7 +14277,7 @@ var blockchain_data = /*#__PURE__*/Object.freeze({
 /* eslint-disable @typescript-eslint/naming-convention */
 class ApiConfiguration extends index$2.Configuration {
 }
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.23.2' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.24.0-alpha' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -14316,7 +14316,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.23.2',
+    sdkVersion: 'ts-immutable-sdk-1.24.0-alpha',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({
@@ -45632,7 +45632,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.23.2';
+const SDK_VERSION = '1.24.0-alpha';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -50827,7 +50827,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.23.2';
+const SDK_VERSION_MARKER = '1.24.0-alpha';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -52096,8 +52096,7 @@ const erc721BalanceAggregator = (itemRequirements) => {
 const balanceAggregator = (itemRequirements) => erc721BalanceAggregator(erc20BalanceAggregator(nativeBalanceAggregator(itemRequirements)));
 
 /* eslint-disable arrow-body-style */
-const getTokensFromRequirements = (itemRequirements) => itemRequirements
-    .map((itemRequirement) => {
+const getTokensFromRequirements = (itemRequirements) => itemRequirements.map((itemRequirement) => {
     switch (itemRequirement.type) {
         case ItemType.ERC20:
             return {
@@ -52122,11 +52121,11 @@ const getERC721BalanceRequirement = (itemRequirement, balances) => {
     // Find the requirements related balance
     const itemBalanceResult = balances.find((balance) => {
         const balanceERC721Result = balance;
-        return isMatchingAddress(balanceERC721Result.contractAddress, itemRequirement.contractAddress)
-            && balanceERC721Result.id === itemRequirement.id;
+        return (isMatchingAddress(balanceERC721Result.contractAddress, itemRequirement.contractAddress) && balanceERC721Result.id === itemRequirement.id);
     });
     // Calculate the balance delta
-    const sufficient = (requiredBalance.isNegative() || requiredBalance.isZero())
+    const sufficient = requiredBalance.isNegative()
+        || requiredBalance.isZero()
         || (itemBalanceResult?.balance.gte(requiredBalance) ?? false);
     const delta = requiredBalance.sub(itemBalanceResult?.balance ?? ethers.BigNumber.from(0));
     let erc721BalanceResult = itemBalanceResult;
@@ -52157,7 +52156,7 @@ const getERC721BalanceRequirement = (itemRequirement, balances) => {
 /**
  * Gets the balance requirement for a NATIVE or ERC20 requirement.
  */
-const getTokenBalanceRequirement = (itemRequirement, balances) => {
+const getTokenBalanceRequirement = async (itemRequirement, balances, provider) => {
     let itemBalanceResult;
     // Get the requirements related balance
     if (itemRequirement.type === ItemType.ERC20) {
@@ -52172,17 +52171,37 @@ const getTokenBalanceRequirement = (itemRequirement, balances) => {
     }
     // Calculate the balance delta
     const requiredBalance = itemRequirement.amount;
-    const sufficient = (requiredBalance.isNegative() || requiredBalance.isZero())
+    const sufficient = requiredBalance.isNegative()
+        || requiredBalance.isZero()
         || (itemBalanceResult?.balance.gte(requiredBalance) ?? false);
     const delta = requiredBalance.sub(itemBalanceResult?.balance ?? ethers.BigNumber.from(0));
     let name = '';
     let symbol = '';
     let decimals = DEFAULT_TOKEN_DECIMALS$1;
     if (itemBalanceResult) {
-        decimals = itemBalanceResult.token?.decimals ?? DEFAULT_TOKEN_DECIMALS$1;
+        decimals = itemBalanceResult.token?.decimals
+            ?? DEFAULT_TOKEN_DECIMALS$1;
         name = itemBalanceResult.token.name;
         symbol = itemBalanceResult.token.symbol;
     }
+    else if (itemRequirement.type === ItemType.ERC20) {
+        // Missing item balance so we need to query contract
+        try {
+            const contract = new ethers.Contract(itemRequirement.tokenAddress, JSON.stringify(ERC20ABI), provider);
+            const [contractName, contractSymbol, contractDecimals] = await Promise.all([
+                contract.name(),
+                contract.symbol(),
+                contract.decimals(),
+            ]);
+            decimals = contractDecimals;
+            name = contractName;
+            symbol = contractSymbol;
+        }
+        catch (error) {
+            // eslint-disable-next-line no-console
+            console.error('Failed to query contract information', itemRequirement.tokenAddress);
+        }
+    }
     let tokenBalanceResult = itemBalanceResult;
     if (itemRequirement.type === ItemType.NATIVE) {
         // No token balance so mark as zero native
@@ -52234,9 +52253,23 @@ const getTokenBalanceRequirement = (itemRequirement, balances) => {
             balance: delta,
             formattedBalance: ethers.utils.formatUnits(delta, decimals),
         },
-        current: tokenBalanceResult,
+        current: {
+            ...tokenBalanceResult,
+            token: {
+                address: itemRequirement.tokenAddress,
+                name,
+                symbol,
+                decimals,
+            },
+        },
         required: {
             ...tokenBalanceResult,
+            token: {
+                address: itemRequirement.tokenAddress,
+                name,
+                symbol,
+                decimals,
+            },
             balance: ethers.BigNumber.from(itemRequirement.amount),
             formattedBalance: ethers.utils.formatUnits(itemRequirement.amount, decimals),
         },
@@ -52333,13 +52366,14 @@ const balanceCheck = async (config, provider, ownerAddress, itemRequirements, fo
     }
     // Wait for all balances and calculate the requirements
     const promisesResponses = await Promise.all(balancePromises);
-    const balanceRequirements = [];
+    const erc721BalanceRequirements = [];
+    const tokenBalanceRequirementPromises = [];
     // Get all ERC20 and NATIVE balances
     if (requiredToken.length > 0 && promisesResponses.length > 0) {
         const result = promisesResponses.shift();
         if (result) {
             requiredToken.forEach((item) => {
-                balanceRequirements.push(getTokenBalanceRequirement(item, result));
+                tokenBalanceRequirementPromises.push(getTokenBalanceRequirement(item, result, provider));
             });
         }
     }
@@ -52348,10 +52382,14 @@ const balanceCheck = async (config, provider, ownerAddress, itemRequirements, fo
         const result = promisesResponses.shift();
         if (result) {
             requiredERC721.forEach((item) => {
-                balanceRequirements.push(getERC721BalanceRequirement(item, result));
+                erc721BalanceRequirements.push(getERC721BalanceRequirement(item, result));
             });
         }
     }
+    const balanceRequirements = [
+        ...erc721BalanceRequirements,
+        ...(await Promise.all(tokenBalanceRequirementPromises)),
+    ];
     // Find if there are any requirements that aren't sufficient.
     // If there is not item with sufficient === false then the requirements
     // are satisfied.

package/dist/index.js

@@ -158,7 +158,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.23.2';
+const SDK_VERSION$1 = '1.24.0-alpha';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -13709,7 +13709,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$2 = { 'x-sdk-version': 'ts-immutable-sdk-1.23.2' };
+const defaultHeaders$2 = { 'x-sdk-version': 'ts-immutable-sdk-1.24.0-alpha' };
 const createConfig$1 = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -13781,7 +13781,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders$1 = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.23.2',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.24.0-alpha',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -14255,7 +14255,7 @@ var blockchain_data = /*#__PURE__*/Object.freeze({
 /* eslint-disable @typescript-eslint/naming-convention */
 class ApiConfiguration extends index$2.Configuration {
 }
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.23.2' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.24.0-alpha' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -14294,7 +14294,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.23.2',
+    sdkVersion: 'ts-immutable-sdk-1.24.0-alpha',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({
@@ -45610,7 +45610,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.23.2';
+const SDK_VERSION = '1.24.0-alpha';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -50805,7 +50805,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.23.2';
+const SDK_VERSION_MARKER = '1.24.0-alpha';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -52074,8 +52074,7 @@ const erc721BalanceAggregator = (itemRequirements) => {
 const balanceAggregator = (itemRequirements) => erc721BalanceAggregator(erc20BalanceAggregator(nativeBalanceAggregator(itemRequirements)));
 
 /* eslint-disable arrow-body-style */
-const getTokensFromRequirements = (itemRequirements) => itemRequirements
-    .map((itemRequirement) => {
+const getTokensFromRequirements = (itemRequirements) => itemRequirements.map((itemRequirement) => {
     switch (itemRequirement.type) {
         case ItemType.ERC20:
             return {
@@ -52100,11 +52099,11 @@ const getERC721BalanceRequirement = (itemRequirement, balances) => {
     // Find the requirements related balance
     const itemBalanceResult = balances.find((balance) => {
         const balanceERC721Result = balance;
-        return isMatchingAddress(balanceERC721Result.contractAddress, itemRequirement.contractAddress)
-            && balanceERC721Result.id === itemRequirement.id;
+        return (isMatchingAddress(balanceERC721Result.contractAddress, itemRequirement.contractAddress) && balanceERC721Result.id === itemRequirement.id);
     });
     // Calculate the balance delta
-    const sufficient = (requiredBalance.isNegative() || requiredBalance.isZero())
+    const sufficient = requiredBalance.isNegative()
+        || requiredBalance.isZero()
         || (itemBalanceResult?.balance.gte(requiredBalance) ?? false);
     const delta = requiredBalance.sub(itemBalanceResult?.balance ?? BigNumber$1.from(0));
     let erc721BalanceResult = itemBalanceResult;
@@ -52135,7 +52134,7 @@ const getERC721BalanceRequirement = (itemRequirement, balances) => {
 /**
  * Gets the balance requirement for a NATIVE or ERC20 requirement.
  */
-const getTokenBalanceRequirement = (itemRequirement, balances) => {
+const getTokenBalanceRequirement = async (itemRequirement, balances, provider) => {
     let itemBalanceResult;
     // Get the requirements related balance
     if (itemRequirement.type === ItemType.ERC20) {
@@ -52150,17 +52149,37 @@ const getTokenBalanceRequirement = (itemRequirement, balances) => {
     }
     // Calculate the balance delta
     const requiredBalance = itemRequirement.amount;
-    const sufficient = (requiredBalance.isNegative() || requiredBalance.isZero())
+    const sufficient = requiredBalance.isNegative()
+        || requiredBalance.isZero()
         || (itemBalanceResult?.balance.gte(requiredBalance) ?? false);
     const delta = requiredBalance.sub(itemBalanceResult?.balance ?? BigNumber$1.from(0));
     let name = '';
     let symbol = '';
     let decimals = DEFAULT_TOKEN_DECIMALS$1;
     if (itemBalanceResult) {
-        decimals = itemBalanceResult.token?.decimals ?? DEFAULT_TOKEN_DECIMALS$1;
+        decimals = itemBalanceResult.token?.decimals
+            ?? DEFAULT_TOKEN_DECIMALS$1;
         name = itemBalanceResult.token.name;
         symbol = itemBalanceResult.token.symbol;
     }
+    else if (itemRequirement.type === ItemType.ERC20) {
+        // Missing item balance so we need to query contract
+        try {
+            const contract = new Contract$1(itemRequirement.tokenAddress, JSON.stringify(ERC20ABI), provider);
+            const [contractName, contractSymbol, contractDecimals] = await Promise.all([
+                contract.name(),
+                contract.symbol(),
+                contract.decimals(),
+            ]);
+            decimals = contractDecimals;
+            name = contractName;
+            symbol = contractSymbol;
+        }
+        catch (error) {
+            // eslint-disable-next-line no-console
+            console.error('Failed to query contract information', itemRequirement.tokenAddress);
+        }
+    }
     let tokenBalanceResult = itemBalanceResult;
     if (itemRequirement.type === ItemType.NATIVE) {
         // No token balance so mark as zero native
@@ -52212,9 +52231,23 @@ const getTokenBalanceRequirement = (itemRequirement, balances) => {
             balance: delta,
             formattedBalance: utils$3.formatUnits(delta, decimals),
         },
-        current: tokenBalanceResult,
+        current: {
+            ...tokenBalanceResult,
+            token: {
+                address: itemRequirement.tokenAddress,
+                name,
+                symbol,
+                decimals,
+            },
+        },
         required: {
             ...tokenBalanceResult,
+            token: {
+                address: itemRequirement.tokenAddress,
+                name,
+                symbol,
+                decimals,
+            },
             balance: BigNumber$1.from(itemRequirement.amount),
             formattedBalance: utils$3.formatUnits(itemRequirement.amount, decimals),
         },
@@ -52311,13 +52344,14 @@ const balanceCheck = async (config, provider, ownerAddress, itemRequirements, fo
     }
     // Wait for all balances and calculate the requirements
     const promisesResponses = await Promise.all(balancePromises);
-    const balanceRequirements = [];
+    const erc721BalanceRequirements = [];
+    const tokenBalanceRequirementPromises = [];
     // Get all ERC20 and NATIVE balances
     if (requiredToken.length > 0 && promisesResponses.length > 0) {
         const result = promisesResponses.shift();
         if (result) {
             requiredToken.forEach((item) => {
-                balanceRequirements.push(getTokenBalanceRequirement(item, result));
+                tokenBalanceRequirementPromises.push(getTokenBalanceRequirement(item, result, provider));
             });
         }
     }
@@ -52326,10 +52360,14 @@ const balanceCheck = async (config, provider, ownerAddress, itemRequirements, fo
         const result = promisesResponses.shift();
         if (result) {
             requiredERC721.forEach((item) => {
-                balanceRequirements.push(getERC721BalanceRequirement(item, result));
+                erc721BalanceRequirements.push(getERC721BalanceRequirement(item, result));
             });
         }
     }
+    const balanceRequirements = [
+        ...erc721BalanceRequirements,
+        ...(await Promise.all(tokenBalanceRequirementPromises)),
+    ];
     // Find if there are any requirements that aren't sufficient.
     // If there is not item with sufficient === false then the requirements
     // are satisfied.

package/dist/orderbook.js

@@ -131,7 +131,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.23.2';
+const SDK_VERSION = '1.24.0-alpha';
 const getReferrer = () => {
     if (isNode()) {
         return '';

package/dist/passport.js

@@ -11446,7 +11446,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.23.2' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.24.0-alpha' };
 const createConfig$1 = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -11625,7 +11625,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.23.2';
+const SDK_VERSION = '1.24.0-alpha';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -11875,7 +11875,7 @@ const addKeysToHeadersOverride = (baseConfig, overrides) => {
 /* eslint-disable @typescript-eslint/naming-convention */
 class ApiConfiguration extends index$2.Configuration {
 }
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.23.2' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.24.0-alpha' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -11914,7 +11914,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.23.2',
+    sdkVersion: 'ts-immutable-sdk-1.24.0-alpha',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({

package/dist/x.js

@@ -8954,7 +8954,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.23.2';
+const SDK_VERSION = '1.24.0-alpha';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -9197,7 +9197,7 @@ const addKeysToHeadersOverride = (baseConfig, overrides) => {
 /* eslint-disable @typescript-eslint/naming-convention */
 class ApiConfiguration extends index$2.Configuration {
 }
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.23.2' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.24.0-alpha' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -9236,7 +9236,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.23.2',
+    sdkVersion: 'ts-immutable-sdk-1.24.0-alpha',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({

package/package.json

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