@imtbl/sdk 0.44.1 → 0.44.2

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.44.1' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.44.2' };
 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.44.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.44.2',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -11130,7 +11130,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.44.1',
+    sdkVersion: 'ts-immutable-sdk-0.44.2',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -37016,38 +37016,84 @@ class TokenBridge {
    * @throws {BridgeError} - If an error occurs during the query, a BridgeError will be thrown with a specific error type.
    */
     async getTransactionStatus(req) {
-        const axelarAPIEndpoint = this.getAxelarEndpoint(req.sourceChainId);
         const txStatusResponse = {
             transactions: [],
         };
-        const abiCoder = new AbiCoder();
-        const statusPromises = [];
-        for (const transaction of req.transactions) {
-            statusPromises.push(queryTransactionStatus(axelarAPIEndpoint, transaction.txHash));
+        const txStatusItems = await this.getAxelarStatus(req.transactions, req.sourceChainId);
+        const uniqueReceivers = await this.getUniqueReceivers(txStatusItems, req.sourceChainId);
+        const pendingWithdrawalPromises = [];
+        for (const address of uniqueReceivers) {
+            pendingWithdrawalPromises.push(this.getPendingWithdrawals({ recipient: address }));
         }
-        let statusResponses;
+        let pendingWithdrawalResponses = [];
         try {
-            statusResponses = await Promise.all(statusPromises);
+            pendingWithdrawalResponses = await Promise.all(pendingWithdrawalPromises);
         }
         catch (err) {
-            throw new BridgeError(`Failed to fetch the Axelar Status with the reason: ${err}`, BridgeErrorType.AXELAR_GAS_ESTIMATE_FAILED);
+            console.log('err', err);
+            throw new BridgeError(`Failed to fetch the pending withdrawals with: ${err}`, BridgeErrorType.FLOW_RATE_ERROR);
         }
-        const unpaidGasStatus = [GasPaidStatus.GAS_UNPAID, GasPaidStatus.GAS_PAID_NOT_ENOUGH_GAS];
+        txStatusResponse.transactions = txStatusItems;
+        // try match a completed transaction to a pending flowRate transaction
+        for (const txStatusRes of txStatusResponse.transactions) {
+            if (txStatusRes.status === StatusResponse.COMPLETE) {
+                (() => {
+                    for (const pendingWithdrawals of pendingWithdrawalResponses) {
+                        const flowRatedTxIndex = pendingWithdrawals.pending.findIndex((el) => (el.amount.toString() === txStatusRes.amount.toString()
+                            && el.token === txStatusRes.token
+                            && el.withdrawer === txStatusRes.sender
+                            && el.recipient === txStatusRes.recipient));
+                        if (flowRatedTxIndex !== -1) {
+                            txStatusRes.status = StatusResponse.FLOW_RATE_CONTROLLED;
+                            txStatusRes.data = {
+                                canWithdraw: pendingWithdrawals.pending[flowRatedTxIndex].canWithdraw,
+                                timeoutStart: pendingWithdrawals.pending[flowRatedTxIndex].timeoutStart,
+                                timeoutEnd: pendingWithdrawals.pending[flowRatedTxIndex].timeoutEnd,
+                            };
+                            pendingWithdrawals.pending.splice(flowRatedTxIndex, 1);
+                            return;
+                        }
+                    }
+                })();
+            }
+        }
+        // Return the tx status response
+        return txStatusResponse;
+    }
+    async getUniqueReceivers(txStatusItems, sourceChainId) {
+        const uniqueReceivers = [];
         const isWithdraw = [
             ZKEVM_DEVNET_CHAIN_ID,
             ZKEVM_TESTNET_CHAIN_ID,
             ZKEVM_MAINNET_CHAIN_ID
-        ].includes(req.sourceChainId);
-        let rootBridge;
-        if (isWithdraw) {
-            rootBridge = await withBridgeError(async () => {
-                const contract = new Contract(this.config.bridgeContracts.rootERC20BridgeFlowRate, ROOT_ERC20_BRIDGE_FLOW_RATE, this.config.rootProvider);
-                return contract;
-            }, BridgeErrorType.INTERNAL_ERROR);
+        ].includes(sourceChainId);
+        for (let i = 0, l = txStatusItems.length; i < l; i++) {
+            if (txStatusItems[i].status === StatusResponse.COMPLETE
+                && isWithdraw && txStatusItems[i].recipient) {
+                const receiverIndex = uniqueReceivers.findIndex((el) => el === txStatusItems[i].recipient);
+                if (receiverIndex === -1) {
+                    uniqueReceivers.push(txStatusItems[i].recipient);
+                }
+            }
+        } // for
+        return uniqueReceivers;
+    }
+    async getAxelarStatus(transactions, sourceChainId) {
+        const txStatusItems = [];
+        const statusPromises = [];
+        const axelarAPIEndpoint = this.getAxelarEndpoint(sourceChainId);
+        const unpaidGasStatus = [GasPaidStatus.GAS_UNPAID, GasPaidStatus.GAS_PAID_NOT_ENOUGH_GAS];
+        const abiCoder = new AbiCoder();
+        for (const transaction of transactions) {
+            statusPromises.push(queryTransactionStatus(axelarAPIEndpoint, transaction.txHash));
+        }
+        let statusResponses;
+        try {
+            statusResponses = await Promise.all(statusPromises);
+        }
+        catch (err) {
+            throw new BridgeError(`Failed to fetch the Axelar Status with the reason: ${err}`, BridgeErrorType.AXELAR_GAS_ESTIMATE_FAILED);
         }
-        const flowRatePromises = [];
-        const flowRateLengthPromises = [];
-        const flowRatePromisesReceivers = [];
         for (let i = 0, l = statusResponses.length; i < l; i++) {
             let metaStatus;
             // consolidate axelar statuses to our own simplified metaStatus
@@ -37081,7 +37127,7 @@ class TokenBridge {
                 }
             }
             let txItem = {
-                txHash: req.transactions[i].txHash,
+                txHash: transactions[i].txHash,
                 status: metaStatus,
                 data: {
                     gmpResponse: statusResponses[i].status,
@@ -37098,61 +37144,9 @@ class TokenBridge {
                     amount: decodedData[4],
                 };
             }
-            let flowRatePromiseIndex = flowRatePromisesReceivers.findIndex((el) => el === txItem.recipient);
-            if (metaStatus === StatusResponse.COMPLETE
-                && isWithdraw && txItem.recipient) {
-                // consolidate the calls we have to make to the flow rate by receiver
-                if (flowRatePromiseIndex === -1) {
-                    flowRatePromisesReceivers.push(txItem.recipient);
-                    flowRatePromiseIndex = flowRatePromisesReceivers.length - 1;
-                }
-                txItem.data.flowRatePromiseIndex = flowRatePromiseIndex;
-            }
-            txStatusResponse.transactions.push(txItem);
+            txStatusItems.push(txItem);
         } // for
-        for (const flowRateReceiver of flowRatePromisesReceivers) {
-            flowRateLengthPromises.push(rootBridge.getPendingWithdrawalsLength(flowRateReceiver));
-        }
-        let flowRateLengthResponses = [];
-        try {
-            flowRateLengthResponses = await Promise.all(flowRateLengthPromises);
-        }
-        catch (err) {
-            throw new BridgeError(`Failed to fetch the Flow Rate pending lengths with the reason: ${err}`, BridgeErrorType.FLOW_RATE_ERROR);
-        }
-        for (let i = 0, l = flowRatePromisesReceivers.length; i < l; i++) {
-            const indices = [];
-            const indicesLength = flowRateLengthResponses[i].toNumber();
-            for (let j = 0; j < indicesLength; j++) {
-                indices.push(j);
-            }
-            flowRatePromises.push(rootBridge.getPendingWithdrawals(flowRatePromisesReceivers[i], indices));
-        }
-        let flowRateResponses = [];
-        if (flowRatePromises.length > 0) {
-            try {
-                flowRateResponses = await Promise.all(flowRatePromises);
-            }
-            catch (err) {
-                throw new BridgeError(`Failed to fetch the Flow Rate statuses with the reason: ${err}`, BridgeErrorType.FLOW_RATE_ERROR);
-            }
-        }
-        for (const txStatusRes of txStatusResponse.transactions) {
-            if (txStatusRes.data.flowRatePromiseIndex !== -1 && flowRateResponses[txStatusRes.data.flowRatePromiseIndex]) {
-                const flowRatedTx = flowRateResponses[txStatusRes.data.flowRatePromiseIndex].find((el) => (el.amount.toString() === txStatusRes.amount.toString()
-                    && el.token === txStatusRes.token
-                    && el.withdrawer === txStatusRes.sender));
-                if (flowRatedTx) {
-                    txStatusRes.status = StatusResponse.FLOW_RATE_CONTROLLED;
-                    txStatusRes.data = {
-                        timestamp: flowRatedTx.timestamp.toString(),
-                    };
-                }
-            }
-            delete txStatusRes.data.flowRatePromiseIndex;
-        }
-        // Return the tx status response
-        return txStatusResponse;
+        return txStatusItems;
     }
     /**
    * Queries for the information about which tokens are flowrated and how long the delay is.
@@ -37178,6 +37172,7 @@ class TokenBridge {
                 token = ETHEREUM_NATIVE_TOKEN_ADDRESS;
             }
             contractPromises.push(rootBridge.flowRateBuckets(token));
+            contractPromises.push(rootBridge.largeTransferThresholds(token));
         }
         let contractPromisesRes;
         try {
@@ -37187,19 +37182,25 @@ class TokenBridge {
             throw new BridgeError('unable to query contract for flowrate info', BridgeErrorType.INTERNAL_ERROR);
         }
         const tokensRes = {};
-        // @note it's i + 2 because the first 2 promises are not token buckets
+        const withdrawalQueueActivated = contractPromisesRes[0];
+        const withdrawalDelay = contractPromisesRes[1].toNumber();
+        // remove first 2 items from promise all response
+        contractPromisesRes.splice(0, 2);
+        // the remaining items should be sets of 2 per token
         for (let i = 0, l = req.tokens.length; i < l; i++) {
+            const shifter = i * 2;
             tokensRes[req.tokens[i]] = {
-                capacity: contractPromisesRes[i + 2].capacity,
-                depth: contractPromisesRes[i + 2].depth,
-                refillTime: contractPromisesRes[i + 2].refillTime.toNumber(),
-                refillRate: contractPromisesRes[i + 2].refillRate,
+                capacity: contractPromisesRes[shifter].capacity,
+                depth: contractPromisesRes[shifter].depth,
+                refillTime: contractPromisesRes[shifter].refillTime.toNumber(),
+                refillRate: contractPromisesRes[shifter].refillRate,
+                largeTransferThreshold: contractPromisesRes[shifter + 1],
             };
         }
         // Return the token mappings
         return {
-            withdrawalQueueActivated: contractPromisesRes[0],
-            withdrawalDelay: contractPromisesRes[1].toNumber(),
+            withdrawalQueueActivated,
+            withdrawalDelay,
             tokens: tokensRes,
         };
     }
@@ -37246,6 +37247,7 @@ class TokenBridge {
                     canWithdraw: true,
                 };
             }
+            pendingWithdrawals.pending[i].recipient = req.recipient;
             pendingWithdrawals.pending[i].withdrawer = pending[i].withdrawer;
             pendingWithdrawals.pending[i].token = pending[i].token;
             pendingWithdrawals.pending[i].amount = pending[i].amount;
@@ -37289,6 +37291,7 @@ class TokenBridge {
                 pendingWithdrawal: {
                     canWithdraw: false,
                     withdrawer: pending[0].withdrawer,
+                    recipient: req.recipient,
                     token: pending[0].token,
                     amount: pending[0].amount,
                     timeoutStart: pending[0].timestamp.toNumber(),
@@ -37302,6 +37305,7 @@ class TokenBridge {
             pendingWithdrawal: {
                 canWithdraw: true,
                 withdrawer: pending[0].withdrawer,
+                recipient: req.recipient,
                 token: pending[0].token,
                 amount: pending[0].amount,
                 timeoutStart: pending[0].timestamp.toNumber(),
@@ -37327,10 +37331,38 @@ class TokenBridge {
    */
     async getTokenMapping(req) {
         // eslint-disable-next-line no-console
-        console.log('stubbed response with req', req);
+        if (req.rootToken.toUpperCase() === 'NATIVE'
+            || req.rootToken === this.config.bridgeContracts.rootChainWrappedETH) {
+            const childBridge = await withBridgeError(async () => {
+                const contract = new Contract(this.config.bridgeContracts.childERC20Bridge, CHILD_ERC20_BRIDGE, this.config.childProvider);
+                return contract;
+            }, BridgeErrorType.INTERNAL_ERROR);
+            const childETHToken = await childBridge.childETHToken();
+            return {
+                rootToken: req.rootToken,
+                childToken: childETHToken,
+            };
+        }
+        const rootBridge = await withBridgeError(async () => {
+            const contract = new Contract(this.config.bridgeContracts.rootERC20BridgeFlowRate, ROOT_ERC20_BRIDGE_FLOW_RATE, this.config.rootProvider);
+            return contract;
+        }, BridgeErrorType.INTERNAL_ERROR);
+        const rootTokenChildAddress = await rootBridge.rootTokenToChildToken(req.rootToken);
+        if (rootTokenChildAddress === AddressZero) {
+            return {
+                rootToken: req.rootToken,
+                childToken: null,
+            };
+        }
+        if (rootTokenChildAddress === req.rootToken) {
+            return {
+                rootToken: req.rootToken,
+                childToken: 'NATIVE',
+            };
+        }
         return {
-            rootToken: '0xF57e7e7C23978C3cAEC3C3548E3D615c346e79fF',
-            childToken: 'NATIVE',
+            rootToken: req.rootToken,
+            childToken: rootTokenChildAddress,
         };
     }
 }
@@ -41256,12 +41288,14 @@ const validateProviderDefaults = {
  * @property {string} SUCCESS - If checkout succeeded as the transactions were able to be processed
  * @property {string} FAILED - If checkout failed due to transactions not settling on chain
  * @property {string} INSUFFICIENT_FUNDS - If checkout failed due to insufficient funds
+ * @property {string} FULFILLMENTS_UNSETTLED - If checkout succeeded but the fulfillment transactions are not yet settled
  */
 var CheckoutStatus;
 (function (CheckoutStatus) {
     CheckoutStatus["SUCCESS"] = "SUCCESS";
     CheckoutStatus["FAILED"] = "FAILED";
     CheckoutStatus["INSUFFICIENT_FUNDS"] = "INSUFFICIENT_FUNDS";
+    CheckoutStatus["FULFILLMENTS_UNSETTLED"] = "FULFILLMENTS_UNSETTLED";
 })(CheckoutStatus || (CheckoutStatus = {}));
 /**
  * An enum representing the item types
@@ -41936,7 +41970,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.44.1';
+const SDK_VERSION_MARKER = '0.44.2';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -44997,7 +45031,9 @@ const getTransactionOrGas = (gasLimit, fulfillmentTransactions) => {
         },
     };
 };
-const buy = async (config, provider, orders) => {
+const buy = async (config, provider, orders, overrides = {
+    waitFulfillmentSettlements: true,
+}) => {
     if (orders.length === 0) {
         throw new CheckoutError('No orders were provided to the orders array. Please provide at least one order.', CheckoutErrorType.FULFILL_ORDER_LISTING_ERROR);
     }
@@ -45125,18 +45161,35 @@ const buy = async (config, provider, orders) => {
                 message: err.message,
             });
         }
-        const fulfillmentResult = await signFulfillmentTransactions(provider, unsignedFulfillmentTransactions);
-        if (fulfillmentResult.type === SignTransactionStatusType.FAILED) {
+        if (overrides.waitFulfillmentSettlements) {
+            const fulfillmentResult = await signFulfillmentTransactions(provider, unsignedFulfillmentTransactions);
+            if (fulfillmentResult.type === SignTransactionStatusType.FAILED) {
+                return {
+                    status: CheckoutStatus.FAILED,
+                    transactionHash: fulfillmentResult.transactionHash,
+                    reason: fulfillmentResult.reason,
+                    smartCheckoutResult,
+                };
+            }
             return {
-                status: CheckoutStatus.FAILED,
-                transactionHash: fulfillmentResult.transactionHash,
-                reason: fulfillmentResult.reason,
+                status: CheckoutStatus.SUCCESS,
                 smartCheckoutResult,
             };
         }
+        let transactions;
+        try {
+            const response = await Promise.all(unsignedFulfillmentTransactions.map((transaction) => sendTransaction(provider, transaction)));
+            transactions = response.map((result) => result.transactionResponse);
+        }
+        catch (err) {
+            throw new CheckoutError('An error occurred while executing the fulfillment transaction', CheckoutErrorType.EXECUTE_FULFILLMENT_TRANSACTION_ERROR, {
+                message: err.message,
+            });
+        }
         return {
-            status: CheckoutStatus.SUCCESS,
+            status: CheckoutStatus.FULFILLMENTS_UNSETTLED,
             smartCheckoutResult,
+            transactions,
         };
     }
     return {
@@ -45713,7 +45766,7 @@ class Checkout {
             console.warn('This endpoint currently only processes the first order in the array.');
         }
         const web3Provider = await validateProvider(this.config, params.provider);
-        return await buy(this.config, web3Provider, params.orders);
+        return await buy(this.config, web3Provider, params.orders, params.overrides);
     }
     /**
      * Determines the requirements for performing a sell.

package/dist/orderbook.d.ts

@@ -1653,4 +1653,4 @@ declare const constants: {
     estimatedFulfillmentGasGwei: number;
 };
 
-export { Action, ActionType, CancelOrdersOnChainResponse, CreateListingParams, ERC20Item, ERC721Item, Fee, FeeType, FeeValue, FulfillBulkOrdersInsufficientBalanceResponse, FulfillBulkOrdersResponse, FulfillBulkOrdersSufficientBalanceResponse, FulfillOrderResponse, FulfillmentListing, ListListingsParams, ListListingsResult, ListTradesParams, ListTradesResult, ListingResult, NativeItem, Order, OrderStatusName, Orderbook, Page, PrepareCancelOrdersResponse, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, SignableAction, SignablePurpose, Trade, TradeResult, TransactionAction, TransactionBuilder, TransactionPurpose, UnfulfillableOrder, constants };
+export { Action, ActionType, CancelOrdersOnChainResponse, CreateListingParams, ERC20Item, ERC721Item, Fee, FeeType, FeeValue, FulfillBulkOrdersInsufficientBalanceResponse, FulfillBulkOrdersResponse, FulfillBulkOrdersSufficientBalanceResponse, FulfillOrderResponse, FulfillmentListing, ListListingsParams, ListListingsResult, ListTradesParams, ListTradesResult, ListingResult, NativeItem, Order, OrderStatusName, Orderbook, OrderbookModuleConfiguration, OrderbookOverrides, Page, PrepareCancelOrdersResponse, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, SignableAction, SignablePurpose, Trade, TradeResult, TransactionAction, TransactionBuilder, TransactionPurpose, UnfulfillableOrder, constants };

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.44.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.44.2' };
 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.44.1',
+    sdkVersion: 'ts-immutable-sdk-0.44.2',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.44.1",
+  "version": "0.44.2",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
     "@0xsequence/abi": "^1.4.3",
     "@0xsequence/core": "^1.4.3",
-    "@biom3/design-tokens": "0.2.9",
-    "@biom3/react": "^0.19.34",
+    "@biom3/design-tokens": "^0.2.10",
+    "@biom3/react": "^0.19.40",
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/abstract-signer": "^5.7.0",
     "@ethersproject/providers": "^5.7.2",
@@ -17,7 +17,7 @@
     "@imtbl/core-sdk": "^2.4.0",
     "@imtbl/react-analytics": "0.2.1-alpha",
     "@jest/globals": "^29.5.0",
-    "@magic-ext/oidc": "^4.2.0",
+    "@magic-ext/oidc": "4.2.0",
     "@metamask/detect-provider": "^2.0.0",
     "@opensea/seaport-js": "2.0.7",
     "@uniswap/router-sdk": "^1.4.0",
@@ -35,7 +35,7 @@
     "i18next-browser-languagedetector": "^7.2.0",
     "jwt-decode": "^3.1.2",
     "magic-sdk": "^21.2.0",
-    "oidc-client-ts": "^2.2.1",
+    "oidc-client-ts": "2.2.1",
     "os-browserify": "^0.3.0",
     "pako": "^2.1.0",
     "react-i18next": "^13.5.0",
@@ -127,7 +127,7 @@
   },
   "repository": "immutable/ts-immutable-sdk.git",
   "resolutions": {
-    "@biom3/design-tokens": "0.2.9",
+    "@biom3/design-tokens": "^0.2.10",
     "@openzeppelin/contracts": "3.4.2-solc-0.7"
   },
   "scripts": {