@imtbl/sdk 0.20.1 → 0.22.0-alpha.1

package/dist/orderbook.d.ts

@@ -724,8 +724,8 @@ declare namespace Fee$1 {
      */
     enum fee_type {
         ROYALTY = "ROYALTY",
-        MAKER_MARKETPLACE = "MAKER_MARKETPLACE",
-        TAKER_MARKETPLACE = "TAKER_MARKETPLACE",
+        MAKER_ECOSYSTEM = "MAKER_ECOSYSTEM",
+        TAKER_ECOSYSTEM = "TAKER_ECOSYSTEM",
         PROTOCOL = "PROTOCOL"
     }
 }
@@ -818,7 +818,7 @@ type CreateListingRequestBody = {
     /**
      * Time after which the Order is considered expired
      */
-    end_time: string;
+    end_at: string;
     protocol_data: ProtocolData;
     /**
      * A random value added to the create Order request
@@ -835,12 +835,7 @@ type CreateListingRequestBody = {
     /**
      * Time after which Order is considered active
      */
-    start_time: string;
-};
-
-type FulfillmentDataRequest = {
-    order_id: string;
-    fees: Array<Fee$1>;
+    start_at: string;
 };
 
 /**
@@ -877,11 +872,11 @@ type Order$1 = {
     /**
      * Time the Order is created
      */
-    create_time: string;
+    created_at: string;
     /**
      * Time after which the Order is considered expired
      */
-    end_time: string;
+    end_at: string;
     /**
      * Global Order identifier
      */
@@ -899,19 +894,24 @@ type Order$1 = {
     /**
      * Time after which Order is considered active
      */
-    start_time: string;
+    start_at: string;
     status: OrderStatus;
     /**
      * Time the Order is last updated
      */
-    update_time: string;
+    updated_at: string;
 };
 
-type FulfillmentDataResult = {
+type FulfillableOrder = {
     extra_data: string;
     order: Order$1;
 };
 
+type FulfillmentDataRequest = {
+    order_id: string;
+    fees: Array<Fee$1>;
+};
+
 type ListingResult$1 = {
     result: Order$1;
 };
@@ -997,6 +997,17 @@ type TradeResult$1 = {
     result: Trade$1;
 };
 
+type UnfulfillableOrder = {
+    /**
+     * OrderID for the requested but unfulfillable order
+     */
+    order_id: string;
+    /**
+     * Nullable string containing error reason if the signing is unsuccessful for the order
+     */
+    reason: string;
+};
+
 declare class OrdersService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
@@ -1074,7 +1085,10 @@ declare class OrdersService {
         chainName: ChainName;
         requestBody: Array<FulfillmentDataRequest>;
     }): CancelablePromise<{
-        result: Array<FulfillmentDataResult>;
+        result: {
+            fulfillable_orders: Array<FulfillableOrder>;
+            unfulfillable_orders: Array<UnfulfillableOrder>;
+        };
     }>;
     /**
      * List all trades
@@ -1092,7 +1106,7 @@ declare class OrdersService {
         /**
          * Trade field to sort by
          */
-        sortBy?: 'created_at';
+        sortBy?: 'indexed_at';
         /**
          * Ascending or descending direction for sort
          */
