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

package/dist/orderbook.d.ts

@@ -1,7 +1,24 @@
-import { OrderbookModuleConfiguration } from 'config/config';
+import { OrderbookOverrides } from 'config/config';
 import { ListingResult, ListListingsResult } from 'openapi/sdk';
 import { ListListingsParams, PrepareListingParams, PrepareListingResponse, CreateListingParams, FulfillOrderResponse, CancelOrderResponse } from 'types';
 
+declare enum Environment {
+    PRODUCTION = "production",
+    SANDBOX = "sandbox"
+}
+declare class ImmutableConfiguration {
+    readonly environment: Environment;
+    readonly apiKey?: string;
+    constructor(options: {
+        environment: Environment;
+        apiKey?: string;
+    });
+}
+interface ModuleConfiguration<T> {
+    baseConfig: ImmutableConfiguration;
+    overrides?: T;
+}
+
 /**
  * zkEVM orderbook SDK
  * @constructor
@@ -11,7 +28,7 @@ declare class Orderbook {
     private config;
     private apiClient;
     private seaport;
-    constructor(config: OrderbookModuleConfiguration);
+    constructor(config: ModuleConfiguration<OrderbookOverrides>);
     /**
      * Get an order by ID
      * @param {string} listingId - The listingId to find.

package/dist/orderbook.js

@@ -1,6 +1,8 @@
 import axios from 'axios';
 import FormData from 'form-data';
-import { utils, Contract, BigNumber, constants } from 'ethers';
+import { SEAPORT_CONTRACT_VERSION_V1_4 as SEAPORT_CONTRACT_VERSION_V1_4$1, SEAPORT_CONTRACT_VERSION_V1_5 } from '@opensea/seaport-js/lib/constants';
+import { providers, BigNumber, constants, utils, Contract } from 'ethers';
+import dotenv from 'dotenv';
 import { Seaport as Seaport$1 } from '@opensea/seaport-js';
 
 class BaseHttpRequest {
@@ -387,86 +389,6 @@ class AxiosHttpRequest extends BaseHttpRequest {
     }
 }
 
-class ListingsService {
-    httpRequest;
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * List all listings
-     * List all listings
-     * @returns ListListingsResult OK response.
-     * @throws ApiError
-     */
-    listListings({ chainName, status, sellItemContractAddress, buyItemContractAddress, sellItemTokenId, pageSize, sortBy, sortDirection, pageCursor, }) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/v1/chains/{chain_name}/orders/listings',
-            path: {
-                'chain_name': chainName,
-            },
-            query: {
-                'status': status,
-                'sell_item_contract_address': sellItemContractAddress,
-                'buy_item_contract_address': buyItemContractAddress,
-                'sell_item_token_id': sellItemTokenId,
-                'page_size': pageSize,
-                'sort_by': sortBy,
-                'sort_direction': sortDirection,
-                'page_cursor': pageCursor,
-            },
-            errors: {
-                400: `Bad Request (400)`,
-                404: `The specified resource was not found (404)`,
-                500: `Internal Server Error (500)`,
-            },
-        });
-    }
-    /**
-     * Create a listing
-     * Create a listing
-     * @returns ListingResult Created response.
-     * @throws ApiError
-     */
-    createListing({ chainName, requestBody, }) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/v1/chains/{chain_name}/orders/listings',
-            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)`,
-            },
-        });
-    }
-    /**
-     * Get a single listing by ID
-     * Get a single listing by ID
-     * @returns ListingResult OK response.
-     * @throws ApiError
-     */
-    getListing({ chainName, listingId, }) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/v1/chains/{chain_name}/orders/listings/{listing_id}',
-            path: {
-                'chain_name': chainName,
-                'listing_id': listingId,
-            },
-            errors: {
-                400: `Bad Request (400)`,
-                404: `The specified resource was not found (404)`,
-                500: `Internal Server Error (500)`,
-            },
-        });
-    }
-}
-
 class OrdersService {
     httpRequest;
     constructor(httpRequest) {
@@ -548,7 +470,6 @@ class OrdersService {
 }
 
 class OrderBookClient {
-    listings;
     orders;
     request;
     constructor(config, HttpRequest = AxiosHttpRequest) {
@@ -563,7 +484,6 @@ class OrderBookClient {
             HEADERS: config?.HEADERS,
             ENCODE_PATH: config?.ENCODE_PATH,
         });
-        this.listings = new ListingsService(this.request);
         this.orders = new OrdersService(this.request);
     }
 }
@@ -719,7 +639,7 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
                 };
         }
     });
-    const fees = order.buy_fees.map((fee) => ({
+    const fees = order.fees.map((fee) => ({
         startAmount: fee.amount,
         endAmount: fee.amount,
         itemType: order.buy[0].item_type === 'ERC20' ? ItemType.ERC20 : ItemType.NATIVE,
@@ -755,12 +675,12 @@ function mapImmutableOrderToSeaportOrderComponents(order, counter, zoneAddress)
 }
 
 class Seaport {
-    seaport;
+    seaportLibFactory;
     provider;
     seaportContractAddress;
     zoneContractAddress;
-    constructor(seaport, provider, seaportContractAddress, zoneContractAddress) {
-        this.seaport = seaport;
+    constructor(seaportLibFactory, provider, seaportContractAddress, zoneContractAddress) {
+        this.seaportLibFactory = seaportLibFactory;
         this.provider = provider;
         this.seaportContractAddress = seaportContractAddress;
         this.zoneContractAddress = zoneContractAddress;
@@ -784,12 +704,13 @@ class Seaport {
             unsignedApprovalTransaction: approvalTransaction,
             typedOrderMessageForSigning: await this.getTypedDataFromOrderComponents(orderComponents),
             orderComponents,
-            orderHash: await this.seaport.getOrderHash(orderComponents),
+            orderHash: this.getSeaportLib().getOrderHash(orderComponents),
         };
     }
     async fulfilOrder(order, account) {
         const orderComponents = await this.mapImmutableOrderToSeaportOrderComponents(order);
-        const { actions } = await this.seaport.fulfillOrders({
+        const seaportLib = this.getSeaportLib(order);
+        const { actions } = await seaportLib.fulfillOrders({
             accountAddress: account,
             fulfillOrderDetails: [{
                     order: {
@@ -818,15 +739,17 @@ class Seaport {
     }
     async cancelOrder(order, account) {
         const orderComponents = await this.mapImmutableOrderToSeaportOrderComponents(order);
-        const cancellationTransaction = await this.seaport.cancelOrders([orderComponents], account);
+        const seaportLib = this.getSeaportLib(order);
+        const cancellationTransaction = await seaportLib.cancelOrders([orderComponents], account);
         return prepareTransaction(cancellationTransaction);
     }
-    async mapImmutableOrderToSeaportOrderComponents(order) {
-        const counterForOfferer = await this.seaport.getCounter(order.account_address);
-        return mapImmutableOrderToSeaportOrderComponents(order, counterForOfferer.toString(), this.zoneContractAddress);
+    mapImmutableOrderToSeaportOrderComponents(order) {
+        const orderCounter = order.protocol_data.counter;
+        return mapImmutableOrderToSeaportOrderComponents(order, orderCounter, this.zoneContractAddress);
     }
     createSeaportOrder(offerer, listingItem, considerationItem, royaltyInfo, orderStart, orderExpiry) {
-        return this.seaport.createOrder({
+        const seaportLib = this.getSeaportLib();
+        return seaportLib.createOrder({
             allowPartialFills: false,
             offer: [
                 {
@@ -857,7 +780,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_4$1,
             chainId,
             verifyingContract: this.seaportContractAddress,
         };
@@ -867,27 +790,13 @@ class Seaport {
             value: orderComponents,
         };
     }
-}
-
-class SeaportFactory {
-    seaportContractAddress;
-    zoneContractAddress;
-    provider;
-    seaport;
-    constructor(seaportContractAddress, zoneContractAddress, provider) {
-        this.seaportContractAddress = seaportContractAddress;
-        this.zoneContractAddress = zoneContractAddress;
-        this.provider = provider;
-        this.seaport = new Seaport$1(provider, {
-            seaportVersion: '1.4',
-            balanceAndApprovalChecksOnOrderCreation: true,
-            overrides: {
-                contractAddress: seaportContractAddress,
-            },
-        });
-    }
-    create() {
-        return new Seaport(this.seaport, this.provider, this.seaportContractAddress, this.zoneContractAddress);
+    getSeaportLib(order) {
+        const seaportAddress = order?.protocol_data?.seaport_address ?? this.seaportContractAddress;
+        let seaportVersion = SEAPORT_CONTRACT_VERSION_V1_4$1;
+        if (order?.protocol_data?.seaport_version === SEAPORT_CONTRACT_VERSION_V1_5) {
+            seaportVersion = SEAPORT_CONTRACT_VERSION_V1_5;
+        }
+        return this.seaportLibFactory.create(seaportVersion, seaportAddress);
     }
 }
 
@@ -941,7 +850,7 @@ class ImmutableApiClient {
                         contract_address: orderComponents.consideration[0].token,
                     },
                 ],
-                buy_fees: orderComponents.consideration.length > 1
+                fees: orderComponents.consideration.length > 1
                     ? [
                         {
                             amount: orderComponents.consideration[1].startAmount,
@@ -990,6 +899,73 @@ class ImmutableApiClientFactory {
     }
 }
 
+// eslint-disable-next-line
+dotenv.config();
+function getConfig() {
+    if (!process.env.ORDERBOOK_MR_API_URL
+        || !process.env.SEAPORT_CONTRACT_ADDRESS
+        || !process.env.ZONE_CONTRACT_ADDRESS) {
+        throw new Error('missing config');
+    }
+    return {
+        apiUrl: process.env.ORDERBOOK_MR_API_URL,
+        seaportContractAddress: process.env.SEAPORT_CONTRACT_ADDRESS,
+        zoneContractAddress: process.env.ZONE_CONTRACT_ADDRESS,
+    };
+}
+
+dotenv.config();
+function getLocalhostProvider() {
+    const endpoint = process.env.LOCAL_RPC_ENDPOINT;
+    if (!endpoint) {
+        throw new Error('LOCAL_RPC_ENDPOINT not set');
+    }
+    return new providers.JsonRpcProvider(endpoint);
+}
+
+dotenv.config();
+
+const LOCAL_CHAIN_NAME = 'imtbl-zkevm-local';
+const DEVNET_CHAIN_NAME = 'imtbl-zkevm-devnet';
+const TESTNET_CHAIN_NAME = 'imtbl-zkevm-testnet';
+const MAINNET_CHAIN_NAME = 'imtbl-zkevm-mainnet';
+function getOrderbookConfig(chainName) {
+    const localConfig = getConfig();
+    switch (chainName) {
+        case LOCAL_CHAIN_NAME:
+            return {
+                seaportContractAddress: localConfig.seaportContractAddress,
+                zoneContractAddress: localConfig.zoneContractAddress,
+                apiEndpoint: localConfig.apiUrl,
+                provider: getLocalhostProvider(),
+            };
+        case DEVNET_CHAIN_NAME:
+            return {
+                seaportContractAddress: '0x41388404Efb7a68Fd31d75CEf71dF91e2BDBa2fb',
+                zoneContractAddress: '0xCb5063b0c1dcF4f7fed8E7eaa79faf9859792767',
+                apiEndpoint: 'https://order-book-mr.dev.imtbl.com',
+                provider: new providers.JsonRpcProvider('https://zkevm-rpc.dev.x.immutable.com'),
+            };
+        case TESTNET_CHAIN_NAME:
+            return {
+                seaportContractAddress: '0x45E23dA18804F99Cf67408AeBE85F67c958381Ff',
+                zoneContractAddress: '0x25b00b7eb97eab6194798E9B8eF63Aa526D5bd7E',
+                apiEndpoint: 'https://order-book-mr.sandbox.imtbl.com',
+                provider: new providers.JsonRpcProvider('https://zkevm-rpc.sandbox.x.immutable.com'),
+            };
+        case MAINNET_CHAIN_NAME:
+            // not yet deployed
+            return {
+                seaportContractAddress: '',
+                zoneContractAddress: '',
+                apiEndpoint: 'https://order-book-mr.imtbl.com',
+                provider: new providers.JsonRpcProvider('https://zkevm-rpc.x.immutable.com'),
+            };
+        default:
+            return null;
+    }
+}
+
 class ERC721 {
     erc721;
     constructor(erc721) {
@@ -1912,6 +1888,26 @@ class ERC721Factory {
     }
 }
 
+class SeaportLibFactory {
+    defaultSeaportContractAddress;
+    provider;
+    constructor(defaultSeaportContractAddress, provider) {
+        this.defaultSeaportContractAddress = defaultSeaportContractAddress;
+        this.provider = provider;
+    }
+    create(orderSeaportVersion, orderSeaportAddress) {
+        const seaportVersion = orderSeaportVersion ?? SEAPORT_CONTRACT_VERSION_V1_4$1;
+        const seaportContractAddress = orderSeaportAddress ?? this.defaultSeaportContractAddress;
+        return new Seaport$1(this.provider, {
+            seaportVersion,
+            balanceAndApprovalChecksOnOrderCreation: true,
+            overrides: {
+                contractAddress: seaportContractAddress,
+            },
+        });
+    }
+}
+
 /**
  * zkEVM orderbook SDK
  * @constructor
@@ -1923,8 +1919,8 @@ class Orderbook {
     seaport;
     constructor(config) {
         this.config = config;
-        // TODO: Move endpoint lookup to a map based on env. Just using override to get dev started
-        const apiEndpoint = config.overrides?.apiEndpoint;
+        const orderbookConfig = getOrderbookConfig(config.overrides?.chainName);
+        const apiEndpoint = orderbookConfig?.apiEndpoint;
         if (!apiEndpoint) {
             throw new Error('API endpoint must be provided as an override');
         }
@@ -1933,8 +1929,9 @@ class Orderbook {
         if (!chainName) {
             throw new Error('chainName must be provided as an override');
         }
-        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, this.config.seaportContractAddress).create();
-        this.seaport = new SeaportFactory(this.config.seaportContractAddress, this.config.zoneContractAddress, this.config.provider).create();
+        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, orderbookConfig.seaportContractAddress).create();
+        const seaportLibFactory = new SeaportLibFactory(orderbookConfig.seaportContractAddress, orderbookConfig.provider);
+        this.seaport = new Seaport(seaportLibFactory, orderbookConfig.provider, orderbookConfig.seaportContractAddress, orderbookConfig.zoneContractAddress);
     }
     /**
      * Get an order by ID
@@ -1962,7 +1959,8 @@ class Orderbook {
      * the order components that can be submitted to `createListing` with a signature.
      */
     async prepareListing({ makerAddress, sell, buy, orderExpiry, }) {
-        const erc721 = new ERC721Factory(sell.contractAddress, this.config.provider).create();
+        const orderbookConfig = getOrderbookConfig(this.config.overrides?.chainName);
+        const erc721 = new ERC721Factory(sell.contractAddress, orderbookConfig.provider).create();
         const royaltyInfo = await erc721.royaltyInfo(sell.tokenId, buy.amount);
         return this.seaport.prepareSeaportOrder(makerAddress, sell, buy, royaltyInfo, 
         // Default order start to now

package/dist/passport.js

@@ -21,7 +21,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.1.10-alpha',
+    sdkVersion: 'ts-immutable-sdk-0.1.10-alpha.2',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -4449,8 +4449,10 @@ class GuardianClient {
         }));
         this.imxEtherAddress = imxEtherAddress;
     }
-    async validate({ popupWindowSize, payloadHash }) {
+    loading(popupWindowSize) {
         this.confirmationScreen.loading(popupWindowSize);
+    }
+    async validate({ payloadHash }) {
         const finallyFn = () => {
             this.confirmationScreen.closeWindow();
         };
@@ -4527,6 +4529,7 @@ async function exchangeTransfer({ user, starkSigner, request, exchangesApi, }) {
 const ERC721$1 = 'ERC721';
 async function createOrder({ starkSigner, user, request, ordersApi, guardianClient, }) {
     return withPassportError(async () => {
+        guardianClient.loading();
         const { ethAddress } = user.imx;
         const amountSell = request.sell.type === ERC721$1 ? '1' : request.sell.amount;
         const amountBuy = request.buy.type === ERC721$1 ? '1' : request.buy.amount;
@@ -4578,6 +4581,7 @@ async function createOrder({ starkSigner, user, request, ordersApi, guardianClie
 }
 async function cancelOrder({ user, starkSigner, request, ordersApi, guardianClient, }) {
     return withPassportError(async () => {
+        guardianClient.loading();
         const getSignableCancelOrderRequest = {
             order_id: request.order_id,
         };
@@ -4635,6 +4639,7 @@ async function registerPassport({ ethSigner, starkSigner, usersApi }, authorizat
 
 async function createTrade({ request, tradesApi, user, starkSigner, guardianClient, }) {
     return withPassportError(async () => {
+        guardianClient.loading();
         const { ethAddress } = user.imx;
         const getSignableTradeRequest = {
             expiration_timestamp: request.expiration_timestamp,
@@ -4681,6 +4686,7 @@ async function createTrade({ request, tradesApi, user, starkSigner, guardianClie
 const ERC721 = 'ERC721';
 async function transfer({ request, transfersApi, starkSigner, user, guardianClient, }) {
     return withPassportError(async () => {
+        guardianClient.loading();
         const transferAmount = request.type === ERC721 ? '1' : request.amount;
         const getSignableTransferRequest = {
             sender: user.imx.ethAddress,
@@ -4726,6 +4732,8 @@ async function transfer({ request, transfersApi, starkSigner, user, guardianClie
 }
 async function batchNftTransfer({ user, starkSigner, request, transfersApi, guardianClient, }) {
     return withPassportError(async () => {
+        const popupWindowSize = { width: 480, height: 784 };
+        guardianClient.loading(popupWindowSize);
         const { ethAddress } = user.imx;
         const signableRequests = request.map((nftTransfer) => ({
             amount: '1',
@@ -4747,10 +4755,8 @@ async function batchNftTransfer({ user, starkSigner, request, transfersApi, guar
         const signableResult = await transfersApi.getSignableTransfer({
             getSignableTransferRequestV2,
         }, { headers });
-        const popupWindowSize = { width: 480, height: 784 };
         await guardianClient.validate({
             payloadHash: signableResult.data.signable_responses[0]?.payload_hash,
-            popupWindowSize,
         });
         const requests = await Promise.all(signableResult.data.signable_responses.map(async (resp) => {
             const starkSignature = await starkSigner.signMessage(resp.payload_hash);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.1.10-alpha",
+  "version": "0.1.10-alpha.2",
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
@@ -85,6 +85,14 @@
       "types": "./dist/provider.d.ts",
       "import": "./dist/provider.js"
     },
+    "./checkout_sdk": {
+      "types": "./dist/checkout_sdk.d.ts",
+      "import": "./dist/checkout_sdk.js"
+    },
+    "./checkout_widgets": {
+      "types": "./dist/checkout_widgets.d.ts",
+      "import": "./dist/checkout_widgets.js"
+    },
     "./erc20": {
       "types": "./dist/erc20.d.ts",
       "import": "./dist/erc20.js"