@imtbl/sdk 0.18.3 → 0.20.0

package/dist/index.cjs

@@ -2725,7 +2725,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.18.3' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.20.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -2785,7 +2785,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.18.3',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.20.0',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -3071,7 +3071,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.18.3',
+    sdkVersion: 'ts-immutable-sdk-0.20.0',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -10761,7 +10761,7 @@ class ImmutableApiClient {
             ...listTradesParams,
         });
     }
-    async createListing({ orderHash, orderComponents, orderSignature, makerFee, }) {
+    async createListing({ orderHash, orderComponents, orderSignature, makerFees, }) {
         if (orderComponents.offer.length !== 1) {
             throw new Error('Only one item can be listed at a time');
         }
@@ -10790,11 +10790,11 @@ class ImmutableApiClient {
                         contract_address: orderComponents.consideration[0].token,
                     },
                 ],
-                fee: makerFee ? {
-                    amount: makerFee.amount,
+                fees: makerFees.map((x) => ({
+                    amount: x.amount,
                     fee_type: FeeType.MAKER_MARKETPLACE,
-                    recipient: makerFee.recipient,
-                } : undefined,
+                    recipient: x.recipient,
+                })),
                 end_time: new Date(parseInt(`${orderComponents.endTime.toString()}000`, 10)).toISOString(),
                 protocol_data: {
                     order_type: ProtocolData.order_type.FULL_RESTRICTED,
@@ -10984,15 +10984,8 @@ class Orderbook {
      * @return {ListingResult} The result of the order created in the Immutable services.
      */
     async createListing(createListingParams) {
-        const makerFee = createListingParams.makerFee
-            ? {
-                ...createListingParams.makerFee,
-                type: FeeType.MAKER_MARKETPLACE,
-            }
-            : undefined;
         const apiListingResponse = await this.apiClient.createListing({
             ...createListingParams,
-            makerFee,
         });
         return {
             result: mapFromOpenApiOrder(apiListingResponse.result),
@@ -11006,17 +10999,15 @@ class Orderbook {
      * @param {string} fulfillerAddress - The address of the account fulfilling the order.
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
-    async fulfillOrder(listingId, takerAddress, takerFee) {
+    async fulfillOrder(listingId, takerAddress, takerFees) {
         const fulfillmentDataRes = await this.apiClient.fulfillmentData([
             {
                 order_id: listingId,
-                fee: takerFee
-                    ? {
-                        amount: takerFee.amount,
-                        fee_type: FeeType.TAKER_MARKETPLACE,
-                        recipient: takerFee.recipient,
-                    }
-                    : undefined,
+                fees: takerFees.map((fee) => ({
+                    amount: fee.amount,
+                    fee_type: FeeType.TAKER_MARKETPLACE,
+                    recipient: fee.recipient,
+                })),
             },
         ]);
         if (fulfillmentDataRes.result.length !== 1) {
@@ -30652,7 +30643,7 @@ const $64863c39386de592$export$7f8e2b98eca5a7f0 = async (config, provider, order
     };
     try {
         const fulfillerAddress = await provider.getSigner().getAddress();
-        const { actions: actions } = await orderbook.fulfillOrder(orderId, fulfillerAddress);
+        const { actions: actions } = await orderbook.fulfillOrder(orderId, fulfillerAddress, []);
         unsignedTransactions = await (0, $a7367d01c6e76b1c$export$b087719c36e0f2dc)(actions);
     } catch  {
     // Silently ignore error as this is usually thrown if user does not have enough balance
@@ -30903,14 +30894,13 @@ const $9085b221b72ac69e$export$e761f9e0703de895 = async (config, provider, order
         const createListingParams = {
             orderComponents: signedMessage.orderComponents,
             orderHash: signedMessage.orderHash,
-            orderSignature: signedMessage.signedMessage
+            orderSignature: signedMessage.signedMessage,
+            makerFees: []
         };
         if (makerFees !== undefined) {
             const orderBookFees = ($9051cee080948594$export$1e69c9cfc42e28d8)(makerFees, buyTokenOrNative.amount, decimals);
-            // @TODO add support for an array of fees when the orderbook enables it
             if (orderBookFees.length !== makerFees.length) throw new ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)("One of the fees is too small, must be greater than 0.000001", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).CREATE_ORDER_LISTING_ERROR);
-            const [makerFee] = orderBookFees;
-            createListingParams.makerFee = makerFee;
+            createListingParams.makerFees = orderBookFees;
         }
         try {
             const order = await orderbook.createListing(createListingParams);
@@ -31227,7 +31217,7 @@ var checkout_sdk = /*#__PURE__*/Object.freeze({
 function $parcel$export(e, n, v, s) {
   Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
 }
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.18.3";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.20.0";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/index.d.ts

@@ -13507,7 +13507,10 @@ type CreateListingRequestBody = {
      * Buy item for listing should either be NATIVE or ERC20 item
      */
     buy: Array<Item>;
-    fee?: Fee$1;
+    /**
+     * Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.
+     */
+    fees: Array<Fee$1>;
     /**
      * Time after which the Order is considered expired
      */
@@ -13533,7 +13536,7 @@ type CreateListingRequestBody = {
 
 type FulfillmentDataRequest = {
     order_id: string;
-    fee?: Fee$1;
+    fees: Array<Fee$1>;
 };
 
 /**
@@ -13843,7 +13846,7 @@ interface CreateListingParams {
     orderComponents: OrderComponents;
     orderHash: string;
     orderSignature: string;
-    makerFee?: FeeValue;
+    makerFees: FeeValue[];
 }
 type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
 type ListTradesParams = Omit<Parameters<typeof OrdersService.prototype.listTrades>[0], 'chainName'>;
@@ -14056,7 +14059,7 @@ declare class Orderbook {
      * @param {string} fulfillerAddress - The address of the account fulfilling the order.
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
-    fulfillOrder(listingId: string, takerAddress: string, takerFee?: FeeValue): Promise<FulfillOrderResponse>;
+    fulfillOrder(listingId: string, takerAddress: string, takerFees: FeeValue[]): Promise<FulfillOrderResponse>;
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
      * the account that created them.

package/dist/index.js

@@ -2703,7 +2703,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.18.3' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.20.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -2763,7 +2763,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.18.3',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.20.0',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -3049,7 +3049,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.18.3',
+    sdkVersion: 'ts-immutable-sdk-0.20.0',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -10739,7 +10739,7 @@ class ImmutableApiClient {
             ...listTradesParams,
         });
     }
-    async createListing({ orderHash, orderComponents, orderSignature, makerFee, }) {
+    async createListing({ orderHash, orderComponents, orderSignature, makerFees, }) {
         if (orderComponents.offer.length !== 1) {
             throw new Error('Only one item can be listed at a time');
         }
@@ -10768,11 +10768,11 @@ class ImmutableApiClient {
                         contract_address: orderComponents.consideration[0].token,
                     },
                 ],
-                fee: makerFee ? {
-                    amount: makerFee.amount,
+                fees: makerFees.map((x) => ({
+                    amount: x.amount,
                     fee_type: FeeType.MAKER_MARKETPLACE,
-                    recipient: makerFee.recipient,
-                } : undefined,
+                    recipient: x.recipient,
+                })),
                 end_time: new Date(parseInt(`${orderComponents.endTime.toString()}000`, 10)).toISOString(),
                 protocol_data: {
                     order_type: ProtocolData.order_type.FULL_RESTRICTED,
@@ -10962,15 +10962,8 @@ class Orderbook {
      * @return {ListingResult} The result of the order created in the Immutable services.
      */
     async createListing(createListingParams) {
-        const makerFee = createListingParams.makerFee
-            ? {
-                ...createListingParams.makerFee,
-                type: FeeType.MAKER_MARKETPLACE,
-            }
-            : undefined;
         const apiListingResponse = await this.apiClient.createListing({
             ...createListingParams,
-            makerFee,
         });
         return {
             result: mapFromOpenApiOrder(apiListingResponse.result),
@@ -10984,17 +10977,15 @@ class Orderbook {
      * @param {string} fulfillerAddress - The address of the account fulfilling the order.
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
-    async fulfillOrder(listingId, takerAddress, takerFee) {
+    async fulfillOrder(listingId, takerAddress, takerFees) {
         const fulfillmentDataRes = await this.apiClient.fulfillmentData([
             {
                 order_id: listingId,
-                fee: takerFee
-                    ? {
-                        amount: takerFee.amount,
-                        fee_type: FeeType.TAKER_MARKETPLACE,
-                        recipient: takerFee.recipient,
-                    }
-                    : undefined,
+                fees: takerFees.map((fee) => ({
+                    amount: fee.amount,
+                    fee_type: FeeType.TAKER_MARKETPLACE,
+                    recipient: fee.recipient,
+                })),
             },
         ]);
         if (fulfillmentDataRes.result.length !== 1) {
@@ -30630,7 +30621,7 @@ const $64863c39386de592$export$7f8e2b98eca5a7f0 = async (config, provider, order
     };
     try {
         const fulfillerAddress = await provider.getSigner().getAddress();
-        const { actions: actions } = await orderbook.fulfillOrder(orderId, fulfillerAddress);
+        const { actions: actions } = await orderbook.fulfillOrder(orderId, fulfillerAddress, []);
         unsignedTransactions = await (0, $a7367d01c6e76b1c$export$b087719c36e0f2dc)(actions);
     } catch  {
     // Silently ignore error as this is usually thrown if user does not have enough balance
@@ -30881,14 +30872,13 @@ const $9085b221b72ac69e$export$e761f9e0703de895 = async (config, provider, order
         const createListingParams = {
             orderComponents: signedMessage.orderComponents,
             orderHash: signedMessage.orderHash,
-            orderSignature: signedMessage.signedMessage
+            orderSignature: signedMessage.signedMessage,
+            makerFees: []
         };
         if (makerFees !== undefined) {
             const orderBookFees = ($9051cee080948594$export$1e69c9cfc42e28d8)(makerFees, buyTokenOrNative.amount, decimals);
-            // @TODO add support for an array of fees when the orderbook enables it
             if (orderBookFees.length !== makerFees.length) throw new ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)("One of the fees is too small, must be greater than 0.000001", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).CREATE_ORDER_LISTING_ERROR);
-            const [makerFee] = orderBookFees;
-            createListingParams.makerFee = makerFee;
+            createListingParams.makerFees = orderBookFees;
         }
         try {
             const order = await orderbook.createListing(createListingParams);
@@ -31205,7 +31195,7 @@ var checkout_sdk = /*#__PURE__*/Object.freeze({
 function $parcel$export(e, n, v, s) {
   Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
 }
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.18.3";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.20.0";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/orderbook.d.ts

@@ -811,7 +811,10 @@ type CreateListingRequestBody = {
      * Buy item for listing should either be NATIVE or ERC20 item
      */
     buy: Array<Item>;
-    fee?: Fee$1;
+    /**
+     * Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.
+     */
+    fees: Array<Fee$1>;
     /**
      * Time after which the Order is considered expired
      */
@@ -837,7 +840,7 @@ type CreateListingRequestBody = {
 
 type FulfillmentDataRequest = {
     order_id: string;
-    fee?: Fee$1;
+    fees: Array<Fee$1>;
 };
 
 /**
@@ -1147,7 +1150,7 @@ interface CreateListingParams {
     orderComponents: OrderComponents;
     orderHash: string;
     orderSignature: string;
-    makerFee?: FeeValue;
+    makerFees: FeeValue[];
 }
 type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
 type ListTradesParams = Omit<Parameters<typeof OrdersService.prototype.listTrades>[0], 'chainName'>;
@@ -1360,7 +1363,7 @@ declare class Orderbook {
      * @param {string} fulfillerAddress - The address of the account fulfilling the order.
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
-    fulfillOrder(listingId: string, takerAddress: string, takerFee?: FeeValue): Promise<FulfillOrderResponse>;
+    fulfillOrder(listingId: string, takerAddress: string, takerFees: FeeValue[]): Promise<FulfillOrderResponse>;
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
      * the account that created them.

package/dist/orderbook.js

@@ -1075,7 +1075,7 @@ class ImmutableApiClient {
             ...listTradesParams,
         });
     }
-    async createListing({ orderHash, orderComponents, orderSignature, makerFee, }) {
+    async createListing({ orderHash, orderComponents, orderSignature, makerFees, }) {
         if (orderComponents.offer.length !== 1) {
             throw new Error('Only one item can be listed at a time');
         }
@@ -1104,11 +1104,11 @@ class ImmutableApiClient {
                         contract_address: orderComponents.consideration[0].token,
                     },
                 ],
-                fee: makerFee ? {
-                    amount: makerFee.amount,
+                fees: makerFees.map((x) => ({
+                    amount: x.amount,
                     fee_type: FeeType.MAKER_MARKETPLACE,
-                    recipient: makerFee.recipient,
-                } : undefined,
+                    recipient: x.recipient,
+                })),
                 end_time: new Date(parseInt(`${orderComponents.endTime.toString()}000`, 10)).toISOString(),
                 protocol_data: {
                     order_type: ProtocolData.order_type.FULL_RESTRICTED,
@@ -1298,15 +1298,8 @@ class Orderbook {
      * @return {ListingResult} The result of the order created in the Immutable services.
      */
     async createListing(createListingParams) {
-        const makerFee = createListingParams.makerFee
-            ? {
-                ...createListingParams.makerFee,
-                type: FeeType.MAKER_MARKETPLACE,
-            }
-            : undefined;
         const apiListingResponse = await this.apiClient.createListing({
             ...createListingParams,
-            makerFee,
         });
         return {
             result: mapFromOpenApiOrder(apiListingResponse.result),
@@ -1320,17 +1313,15 @@ class Orderbook {
      * @param {string} fulfillerAddress - The address of the account fulfilling the order.
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
-    async fulfillOrder(listingId, takerAddress, takerFee) {
+    async fulfillOrder(listingId, takerAddress, takerFees) {
         const fulfillmentDataRes = await this.apiClient.fulfillmentData([
             {
                 order_id: listingId,
-                fee: takerFee
-                    ? {
-                        amount: takerFee.amount,
-                        fee_type: FeeType.TAKER_MARKETPLACE,
-                        recipient: takerFee.recipient,
-                    }
-                    : undefined,
+                fees: takerFees.map((fee) => ({
+                    amount: fee.amount,
+                    fee_type: FeeType.TAKER_MARKETPLACE,
+                    recipient: fee.recipient,
+                })),
             },
         ]);
         if (fulfillmentDataRes.result.length !== 1) {

package/dist/passport.js

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

package/package.json

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