@@ -1155,8 +1169,8 @@ interface CreateListingParams {
 type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
 type ListTradesParams = Omit<Parameters<typeof OrdersService.prototype.listTrades>[0], 'chainName'>;
 declare enum FeeType {
-    MAKER_MARKETPLACE = "MAKER_MARKETPLACE",
-    TAKER_MARKETPLACE = "TAKER_MARKETPLACE",
+    MAKER_ECOSYSTEM = "MAKER_ECOSYSTEM",
+    TAKER_ECOSYSTEM = "TAKER_ECOSYSTEM",
     PROTOCOL = "PROTOCOL",
     ROYALTY = "ROYALTY"
 }
@@ -1216,16 +1230,16 @@ interface Order {
         id: string;
         name: string;
     };
-    createTime: string;
-    updateTime: string;
+    createdAt: string;
+    updatedAt: string;
     /**
      * Time after which the Order is considered active
      */
-    startTime: string;
+    startAt: string;
     /**
      * Time after which the Order is expired
      */
-    endTime: string;
+    endAt: string;
     protocolData: {
         orderType: 'FULL_RESTRICTED';
         zoneAddress: string;

package/dist/orderbook.js

@@ -569,8 +569,8 @@ var Fee;
 (function (Fee) {
     (function (fee_type) {
         fee_type["ROYALTY"] = "ROYALTY";
-        fee_type["MAKER_MARKETPLACE"] = "MAKER_MARKETPLACE";
-        fee_type["TAKER_MARKETPLACE"] = "TAKER_MARKETPLACE";
+        fee_type["MAKER_ECOSYSTEM"] = "MAKER_ECOSYSTEM";
+        fee_type["TAKER_ECOSYSTEM"] = "TAKER_ECOSYSTEM";
         fee_type["PROTOCOL"] = "PROTOCOL";
     })(Fee.fee_type || (Fee.fee_type = {}));
 })(Fee || (Fee = {}));
@@ -603,8 +603,8 @@ var ProtocolData;
 
 var FeeType;
 (function (FeeType) {
-    FeeType["MAKER_MARKETPLACE"] = "MAKER_MARKETPLACE";
-    FeeType["TAKER_MARKETPLACE"] = "TAKER_MARKETPLACE";
+    FeeType["MAKER_ECOSYSTEM"] = "MAKER_ECOSYSTEM";
+    FeeType["TAKER_ECOSYSTEM"] = "TAKER_ECOSYSTEM";
     FeeType["PROTOCOL"] = "PROTOCOL";
     FeeType["ROYALTY"] = "ROYALTY";
 })(FeeType || (FeeType = {}));
@@ -661,8 +661,8 @@ function mapFromOpenApiOrder(order) {
             type: fee.fee_type,
         })),
         chain: order.chain,
-        createTime: order.create_time,
-        endTime: order.end_time,
+        createdAt: order.created_at,
+        endAt: order.end_at,
         protocolData: {
             counter: order.protocol_data.counter,
             orderType: order.protocol_data.order_type,
@@ -672,9 +672,9 @@ function mapFromOpenApiOrder(order) {
         },
         salt: order.salt,
         signature: order.signature,
-        startTime: order.start_time,
+        startAt: order.start_at,
         status: order.status,
-        updateTime: order.update_time,
+        updatedAt: order.updated_at,
     };
 }
 function mapFromOpenApiTrade(trade) {
@@ -877,8 +877,8 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
                 };
             }),
             counter,
-            endTime: Math.round(new Date(order.end_time).getTime() / 1000).toString(),
-            startTime: Math.round(new Date(order.start_time).getTime() / 1000).toString(),
+            endTime: Math.round(new Date(order.end_at).getTime() / 1000).toString(),
+            startTime: Math.round(new Date(order.start_at).getTime() / 1000).toString(),
             salt: order.salt,
             offerer: order.account_address,
             zone: zoneAddress,
@@ -1106,10 +1106,10 @@ class ImmutableApiClient {
                 ],
                 fees: makerFees.map((x) => ({
                     amount: x.amount,
-                    fee_type: FeeType.MAKER_MARKETPLACE,
+                    fee_type: FeeType.MAKER_ECOSYSTEM,
                     recipient: x.recipient,
                 })),
-                end_time: new Date(parseInt(`${orderComponents.endTime.toString()}000`, 10)).toISOString(),
+                end_at: new Date(parseInt(`${orderComponents.endTime.toString()}000`, 10)).toISOString(),
                 protocol_data: {
                     order_type: ProtocolData.order_type.FULL_RESTRICTED,
                     zone_address: orderComponents.zone,
@@ -1126,7 +1126,7 @@ class ImmutableApiClient {
                     },
                 ],
                 signature: orderSignature,
