@imtbl/sdk 1.20.3-alpha → 1.20.4

package/dist/passport.js

@@ -10,7 +10,7 @@ import hashJS from 'hash.js';
 import { ec, curves } from 'elliptic';
 import 'ethereumjs-wallet';
 import 'assert';
-import { BigNumber, Contract, errors, utils as utils$2, ethers, constants } from 'ethers';
+import { utils as utils$2, BigNumber, Contract, errors, ethers, constants } from 'ethers';
 import '@ethersproject/abstract-signer';
 import { UserManager, User, ErrorTimeout, ErrorResponse, InMemoryWebStorage, WebStorageStateStore } from 'oidc-client-ts';
 import jwt_decode from 'jwt-decode';
@@ -18,7 +18,7 @@ import * as crypto from 'crypto';
 import { Magic } from 'magic-sdk';
 import { OpenIdExtension } from '@magic-ext/oidc';
 import { generateLegacyStarkPrivateKey, createStarkSigner } from '@imtbl/core-sdk';
-import { JsonRpcProvider, Web3Provider } from '@ethersproject/providers';
+import { StaticJsonRpcProvider, Web3Provider } from '@ethersproject/providers';
 import { EventEmitter } from 'events';
 import { walletContracts } from '@0xsequence/abi';
 import { v1 } from '@0xsequence/core';
@@ -11350,7 +11350,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.20.3-alpha' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.20.4' };
 const createConfig$1 = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -11529,7 +11529,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.20.3-alpha';
