@imtbl/sdk 1.28.1 → 1.28.2

package/dist/index.cjs

@@ -182,7 +182,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.28.1';
+const SDK_VERSION$1 = '1.28.2';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -14334,7 +14334,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$2 = { 'x-sdk-version': 'ts-immutable-sdk-1.28.1' };
+const defaultHeaders$2 = { 'x-sdk-version': 'ts-immutable-sdk-1.28.2' };
 const createConfig$1 = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -14406,7 +14406,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders$1 = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.28.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.28.2',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -14880,7 +14880,7 @@ var blockchain_data = /*#__PURE__*/Object.freeze({
 /* eslint-disable @typescript-eslint/naming-convention */
 class ApiConfiguration extends index$2.Configuration {
 }
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.28.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.28.2' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -14919,7 +14919,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.28.1',
+    sdkVersion: 'ts-immutable-sdk-1.28.2',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({
@@ -28443,11 +28443,13 @@ class Seaport {
     provider;
     seaportContractAddress;
     zoneContractAddress;
-    constructor(seaportLibFactory, provider, seaportContractAddress, zoneContractAddress) {
+    rateLimitingKey;
+    constructor(seaportLibFactory, provider, seaportContractAddress, zoneContractAddress, rateLimitingKey) {
         this.seaportLibFactory = seaportLibFactory;
         this.provider = provider;
         this.seaportContractAddress = seaportContractAddress;
         this.zoneContractAddress = zoneContractAddress;
+        this.rateLimitingKey = rateLimitingKey;
     }
     async prepareSeaportOrder(offerer, listingItem, considerationItem, orderStart, orderExpiry) {
         const { actions: seaportActions } = await this.createSeaportOrder(offerer, listingItem, considerationItem, orderStart, orderExpiry);
@@ -28613,11 +28615,7 @@ class Seaport {
     }
     getSeaportLib(order) {
         const seaportAddress = order?.protocol_data?.seaport_address ?? this.seaportContractAddress;
-        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);
+        return this.seaportLibFactory.create(seaportAddress, this.rateLimitingKey);
     }
     static getExpirationISOTimeFromExtraData(extraData) {
         // Expirtaion bytes in SIP7 extra data [21:29]
@@ -28740,12 +28738,17 @@ class ImmutableApiClientFactory {
     chainName;
     seaportAddress;
     orderbookClient;
-    constructor(apiEndpoint, chainName, seaportAddress) {
+    constructor(apiEndpoint, chainName, seaportAddress, rateLimitingKey) {
         this.chainName = chainName;
         this.seaportAddress = seaportAddress;
         this.orderbookClient = new OrderBookClient({
             // eslint-disable-next-line @typescript-eslint/naming-convention
             BASE: apiEndpoint,
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            HEADERS: rateLimitingKey ? {
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                'x-api-key': rateLimitingKey,
+            } : undefined,
         });
     }
     create() {
@@ -28755,15 +28758,24 @@ class ImmutableApiClientFactory {
 
 const TESTNET_CHAIN_NAME = 'imtbl-zkevm-testnet';
 const MAINNET_CHAIN_NAME = 'imtbl-zkevm-mainnet';
-function getOrderbookConfig(environment) {
-    switch (environment) {
+function getConfiguredProvider(url, rateLimitingKey) {
+    return new ethers.providers.JsonRpcProvider({
+        url,
+        headers: rateLimitingKey ? {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            'x-api-key': rateLimitingKey,
+        } : undefined,
+    });
+}
+function getOrderbookConfig(config) {
+    switch (config.baseConfig.environment) {
         case Environment$1.SANDBOX:
             return {
                 seaportContractAddress: '0x7d117aA8BD6D31c4fa91722f246388f38ab1942c',
                 zoneContractAddress: '0x8831867E347AB87FA30199C5B695F0A31604Bb52',
                 apiEndpoint: 'https://api.sandbox.immutable.com',
                 chainName: TESTNET_CHAIN_NAME,
-                provider: new ethers.providers.JsonRpcProvider('https://rpc.testnet.immutable.com'),
+                provider: getConfiguredProvider('https://rpc.testnet.immutable.com', config.baseConfig.rateLimitingKey),
             };
         // not yet deployed
         case Environment$1.PRODUCTION:
@@ -28772,7 +28784,7 @@ function getOrderbookConfig(environment) {
                 zoneContractAddress: '0x00338b92Bec262078B3e49BF12bbEA058916BF91',
                 apiEndpoint: 'https://api.immutable.com',
                 chainName: MAINNET_CHAIN_NAME,
-                provider: new ethers.providers.JsonRpcProvider('https://rpc.immutable.com'),
+                provider: getConfiguredProvider('https://rpc.immutable.com', config.baseConfig.rateLimitingKey),
             };
         default:
             return null;
@@ -28782,8 +28794,12 @@ function getOrderbookConfig(environment) {
 // The order book module only supports V5 JsonRpcProviders. These are instantiated
 // by the environment or by providing an RPC URL override. For this reason we can
 // safely instantiate a V6 provider for the V5 provider URL.
-function convertToV6Provider(provider) {
-    const overwrittenProvider = new ethersV6.JsonRpcProvider(provider.connection.url);
+function convertToV6Provider(provider, rateLimitingKey) {
+    const fetch = new ethersV6.FetchRequest(provider.connection.url);
+    if (rateLimitingKey) {
+        fetch.setHeader('x-api-key', rateLimitingKey);
+    }
+    const overwrittenProvider = new ethersV6.JsonRpcProvider(fetch);
     // Need to override the getSigner method to mimic V5 behaviour
     overwrittenProvider.getSigner = async function getSigner(address) {
         if (address == null) {
@@ -28813,9 +28829,9 @@ class SeaportLibFactory {
         this.defaultSeaportContractAddress = defaultSeaportContractAddress;
         this.provider = provider;
     }
-    create(orderSeaportVersion, orderSeaportAddress) {
+    create(orderSeaportAddress, rateLimitingKey) {
         const seaportContractAddress = orderSeaportAddress ?? this.defaultSeaportContractAddress;
-        return new seaportJs.Seaport(convertToV6Provider(this.provider), {
+        return new seaportJs.Seaport(convertToV6Provider(this.provider, rateLimitingKey), {
             balanceAndApprovalChecksOnOrderCreation: true,
             overrides: {
                 contractAddress: seaportContractAddress,
@@ -28834,13 +28850,13 @@ class Orderbook {
     seaport;
     orderbookConfig;
     constructor(config) {
-        const obConfig = getOrderbookConfig(config.baseConfig.environment);
+        const obConfig = getOrderbookConfig(config);
         const finalConfig = {
             ...obConfig,
             ...config.overrides,
         };
         if (config.overrides?.jsonRpcProviderUrl) {
-            finalConfig.provider = new ethers.providers.JsonRpcProvider(config.overrides.jsonRpcProviderUrl);
+            finalConfig.provider = getConfiguredProvider(config.overrides?.jsonRpcProviderUrl, config.baseConfig.rateLimitingKey);
         }
         if (!finalConfig) {
             throw new Error('Orderbook configuration not passed, please specify the environment under config.baseConfig.environment');
@@ -28850,9 +28866,9 @@ class Orderbook {
         if (!apiEndpoint) {
             throw new Error('API endpoint must be provided');
         }
-        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, this.orderbookConfig.seaportContractAddress).create();
+        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, this.orderbookConfig.seaportContractAddress, config.baseConfig.rateLimitingKey).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);
+        this.seaport = new Seaport(seaportLibFactory, this.orderbookConfig.provider, this.orderbookConfig.seaportContractAddress, this.orderbookConfig.zoneContractAddress, config.baseConfig.rateLimitingKey);
     }
     /**
      * Return the configuration for the orderbook module.
@@ -46319,7 +46335,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.28.1';
+const SDK_VERSION = '1.28.2';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -51514,7 +51530,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.28.1';
+const SDK_VERSION_MARKER = '1.28.2';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 

package/dist/index.js

@@ -23,7 +23,7 @@ import { walletContracts } from '@0xsequence/abi';
 import { v1 } from '@0xsequence/core';
 import FormData$2 from 'form-data';
 import { Seaport as Seaport$1 } from '@opensea/seaport-js';
-import { JsonRpcProvider, JsonRpcSigner } from 'ethers-v6';
+import { FetchRequest, JsonRpcProvider, JsonRpcSigner } from 'ethers-v6';
 import detectEthereumProvider from '@metamask/detect-provider';
 import * as Uniswap from '@uniswap/sdk-core';
 import { TradeType, Percent } from '@uniswap/sdk-core';
@@ -159,7 +159,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.28.1';
+const SDK_VERSION$1 = '1.28.2';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -14311,7 +14311,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$2 = { 'x-sdk-version': 'ts-immutable-sdk-1.28.1' };
+const defaultHeaders$2 = { 'x-sdk-version': 'ts-immutable-sdk-1.28.2' };
 const createConfig$1 = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -14383,7 +14383,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders$1 = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.28.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.28.2',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -14857,7 +14857,7 @@ var blockchain_data = /*#__PURE__*/Object.freeze({
 /* eslint-disable @typescript-eslint/naming-convention */
 class ApiConfiguration extends index$2.Configuration {
 }
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.28.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.28.2' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -14896,7 +14896,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.28.1',
+    sdkVersion: 'ts-immutable-sdk-1.28.2',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({
@@ -28420,11 +28420,13 @@ class Seaport {
     provider;
     seaportContractAddress;
     zoneContractAddress;
-    constructor(seaportLibFactory, provider, seaportContractAddress, zoneContractAddress) {
+    rateLimitingKey;
+    constructor(seaportLibFactory, provider, seaportContractAddress, zoneContractAddress, rateLimitingKey) {
         this.seaportLibFactory = seaportLibFactory;
         this.provider = provider;
         this.seaportContractAddress = seaportContractAddress;
         this.zoneContractAddress = zoneContractAddress;
+        this.rateLimitingKey = rateLimitingKey;
     }
     async prepareSeaportOrder(offerer, listingItem, considerationItem, orderStart, orderExpiry) {
         const { actions: seaportActions } = await this.createSeaportOrder(offerer, listingItem, considerationItem, orderStart, orderExpiry);
@@ -28590,11 +28592,7 @@ class Seaport {
     }
     getSeaportLib(order) {
         const seaportAddress = order?.protocol_data?.seaport_address ?? this.seaportContractAddress;
-        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);
+        return this.seaportLibFactory.create(seaportAddress, this.rateLimitingKey);
     }
     static getExpirationISOTimeFromExtraData(extraData) {
         // Expirtaion bytes in SIP7 extra data [21:29]
@@ -28717,12 +28715,17 @@ class ImmutableApiClientFactory {
     chainName;
     seaportAddress;
     orderbookClient;
-    constructor(apiEndpoint, chainName, seaportAddress) {
+    constructor(apiEndpoint, chainName, seaportAddress, rateLimitingKey) {
         this.chainName = chainName;
         this.seaportAddress = seaportAddress;
         this.orderbookClient = new OrderBookClient({
             // eslint-disable-next-line @typescript-eslint/naming-convention
             BASE: apiEndpoint,
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            HEADERS: rateLimitingKey ? {
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                'x-api-key': rateLimitingKey,
+            } : undefined,
         });
     }
     create() {
@@ -28732,15 +28735,24 @@ class ImmutableApiClientFactory {
 
 const TESTNET_CHAIN_NAME = 'imtbl-zkevm-testnet';
 const MAINNET_CHAIN_NAME = 'imtbl-zkevm-mainnet';
-function getOrderbookConfig(environment) {
-    switch (environment) {
+function getConfiguredProvider(url, rateLimitingKey) {
+    return new providers.JsonRpcProvider({
+        url,
+        headers: rateLimitingKey ? {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            'x-api-key': rateLimitingKey,
+        } : undefined,
+    });
+}
+function getOrderbookConfig(config) {
+    switch (config.baseConfig.environment) {
         case Environment$1.SANDBOX:
             return {
                 seaportContractAddress: '0x7d117aA8BD6D31c4fa91722f246388f38ab1942c',
                 zoneContractAddress: '0x8831867E347AB87FA30199C5B695F0A31604Bb52',
                 apiEndpoint: 'https://api.sandbox.immutable.com',
                 chainName: TESTNET_CHAIN_NAME,
-                provider: new providers.JsonRpcProvider('https://rpc.testnet.immutable.com'),
+                provider: getConfiguredProvider('https://rpc.testnet.immutable.com', config.baseConfig.rateLimitingKey),
             };
         // not yet deployed
         case Environment$1.PRODUCTION:
@@ -28749,7 +28761,7 @@ function getOrderbookConfig(environment) {
                 zoneContractAddress: '0x00338b92Bec262078B3e49BF12bbEA058916BF91',
                 apiEndpoint: 'https://api.immutable.com',
                 chainName: MAINNET_CHAIN_NAME,
-                provider: new providers.JsonRpcProvider('https://rpc.immutable.com'),
+                provider: getConfiguredProvider('https://rpc.immutable.com', config.baseConfig.rateLimitingKey),
             };
         default:
             return null;
@@ -28759,8 +28771,12 @@ function getOrderbookConfig(environment) {
 // The order book module only supports V5 JsonRpcProviders. These are instantiated
 // by the environment or by providing an RPC URL override. For this reason we can
 // safely instantiate a V6 provider for the V5 provider URL.
-function convertToV6Provider(provider) {
-    const overwrittenProvider = new JsonRpcProvider(provider.connection.url);
+function convertToV6Provider(provider, rateLimitingKey) {
+    const fetch = new FetchRequest(provider.connection.url);
+    if (rateLimitingKey) {
+        fetch.setHeader('x-api-key', rateLimitingKey);
+    }
+    const overwrittenProvider = new JsonRpcProvider(fetch);
     // Need to override the getSigner method to mimic V5 behaviour
     overwrittenProvider.getSigner = async function getSigner(address) {
         if (address == null) {
@@ -28790,9 +28806,9 @@ class SeaportLibFactory {
         this.defaultSeaportContractAddress = defaultSeaportContractAddress;
         this.provider = provider;
     }
-    create(orderSeaportVersion, orderSeaportAddress) {
+    create(orderSeaportAddress, rateLimitingKey) {
         const seaportContractAddress = orderSeaportAddress ?? this.defaultSeaportContractAddress;
-        return new Seaport$1(convertToV6Provider(this.provider), {
+        return new Seaport$1(convertToV6Provider(this.provider, rateLimitingKey), {
             balanceAndApprovalChecksOnOrderCreation: true,
             overrides: {
                 contractAddress: seaportContractAddress,
@@ -28811,13 +28827,13 @@ class Orderbook {
     seaport;
     orderbookConfig;
     constructor(config) {
-        const obConfig = getOrderbookConfig(config.baseConfig.environment);
+        const obConfig = getOrderbookConfig(config);
         const finalConfig = {
             ...obConfig,
             ...config.overrides,
         };
         if (config.overrides?.jsonRpcProviderUrl) {
-            finalConfig.provider = new providers.JsonRpcProvider(config.overrides.jsonRpcProviderUrl);
+            finalConfig.provider = getConfiguredProvider(config.overrides?.jsonRpcProviderUrl, config.baseConfig.rateLimitingKey);
         }
         if (!finalConfig) {
             throw new Error('Orderbook configuration not passed, please specify the environment under config.baseConfig.environment');
@@ -28827,9 +28843,9 @@ class Orderbook {
         if (!apiEndpoint) {
             throw new Error('API endpoint must be provided');
         }
-        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, this.orderbookConfig.seaportContractAddress).create();
+        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, this.orderbookConfig.seaportContractAddress, config.baseConfig.rateLimitingKey).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);
+        this.seaport = new Seaport(seaportLibFactory, this.orderbookConfig.provider, this.orderbookConfig.seaportContractAddress, this.orderbookConfig.zoneContractAddress, config.baseConfig.rateLimitingKey);
     }
     /**
      * Return the configuration for the orderbook module.
@@ -46296,7 +46312,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.28.1';
+const SDK_VERSION = '1.28.2';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -51491,7 +51507,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.28.1';
+const SDK_VERSION_MARKER = '1.28.2';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 

package/dist/orderbook.js

@@ -1,10 +1,10 @@
-import { providers, BigNumber, constants as constants$1 } from 'ethers';
 import axios from 'axios';
 import FormData from 'form-data';
+import { providers, BigNumber, constants as constants$1 } from 'ethers';
 import { memorise } from 'lru-memorise';
 import { getGlobalisedValue as getGlobalisedValue$1 } from 'global-const';
 import { Seaport as Seaport$1 } from '@opensea/seaport-js';
-import { JsonRpcProvider, JsonRpcSigner } from 'ethers-v6';
+import { FetchRequest, JsonRpcProvider, JsonRpcSigner } from 'ethers-v6';
 
 const isNode = () => typeof window === 'undefined';
 const isBrowser = () => !isNode();
@@ -132,7 +132,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.28.1';
+const SDK_VERSION = '1.28.2';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -1294,11 +1294,13 @@ class Seaport {
     provider;
     seaportContractAddress;
     zoneContractAddress;
-    constructor(seaportLibFactory, provider, seaportContractAddress, zoneContractAddress) {
+    rateLimitingKey;
+    constructor(seaportLibFactory, provider, seaportContractAddress, zoneContractAddress, rateLimitingKey) {
         this.seaportLibFactory = seaportLibFactory;
         this.provider = provider;
         this.seaportContractAddress = seaportContractAddress;
         this.zoneContractAddress = zoneContractAddress;
+        this.rateLimitingKey = rateLimitingKey;
     }
     async prepareSeaportOrder(offerer, listingItem, considerationItem, orderStart, orderExpiry) {
         const { actions: seaportActions } = await this.createSeaportOrder(offerer, listingItem, considerationItem, orderStart, orderExpiry);
@@ -1464,11 +1466,7 @@ class Seaport {
     }
     getSeaportLib(order) {
         const seaportAddress = order?.protocol_data?.seaport_address ?? this.seaportContractAddress;
-        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);
+        return this.seaportLibFactory.create(seaportAddress, this.rateLimitingKey);
     }
     static getExpirationISOTimeFromExtraData(extraData) {
         // Expirtaion bytes in SIP7 extra data [21:29]
@@ -1591,12 +1589,17 @@ class ImmutableApiClientFactory {
     chainName;
     seaportAddress;
     orderbookClient;
-    constructor(apiEndpoint, chainName, seaportAddress) {
+    constructor(apiEndpoint, chainName, seaportAddress, rateLimitingKey) {
         this.chainName = chainName;
         this.seaportAddress = seaportAddress;
         this.orderbookClient = new OrderBookClient({
             // eslint-disable-next-line @typescript-eslint/naming-convention
             BASE: apiEndpoint,
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            HEADERS: rateLimitingKey ? {
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                'x-api-key': rateLimitingKey,
+            } : undefined,
         });
     }
     create() {
@@ -1606,15 +1609,24 @@ class ImmutableApiClientFactory {
 
 const TESTNET_CHAIN_NAME = 'imtbl-zkevm-testnet';
 const MAINNET_CHAIN_NAME = 'imtbl-zkevm-mainnet';
-function getOrderbookConfig(environment) {
-    switch (environment) {
+function getConfiguredProvider(url, rateLimitingKey) {
+    return new providers.JsonRpcProvider({
+        url,
+        headers: rateLimitingKey ? {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            'x-api-key': rateLimitingKey,
+        } : undefined,
+    });
+}
+function getOrderbookConfig(config) {
+    switch (config.baseConfig.environment) {
         case Environment.SANDBOX:
             return {
                 seaportContractAddress: '0x7d117aA8BD6D31c4fa91722f246388f38ab1942c',
                 zoneContractAddress: '0x8831867E347AB87FA30199C5B695F0A31604Bb52',
                 apiEndpoint: 'https://api.sandbox.immutable.com',
                 chainName: TESTNET_CHAIN_NAME,
-                provider: new providers.JsonRpcProvider('https://rpc.testnet.immutable.com'),
+                provider: getConfiguredProvider('https://rpc.testnet.immutable.com', config.baseConfig.rateLimitingKey),
             };
         // not yet deployed
         case Environment.PRODUCTION:
@@ -1623,7 +1635,7 @@ function getOrderbookConfig(environment) {
                 zoneContractAddress: '0x00338b92Bec262078B3e49BF12bbEA058916BF91',
                 apiEndpoint: 'https://api.immutable.com',
                 chainName: MAINNET_CHAIN_NAME,
-                provider: new providers.JsonRpcProvider('https://rpc.immutable.com'),
+                provider: getConfiguredProvider('https://rpc.immutable.com', config.baseConfig.rateLimitingKey),
             };
         default:
             return null;
@@ -1633,8 +1645,12 @@ function getOrderbookConfig(environment) {
 // The order book module only supports V5 JsonRpcProviders. These are instantiated
 // by the environment or by providing an RPC URL override. For this reason we can
 // safely instantiate a V6 provider for the V5 provider URL.
-function convertToV6Provider(provider) {
-    const overwrittenProvider = new JsonRpcProvider(provider.connection.url);
+function convertToV6Provider(provider, rateLimitingKey) {
+    const fetch = new FetchRequest(provider.connection.url);
+    if (rateLimitingKey) {
+        fetch.setHeader('x-api-key', rateLimitingKey);
+    }
+    const overwrittenProvider = new JsonRpcProvider(fetch);
     // Need to override the getSigner method to mimic V5 behaviour
     overwrittenProvider.getSigner = async function getSigner(address) {
         if (address == null) {
@@ -1664,9 +1680,9 @@ class SeaportLibFactory {
         this.defaultSeaportContractAddress = defaultSeaportContractAddress;
         this.provider = provider;
     }
-    create(orderSeaportVersion, orderSeaportAddress) {
+    create(orderSeaportAddress, rateLimitingKey) {
         const seaportContractAddress = orderSeaportAddress ?? this.defaultSeaportContractAddress;
-        return new Seaport$1(convertToV6Provider(this.provider), {
+        return new Seaport$1(convertToV6Provider(this.provider, rateLimitingKey), {
             balanceAndApprovalChecksOnOrderCreation: true,
             overrides: {
                 contractAddress: seaportContractAddress,
@@ -1685,13 +1701,13 @@ class Orderbook {
     seaport;
     orderbookConfig;
     constructor(config) {
-        const obConfig = getOrderbookConfig(config.baseConfig.environment);
+        const obConfig = getOrderbookConfig(config);
         const finalConfig = {
             ...obConfig,
             ...config.overrides,
         };
         if (config.overrides?.jsonRpcProviderUrl) {
-            finalConfig.provider = new providers.JsonRpcProvider(config.overrides.jsonRpcProviderUrl);
+            finalConfig.provider = getConfiguredProvider(config.overrides?.jsonRpcProviderUrl, config.baseConfig.rateLimitingKey);
         }
         if (!finalConfig) {
             throw new Error('Orderbook configuration not passed, please specify the environment under config.baseConfig.environment');
@@ -1701,9 +1717,9 @@ class Orderbook {
         if (!apiEndpoint) {
             throw new Error('API endpoint must be provided');
         }
-        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, this.orderbookConfig.seaportContractAddress).create();
+        this.apiClient = new ImmutableApiClientFactory(apiEndpoint, chainName, this.orderbookConfig.seaportContractAddress, config.baseConfig.rateLimitingKey).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);
+        this.seaport = new Seaport(seaportLibFactory, this.orderbookConfig.provider, this.orderbookConfig.seaportContractAddress, this.orderbookConfig.zoneContractAddress, config.baseConfig.rateLimitingKey);
     }
     /**
      * Return the configuration for the orderbook module.

package/dist/passport.js

@@ -11563,7 +11563,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.28.1' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.28.2' };
 const createConfig$1 = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -11742,7 +11742,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.28.1';
+const SDK_VERSION = '1.28.2';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -11992,7 +11992,7 @@ const addKeysToHeadersOverride = (baseConfig, overrides) => {
 /* eslint-disable @typescript-eslint/naming-convention */
 class ApiConfiguration extends index$2.Configuration {
 }
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.28.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.28.2' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -12031,7 +12031,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.28.1',
+    sdkVersion: 'ts-immutable-sdk-1.28.2',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({

package/dist/x.js

@@ -9003,7 +9003,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.28.1';
+const SDK_VERSION = '1.28.2';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -9246,7 +9246,7 @@ const addKeysToHeadersOverride = (baseConfig, overrides) => {
 /* eslint-disable @typescript-eslint/naming-convention */
 class ApiConfiguration extends index$2.Configuration {
 }
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.28.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.28.2' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -9285,7 +9285,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.28.1',
+    sdkVersion: 'ts-immutable-sdk-1.28.2',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({

package/package.json

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