-                start_time: new Date(parseInt(`${orderComponents.startTime.toString()}000`, 10)).toISOString(),
+                start_at: new Date(parseInt(`${orderComponents.startTime.toString()}000`, 10)).toISOString(),
             },
         });
     }
@@ -1319,16 +1319,19 @@ class Orderbook {
                 order_id: listingId,
                 fees: takerFees.map((fee) => ({
                     amount: fee.amount,
-                    fee_type: FeeType.TAKER_MARKETPLACE,
+                    fee_type: FeeType.TAKER_ECOSYSTEM,
                     recipient: fee.recipient,
                 })),
             },
         ]);
-        if (fulfillmentDataRes.result.length !== 1) {
-            throw new Error('unexpected fulfillment data result length');
+        if (fulfillmentDataRes.result.unfulfillable_orders?.length > 0) {
+            throw new Error(`Unable to prepare fulfillment date: ${fulfillmentDataRes.result.unfulfillable_orders[0].reason}`);
         }
-        const extraData = fulfillmentDataRes.result[0].extra_data;
-        const orderResult = fulfillmentDataRes.result[0].order;
+        else if (fulfillmentDataRes.result.fulfillable_orders?.length !== 1) {
+            throw new Error('unexpected fulfillable order result length');
+        }
+        const extraData = fulfillmentDataRes.result.fulfillable_orders[0].extra_data;
+        const orderResult = fulfillmentDataRes.result.fulfillable_orders[0].order;
         if (orderResult.status !== OrderStatus.ACTIVE) {
             throw new Error(`Cannot fulfil order that is not active. Current status: ${orderResult.status}`);
         }

package/dist/passport.js

@@ -178,6 +178,18 @@ const assertParamExists$1 = function (functionName, paramName, paramValue) {
         throw new RequiredError$1(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
     }
 };
+/**
+ *
+ * @export
+ */
+const setApiKeyToObject = async function (object, keyParamName, configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+};
 /**
  *
  * @export
@@ -668,6 +680,46 @@ const CollectionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Refresh collection metadata
+         * @summary Refresh collection metadata
+         * @param {string} contractAddress The address contract
+         * @param {string} chainName The name of chain
+         * @param {RefreshCollectionMetadataRequest} refreshCollectionMetadataRequest The request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        refreshCollectionMetadata: async (contractAddress, chainName, refreshCollectionMetadataRequest, options = {}) => {
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists$1('refreshCollectionMetadata', 'contractAddress', contractAddress);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists$1('refreshCollectionMetadata', 'chainName', chainName);
+            // verify required parameter 'refreshCollectionMetadataRequest' is not null or undefined
+            assertParamExists$1('refreshCollectionMetadata', 'refreshCollectionMetadataRequest', refreshCollectionMetadataRequest);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/refresh-metadata`
+                .replace(`{${"contract_address"}}`, encodeURIComponent(String(contractAddress)))
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$1);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ImmutableApiKey required
+            await setApiKeyToObject(localVarHeaderParameter, "X-Immutable-API-Key", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams$1(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            localVarRequestOptions.data = serializeDataIfNeeded$1(refreshCollectionMetadataRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString$1(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
     };
 };
 /**
@@ -716,6 +768,19 @@ const CollectionsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listCollectionsByNFTOwner(accountAddress, chainName, pageCursor, pageSize, options);
             return createRequestFunction$1(localVarAxiosArgs, globalAxios$1, BASE_PATH$1, configuration);
         },
+        /**
+         * Refresh collection metadata
+         * @summary Refresh collection metadata
+         * @param {string} contractAddress The address contract
+         * @param {string} chainName The name of chain
+         * @param {RefreshCollectionMetadataRequest} refreshCollectionMetadataRequest The request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async refreshCollectionMetadata(contractAddress, chainName, refreshCollectionMetadataRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.refreshCollectionMetadata(contractAddress, chainName, refreshCollectionMetadataRequest, options);
+            return createRequestFunction$1(localVarAxiosArgs, globalAxios$1, BASE_PATH$1, configuration);
+        },
     };
 };
 /**
@@ -758,6 +823,17 @@ class CollectionsApi extends BaseAPI$1 {
     listCollectionsByNFTOwner(requestParameters, options) {
         return CollectionsApiFp(this.configuration).listCollectionsByNFTOwner(requestParameters.accountAddress, requestParameters.chainName, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Refresh collection metadata
+     * @summary Refresh collection metadata
+     * @param {CollectionsApiRefreshCollectionMetadataRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    refreshCollectionMetadata(requestParameters, options) {
+        return CollectionsApiFp(this.configuration).refreshCollectionMetadata(requestParameters.contractAddress, requestParameters.chainName, requestParameters.refreshCollectionMetadataRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 /* tslint:disable */
@@ -1327,7 +1403,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
          * @param {string} chainName
          * @param {string} [accountAddress]
          * @param {number} [pageSize] Maximum number of trades to return per page
-         * @param {'created_at'} [sortBy] Trade field to sort by
+         * @param {'indexed_at'} [sortBy] Trade field to sort by
          * @param {'asc' | 'desc'} [sortDirection] Ascending or descending direction for sort
          * @param {string} [pageCursor] Page cursor to retrieve previous or next page. Use the value returned in the response.
          * @param {*} [options] Override http request option.
@@ -1452,7 +1528,7 @@ const OrdersApiFp = function (configuration) {
          * @param {string} chainName
          * @param {string} [accountAddress]
          * @param {number} [pageSize] Maximum number of trades to return per page
-         * @param {'created_at'} [sortBy] Trade field to sort by
+         * @param {'indexed_at'} [sortBy] Trade field to sort by
          * @param {'asc' | 'desc'} [sortDirection] Ascending or descending direction for sort
          * @param {string} [pageCursor] Page cursor to retrieve previous or next page. Use the value returned in the response.
          * @param {*} [options] Override http request option.
@@ -1709,7 +1785,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.20.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.22.0-alpha.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -1765,7 +1841,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.20.1',
+    sdkVersion: 'ts-immutable-sdk-0.22.0-alpha.1',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -7506,6 +7582,7 @@ var ReceiveMessage;
     ReceiveMessage["TRANSACTION_ERROR"] = "transaction_error";
     ReceiveMessage["MESSAGE_CONFIRMED"] = "message_confirmed";
     ReceiveMessage["MESSAGE_REJECTED"] = "message_rejected";
+    ReceiveMessage["LOGOUT_SUCCESS"] = "logout_success";
 })(ReceiveMessage || (ReceiveMessage = {}));
 const PASSPORT_EVENT_TYPE = 'imx_passport_confirmation';
 
