@imtbl/sdk 0.44.1 → 0.44.2

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.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');
@@ -10713,7 +10713,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
@@ -11152,7 +11152,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
@@ -37038,38 +37038,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
@@ -37103,7 +37149,7 @@ class TokenBridge {
                 }
             }
             let txItem = {
-                txHash: req.transactions[i].txHash,
+                txHash: transactions[i].txHash,
                 status: metaStatus,
                 data: {
                     gmpResponse: statusResponses[i].status,
@@ -37120,61 +37166,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.
@@ -37200,6 +37194,7 @@ class TokenBridge {
                 token = ETHEREUM_NATIVE_TOKEN_ADDRESS;
             }
             contractPromises.push(rootBridge.flowRateBuckets(token));
+            contractPromises.push(rootBridge.largeTransferThresholds(token));
         }
         let contractPromisesRes;
         try {
@@ -37209,19 +37204,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,
         };
     }
@@ -37268,6 +37269,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;
@@ -37311,6 +37313,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(),
@@ -37324,6 +37327,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(),
@@ -37349,10 +37353,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,
         };
     }
 }
@@ -41278,12 +41310,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
@@ -41958,7 +41992,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.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;
 
@@ -45019,7 +45053,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);
     }
@@ -45147,18 +45183,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 {
@@ -45735,7 +45788,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/index.d.ts

@@ -16861,6 +16861,8 @@ type orderbook_d_OrderStatusName = OrderStatusName;
 declare const orderbook_d_OrderStatusName: typeof OrderStatusName;
 type orderbook_d_Orderbook = Orderbook;
 declare const orderbook_d_Orderbook: typeof Orderbook;
+type orderbook_d_OrderbookModuleConfiguration = OrderbookModuleConfiguration;
+type orderbook_d_OrderbookOverrides = OrderbookOverrides;
 type orderbook_d_Page = Page;
 type orderbook_d_PrepareCancelOrdersResponse = PrepareCancelOrdersResponse;
 type orderbook_d_PrepareListingParams = PrepareListingParams;
@@ -16902,6 +16904,8 @@ declare namespace orderbook_d {
     orderbook_d_Order as Order,
     orderbook_d_OrderStatusName as OrderStatusName,
     orderbook_d_Orderbook as Orderbook,
+    orderbook_d_OrderbookModuleConfiguration as OrderbookModuleConfiguration,
+    orderbook_d_OrderbookOverrides as OrderbookOverrides,
     orderbook_d_Page as Page,
     orderbook_d_PrepareCancelOrdersResponse as PrepareCancelOrdersResponse,
     orderbook_d_PrepareListingParams as PrepareListingParams,
@@ -17062,7 +17066,7 @@ interface FeePercentage {
     percentageDecimal: number;
 }
 
-type BuyResult = BuyResultSuccess | BuyResultFailed | BuyResultInsufficientFunds;
+type BuyResult = BuyResultSuccess | BuyResultFailed | BuyResultFulfillmentsUnsettled | BuyResultInsufficientFunds;
 /**
  * Represents the result of {@link Checkout.buy}
  * @property {CheckoutStatus.SUCCESS} status
@@ -17091,6 +17095,20 @@ type BuyResultFailed = {
     /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
+/**
+ * Represents the result of {@link Checkout.buy}
+ * @property {CheckoutStatus.FULFILLMENTS_UNSETTLED} status
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
+ * @property {SendTransactionResult[]} transactions
+ */
+type BuyResultFulfillmentsUnsettled = {
+    /** The status to indicate success */
+    status: CheckoutStatus.FULFILLMENTS_UNSETTLED;
+    /** The sufficient result of smart checkout */
+    smartCheckoutResult: SmartCheckoutSufficient;
+    /** Array of transaction results */
+    transactions: TransactionResponse[];
+};
 /**
  * Represents the result of {@link Checkout.buy}
  * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status
@@ -17102,6 +17120,14 @@ type BuyResultInsufficientFunds = {
     /** The insufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutInsufficient;
 };
+/**
+ * Represents the overrides available for {@link Checkout.buy}
+ * @property {boolean} waitFulfillmentSettlements
+ */
+type BuyOverrides = {
+    /** If the buy should wait for the fulfillment transactions to settle */
+    waitFulfillmentSettlements?: boolean;
+};
 type SellResult = SellResultSuccess | SellResultFailed | SellResultInsufficientFunds;
 /**
  * Represents the result of {@link Checkout.sell}
@@ -17174,11 +17200,13 @@ type CancelResultFailed = {
  * @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
  */
 declare enum CheckoutStatus {
     SUCCESS = "SUCCESS",
     FAILED = "FAILED",
-    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS"
+    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
+    FULFILLMENTS_UNSETTLED = "FULFILLMENTS_UNSETTLED"
 }
 /**
  * The type representing the order to buy
@@ -17737,11 +17765,13 @@ type AvailableRoutingOptions = {
  * Interface representing the parameters for {@link Checkout.buy}
  * @property {Web3Provider} provider - The provider to use for the buy.
  * @property {Array<BuyOrder>} orders - The orders to buy
+ * @property {BuyOverrides} overrides - The overrides to use for the buy.
  * Currently only processes the first order in the array until batch processing is supported.
  */
 interface BuyParams {
     provider: Web3Provider;
     orders: Array<BuyOrder>;
+    overrides?: BuyOverrides;
 }
 
 /**
@@ -19470,6 +19500,7 @@ type checkout_d_BridgeTransactionSent = BridgeTransactionSent;
 type checkout_d_BridgeWidgetConfiguration = BridgeWidgetConfiguration;
 type checkout_d_BridgeWidgetParams = BridgeWidgetParams;
 type checkout_d_BuyOrder = BuyOrder;
+type checkout_d_BuyOverrides = BuyOverrides;
 type checkout_d_BuyParams = BuyParams;
 type checkout_d_BuyResult = BuyResult;
 type checkout_d_BuyResultFailed = BuyResultFailed;
@@ -19679,6 +19710,7 @@ declare namespace checkout_d {
     checkout_d_BridgeWidgetConfiguration as BridgeWidgetConfiguration,
     checkout_d_BridgeWidgetParams as BridgeWidgetParams,
     checkout_d_BuyOrder as BuyOrder,
+    checkout_d_BuyOverrides as BuyOverrides,
     checkout_d_BuyParams as BuyParams,
     checkout_d_BuyResult as BuyResult,
     checkout_d_BuyResultFailed as BuyResultFailed,