+const SDK_VERSION = '1.20.4';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -11779,7 +11779,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.20.3-alpha' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.20.4' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -11818,7 +11818,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.20.3-alpha',
+    sdkVersion: 'ts-immutable-sdk-1.20.4',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({
@@ -20596,9 +20596,9 @@ function digestOfTransactionsAndNonce(nonce, normalisedTransactions) {
     const packMetaTransactionsNonceData = utils$2.defaultAbiCoder.encode(['uint256', META_TRANSACTIONS_TYPE], [nonce, normalisedTransactions]);
     return utils$2.keccak256(packMetaTransactionsNonceData);
 }
-const getNonce = async (jsonRpcProvider, smartContractWalletAddress) => {
+const getNonce = async (rpcProvider, smartContractWalletAddress) => {
     try {
-        const contract = new Contract(smartContractWalletAddress, walletContracts.mainModule.abi, jsonRpcProvider);
+        const contract = new Contract(smartContractWalletAddress, walletContracts.mainModule.abi, rpcProvider);
         const result = await contract.nonce();
         if (result instanceof BigNumber) {
             return result;
@@ -20700,11 +20700,11 @@ const getEip155ChainId = (chainId) => `eip155:${chainId}`;
 
 class RelayerClient {
     config;
-    jsonRpcProvider;
+    rpcProvider;
     authManager;
-    constructor({ config, jsonRpcProvider, authManager }) {
+    constructor({ config, rpcProvider, authManager }) {
         this.config = config;
-        this.jsonRpcProvider = jsonRpcProvider;
+        this.rpcProvider = rpcProvider;
         this.authManager = authManager;
     }
     async postToRelayer(request) {
@@ -20729,7 +20729,7 @@ class RelayerClient {
         return jsonResponse;
     }
     async ethSendTransaction(to, data) {
-        const { chainId } = await this.jsonRpcProvider.ready;
+        const { chainId } = await this.rpcProvider.detectNetwork();
         const payload = {
             method: 'eth_sendTransaction',
             params: [{
@@ -20750,7 +20750,7 @@ class RelayerClient {
         return result;
     }
     async imGetFeeOptions(userAddress, data) {
-        const { chainId } = await this.jsonRpcProvider.ready;
+        const { chainId } = await this.rpcProvider.detectNetwork();
         const payload = {
             method: 'im_getFeeOptions',
             params: [{
@@ -20763,7 +20763,7 @@ class RelayerClient {
         return result;
     }
     async imSignTypedData(address, eip712Payload) {
-        const { chainId } = await this.jsonRpcProvider.ready;
+        const { chainId } = await this.rpcProvider.detectNetwork();
         const payload = {
             method: 'im_signTypedData',
             params: [{
@@ -20810,11 +20810,11 @@ class JsonRpcError extends Error {
 }
 
 const MESSAGE_TO_SIGN = 'Only sign this message from Immutable Passport';
-async function registerZkEvmUser({ authManager, ethSigner, multiRollupApiClients, accessToken, jsonRpcProvider, }) {
+async function registerZkEvmUser({ authManager, ethSigner, multiRollupApiClients, accessToken, rpcProvider, }) {
     const [ethereumAddress, ethereumSignature, network, chainListResponse] = await Promise.all([
         ethSigner.getAddress(),
         signRaw(MESSAGE_TO_SIGN, ethSigner),
-        jsonRpcProvider.ready,
+        rpcProvider.detectNetwork(),
         multiRollupApiClients.chainsApi.listChains(),
     ]);
     const eipChainId = getEip155ChainId(network.chainId);
@@ -21035,15 +21035,15 @@ const getMetaTransactions = async (metaTransaction, nonce, chainId, walletAddres
     }
     return [metaTransaction, feeMetaTransaction];
 };
-const sendTransaction = ({ params, ethSigner, jsonRpcProvider, relayerClient, guardianClient, zkevmAddress, }) => guardianClient
+const sendTransaction = ({ params, ethSigner, rpcProvider, relayerClient, guardianClient, zkevmAddress, }) => guardianClient
     .withConfirmationScreen({ width: 480, height: 720 })(async () => {
     const transactionRequest = params[0];
     if (!transactionRequest.to) {
         throw new JsonRpcError(RpcErrorCode.INVALID_PARAMS, 'eth_sendTransaction requires a "to" field');
     }
-    const { chainId } = await jsonRpcProvider.ready;
+    const { chainId } = await rpcProvider.detectNetwork();
     const chainIdBigNumber = BigNumber.from(chainId);
-    const nonce = await getNonce(jsonRpcProvider, zkevmAddress);
+    const nonce = await getNonce(rpcProvider, zkevmAddress);
     const metaTransaction = {
         to: transactionRequest.to,
         data: transactionRequest.data,
@@ -21131,14 +21131,14 @@ const transformTypedData = (typedData, chainId) => {
     }
     return transformedTypedData;
 };
-const signTypedDataV4 = async ({ params, method, ethSigner, jsonRpcProvider, relayerClient, guardianClient, }) => guardianClient
+const signTypedDataV4 = async ({ params, method, ethSigner, rpcProvider, relayerClient, guardianClient, }) => guardianClient
     .withConfirmationScreen({ width: 480, height: 720 })(async () => {
     const fromAddress = params[0];
     const typedDataParam = params[1];
     if (!fromAddress || !typedDataParam) {
         throw new JsonRpcError(RpcErrorCode.INVALID_PARAMS, `${method} requires an address and a typed data JSON`);
     }
-    const { chainId } = await jsonRpcProvider.ready;
+    const { chainId } = await rpcProvider.detectNetwork();
     const typedData = transformTypedData(typedDataParam, chainId);
     await guardianClient.validateMessage({ chainID: String(chainId), payload: typedData });
     const relayerSignature = await relayerClient.imSignTypedData(fromAddress, typedData);
@@ -21151,7 +21151,7 @@ class ZkEvmProvider {
     #config;
     #eventEmitter;
     #guardianClient;
-    #jsonRpcProvider; // Used for read
+    #rpcProvider; // Used for read
     #magicAdapter;
     #multiRollupApiClients;
     #relayerClient;
@@ -21171,19 +21171,19 @@ class ZkEvmProvider {
         this.#config = config;
         this.#guardianClient = guardianClient;
         if (config.crossSdkBridgeEnabled) {
-            // JsonRpcProvider by default sets the referrer as "client".
+            // StaticJsonRpcProvider by default sets the referrer as "client".
             // On Unreal 4 this errors as the browser used is expecting a valid URL.
-            this.#jsonRpcProvider = new JsonRpcProvider({
+            this.#rpcProvider = new StaticJsonRpcProvider({
                 url: this.#config.zkEvmRpcUrl,
                 fetchOptions: { referrer: 'http://imtblgamesdk.local' },
             });
         }
         else {
-            this.#jsonRpcProvider = new JsonRpcProvider(this.#config.zkEvmRpcUrl);
+            this.#rpcProvider = new StaticJsonRpcProvider(this.#config.zkEvmRpcUrl);
         }
         this.#relayerClient = new RelayerClient({
             config: this.#config,
-            jsonRpcProvider: this.#jsonRpcProvider,
+            rpcProvider: this.#rpcProvider,
             authManager: this.#authManager,
         });
         this.#multiRollupApiClients = multiRollupApiClients;
@@ -21254,7 +21254,7 @@ class ZkEvmProvider {
                         authManager: this.#authManager,
                         multiRollupApiClients: this.#multiRollupApiClients,
                         accessToken: user.accessToken,
-                        jsonRpcProvider: this.#jsonRpcProvider,
+                        rpcProvider: this.#rpcProvider,
                     });
                 }
                 else {
@@ -21272,7 +21272,7 @@ class ZkEvmProvider {
                     params: request.params || [],
                     ethSigner,
                     guardianClient: this.#guardianClient,
-                    jsonRpcProvider: this.#jsonRpcProvider,
+                    rpcProvider: this.#rpcProvider,
                     relayerClient: this.#relayerClient,
                     zkevmAddress: this.#zkEvmAddress,
                 });
@@ -21290,11 +21290,21 @@ class ZkEvmProvider {
                     method: request.method,
                     params: request.params || [],
                     ethSigner,
-                    jsonRpcProvider: this.#jsonRpcProvider,
+                    rpcProvider: this.#rpcProvider,
                     relayerClient: this.#relayerClient,
                     guardianClient: this.#guardianClient,
                 });
             }
+            case 'eth_chainId': {
+                // Call detect network to fetch the chainId so to take advantage of
+                // the caching layer provided by StaticJsonRpcProvider.
+                // In case Passport is changed from StaticJsonRpcProvider to a
+                // JsonRpcProvider, this function will still work as expected given
+                // that detectNetwork call _uncachedDetectNetwork which will force
+                // the provider to re-fetch the chainId from remote.
+                const { chainId } = await this.#rpcProvider.detectNetwork();
+                return utils$2.hexlify(chainId);
+            }
             // Pass through methods
             case 'eth_gasPrice':
             case 'eth_getBalance':
@@ -21303,13 +21313,12 @@ class ZkEvmProvider {
             case 'eth_estimateGas':
             case 'eth_call':
             case 'eth_blockNumber':
-            case 'eth_chainId':
             case 'eth_getBlockByHash':
             case 'eth_getBlockByNumber':
             case 'eth_getTransactionByHash':
             case 'eth_getTransactionReceipt':
             case 'eth_getTransactionCount': {
-                return this.#jsonRpcProvider.send(request.method, request.params || []);
+                return this.#rpcProvider.send(request.method, request.params || []);
             }
             default: {
                 throw new JsonRpcError(ProviderErrorCode.UNSUPPORTED_METHOD, 'Method not supported');

package/dist/x.js

@@ -8953,7 +8953,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.20.3-alpha';
+const SDK_VERSION = '1.20.4';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -9196,7 +9196,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.20.3-alpha' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.20.4' };
 /**
  * @dev use createImmutableXConfiguration instead
  */
@@ -9235,7 +9235,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.20.3-alpha',
+    sdkVersion: 'ts-immutable-sdk-1.20.4',
     baseConfig,
 });
 const production = ({ baseConfig }) => createImmutableXConfiguration({

package/package.json

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

package/dist/browser/checkout/index-01833964.js

@@ -1 +0,0 @@
-import{cs as n,ct as t}from"./index-e3a0f33f.js";function i(i){return n(this,void 0,void 0,(function(){var n;return t(this,(function(t){switch(t.label){case 0:return[4,import("./index.umd-b2990cfb.js").then((function(n){return n.i}))];case 1:return n=t.sent(),i._plugins=n,[2]}}))}))}export{i as loadLegacyVideoPlugins};