@@ -7530,6 +7607,8 @@ const CONFIRMATION_WINDOW_TITLE = 'Confirm this transaction';
 const CONFIRMATION_WINDOW_HEIGHT = 380;
 const CONFIRMATION_WINDOW_WIDTH = 480;
 const CONFIRMATION_WINDOW_CLOSED_POLLING_DURATION = 1000;
+const CONFIRMATION_IFRAME_ID = 'passport-confirm';
+const CONFIRMATION_IFRAME_STYLE = 'display: none; position: absolute;width:0px;height:0px;border:0;';
 class ConfirmationScreen {
     config;
     confirmationWindow;
@@ -7623,6 +7702,28 @@ class ConfirmationScreen {
     closeWindow() {
         this.confirmationWindow?.close();
     }
+    logout() {
+        return new Promise((resolve, rejects) => {
+            const iframe = document.createElement('iframe');
+            iframe.setAttribute('id', CONFIRMATION_IFRAME_ID);
+            iframe.setAttribute('src', `${this.config.passportDomain}/transaction-confirmation/logout`);
+            iframe.setAttribute('style', CONFIRMATION_IFRAME_STYLE);
+            const logoutHandler = ({ data, origin }) => {
+                if (origin !== this.config.passportDomain
+                    || data.eventType !== PASSPORT_EVENT_TYPE) {
+                    return;
+                }
+                window.removeEventListener('message', logoutHandler);
+                iframe.remove();
+                if (data.messageType === ReceiveMessage.LOGOUT_SUCCESS) {
+                    resolve({ logout: true });
+                }
+                rejects(new Error('Unsupported logout type'));
+            };
+            window.addEventListener('message', logoutHandler);
+            document.body.appendChild(iframe);
+        });
+    }
     showConfirmationScreen(href, messageHandler, resolve) {
         this.confirmationWindow.location.href = href;
         // https://stackoverflow.com/questions/9388380/capture-the-close-event-of-popup-window-in-javascript/48240128#48240128
@@ -7968,7 +8069,11 @@ const sendTransaction = ({ params, magicProvider, jsonRpcProvider, relayerClient
         RelayerTransactionStatus.SUBMITTED,
         RelayerTransactionStatus.SUCCESSFUL,
     ].includes(relayerTransaction.status)) {
-        throw new JsonRpcError(RpcErrorCode.RPC_SERVER_ERROR, `Transaction failed to submit with status ${relayerTransaction.status}`);
+        let errorMessage = `Transaction failed to submit with status ${relayerTransaction.status}.`;
+        if (relayerTransaction.statusMessage) {
+            errorMessage += ` Error message: ${relayerTransaction.statusMessage}`;
+        }
+        throw new JsonRpcError(RpcErrorCode.RPC_SERVER_ERROR, errorMessage);
     }
     return relayerTransaction.hash;
 });
@@ -8318,6 +8423,7 @@ class Passport {
     }
     async logout() {
         await this.authManager.logout();
+        await this.confirmationScreen.logout();
         // Code after this point is only executed if the logout mode is silent
         await this.magicAdapter.logout();
         this.passportEventEmitter.emit(PassportEvents.LOGGED_OUT);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.20.1",
+  "version": "0.22.0-alpha.1",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
@@ -10,8 +10,6 @@
     "@0xsequence/config": "^0.43.34",
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/abstract-signer": "^5.7.0",
-    "@ethersproject/bignumber": "^5.7.0",
-    "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.7.2",
     "@ethersproject/wallet": "^5.7.0",
     "@imtbl/core-sdk": "^2.0.2",
@@ -27,8 +25,7 @@
     "enc-utils": "^3.0.0",
     "ethers": "^5.7.2",
     "magic-sdk": "^13.3.1",
-    "oidc-client-ts": "^2.2.1",
-    "typechain": "^8.1.1"
+    "oidc-client-ts": "^2.2.1"
   },
   "devDependencies": {
     "@imtbl/blockchain-data": "0.0.0",
@@ -36,9 +33,6 @@
     "@imtbl/checkout-widgets": "0.0.0",
     "@imtbl/config": "0.0.0",
     "@imtbl/cryptofiat": "0.0.0",
-    "@imtbl/erc20": "0.0.0",
-    "@imtbl/erc721": "0.0.0",
-    "@imtbl/erc721-mint-by-id": "0.0.0",
     "@imtbl/generated-clients": "0.0.0",
     "@imtbl/guardian": "0.0.0",
     "@imtbl/immutablex-client": "0.0.0",
@@ -103,18 +97,6 @@
     "./checkout_widgets": {
       "types": "./dist/checkout_widgets.d.ts",
       "import": "./dist/checkout_widgets.js"
-    },
-    "./erc20": {
-      "types": "./dist/erc20.d.ts",
-      "import": "./dist/erc20.js"
-    },
-    "./erc721": {
-      "types": "./dist/erc721.d.ts",
-      "import": "./dist/erc721.js"
-    },
-    "./erc721_mint_by_id": {
-      "types": "./dist/erc721_mint_by_id.d.ts",
-      "import": "./dist/erc721_mint_by_id.js"
     }
   },
   "files": [