@imtbl/sdk 0.28.1-alpha → 0.28.3

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.1-alpha' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.28.3' };
 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.1-alpha',
+    sdkVersion: 'ts-immutable-sdk-0.28.3',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -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,
@@ -8368,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');
@@ -8408,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);
@@ -8755,33 +8761,16 @@ class Passport {
             passportEventEmitter: this.passportEventEmitter,
         });
     }
-    async signIn(options) {
-        const { useCachedSession = false } = options || {};
-        let user = await this.authManager.loginSilent();
-        if (!user && !useCachedSession) {
-            user = await this.authManager.login();
-        }
-        if (!user) {
-            return null;
-        }
-        return user.profile;
-    }
     /**
-     * @deprecated The method connectImx(useCachedSession) should be used instead
+     * @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(options) {
-        const { useCachedSession = false } = options || {};
-        if (useCachedSession) {
-            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);
     }
@@ -8813,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,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.28.1-alpha",
+  "version": "0.28.3",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
@@ -12,7 +12,7 @@
     "@ethersproject/abstract-signer": "^5.7.0",
     "@ethersproject/providers": "^5.7.2",
     "@ethersproject/wallet": "^5.7.0",
-    "@imtbl/core-sdk": "^2.0.2",
+    "@imtbl/core-sdk": "^2.4.0",
     "@jest/globals": "^29.5.0",
     "@magic-ext/oidc": "^1.0.1",
     "@metamask/detect-provider": "^2.0.0",

package/dist/global.d.ts

@@ -1,42 +0,0 @@
-/* eslint-disable @typescript-eslint/naming-convention */
-import {
-  ImtblConnectProps,
-  ImtblWalletProps,
-  ImtblSwapProps,
-  ImtblBridgeProps,
-  ImtblOnRampProps,
-  // ImtblExampleProps,
-  // ImtblBuyProps,
-  // ImtblTransitionExampleProps,
-  // ImtblInnerWidgetExampleProps,
-  // ImtblOuterWidgetExampleProps,
-  ImtblSaleProps,
-} from '@imtbl/checkout-widgets';
-
-declare global {
-  interface Window {
-    ImtblCheckoutWidgetConfig: any;
-  }
-  namespace JSX {
-    interface IntrinsicElements {
-      'imtbl-connect': ImtblConnectProps;
-      'imtbl-wallet': ImtblWalletProps;
-      'imtbl-swap': ImtblSwapProps;
-      'imtbl-bridge': ImtblBridgeProps;
-      'imtbl-onramp': ImtblOnRampProps;
-      // 'imtbl-buy': ImtblBuyProps;
-      'imtbl-sale': ImtblSaleProps;
-      // 'imtbl-example': ImtblExampleProps;
-      // 'imtbl-transition-example': ImtblTransitionExampleProps;
-      // 'imtbl-inner-widget-example': ImtblInnerWidgetExampleProps;
-      // 'imtbl-outer-widget-example': ImtblOuterWidgetExampleProps;
-    }
-  }
-  interface ImmutableWebComponent {
-    setProvider: Function;
-    addPassportOption: Function;
-    setAttribute: Function;
-  }
-}
-
-export {};