@imtbl/sdk 0.14.0-alpha → 0.14.0-alpha.2

package/dist/orderbook.d.ts

@@ -866,7 +866,7 @@ declare enum OrderStatus {
     EXPIRED = "EXPIRED"
 }
 
-type Order = {
+type Order$1 = {
     account_address: string;
     buy: Array<Item>;
     fees: Array<Fee$1>;
@@ -906,17 +906,17 @@ type Order = {
 
 type FulfillmentDataResult = {
     extra_data: string;
-    order: Order;
+    order: Order$1;
 };
 
-type ListingResult = {
-    result: Order;
+type ListingResult$1 = {
+    result: Order$1;
 };
 
 /**
  * Pagination properties
  */
-type Page = {
+type Page$1 = {
     /**
      * First item as an encoded string
      */
@@ -927,9 +927,9 @@ type Page = {
     next_cursor: string | null;
 };
 
-type ListListingsResult = {
-    page: Page;
-    result: Array<Order>;
+type ListListingsResult$1 = {
+    page: Page$1;
+    result: Array<Order$1>;
 };
 
 /**
@@ -985,7 +985,7 @@ declare class OrdersService {
          * Page cursor to retrieve previous or next page. Use the value returned in the response.
          */
         pageCursor?: PageCursor;
-    }): CancelablePromise<ListListingsResult>;
+    }): CancelablePromise<ListListingsResult$1>;
     /**
      * Create a listing
      * Create a listing
@@ -995,7 +995,7 @@ declare class OrdersService {
     createListing({ chainName, requestBody, }: {
         chainName: ChainName;
         requestBody: CreateListingRequestBody;
-    }): CancelablePromise<ListingResult>;
+    }): CancelablePromise<ListingResult$1>;
     /**
      * Get a single listing by ID
      * Get a single listing by ID
@@ -1008,7 +1008,7 @@ declare class OrdersService {
          * Global Order identifier
          */
         listingId: string;
-    }): CancelablePromise<ListingResult>;
+    }): CancelablePromise<ListingResult$1>;
     /**
      * Retrieve fulfillment data for orders
      * Retrieve signed fulfillment data based on the list of order IDs and corresponding fees.
@@ -1056,7 +1056,7 @@ interface CreateListingParams {
     orderComponents: OrderComponents;
     orderHash: string;
     orderSignature: string;
-    makerFee?: Fee;
+    makerFee?: FeeValue;
 }
 type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
 declare enum FeeType {
@@ -1065,11 +1065,13 @@ declare enum FeeType {
     PROTOCOL = "PROTOCOL",
     ROYALTY = "ROYALTY"
 }
-interface Fee {
-    type: FeeType;
+interface FeeValue {
     recipient: string;
     amount: string;
 }
+interface Fee extends FeeValue {
+    type: FeeType;
+}
 declare enum TransactionPurpose {
     APPROVAL = "APPROVAL",
     FULFILL_ORDER = "FULFILL_ORDER"
@@ -1099,10 +1101,64 @@ interface SignableAction {
 type Action = TransactionAction | SignableAction;
 interface FulfillOrderResponse {
     actions: Action[];
+    /**
+     * User MUST submit the fulfillment transaction before the expiration
+     * Submitting after the expiration will result in a on chain revert
+     */
+    expiration: string;
+    order: Order;
 }
 interface CancelOrderResponse {
     unsignedCancelOrderTransaction: PopulatedTransaction;
 }
+interface Order {
+    id: string;
+    accountAddress: string;
+    buy: (ERC20Item | NativeItem)[];
+    sell: ERC721Item[];
+    fees: Fee[];
+    chain: {
+        id: string;
+        name: string;
+    };
+    createTime: string;
+    updateTime: string;
+    /**
+     * Time after which the Order is considered active
+     */
+    startTime: string;
+    /**
+     * Time after which the Order is expired
+     */
+    endTime: string;
+    protocolData: {
+        orderType: 'FULL_RESTRICTED';
+        zoneAddress: string;
+        counter: string;
+        seaportAddress: string;
+        seaportVersion: string;
+    };
+    salt: string;
+    signature: string;
+    status: OrderStatus;
+}
+interface ListingResult {
+    result: Order;
+}
+interface ListListingsResult {
+    page: Page;
+    result: Order[];
+}
+interface Page {
+    /**
+     * First item as an encoded string
+     */
+    previousCursor: string | null;
+    /**
+     * Last item as an encoded string
+     */
+    nextCursor: string | null;
+}
 
 /**
  * zkEVM orderbook SDK
@@ -1155,7 +1211,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?: Fee): Promise<FulfillOrderResponse>;
+    fulfillOrder(listingId: string, takerAddress: string, takerFee?: FeeValue): Promise<FulfillOrderResponse>;
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
      * the account that created them.
@@ -1170,4 +1226,4 @@ declare const constants: {
     estimatedFulfillmentGasGwei: number;
 };
 
-export { Action, ActionType, CancelOrderResponse, CreateListingParams, ERC20Item, ERC721Item, Fee, FeeType, FulfillOrderResponse, ListListingsParams, ListListingsResult, ListingResult, NativeItem, Order, OrderStatus, Orderbook, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, SignableAction, SignablePurpose, TransactionAction, TransactionBuilder, TransactionPurpose, constants };
+export { Action, ActionType, CancelOrderResponse, CreateListingParams, ERC20Item, ERC721Item, Fee, FeeType, FeeValue, FulfillOrderResponse, ListListingsParams, ListListingsResult, ListingResult, NativeItem, Order, OrderStatus, Orderbook, Page, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, SignableAction, SignablePurpose, TransactionAction, TransactionBuilder, TransactionPurpose, constants };

package/dist/orderbook.js

@@ -575,6 +575,67 @@ var ActionType;
     ActionType["SIGNABLE"] = "SIGNABLE";
 })(ActionType || (ActionType = {}));
 
+function mapFromOpenApiOrder(order) {
+    const buyItems = order.buy.map((item) => {
+        if (item.item_type === 'ERC20') {
+            return {
+                type: 'ERC20',
+                contractAddress: item.contract_address,
+                amount: item.start_amount,
+            };
+        }
+        if (item.item_type === 'NATIVE') {
+            return {
+                type: 'NATIVE',
+                amount: item.start_amount,
+            };
+        }
+        throw new Error('Buy items must be either ERC20 or NATIVE');
+    });
+    const sellItems = order.sell.map((item) => {
+        if (item.item_type === 'ERC721') {
+            return {
+                type: 'ERC721',
+                contractAddress: item.contract_address,
+                tokenId: item.token_id,
+            };
+        }
+        throw new Error('Sell items must ERC721');
+    });
+    return {
+        id: order.id,
+        accountAddress: order.account_address,
+        buy: buyItems,
+        sell: sellItems,
+        fees: order.fees.map((fee) => ({
+            amount: fee.amount,
+            recipient: fee.recipient,
+            type: fee.fee_type,
+        })),
+        chain: order.chain,
+        createTime: order.create_time,
+        endTime: order.end_time,
+        protocolData: {
+            counter: order.protocol_data.counter,
+            orderType: order.protocol_data.order_type,
+            seaportAddress: order.protocol_data.seaport_address,
+            seaportVersion: order.protocol_data.seaport_version,
+            zoneAddress: order.protocol_data.zone_address,
+        },
+        salt: order.salt,
+        signature: order.signature,
+        startTime: order.start_time,
+        status: order.status,
+        updateTime: order.update_time,
+    };
+}
+function mapFromOpenApiPage(page) {
+    return {
+        nextCursor: page.next_cursor,
+        previousCursor: page.previous_cursor,
+    };
+}
+
 /* eslint-disable */
 // TODO: Resolve these from seaport-js.
 // There is some bundling issue that is preventing this from working
