@imtbl/sdk 0.34.1-alpha → 0.35.1

package/dist/checkout.js

@@ -14673,7 +14673,6 @@ class UniswapV3Pool__factory extends ContractFactory {
     }
 }
 
-const DEFAULT_GAS_QUOTE = 2000000;
 // TODO: Better description of function and args
 async function multicallSingleCallDataMultipleContracts(multicallContract, functionName, addresses) {
     // Encode args - generate calldata for contract
@@ -14695,22 +14694,6 @@ async function multicallSingleCallDataMultipleContracts(multicallContract, funct
     }
     return multicallContract.callStatic.multicall(calls);
 }
-// TODO: Better description of function and args
-async function multicallMultipleCallDataSingContract(multicallContract, calldata, address, options) {
-    // Create call objects
-    const calls = new Array(calldata.length);
-    // TODO: use object.keys of something similar to avoid iterating over
-    // entire object prototype
-    // eslint-disable-next-line no-restricted-syntax, guard-for-in
-    for (const i in calldata) {
-        calls[i] = {
-            target: address,
-            callData: calldata[i],
-            gasLimit: options?.gasRequired ?? DEFAULT_GAS_QUOTE,
-        };
-    }
-    return multicallContract.callStatic.multicall(calls);
-}
 const getCallData = (methodName, contractInterface) => {
     // Create ethers function fragment
     const fragment = contractInterface?.getFunction(methodName);
@@ -14870,35 +14853,27 @@ const getDefaultDeadlineSeconds = () => Math.floor(Date.now() / 1000) + DEFAULT_
 
 const amountIndex = 0;
 const gasEstimateIndex = 3;
-async function getQuotesForRoutes(multicallContract, quoterContractAddress, routes, amountSpecified, tradeType) {
-    const callData = routes.map((route) => SwapQuoter.quoteCallParameters(route, toCurrencyAmount(amountSpecified), tradeType, {
+async function getQuotesForRoutes(provider, quoterContractAddress, routes, amountSpecified, tradeType) {
+    const callDatas = routes.map((route) => SwapQuoter.quoteCallParameters(route, toCurrencyAmount(amountSpecified), tradeType, {
         useQuoterV2: true,
     }).calldata);
-    let quoteResults;
-    try {
-        quoteResults = await multicallMultipleCallDataSingContract(multicallContract, callData, quoterContractAddress);
-    }
-    catch (e) {
-        const message = e instanceof Error ? e.message : 'Unknown Error';
-        throw new ProviderCallError(`failed multicall: ${message}`);
-    }
-    const decodedQuoteResults = [];
-    // TODO: for..in loops iterate over the entire prototype chain,
-    // Use Object.{keys,values,entries}, and iterate over the resulting array.
-    // eslint-disable-next-line no-restricted-syntax, guard-for-in
-    for (const i in quoteResults.returnData) {
-        const functionSig = callData[i].substring(0, 10);
+    const promises = await Promise.allSettled(callDatas.map((data) => provider.send('eth_call', [
+        { to: quoterContractAddress, data }, 'latest',
+    ])));
+    const decodedQuoteResults = promises.reduce((quoteResults, promiseResult, i) => {
+        if (promiseResult.status === 'rejected')
+            return quoteResults;
+        const functionSig = callDatas[i].substring(0, 10);
         const returnTypes = quoteReturnMapping[functionSig];
         if (!returnTypes) {
             throw new Error('No quoting function signature found');
         }
-        if (quoteResults.returnData[i].returnData === '0x') {
+        if (promiseResult.value === '0x') {
             // There is no quote result for the swap using this route, so don't include it in results
-            // eslint-disable-next-line no-continue
-            continue;
+            return quoteResults;
         }
         try {
-            const decodedQuoteResult = ethers.utils.defaultAbiCoder.decode(returnTypes, quoteResults.returnData[i].returnData);
+            const decodedQuoteResult = utils.defaultAbiCoder.decode(returnTypes, promiseResult.value);
             if (decodedQuoteResult) {
                 // The 0th element in each decoded data is going to be the amountOut or amountIn.
                 const quoteAmount = decodedQuoteResult[amountIndex];
@@ -14906,11 +14881,11 @@ async function getQuotesForRoutes(multicallContract, quoterContractAddress, rout
                     throw new Error('Expected BigNumber');
                 const input = uniswapTokenToERC20(routes[i].input);
                 const output = uniswapTokenToERC20(routes[i].output);
-                decodedQuoteResults.push({
+                quoteResults.push({
                     route: routes[i],
                     amountIn: tradeType === TradeType.EXACT_INPUT ? amountSpecified : newAmount(quoteAmount, input),
                     amountOut: tradeType === TradeType.EXACT_INPUT ? newAmount(quoteAmount, output) : amountSpecified,
-                    gasEstimate: ethers.BigNumber.from(decodedQuoteResult[gasEstimateIndex]),
+                    gasEstimate: BigNumber$1.from(decodedQuoteResult[gasEstimateIndex]),
                     tradeType,
                 });
             }
@@ -14920,7 +14895,8 @@ async function getQuotesForRoutes(multicallContract, quoterContractAddress, rout
             // Other quotes for routes may still succeed, so do nothing
             // and continue processing
         }
-    }
+        return quoteResults;
+    }, new Array());
     return decodedQuoteResults;
 }
 
@@ -15048,19 +15024,24 @@ const fetchValidPools = async (multicallContract, erc20Pair, commonRoutingERC20s
 
 class Router {
     provider;
+    multicallContract;
     routingTokens;
     routingContracts;
-    constructor(provider, routingTokens, routingContracts) {
+    constructor(provider, multicallContract, routingTokens, routingContracts) {
         this.provider = provider;
+        this.multicallContract = multicallContract;
+        this.routingTokens = routingTokens;
+        this.routingContracts = routingContracts;
+        this.provider = provider;
+        this.multicallContract = multicallContract;
         this.routingTokens = routingTokens;
         this.routingContracts = routingContracts;
     }
     async findOptimalRoute(amountSpecified, otherToken, tradeType, maxHops = 2) {
         const [tokenIn, tokenOut] = this.determineERC20InAndERC20Out(tradeType, amountSpecified, otherToken);
-        const multicallContract = Multicall__factory.connect(this.routingContracts.multicallAddress, this.provider);
         const erc20Pair = [tokenIn, tokenOut];
         // Get all pools and use these to get all possible routes.
-        const pools = await fetchValidPools(multicallContract, erc20Pair, this.routingTokens, this.routingContracts.factoryAddress);
+        const pools = await fetchValidPools(this.multicallContract, erc20Pair, this.routingTokens, this.routingContracts.coreFactory);
         const noValidPools = pools.length === 0;
         if (noValidPools) {
             throw new NoRoutesAvailableError();
@@ -15074,10 +15055,10 @@ class Router {
             throw new NoRoutesAvailableError();
         }
         // Get the best quote from all of the given routes
-        return await this.getBestQuoteFromRoutes(multicallContract, routes, amountSpecified, tradeType);
+        return await this.getBestQuoteFromRoutes(routes, amountSpecified, tradeType);
     }
-    async getBestQuoteFromRoutes(multicallContract, routes, amountSpecified, tradeType) {
-        const quotes = await getQuotesForRoutes(multicallContract, this.routingContracts.quoterAddress, routes, amountSpecified, tradeType);
+    async getBestQuoteFromRoutes(routes, amountSpecified, tradeType) {
+        const quotes = await getQuotesForRoutes(this.provider, this.routingContracts.quoterV2, routes, amountSpecified, tradeType);
         if (quotes.length === 0) {
             throw new NoRoutesAvailableError();
         }
@@ -15806,6 +15787,7 @@ const toPublicQuote = (amount, amountWithMaxSlippage, slippage, fees) => ({
 });
 class Exchange {
     provider;
+    batchProvider;
     router;
     chainId;
     nativeToken;
@@ -15823,12 +15805,16 @@ class Exchange {
         this.secondaryFees = config.secondaryFees;
         this.routerContractAddress = config.chain.contracts.peripheryRouter;
         this.secondaryFeeContractAddress = config.chain.contracts.secondaryFee;
-        this.provider = new ethers.providers.JsonRpcProvider(config.chain.rpcUrl);
-        this.router = new Router(this.provider, config.chain.commonRoutingTokens, {
-            multicallAddress: config.chain.contracts.multicall,
-            factoryAddress: config.chain.contracts.coreFactory,
-            quoterAddress: config.chain.contracts.quoterV2,
-        });
+        this.provider = new ethers.providers.StaticJsonRpcProvider({
+            url: config.chain.rpcUrl,
+            skipFetchSetup: true,
+        }, config.chain.chainId);
+        this.batchProvider = new ethers.providers.JsonRpcBatchProvider({
+            url: config.chain.rpcUrl,
+            skipFetchSetup: true,
+        }, config.chain.chainId);
+        const multicallContract = Multicall__factory.connect(config.chain.contracts.multicall, this.provider);
+        this.router = new Router(this.batchProvider, multicallContract, config.chain.commonRoutingTokens, config.chain.contracts);
     }
     static validate(tokenInAddress, tokenOutAddress, maxHops, slippagePercent, fromAddress) {
         assert(isValidNonZeroAddress(fromAddress), new InvalidAddressError('invalid from address'));
@@ -15840,11 +15826,11 @@ class Exchange {
         assert(slippagePercent <= 50, new InvalidSlippageError('slippage percent must be less than or equal to 50'));
         assert(slippagePercent >= 0, new InvalidSlippageError('slippage percent must be greater than or equal to 0'));
     }
-    async getSecondaryFees() {
+    async getSecondaryFees(provider) {
         if (this.secondaryFees.length === 0) {
             return [];
         }
-        const secondaryFeeContract = SecondaryFee__factory.connect(this.secondaryFeeContractAddress, this.provider);
+        const secondaryFeeContract = SecondaryFee__factory.connect(this.secondaryFeeContractAddress, provider);
         if (await secondaryFeeContract.paused()) {
             // Do not use secondary fees if the contract is paused
             return [];
@@ -15865,11 +15851,13 @@ class Exchange {
     async getUnsignedSwapTx(fromAddress, tokenInLiteral, tokenOutLiteral, amount, slippagePercent, maxHops, deadline, tradeType) {
         Exchange.validate(tokenInLiteral, tokenOutLiteral, maxHops, slippagePercent, fromAddress);
         // get the decimals of the tokens that will be swapped
-        const [tokenInDecimals, tokenOutDecimals, secondaryFees] = await Promise.all([
-            getTokenDecimals(tokenInLiteral, this.provider, this.nativeToken),
-            getTokenDecimals(tokenOutLiteral, this.provider, this.nativeToken),
-            this.getSecondaryFees(),
-        ]);
+        const promises = [
+            getTokenDecimals(tokenInLiteral, this.batchProvider, this.nativeToken),
+            getTokenDecimals(tokenOutLiteral, this.batchProvider, this.nativeToken),
+            this.getSecondaryFees(this.batchProvider),
+            fetchGasPrice(this.batchProvider, this.nativeToken),
+        ];
+        const [tokenInDecimals, tokenOutDecimals, secondaryFees, gasPrice] = await Promise.all(promises);
         const tokenIn = this.parseTokenLiteral(tokenInLiteral, tokenInDecimals);
         const tokenOut = this.parseTokenLiteral(tokenOutLiteral, tokenOutDecimals);
         // determine which amount was specified for the swap from the TradeType
@@ -15878,10 +15866,7 @@ class Exchange {
         const fees = new Fees(secondaryFees, tokenIn);
         const ourQuoteReqAmount = getOurQuoteReqAmount(amountSpecified, fees, tradeType, this.nativeTokenService);
         // Quotes will always use ERC20s. If the user-specified token is Native, we use the Wrapped Native Token pool
-        const [ourQuote, gasPrice] = await Promise.all([
-            this.router.findOptimalRoute(ourQuoteReqAmount, this.nativeTokenService.maybeWrapToken(otherToken), tradeType, maxHops),
-            fetchGasPrice(this.provider, this.nativeToken),
-        ]);
+        const ourQuote = await this.router.findOptimalRoute(ourQuoteReqAmount, this.nativeTokenService.maybeWrapToken(otherToken), tradeType, maxHops);
         const adjustedQuote = adjustQuoteWithFees(ourQuote, amountSpecified, fees, this.nativeTokenService);
         const swap = getSwap(tokenIn, tokenOut, adjustedQuote, fromAddress, slippagePercent, deadline, this.routerContractAddress, this.secondaryFeeContractAddress, gasPrice, secondaryFees);
         const { quotedAmount, quotedAmountWithMaxSlippage } = prepareUserQuote(this.nativeTokenService, adjustedQuote, slippagePercent, otherToken);
@@ -16538,14 +16523,24 @@ var FailedOrderCancellation;
 /* eslint-disable */
 var Fee;
 (function (Fee) {
-    (function (fee_type) {
-        fee_type["ROYALTY"] = "ROYALTY";
-        fee_type["MAKER_ECOSYSTEM"] = "MAKER_ECOSYSTEM";
-        fee_type["TAKER_ECOSYSTEM"] = "TAKER_ECOSYSTEM";
-        fee_type["PROTOCOL"] = "PROTOCOL";
-    })(Fee.fee_type || (Fee.fee_type = {}));
+    (function (type) {
+        type["ROYALTY"] = "ROYALTY";
+        type["MAKER_ECOSYSTEM"] = "MAKER_ECOSYSTEM";
+        type["TAKER_ECOSYSTEM"] = "TAKER_ECOSYSTEM";
+        type["PROTOCOL"] = "PROTOCOL";
+    })(Fee.type || (Fee.type = {}));
 })(Fee || (Fee = {}));
 
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+var Order;
+(function (Order) {
+    (function (type) {
+        type["LISTING"] = "LISTING";
+    })(Order.type || (Order.type = {}));
+})(Order || (Order = {}));
+
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -16598,14 +16593,14 @@ var ActionType;
 
 function mapFromOpenApiOrder(order) {
     const buyItems = order.buy.map((item) => {
-        if (item.item_type === 'ERC20') {
+        if (item.type === 'ERC20') {
             return {
                 type: 'ERC20',
                 contractAddress: item.contract_address,
                 amount: item.amount,
             };
         }
-        if (item.item_type === 'NATIVE') {
+        if (item.type === 'NATIVE') {
             return {
                 type: 'NATIVE',
                 amount: item.amount,
@@ -16614,7 +16609,7 @@ function mapFromOpenApiOrder(order) {
         throw new Error('Buy items must be either ERC20 or NATIVE');
     });
     const sellItems = order.sell.map((item) => {
-        if (item.item_type === 'ERC721') {
+        if (item.type === 'ERC721') {
             return {
                 type: 'ERC721',
                 contractAddress: item.contract_address,
@@ -16625,20 +16620,22 @@ function mapFromOpenApiOrder(order) {
     });
     return {
         id: order.id,
+        type: order.type,
         accountAddress: order.account_address,
         buy: buyItems,
         sell: sellItems,
         fees: order.fees.map((fee) => ({
             amount: fee.amount,
-            recipient: fee.recipient,
-            type: fee.fee_type,
+            recipientAddress: fee.recipient_address,
+            type: fee.type,
         })),
         chain: order.chain,
         createdAt: order.created_at,
         endAt: order.end_at,
+        orderHash: order.order_hash,
         protocolData: {
-            counter: order.protocol_data.counter,
             orderType: order.protocol_data.order_type,
+            counter: order.protocol_data.counter,
             seaportAddress: order.protocol_data.seaport_address,
             seaportVersion: order.protocol_data.seaport_version,
             zoneAddress: order.protocol_data.zone_address,
@@ -16652,14 +16649,14 @@ function mapFromOpenApiOrder(order) {
 }
 function mapFromOpenApiTrade(trade) {
     const buyItems = trade.buy.map((item) => {
-        if (item.item_type === 'ERC20') {
+        if (item.type === 'ERC20') {
             return {
                 type: 'ERC20',
                 contractAddress: item.contract_address,
                 amount: item.amount,
             };
         }
-        if (item.item_type === 'NATIVE') {
+        if (item.type === 'NATIVE') {
             return {
                 type: 'NATIVE',
                 amount: item.amount,
@@ -16668,7 +16665,7 @@ function mapFromOpenApiTrade(trade) {
         throw new Error('Buy items must be either ERC20 or NATIVE');
     });
     const sellItems = trade.sell.map((item) => {
-        if (item.item_type === 'ERC721') {
+        if (item.type === 'ERC721') {
             return {
                 type: 'ERC721',
                 contractAddress: item.contract_address,
@@ -16684,8 +16681,8 @@ function mapFromOpenApiTrade(trade) {
         sell: sellItems,
         buyerFees: trade.buyer_fees.map((fee) => ({
             amount: fee.amount,
-            recipient: fee.recipient,
-            type: fee.fee_type,
+            recipientAddress: fee.recipient_address,
+            type: fee.type,
         })),
         chain: trade.chain,
         indexedAt: trade.indexed_at,
@@ -16799,7 +16796,7 @@ chainId) {
 
 function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress) {
     const considerationItems = order.buy.map((buyItem) => {
-        switch (buyItem.item_type) {
+        switch (buyItem.type) {
             case 'NATIVE':
                 return {
                     startAmount: buyItem.amount,
@@ -16831,9 +16828,9 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
     });
     const fees = order.fees.map((fee) => ({
         amount: fee.amount,
-        itemType: order.buy[0].item_type === 'ERC20' ? ItemType$1.ERC20 : ItemType$1.NATIVE,
-        recipient: fee.recipient,
-        token: order.buy[0].item_type === 'ERC20'
+        itemType: order.buy[0].type === 'ERC20' ? ItemType$1.ERC20 : ItemType$1.NATIVE,
+        recipient: fee.recipient_address,
+        token: order.buy[0].type === 'ERC20'
             ? order.buy[0].contract_address
             : constants$1.AddressZero,
         identifierOrCriteria: '0',
@@ -17125,11 +17122,10 @@ class ImmutableApiClient {
         return this.orderbookService.createListing({
             chainName: this.chainName,
             requestBody: {
-                order_hash: orderHash,
                 account_address: orderComponents.offerer,
                 buy: [
                     {
-                        item_type: Number(orderComponents.consideration[0].itemType)
+                        type: Number(orderComponents.consideration[0].itemType)
                             === ItemType$1.NATIVE
                             ? 'NATIVE'
                             : 'ERC20',
@@ -17139,10 +17135,11 @@ class ImmutableApiClient {
                 ],
                 fees: makerFees.map((x) => ({
                     amount: x.amount,
-                    fee_type: FeeType.MAKER_ECOSYSTEM,
-                    recipient: x.recipient,
+                    type: FeeType.MAKER_ECOSYSTEM,
+                    recipient_address: x.recipientAddress,
                 })),
                 end_at: new Date(parseInt(`${orderComponents.endTime.toString()}000`, 10)).toISOString(),
+                order_hash: orderHash,
                 protocol_data: {
                     order_type: ProtocolData.order_type.FULL_RESTRICTED,
                     zone_address: orderComponents.zone,
@@ -17155,7 +17152,7 @@ class ImmutableApiClient {
                     {
                         contract_address: orderComponents.offer[0].token,
                         token_id: orderComponents.offer[0].identifierOrCriteria,
-                        item_type: 'ERC721',
+                        type: 'ERC721',
                     },
                 ],
                 signature: orderSignature,
@@ -17188,8 +17185,8 @@ function getOrderbookConfig(environment) {
     switch (environment) {
         case Environment$1.SANDBOX:
             return {
-                seaportContractAddress: '0x2CFA8f64e1B49A2DF28532D1D30Cda45117cF778',
-                zoneContractAddress: '0x1Bb4Fb11Ba021Bd0104F0Ee8E5F5c728Bc83d7F1',
+                seaportContractAddress: '0x3A0C2Ba54D6CBd3121F01b96dFd20e99D1696C9D',
+                zoneContractAddress: '0x2EA937879beeF3393853A74Ad62F9ad7DA0B9E81',
                 apiEndpoint: 'https://api.sandbox.immutable.com',
                 chainName: TESTNET_CHAIN_NAME,
                 provider: new providers.JsonRpcProvider('https://rpc.testnet.immutable.com'),
@@ -17352,8 +17349,8 @@ class Orderbook {
                 order_id: listingId,
                 fees: takerFees.map((fee) => ({
                     amount: fee.amount,
-                    fee_type: FeeType.TAKER_ECOSYSTEM,
-                    recipient: fee.recipient,
+                    type: FeeType.TAKER_ECOSYSTEM,
+                    recipient_address: fee.recipientAddress,
                 })),
             },
         ]);
@@ -17375,8 +17372,8 @@ class Orderbook {
             order_id: listingRequest.listingId,
             fees: listingRequest.takerFees.map((fee) => ({
                 amount: fee.amount,
-                fee_type: FeeType.TAKER_ECOSYSTEM,
-                recipient: fee.recipient,
+                type: FeeType.TAKER_ECOSYSTEM,
+                recipient_address: fee.recipientAddress,
             })),
         })));
         try {
@@ -20987,7 +20984,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.34.1-alpha',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.35.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -22264,7 +22261,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.34.1-alpha';
+const SDK_VERSION_MARKER = '0.35.1';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -25295,7 +25292,7 @@ const calculateFees = (orderFees, weiAmount, decimals = 18) => {
         if (currentFeeBn.gt(0)) {
             calculateFeesResult.push({
                 amount: currentFeeBn.toString(),
-                recipient: orderFee.recipient,
+                recipientAddress: orderFee.recipient,
             });
         }
     } // for

package/dist/immutablex_client.js

@@ -17,7 +17,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.34.1-alpha',
+    sdkVersion: 'ts-immutable-sdk-0.35.1',
 });
 /**
  * Sets `sdkVersion` at the time of build