@imtbl/sdk 0.28.3-alpha.1 → 0.28.4

package/dist/passport.js

@@ -2072,7 +2072,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.28.3-alpha.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.28.4' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -2128,7 +2128,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.28.3-alpha.1',
+    sdkVersion: 'ts-immutable-sdk-0.28.4',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -2144,9 +2144,9 @@ const production = () => createImmutableXConfiguration({
  */
 const sandbox = () => createImmutableXConfiguration({
     basePath: 'https://api.sandbox.x.immutable.com',
-    chainID: 5,
-    coreContractAddress: '0x7917eDb51ecD6CdB3F9854c3cc593F33de10c623',
-    registrationContractAddress: '0x1C97Ada273C9A52253f463042f29117090Cd7D83',
+    chainID: 11155111,
+    coreContractAddress: '0x2d5C349fD8464DA06a3f90b4B0E9195F3d1b7F98',
+    registrationContractAddress: '0xDbA6129C02E69405622fAdc3d5A7f8d23eac3b97',
 });
 class ImxConfiguration {
     immutableXConfig;
@@ -7061,7 +7061,7 @@ class MagicAdapter {
     magicClient;
     constructor(config) {
         this.config = config;
-        if (window) {
+        if (typeof window !== 'undefined') {
             this.magicClient = this.initMagicClient();
             this.magicClient.preload();
         }
@@ -7297,7 +7297,7 @@ class GuardianClient {
             throw new JsonRpcError(RpcErrorCode.TRANSACTION_REJECTED, transactionRejectedCrossSdkBridgeError);
         }
         if (confirmationRequired && !!messageId) {
-            const confirmationResult = await this.confirmationScreen.requestMessageConfirmation(messageId);
+            const confirmationResult = await this.confirmationScreen.requestMessageConfirmation(messageId, user.zkEvm.ethAddress);
             if (!confirmationResult.confirmed) {
                 throw new JsonRpcError(RpcErrorCode.TRANSACTION_REJECTED, 'Signature rejected by user');
             }
@@ -7581,13 +7581,12 @@ async function batchNftTransfer({ user, starkSigner, request, transfersApi, guar
             }),
             receiver: nftTransfer.receiver,
         }));
-        const getSignableTransferRequestV2 = {
-            sender_ether_key: ethAddress,
-            signable_requests: signableRequests,
-        };
         const headers = { Authorization: `Bearer ${user.accessToken}` };
         const signableResult = await transfersApi.getSignableTransfer({
-            getSignableTransferRequestV2,
+            getSignableTransferRequestV2: {
+                sender_ether_key: ethAddress,
+                signable_requests: signableRequests,
+            },
         }, { headers });
         await guardianClient.evaluateImxTransaction({
             user,
@@ -7758,7 +7757,7 @@ class PassportImxProviderFactory {
         this.passportEventEmitter = passportEventEmitter;
     }
     async getProvider() {
-        const user = await this.authManager.login();
+        const user = await this.authManager.loginSilent() || await this.authManager.login();
         return this.createProviderInstance(user);
     }
     async getProviderSilent() {
@@ -7972,7 +7971,19 @@ class ConfirmationScreen {
     constructor(config) {
         this.config = config;
     }
-    requestConfirmation(transactionId, imxEtherAddress, chainType, chainId) {
+    getHref(relativePath, queryStringParams) {
+        let href = `${this.config.passportDomain}/transaction-confirmation/${relativePath}`;
+        if (queryStringParams) {
+            const queryString = queryStringParams
+                ? Object.keys(queryStringParams)
+                    .map((key) => `${key}=${queryStringParams[key]}`)
+                    .join('&')
+                : '';
+            href = `${href}?${queryString}`;
+        }
+        return href;
+    }
+    requestConfirmation(transactionId, etherAddress, chainType, chainId) {
         return new Promise((resolve, reject) => {
             const messageHandler = ({ data, origin }) => {
                 if (origin !== this.config.passportDomain
@@ -8002,17 +8013,17 @@ class ConfirmationScreen {
             window.addEventListener('message', messageHandler);
             let href = '';
             if (chainType === TransactionApprovalRequestChainTypeEnum.Starkex) {
-                // eslint-disable-next-line max-len
-                href = `${this.config.passportDomain}/transaction-confirmation/transaction?transactionId=${transactionId}&imxEtherAddress=${imxEtherAddress}&chainType=starkex`;
+                href = this.getHref('transaction', { transactionId, etherAddress, chainType });
             }
             else {
-                // eslint-disable-next-line max-len
-                href = `${this.config.passportDomain}/transaction-confirmation/zkevm?transactionId=${transactionId}&imxEtherAddress=${imxEtherAddress}&chainType=evm&chainId=${chainId}`;
+                href = this.getHref('zkevm', {
+                    transactionId, etherAddress, chainType, chainId,
+                });
             }
             this.showConfirmationScreen(href, messageHandler, resolve);
         });
     }
-    requestMessageConfirmation(messageId) {
+    requestMessageConfirmation(messageID, etherAddress) {
         return new Promise((resolve, reject) => {
             const messageHandler = ({ data, origin }) => {
                 if (origin !== this.config.passportDomain
@@ -8040,7 +8051,7 @@ class ConfirmationScreen {
                 return;
             }
             window.addEventListener('message', messageHandler);
-            const href = `${this.config.passportDomain}/transaction-confirmation/zkevm/message?messageID=${messageId}`;
+            const href = this.getHref('zkevm/message', { messageID, etherAddress });
             this.showConfirmationScreen(href, messageHandler, resolve);
         });
     }
@@ -8050,7 +8061,7 @@ class ConfirmationScreen {
             return;
         }
         this.confirmationWindow = openPopupCenter({
-            url: `${this.config.passportDomain}/transaction-confirmation/loading`,
+            url: this.getHref('loading'),
             title: CONFIRMATION_WINDOW_TITLE,
             width: popupOptions?.width || CONFIRMATION_WINDOW_WIDTH,
             height: popupOptions?.height || CONFIRMATION_WINDOW_HEIGHT,
@@ -8063,7 +8074,7 @@ class ConfirmationScreen {
         return new Promise((resolve, rejects) => {
             const iframe = document.createElement('iframe');
             iframe.setAttribute('id', CONFIRMATION_IFRAME_ID);
-            iframe.setAttribute('src', `${this.config.passportDomain}/transaction-confirmation/logout`);
+            iframe.setAttribute('src', this.getHref('logout'));
             iframe.setAttribute('style', CONFIRMATION_IFRAME_STYLE);
             const logoutHandler = ({ data, origin }) => {
                 if (origin !== this.config.passportDomain
@@ -8356,36 +8367,19 @@ const loginZkEvmUser = async ({ authManager, config, magicAdapter, multiRollupAp
 
 const MAX_TRANSACTION_HASH_RETRIEVAL_RETRIES = 30;
 const TRANSACTION_HASH_RETRIEVAL_WAIT = 1000;
-const sendTransaction = ({ params, magicProvider, jsonRpcProvider, relayerClient, guardianClient, user, }) => guardianClient
-    .withConfirmationScreen({ width: 480, height: 520 })(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 chainIdBigNumber = BigNumber.from(chainId);
-    const magicWeb3Provider = new Web3Provider(magicProvider);
-    const signer = magicWeb3Provider.getSigner();
-    const nonce = await getNonce(jsonRpcProvider, user.zkEvm.ethAddress);
-    const metaTransaction = {
-        to: transactionRequest.to,
-        data: transactionRequest.data,
-        nonce,
-        value: transactionRequest.value,
-        revertOnError: true,
-    };
+const getMetaTransactions = async (metaTransaction, nonce, chainId, walletAddress, signer, relayerClient) => {
     // NOTE: We sign the transaction before getting the fee options because
     // accurate estimation of a transaction gas cost is only possible if the smart
     // wallet contract can actually execute it (in a simulated environment) - and
     // it can only execute signed transactions.
-    const signedTransaction = await getSignedMetaTransactions([metaTransaction], nonce, chainIdBigNumber, user.zkEvm.ethAddress, signer);
+    const signedTransaction = await getSignedMetaTransactions([metaTransaction], nonce, chainId, walletAddress, signer);
     // TODO: ID-698 Add support for non-native gas payments (e.g ERC20, feeTransaction initialisation must change)
     // NOTE: "Fee Options" represent the multiple ways we could pay for the gas
     // used in this transaction. Each fee option has a "recipientAddress" we
     // should transfer the payment to, an amount and a currency. We choose one
     // option and build a transaction that sends the expected currency amount for
     // that option to the specified address.
-    const feeOptions = await relayerClient.imGetFeeOptions(user.zkEvm.ethAddress, signedTransaction);
+    const feeOptions = await relayerClient.imGetFeeOptions(walletAddress, signedTransaction);
     const imxFeeOption = feeOptions.find((feeOption) => feeOption.tokenSymbol === 'IMX');
     if (!imxFeeOption) {
         throw new Error('Failed to retrieve fees for IMX token');
@@ -8396,15 +8390,39 @@ const sendTransaction = ({ params, magicProvider, jsonRpcProvider, relayerClient
         value: imxFeeOption.tokenPrice,
         revertOnError: true,
     };
+    if (BigNumber.from(feeMetaTransaction.value).isZero()) {
+        return [metaTransaction];
+    }
+    return [metaTransaction, feeMetaTransaction];
+};
+const sendTransaction = ({ params, magicProvider, jsonRpcProvider, relayerClient, guardianClient, user, }) => guardianClient
+    .withConfirmationScreen({ width: 480, height: 520 })(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 chainIdBigNumber = BigNumber.from(chainId);
+    const magicWeb3Provider = new Web3Provider(magicProvider);
+    const signer = magicWeb3Provider.getSigner();
+    const nonce = await getNonce(jsonRpcProvider, user.zkEvm.ethAddress);
+    const metaTransaction = {
+        to: transactionRequest.to,
+        data: transactionRequest.data,
+        nonce,
+        value: transactionRequest.value,
+        revertOnError: true,
+    };
+    const metaTransactions = await getMetaTransactions(metaTransaction, nonce, chainIdBigNumber, user.zkEvm.ethAddress, signer, relayerClient);
     await guardianClient.validateEVMTransaction({
         chainId: getEip155ChainId(chainId),
         nonce: convertBigNumberishToString(nonce),
         user,
-        metaTransactions: [metaTransaction, feeMetaTransaction],
+        metaTransactions,
     });
     // NOTE: We sign again because we now are adding the fee transaction, so the
     // whole payload is different and needs a new signature.
-    const signedTransactions = await getSignedMetaTransactions([metaTransaction, feeMetaTransaction], nonce, chainIdBigNumber, user.zkEvm.ethAddress, signer);
+    const signedTransactions = await getSignedMetaTransactions(metaTransactions, nonce, chainIdBigNumber, user.zkEvm.ethAddress, signer);
     const relayerId = await relayerClient.ethSendTransaction(user.zkEvm.ethAddress, signedTransactions);
     const retrieveRelayerTransaction = async () => {
         const tx = await relayerClient.imGetTransactionByHash(relayerId);
@@ -8507,7 +8525,17 @@ class ZkEvmProvider {
         this.magicAdapter = magicAdapter;
         this.config = config;
         this.confirmationScreen = confirmationScreen;
-        this.jsonRpcProvider = new JsonRpcProvider(this.config.zkEvmRpcUrl);
+        if (config.crossSdkBridgeEnabled) {
+            // JsonRpcProvider 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({
+                url: this.config.zkEvmRpcUrl,
+                fetchOptions: { referrer: 'http://imtblgamesdk.local' },
+            });
+        }
+        else {
+            this.jsonRpcProvider = new JsonRpcProvider(this.config.zkEvmRpcUrl);
+        }
         this.multiRollupApiClients = multiRollupApiClients;
         this.eventEmitter = new TypedEventEmitter();
         passportEventEmitter.on(PassportEvents.LOGGED_OUT, this.handleLogout);
@@ -8733,15 +8761,16 @@ class Passport {
             passportEventEmitter: this.passportEventEmitter,
         });
     }
+    /**
+     * @deprecated The method `login` with an argument of `{ useCachedSession: true }` should be used in conjunction with
+     * `connectImx` instead.
+     */
     async connectImxSilent() {
         return this.passportImxProviderFactory.getProviderSilent();
     }
     async connectImx() {
         return this.passportImxProviderFactory.getProvider();
     }
-    async loginWithDeviceFlow() {
-        return this.authManager.loginWithDeviceFlow();
-    }
     async connectImxDeviceFlow(deviceCode, interval, timeoutMs) {
         return this.passportImxProviderFactory.getProviderWithDeviceFlow(deviceCode, interval, timeoutMs);
     }
@@ -8773,6 +8802,25 @@ class Passport {
             multiRollupApiClients: this.multiRollupApiClients,
         });
     }
+    /**
+     *
+     * Initiates the authorisation flow.
+     *
+     * @param options.useCachedSession = false - If true, and no active session exists, then the user will not be
+     * prompted to log in and the Promise will resolve with a null value.
+     * @returns {Promise<UserProfile | null>} the user profile if the user is logged in, otherwise null
+     */
+    async login(options) {
+        const { useCachedSession = false } = options || {};
+        let user = await this.authManager.loginSilent();
+        if (!user && !useCachedSession) {
+            user = await this.authManager.login();
+        }
+        return user ? user.profile : null;
+    }
+    async loginWithDeviceFlow() {
+        return this.authManager.loginWithDeviceFlow();
+    }
     async loginCallback() {
         return this.authManager.loginCallback();
     }

package/dist/provider.d.ts

@@ -936,10 +936,14 @@ declare enum Environment {
 }
 declare class ImmutableConfiguration {
     readonly environment: Environment;
+    readonly rateLimitingKey?: string;
     readonly apiKey?: string;
+    readonly clientAppId?: string;
     constructor(options: {
         environment: Environment;
+        rateLimitingKey?: string;
         apiKey?: string;
+        clientAppId?: string;
     });
 }
 interface ModuleConfiguration<T> {

package/dist/provider.js

@@ -5,6 +5,7 @@ import { parseUnits } from '@ethersproject/units';
 import { BigNumber } from '@ethersproject/bignumber';
 import { ethers } from 'ethers';
 import detectEthereumProvider from '@metamask/detect-provider';
+import 'axios';
 
 // used to sign message with L1 keys. Used for registration
 function serializeEthSignature(sig) {
@@ -307,6 +308,8 @@ async function getSignableRegistrationOnchain(etherKey, starkPublicKey, usersApi
     return {
         operator_signature: response.data.operator_signature,
         payload_hash: response.data.payload_hash,
+        readable_transaction: response.data.readable_transaction,
+        verification_signature: response.data.verification_signature,
     };
 }
 

package/package.json

@@ -1,21 +1,18 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.28.3-alpha.1",
+  "version": "0.28.4",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
     "@0xsequence/abi": "^0.43.34",
     "@0xsequence/config": "^0.43.34",
-    "@biom3/design-tokens": "0.2.4-beta",
-    "@biom3/react": "^0.10.12",
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/abstract-signer": "^5.7.0",
     "@ethersproject/providers": "^5.7.2",
     "@ethersproject/wallet": "^5.7.0",
-    "@imtbl/core-sdk": "^2.0.2",
-    "@imtbl/react-analytics": "0.0.5-alpha",
+    "@imtbl/core-sdk": "^2.4.0",
     "@jest/globals": "^29.5.0",
     "@magic-ext/oidc": "^1.0.1",
     "@metamask/detect-provider": "^2.0.0",
@@ -23,25 +20,13 @@
     "@uniswap/router-sdk": "^1.4.0",
     "@uniswap/sdk-core": "^3.0.1",
     "@uniswap/v3-sdk": "^3.9.0",
-    "assert": "^2.0.0",
     "axios": "^1.3.5",
     "bn.js": "^5.2.1",
-    "buffer": "^6.0.3",
-    "crypto-browserify": "^3.12.0",
     "enc-utils": "^3.0.0",
     "ethers": "^5.7.2",
-    "https-browserify": "^1.0.0",
     "jwt-decode": "^3.1.2",
     "magic-sdk": "^13.3.1",
-    "oidc-client-ts": "^2.2.1",
-    "os-browserify": "^0.3.0",
-    "pako": "^2.1.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-router-dom": "^6.11.0",
-    "stream-browserify": "^3.0.0",
-    "stream-http": "^3.2.0",
-    "url": "^0.11.0"
+    "oidc-client-ts": "^2.2.1"
   },
   "devDependencies": {
     "@imtbl/blockchain-data": "0.0.0",
@@ -109,6 +94,10 @@
     "./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"
     }
   },
   "files": [