@@ -804,7 +865,17 @@ class Seaport {
             buildTransaction: prepareTransaction(fulfilOrderAction.transactionMethods),
             purpose: TransactionPurpose.FULFILL_ORDER,
         });
-        return { actions: fulfillmentActions };
+        // Expirtaion bytes in SIP7 extra data [21:29]
+        // In hex string -> [21 * 2 + 2 (0x) : 29 * 2]
+        // In JS slice (start, end_inclusive), (44,60)
+        // 8 bytes uint64 epoch time in seconds
+        const expirationHex = extraData.slice(44, 60);
+        const expirationInSeconds = parseInt(expirationHex, 16);
+        return {
+            actions: fulfillmentActions,
+            expiration: (new Date(expirationInSeconds * 1000)).toISOString(),
+            order: mapFromOpenApiOrder(order),
+        };
     }
     async cancelOrder(order, account) {
         const { orderComponents } = this.mapImmutableOrderToSeaportOrderComponents(order);
@@ -924,7 +995,7 @@ class ImmutableApiClient {
                 ],
                 fees: makerFee ? [{
                         amount: makerFee.amount,
-                        fee_type: makerFee.type,
+                        fee_type: FeeType.MAKER_MARKETPLACE,
                         recipient: makerFee.recipient,
                     }] : [],
                 end_time: new Date(parseInt(`${orderComponents.endTime.toString()}000`, 10)).toISOString(),
@@ -1052,8 +1123,11 @@ class Orderbook {
      * @param {string} listingId - The listingId to find.
      * @return {ListingResult} The returned order result.
      */
-    getListing(listingId) {
-        return this.apiClient.getListing(listingId);
+    async getListing(listingId) {
+        const apiListing = await this.apiClient.getListing(listingId);
+        return {
+            result: mapFromOpenApiOrder(apiListing.result),
+        };
     }
     /**
      * List orders. This method is used to get a list of orders filtered by conditions specified
@@ -1061,8 +1135,12 @@ class Orderbook {
      * @param {ListListingsParams} listOrderParams - Filtering, ordering and page parameters.
      * @return {ListListingsResult} The paged orders.
      */
-    listListings(listOrderParams) {
-        return this.apiClient.listListings(listOrderParams);
+    async listListings(listOrderParams) {
+        const apiListings = await this.apiClient.listListings(listOrderParams);
+        return {
+            page: mapFromOpenApiPage(apiListings.page),
+            result: apiListings.result.map(mapFromOpenApiOrder),
+        };
     }
     /**
      * Get required transactions and messages for signing prior to creating a listing
@@ -1084,8 +1162,20 @@ class Orderbook {
      * @param {CreateListingParams} createListingParams - create an order with the given params.
      * @return {ListingResult} The result of the order created in the Immutable services.
      */
-    createListing(createListingParams) {
-        return this.apiClient.createListing(createListingParams);
+    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),
+        };
     }
     /**
      * Get unsigned transactions that can be submitted to fulfil an open order. If the approval
@@ -1102,7 +1192,7 @@ class Orderbook {
                 fee: takerFee
                     ? {
                         amount: takerFee.amount,
-                        fee_type: takerFee.type,
+                        fee_type: FeeType.TAKER_MARKETPLACE,
                         recipient: takerFee.recipient,
                     }
                     : undefined,

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.14.0-alpha' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.14.0-alpha.2' };
 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.14.0-alpha',
+    sdkVersion: 'ts-immutable-sdk-0.14.0-alpha.2',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

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