@imtbl/sdk 0.1.10-alpha.4 → 0.2.0-alpha

package/dist/index.js

@@ -9,7 +9,6 @@ import * as encUtils from 'enc-utils';
 import { Web3Provider, JsonRpcProvider } from '@ethersproject/providers';
 import FormData$2 from 'form-data';
 import { providers, BigNumber as BigNumber$1, constants, utils as utils$2, Contract as Contract$1, ethers, ContractFactory } from 'ethers';
-import dotenv from 'dotenv';
 import { Seaport as Seaport$1 } from '@opensea/seaport-js';
 import { parseUnits } from '@ethersproject/units';
 import { BigNumber as BigNumber$2 } from '@ethersproject/bignumber';
@@ -5437,7 +5436,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.1.10-alpha.4',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.2.0-alpha',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -5703,7 +5702,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.1.10-alpha.4',
+    sdkVersion: 'ts-immutable-sdk-0.2.0-alpha',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -11826,49 +11825,11 @@ class ImmutableApiClientFactory {
     }
 }
 
-// eslint-disable-next-line
-dotenv.config();
-function getConfigFromEnv() {
-    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 localChainConfig() {
-    const localConfig = getConfigFromEnv();
-    return {
-        seaportContractAddress: localConfig.seaportContractAddress,
-        zoneContractAddress: localConfig.zoneContractAddress,
-        apiEndpoint: localConfig.apiUrl,
-        provider: getLocalhostProvider(),
-    };
-}
 function getOrderbookConfig(chainName) {
     switch (chainName) {
-        case LOCAL_CHAIN_NAME:
-            return localChainConfig();
         case DEVNET_CHAIN_NAME:
             return {
                 seaportContractAddress: '0x41388404Efb7a68Fd31d75CEf71dF91e2BDBa2fb',
@@ -12844,13 +12805,17 @@ class SeaportLibFactory {
  * @param {OrderbookModuleConfiguration} config - Configuration for Immutable services.
  */
 class Orderbook {
-    config;
     apiClient;
     seaport;
-    constructor(config) {
-        this.config = config;
-        const orderbookConfig = getOrderbookConfig(config.overrides?.chainName);
-        const apiEndpoint = orderbookConfig?.apiEndpoint;
+    orderbookConfig;
+    constructor(config, localConfig) {
+        // either use preconfigured config or local config passed in
+        const maybeConfig = getOrderbookConfig(config.overrides?.chainName) || localConfig;
+        if (!maybeConfig) {
+            throw new Error('Orderbook configuration not passed, either select one of the preseet chainNames or pass in localConfig');
+        }
+        this.orderbookConfig = maybeConfig;
+        const { apiEndpoint } = this.orderbookConfig;
         if (!apiEndpoint) {
             throw new Error('API endpoint must be provided as an override');
         }
@@ -12859,9 +12824,9 @@ class Orderbook {
         if (!chainName) {
             throw new Error('chainName must be provided as an override');
         }
-        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);
+        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, this.orderbookConfig.seaportContractAddress).create();
+        const seaportLibFactory = new SeaportLibFactory(this.orderbookConfig.seaportContractAddress, this.orderbookConfig.provider);
+        this.seaport = new Seaport(seaportLibFactory, this.orderbookConfig.provider, this.orderbookConfig.seaportContractAddress, this.orderbookConfig.zoneContractAddress);
     }
     /**
      * Get an order by ID
@@ -12889,8 +12854,7 @@ class Orderbook {
      * the order components that can be submitted to `createListing` with a signature.
      */
     async prepareListing({ makerAddress, sell, buy, orderExpiry, }) {
-        const orderbookConfig = getOrderbookConfig(this.config.overrides?.chainName);
-        const erc721 = new ERC721Factory(sell.contractAddress, orderbookConfig.provider).create();
+        const erc721 = new ERC721Factory(sell.contractAddress, this.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
@@ -24364,9 +24328,8 @@ class ExchangeError extends Error {
     }
 }
 class InvalidConfigurationError extends ExchangeError {
-    constructor() {
-        const message = 'Invalid configuration';
-        super(message, ExchangeErrorCode.INVALID_CONFIGURATION);
+    constructor(message) {
+        super(message || 'Invalid configuration', ExchangeErrorCode.INVALID_CONFIGURATION);
     }
 }
 class ChainNotSupportedError extends ExchangeError {
@@ -26467,20 +26430,84 @@ function getSwap(nativeToken, routeAndQuote, fromAddress, slippage, deadline, pe
     };
 }
 
+const CONTRACTS_FOR_CHAIN_ID = {
+    [IMMUTABLE_TESTNET_CHAIN_ID]: {
+        multicall: '0xb18c44b211065E69844FbA9AE146DA362104AfBf',
+        coreFactory: '0x12739A8f1A8035F439092D016DAE19A2874F30d2',
+        quoterV2: '0xF674847fBcca5C80315e3AE37043Dce99F6CC529',
+        peripheryRouter: '0x0Afe6F5f4DC34461A801420634239FFaD50A2e44',
+    },
+};
+const SUPPORTED_SANDBOX_CHAINS = {
+    [IMMUTABLE_TESTNET_CHAIN_ID]: {
+        chainId: IMMUTABLE_TESTNET_CHAIN_ID,
+        rpcUrl: IMMUTABLE_TESTNET_RPC_URL,
+        contracts: CONTRACTS_FOR_CHAIN_ID[IMMUTABLE_TESTNET_CHAIN_ID],
+        commonRoutingTokens: IMMUTABLE_TESTNET_COMMON_ROUTING_TOKENS,
+        nativeToken: TIMX_IMMUTABLE_TESTNET,
+    },
+};
+const SUPPORTED_PRODUCTION_CHAINS = {};
+const SUPPORTED_CHAIN_IDS_FOR_ENVIRONMENT = {
+    [Environment$1.SANDBOX]: SUPPORTED_SANDBOX_CHAINS,
+    [Environment$1.PRODUCTION]: SUPPORTED_PRODUCTION_CHAINS,
+};
+function validateOverrides(overrides) {
+    Object.entries(overrides).forEach(([key, value]) => {
+        if (!value) {
+            throw new InvalidConfigurationError(`Missing override: ${key}`);
+        }
+    });
+    Object.entries(overrides.exchangeContracts).forEach(([key, contract]) => {
+        if (!isValidNonZeroAddress(contract)) {
+            throw new InvalidConfigurationError(`Invalid exchange contract address for ${key}`);
+        }
+    });
+}
+/**
+ * {@link ExchangeConfiguration} is used to configure the {@link Exchange} class.
+ * @param chainId the ID of the chain to configure. {@link SUPPORTED_CHAIN_IDS_FOR_ENVIRONMENT} contains the supported chains for each environment.
+ * @param baseConfig the base {@link ImmutableConfiguration} for the {@link Exchange} class
+ */
+class ExchangeConfiguration {
+    baseConfig;
+    chain;
+    constructor({ chainId, baseConfig, overrides }) {
+        this.baseConfig = baseConfig;
+        if (overrides) {
+            validateOverrides(overrides);
+            this.chain = {
+                chainId,
+                rpcUrl: overrides.rpcURL,
+                contracts: overrides.exchangeContracts,
+                commonRoutingTokens: overrides.commonRoutingTokens,
+                nativeToken: overrides.nativeToken,
+            };
+            return;
+        }
+        const chain = SUPPORTED_CHAIN_IDS_FOR_ENVIRONMENT[baseConfig.environment][chainId];
+        if (!chain) {
+            throw new ChainNotSupportedError(chainId, baseConfig.environment);
+        }
+        this.chain = chain;
+    }
+}
+
 class Exchange {
     provider;
     router;
     chainId;
     nativeToken;
     constructor(configuration) {
-        this.chainId = configuration.chain.chainId;
-        this.nativeToken = configuration.chain.nativeToken;
-        this.provider = new ethers.providers.JsonRpcProvider(configuration.chain.rpcUrl);
-        this.router = new Router(this.provider, configuration.chain.commonRoutingTokens, {
-            multicallAddress: configuration.chain.contracts.multicall,
-            factoryAddress: configuration.chain.contracts.coreFactory,
-            quoterAddress: configuration.chain.contracts.quoterV2,
-            peripheryRouterAddress: configuration.chain.contracts.peripheryRouter,
+        const config = new ExchangeConfiguration(configuration);
+        this.chainId = config.chain.chainId;
+        this.nativeToken = config.chain.nativeToken;
+        this.provider = new ethers.providers.JsonRpcProvider(config.chain.rpcUrl);
+        this.router = new Router(this.provider, config.chain.commonRoutingTokens, {
+            multicallAddress: config.chain.contracts.multicall,
+            factoryAddress: config.chain.contracts.coreFactory,
+            quoterAddress: config.chain.contracts.quoterV2,
+            peripheryRouterAddress: config.chain.contracts.peripheryRouter,
         });
     }
     static validate(tokenInAddress, tokenOutAddress, maxHops, slippagePercent, fromAddress) {
@@ -26560,67 +26587,6 @@ class Exchange {
     }
 }
 
-const CONTRACTS_FOR_CHAIN_ID = {
-    [IMMUTABLE_TESTNET_CHAIN_ID]: {
-        multicall: '0xb18c44b211065E69844FbA9AE146DA362104AfBf',
-        coreFactory: '0x12739A8f1A8035F439092D016DAE19A2874F30d2',
-        quoterV2: '0xF674847fBcca5C80315e3AE37043Dce99F6CC529',
-        peripheryRouter: '0x0Afe6F5f4DC34461A801420634239FFaD50A2e44',
-    },
-};
-const SUPPORTED_SANDBOX_CHAINS = {
-    [IMMUTABLE_TESTNET_CHAIN_ID]: {
-        chainId: IMMUTABLE_TESTNET_CHAIN_ID,
-        rpcUrl: IMMUTABLE_TESTNET_RPC_URL,
-        contracts: CONTRACTS_FOR_CHAIN_ID[IMMUTABLE_TESTNET_CHAIN_ID],
-        commonRoutingTokens: IMMUTABLE_TESTNET_COMMON_ROUTING_TOKENS,
-        nativeToken: TIMX_IMMUTABLE_TESTNET,
-    },
-};
-const SUPPORTED_PRODUCTION_CHAINS = {};
-const SUPPORTED_CHAIN_IDS_FOR_ENVIRONMENT = {
-    [Environment$1.SANDBOX]: SUPPORTED_SANDBOX_CHAINS,
-    [Environment$1.PRODUCTION]: SUPPORTED_PRODUCTION_CHAINS,
-};
-function validateOverrides(overrides) {
-    if (!overrides.rpcURL || !overrides.exchangeContracts || !overrides.commonRoutingTokens || !overrides.nativeToken) {
-        throw new InvalidConfigurationError();
-    }
-    Object.values(overrides.exchangeContracts).forEach((contract) => {
-        if (!isValidNonZeroAddress(contract)) {
-            throw new InvalidConfigurationError();
-        }
-    });
-}
-/**
- * {@link ExchangeConfiguration} is used to configure the {@link Exchange} class.
- * @param chainId the ID of the chain to configure. {@link SUPPORTED_CHAIN_IDS_FOR_ENVIRONMENT} contains the supported chains for each environment.
- * @param baseConfig the base {@link ImmutableConfiguration} for the {@link Exchange} class
- */
-class ExchangeConfiguration {
-    baseConfig;
-    chain;
-    constructor({ chainId, baseConfig, overrides }) {
-        this.baseConfig = baseConfig;
-        if (overrides) {
-            validateOverrides(overrides);
-            this.chain = {
-                chainId,
-                rpcUrl: overrides.rpcURL,
-                contracts: overrides.exchangeContracts,
-                commonRoutingTokens: overrides.commonRoutingTokens,
-                nativeToken: overrides.nativeToken,
-            };
-            return;
-        }
-        const chain = SUPPORTED_CHAIN_IDS_FOR_ENVIRONMENT[baseConfig.environment][chainId];
-        if (!chain) {
-            throw new ChainNotSupportedError(chainId, baseConfig.environment);
-        }
-        this.chain = chain;
-    }
-}
-
 /* eslint-disable class-methods-use-this */ 
 
 const $762782b6c862d954$export$db5daa1b5156ccfe = [
@@ -27373,13 +27339,13 @@ async function $67fc622a2b913d5f$export$989eefe1274a439c(fromChainId, toChainId,
 }
 async function $67fc622a2b913d5f$export$7cf6178417769841(chainId, config) {
     const dexConfig = await config.remote.getConfig("dex");
-    return new (Exchange)(new (ExchangeConfiguration)({
+    return new (Exchange)({
         chainId: chainId,
         baseConfig: new (ImmutableConfiguration)({
             environment: config.environment
         }),
         overrides: dexConfig?.overrides
-    }));
+    });
 }
 
 
@@ -27743,7 +27709,7 @@ class $a8cb37a3fc8eb863$export$1f60ba4ec72508a0 {
 function $parcel$export(e, n, v, s) {
   Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
 }
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.1.10-alpha.4";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.2.0-alpha";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/orderbook.d.ts

@@ -1,4 +1,4 @@
-import { OrderbookOverrides } from 'config/config';
+import { OrderbookOverrides, OrderbookModuleConfiguration } from 'config/config';
 import { ListingResult, ListListingsResult } from 'openapi/sdk';
 import { ListListingsParams, PrepareListingParams, PrepareListingResponse, CreateListingParams, FulfillOrderResponse, CancelOrderResponse } from 'types';
 
@@ -25,10 +25,10 @@ interface ModuleConfiguration<T> {
  * @param {OrderbookModuleConfiguration} config - Configuration for Immutable services.
  */
 declare class Orderbook {
-    private config;
     private apiClient;
     private seaport;
-    constructor(config: ModuleConfiguration<OrderbookOverrides>);
+    private orderbookConfig;
+    constructor(config: ModuleConfiguration<OrderbookOverrides>, localConfig?: OrderbookModuleConfiguration);
     /**
      * Get an order by ID
      * @param {string} listingId - The listingId to find.

package/dist/orderbook.js

@@ -1,7 +1,6 @@
 import axios from 'axios';
 import FormData from 'form-data';
 import { providers, BigNumber, constants, utils, Contract } from 'ethers';
-import dotenv from 'dotenv';
 import { Seaport as Seaport$1 } from '@opensea/seaport-js';
 
 class BaseHttpRequest {
@@ -899,49 +898,11 @@ class ImmutableApiClientFactory {
     }
 }
 
-// eslint-disable-next-line
-dotenv.config();
-function getConfigFromEnv() {
-    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 localChainConfig() {
-    const localConfig = getConfigFromEnv();
-    return {
-        seaportContractAddress: localConfig.seaportContractAddress,
-        zoneContractAddress: localConfig.zoneContractAddress,
-        apiEndpoint: localConfig.apiUrl,
-        provider: getLocalhostProvider(),
-    };
-}
 function getOrderbookConfig(chainName) {
     switch (chainName) {
-        case LOCAL_CHAIN_NAME:
-            return localChainConfig();
         case DEVNET_CHAIN_NAME:
             return {
                 seaportContractAddress: '0x41388404Efb7a68Fd31d75CEf71dF91e2BDBa2fb',
@@ -1917,13 +1878,17 @@ class SeaportLibFactory {
  * @param {OrderbookModuleConfiguration} config - Configuration for Immutable services.
  */
 class Orderbook {
-    config;
     apiClient;
     seaport;
-    constructor(config) {
-        this.config = config;
-        const orderbookConfig = getOrderbookConfig(config.overrides?.chainName);
-        const apiEndpoint = orderbookConfig?.apiEndpoint;
+    orderbookConfig;
+    constructor(config, localConfig) {
+        // either use preconfigured config or local config passed in
+        const maybeConfig = getOrderbookConfig(config.overrides?.chainName) || localConfig;
+        if (!maybeConfig) {
+            throw new Error('Orderbook configuration not passed, either select one of the preseet chainNames or pass in localConfig');
+        }
+        this.orderbookConfig = maybeConfig;
+        const { apiEndpoint } = this.orderbookConfig;
         if (!apiEndpoint) {
             throw new Error('API endpoint must be provided as an override');
         }
@@ -1932,9 +1897,9 @@ class Orderbook {
         if (!chainName) {
             throw new Error('chainName must be provided as an override');
         }
-        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);
+        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, this.orderbookConfig.seaportContractAddress).create();
+        const seaportLibFactory = new SeaportLibFactory(this.orderbookConfig.seaportContractAddress, this.orderbookConfig.provider);
+        this.seaport = new Seaport(seaportLibFactory, this.orderbookConfig.provider, this.orderbookConfig.seaportContractAddress, this.orderbookConfig.zoneContractAddress);
     }
     /**
      * Get an order by ID
@@ -1962,8 +1927,7 @@ class Orderbook {
      * the order components that can be submitted to `createListing` with a signature.
      */
     async prepareListing({ makerAddress, sell, buy, orderExpiry, }) {
-        const orderbookConfig = getOrderbookConfig(this.config.overrides?.chainName);
-        const erc721 = new ERC721Factory(sell.contractAddress, orderbookConfig.provider).create();
+        const erc721 = new ERC721Factory(sell.contractAddress, this.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.4',
+    sdkVersion: 'ts-immutable-sdk-0.2.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.1.10-alpha.4",
+  "version": "0.2.0-alpha",
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {