@imtbl/sdk 0.8.0-alpha → 0.11.0-alpha

package/dist/orderbook.d.ts

@@ -1,4 +1,4 @@
-import { OrderbookOverrides } from 'config/config';
+import { OrderbookOverrides, OrderbookModuleConfiguration } from 'config/config';
 import { ListingResult, ListListingsResult, OrdersService } from 'openapi/sdk';
 import { ListListingsParams as ListListingsParams$1, PrepareListingParams as PrepareListingParams$1, PrepareListingResponse as PrepareListingResponse$1, CreateListingParams as CreateListingParams$1, FulfillOrderResponse as FulfillOrderResponse$1, CancelOrderResponse as CancelOrderResponse$1 } from 'types';
 
@@ -29,6 +29,11 @@ declare class Orderbook {
     private seaport;
     private orderbookConfig;
     constructor(config: ModuleConfiguration<OrderbookOverrides>);
+    /**
+     * Return the configuration for the orderbook module.
+     * @return {OrderbookModuleConfiguration} The configuration for the orderbook module.
+     */
+    config(): OrderbookModuleConfiguration;
     /**
      * Get an order by ID
      * @param {string} listingId - The listingId to find.
@@ -76,6 +81,10 @@ declare class Orderbook {
     cancelOrder(listingId: string, accountAddress: string): Promise<CancelOrderResponse$1>;
 }
 
+declare const constants: {
+    estimatedFulfillmentGasGwei: number;
+};
+
 declare type Bytes = ArrayLike<number>;
 declare type BytesLike = Bytes | string;
 interface Hexable {
@@ -268,4 +277,4 @@ interface CancelOrderResponse {
     unsignedCancelOrderTransaction: PopulatedTransaction;
 }
 
-export { Action, ActionType, CancelOrderResponse, CreateListingParams, ERC20Item, ERC721Item, FulfillOrderResponse, ListListingsParams, NativeItem, Orderbook, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, SignableAction, SignablePurpose, TransactionAction, TransactionBuilder, TransactionPurpose };
+export { Action, ActionType, CancelOrderResponse, CreateListingParams, ERC20Item, ERC721Item, FulfillOrderResponse, ListListingsParams, NativeItem, Orderbook, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, SignableAction, SignablePurpose, TransactionAction, TransactionBuilder, TransactionPurpose, constants };

package/dist/orderbook.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import FormData from 'form-data';
-import { providers, BigNumber, constants, utils, Contract } from 'ethers';
+import { providers, BigNumber, constants as constants$1, utils, Contract } from 'ethers';
 import { Seaport as Seaport$1 } from '@opensea/seaport-js';
 
 var Environment;
@@ -471,6 +471,28 @@ class OrdersService {
             },
         });
     }
+    /**
+     * Retrieve fulfillment data for orders
+     * Retrieve signed fulfillment data based on the list of order IDs and corresponding fees.
+     * @returns any Successful response
+     * @throws ApiError
+     */
+    fulfillmentData({ chainName, requestBody, }) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/v1/chains/{chain_name}/orders/fulfillment-data',
+            path: {
+                'chain_name': chainName,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Bad Request (400)`,
+                404: `The specified resource was not found (404)`,
+                500: `Internal Server Error (500)`,
+            },
+        });
+    }
 }
 
 class OrderBookClient {
@@ -478,7 +500,7 @@ class OrderBookClient {
     request;
     constructor(config, HttpRequest = AxiosHttpRequest) {
         this.request = new HttpRequest({
-            BASE: config?.BASE ?? 'https://api.dev.immutable.com',
+            BASE: config?.BASE ?? 'https://api.sandbox.immutable.com',
             VERSION: config?.VERSION ?? '1.0.0',
             WITH_CREDENTIALS: config?.WITH_CREDENTIALS ?? false,
             CREDENTIALS: config?.CREDENTIALS ?? 'include',
@@ -547,7 +569,7 @@ var ActionType;
 // TODO: Resolve these from seaport-js.
 // There is some bundling issue that is preventing this from working
 const SEAPORT_CONTRACT_NAME = 'ImmutableSeaport';
-const SEAPORT_CONTRACT_VERSION_V1_4 = '1.4';
+// export const SEAPORT_CONTRACT_VERSION_V1_4 = '1.4';
 const SEAPORT_CONTRACT_VERSION_V1_5 = '1.5';
 const EIP_712_ORDER_TYPE = {
     OrderComponents: [
@@ -638,7 +660,7 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
                     endAmount: buyItem.start_amount,
                     itemType: ItemType.NATIVE,
                     recipient: order.account_address,
-                    token: constants.AddressZero,
+                    token: constants$1.AddressZero,
                     identifierOrCriteria: '0',
                 };
             case 'ERC20':
@@ -647,7 +669,7 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
                     endAmount: buyItem.start_amount,
                     itemType: ItemType.ERC20,
                     recipient: order.account_address,
-                    token: buyItem.contract_address || constants.AddressZero,
+                    token: buyItem.contract_address || constants$1.AddressZero,
                     identifierOrCriteria: '0',
                 };
             default: // ERC721
@@ -656,7 +678,7 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
                     endAmount: '1',
                     itemType: ItemType.ERC721,
                     recipient: order.account_address,
-                    token: buyItem.contract_address || constants.AddressZero,
+                    token: buyItem.contract_address || constants$1.AddressZero,
                     identifierOrCriteria: '0',
                 };
         }
@@ -668,11 +690,11 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
         recipient: fee.recipient,
         token: order.buy[0].item_type === 'ERC20'
             ? order.buy[0].contract_address
-            : constants.AddressZero,
+            : constants$1.AddressZero,
         identifierOrCriteria: '0',
     }));
     return {
-        conduitKey: constants.HashZero,
+        conduitKey: constants$1.HashZero,
         consideration: [...considerationItems, ...fees],
         offer: order.sell.map((sellItem) => {
             const erc721Item = sellItem;
@@ -692,7 +714,7 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
         zone: zoneAddress,
         totalOriginalConsiderationItems: 2,
         orderType: OrderType.FULL_RESTRICTED,
-        zoneHash: constants.HashZero,
+        zoneHash: constants$1.HashZero,
     };
 }
 
@@ -737,7 +759,7 @@ class Seaport {
             orderHash: this.getSeaportLib().getOrderHash(orderComponents),
         };
     }
-    async fulfillOrder(order, account) {
+    async fulfillOrder(order, account, extraData) {
         const orderComponents = await this.mapImmutableOrderToSeaportOrderComponents(order);
         const seaportLib = this.getSeaportLib(order);
         const { actions: seaportActions } = await seaportLib.fulfillOrders({
@@ -747,7 +769,7 @@ class Seaport {
                         parameters: orderComponents,
                         signature: order.signature,
                     },
-                    extraData: order.protocol_data.operator_signature,
+                    extraData,
                 }],
         });
         const fulfillmentActions = [];
@@ -815,7 +837,7 @@ class Seaport {
         const { chainId } = await this.provider.getNetwork();
         const domainData = {
             name: SEAPORT_CONTRACT_NAME,
-            version: SEAPORT_CONTRACT_VERSION_V1_4,
+            version: SEAPORT_CONTRACT_VERSION_V1_5,
             chainId,
             verifyingContract: this.seaportContractAddress,
         };
@@ -827,10 +849,10 @@ class Seaport {
     }
     getSeaportLib(order) {
         const seaportAddress = order?.protocol_data?.seaport_address ?? this.seaportContractAddress;
-        let seaportVersion = SEAPORT_CONTRACT_VERSION_V1_4;
-        if (order?.protocol_data?.seaport_version === SEAPORT_CONTRACT_VERSION_V1_5) {
-            seaportVersion = SEAPORT_CONTRACT_VERSION_V1_5;
-        }
+        const seaportVersion = SEAPORT_CONTRACT_VERSION_V1_5;
+        // if (order?.protocol_data?.seaport_version === SEAPORT_CONTRACT_VERSION_V1_5) {
+        //   seaportVersion = SEAPORT_CONTRACT_VERSION_V1_5;
+        // }
         return this.seaportLibFactory.create(seaportVersion, seaportAddress);
     }
 }
@@ -844,6 +866,12 @@ class ImmutableApiClient {
         this.chainName = chainName;
         this.seaportAddress = seaportAddress;
     }
+    async fulfillmentData(requests) {
+        return this.orderbookService.fulfillmentData({
+            chainName: this.chainName,
+            requestBody: requests,
+        });
+    }
     async getListing(listingId) {
         return this.orderbookService.getListing({
             chainName: this.chainName,
@@ -899,7 +927,7 @@ class ImmutableApiClient {
                     order_type: CreateOrderProtocolData.order_type.FULL_RESTRICTED,
                     zone_address: orderComponents.zone,
                     seaport_address: this.seaportAddress,
-                    seaport_version: SEAPORT_CONTRACT_VERSION_V1_4,
+                    seaport_version: SEAPORT_CONTRACT_VERSION_V1_5,
                     counter: orderComponents.counter.toString(),
                 },
                 salt: orderComponents.salt,
@@ -940,9 +968,9 @@ function getOrderbookConfig(environment) {
     switch (environment) {
         case Environment.SANDBOX:
             return {
-                seaportContractAddress: '0x410000346E270aDbC89b2b688177d3AE76348dE9',
-                zoneContractAddress: '0x979C2aCA989A56554Eb63E01e576E3179Cdad5A0',
-                apiEndpoint: 'https://order-book-mr.sandbox.imtbl.com',
+                seaportContractAddress: '0x7Fb7Da6De152597830eD16361633e362A2F59410',
+                zoneContractAddress: '0x63441cBfBd15Dd8f5E92598E535661Ac5aCB808E',
+                apiEndpoint: 'https://api.sandbox.immutable.com',
                 chainName: TESTNET_CHAIN_NAME,
                 provider: new providers.JsonRpcProvider('https://rpc.testnet.immutable.com'),
             };
@@ -1890,7 +1918,7 @@ class SeaportLibFactory {
         this.provider = provider;
     }
     create(orderSeaportVersion, orderSeaportAddress) {
-        const seaportVersion = orderSeaportVersion ?? SEAPORT_CONTRACT_VERSION_V1_4;
+        const seaportVersion = orderSeaportVersion ?? SEAPORT_CONTRACT_VERSION_V1_5;
         const seaportContractAddress = orderSeaportAddress ?? this.defaultSeaportContractAddress;
         return new Seaport$1(this.provider, {
             seaportVersion,
@@ -1929,6 +1957,13 @@ class Orderbook {
         const seaportLibFactory = new SeaportLibFactory(this.orderbookConfig.seaportContractAddress, this.orderbookConfig.provider);
         this.seaport = new Seaport(seaportLibFactory, this.orderbookConfig.provider, this.orderbookConfig.seaportContractAddress, this.orderbookConfig.zoneContractAddress);
     }
+    /**
+     * Return the configuration for the orderbook module.
+     * @return {OrderbookModuleConfiguration} The configuration for the orderbook module.
+     */
+    config() {
+        return this.orderbookConfig;
+    }
     /**
      * Get an order by ID
      * @param {string} listingId - The listingId to find.
@@ -1980,11 +2015,20 @@ class Orderbook {
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
     async fulfillOrder(listingId, takerAddress) {
-        const orderResult = await this.apiClient.getListing(listingId);
-        if (orderResult.result.status !== OrderStatus.ACTIVE) {
-            throw new Error(`Cannot fulfil order that is not active. Current status: ${orderResult.result.status}`);
+        const fulfillmentDataRes = await this.apiClient.fulfillmentData([{
+                order_id: listingId,
+                // fee: takerFee,
+                fee: undefined,
+            }]);
+        if (fulfillmentDataRes.result.length !== 1) {
+            throw new Error('unexpected fulfillment data result length');
         }
-        return this.seaport.fulfillOrder(orderResult.result, takerAddress);
+        const extraData = fulfillmentDataRes.result[0].extra_data;
+        const orderResult = fulfillmentDataRes.result[0].order;
+        if (orderResult.status !== OrderStatus.ACTIVE) {
+            throw new Error(`Cannot fulfil order that is not active. Current status: ${orderResult.status}`);
+        }
+        return this.seaport.fulfillOrder(orderResult, takerAddress, extraData);
     }
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
@@ -2008,4 +2052,12 @@ class Orderbook {
     }
 }
 
-export { ActionType, Orderbook, SignablePurpose, TransactionPurpose };
+// Consumers might want an estimated gas limit for fulfilling an order
+// without calling the transaction builder. This is an estimate that
+// should work for all fulfillment scenarios.
+const ESTIMATED_FULFILLMENT_GAS_GWEI = 400000;
+const constants = {
+    estimatedFulfillmentGasGwei: ESTIMATED_FULFILLMENT_GAS_GWEI,
+};
+
+export { ActionType, Orderbook, SignablePurpose, TransactionPurpose, constants };

package/dist/passport.js

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

package/package.json

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