@imtbl/sdk 0.28.0 → 0.28.1-alpha

package/dist/index.cjs

@@ -3632,7 +3632,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.28.0' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.28.1-alpha' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -3692,7 +3692,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.28.0',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.28.1-alpha',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4103,7 +4103,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.28.0',
+    sdkVersion: 'ts-immutable-sdk-0.28.1-alpha',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -9750,7 +9750,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() {
@@ -10747,10 +10747,28 @@ 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
+     */
     async connectImxSilent() {
         return this.passportImxProviderFactory.getProviderSilent();
     }
-    async connectImx() {
+    async connectImx(options) {
+        const { useCachedSession = false } = options || {};
+        if (useCachedSession) {
+            return this.passportImxProviderFactory.getProviderSilent();
+        }
         return this.passportImxProviderFactory.getProvider();
     }
     async loginWithDeviceFlow() {
@@ -25945,15 +25963,6 @@ class ApproveError extends ExchangeError {
         super(message, ExchangeErrorCode.APPROVE_ERROR);
     }
 }
-class AlreadyApprovedError extends ExchangeError {
-    tokenAddress;
-    spenderAddress;
-    constructor(amountApproved, tokenAddress, spenderAddress) {
-        super(`already approved ${amountApproved} tokens`, ExchangeErrorCode.ALREADY_APPROVED_ERROR);
-        this.tokenAddress = tokenAddress;
-        this.spenderAddress = spenderAddress;
-    }
-}
 
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
@@ -28587,8 +28596,7 @@ const calculateGasFee = (gasPrice, gasEstimate) =>
 newAmount(gasEstimate.mul(gasPrice.value), gasPrice.token);
 
 /**
- * Get the amount of an ERC20 token that needs to be approved by
- * checking the existing allowance for the spender
+ * Check if the spender needs approval for the token
  *
  * @param provider - The provider to use for the call
  * @param ownerAddress - The address of the owner of the token
@@ -28596,11 +28604,11 @@ newAmount(gasEstimate.mul(gasPrice.value), gasPrice.token);
  * @param spenderAddress - The address of the spender
  * @returns - The amount of the token that needs to be approved
  */
-const getERC20AmountToApprove = async (provider, ownerAddress, tokenAmount, spenderAddress) => {
+const doesSpenderNeedApproval = async (provider, ownerAddress, tokenAmount, spenderAddress) => {
     // create an instance of the ERC20 token contract
     const erc20Contract = ERC20__factory.connect(tokenAmount.token.address, provider);
     // get the allowance for the token spender
-    // minimum is 0 - no allowance
+    // the minimum allowance is 0 - no allowance
     let allowance;
     try {
         allowance = await erc20Contract.allowance(ownerAddress, spenderAddress);
@@ -28609,12 +28617,12 @@ const getERC20AmountToApprove = async (provider, ownerAddress, tokenAmount, spen
         const message = e instanceof Error ? e.message : 'Unknown Error';
         throw new ApproveError(`failed to get allowance: ${message}`);
     }
-    // get the amount that needs to be approved
+    // check if approval is needed
     const requiredAmount = tokenAmount.value.sub(allowance);
     if (requiredAmount.isNegative() || requiredAmount.isZero()) {
-        throw new AlreadyApprovedError(tokenAmount.toString(), tokenAmount.token.address, spenderAddress);
+        return false;
     }
-    return newAmount(requiredAmount, tokenAmount.token);
+    return true;
 };
 /**
  * Get an unsigned ERC20 approve transaction
@@ -28656,18 +28664,9 @@ const prepareApproval = (tradeType, userSpecifiedAmount, quotedAmountWithSlippag
  * @returns The unsigned ERC20 approve transaction, or null if no approval is needed
  */
 const getApproveTransaction = async (provider, ownerAddress, tokenAmount, spenderAddress) => {
-    let amountToApprove;
-    try {
-        amountToApprove = await getERC20AmountToApprove(provider, ownerAddress, tokenAmount, spenderAddress);
-    }
-    catch (e) {
-        if (e instanceof AlreadyApprovedError) {
-            // already approved for the required amount, nothing to do
-            return null;
-        }
-        throw e;
-    }
-    return getUnsignedERC20ApproveTransaction(ownerAddress, amountToApprove, spenderAddress);
+    const needsApproval = await doesSpenderNeedApproval(provider, ownerAddress, tokenAmount, spenderAddress);
+    // @dev approvals are not additive, so we need to approve the full amount
+    return needsApproval ? getUnsignedERC20ApproveTransaction(ownerAddress, tokenAmount, spenderAddress) : null;
 };
 async function getApproveGasEstimate(provider, ownerAddress, spenderAddress, tokenAddress) {
     const erc20Contract = ERC20__factory.connect(tokenAddress, provider);
@@ -33559,7 +33558,7 @@ var $045213b18e9f1f94$export$75be0f6af9650f2c;
 })($045213b18e9f1f94$export$75be0f6af9650f2c || ($045213b18e9f1f94$export$75be0f6af9650f2c = {}));
 
 
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.28.0";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.28.1-alpha";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/index.d.ts

@@ -14961,8 +14961,16 @@ declare class Passport {
     private readonly passportImxProviderFactory;
     private readonly passportEventEmitter;
     constructor(passportModuleConfiguration: PassportModuleConfiguration);
+    signIn(options?: {
+        useCachedSession: boolean;
+    }): Promise<UserProfile | null>;
+    /**
+     * @deprecated The method connectImx(useCachedSession) should be used instead
+     */
     connectImxSilent(): Promise<IMXProvider | null>;
-    connectImx(): Promise<IMXProvider>;
+    connectImx(options?: {
+        useCachedSession: boolean;
+    }): Promise<IMXProvider | null>;
     loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
     connectImxDeviceFlow(deviceCode: string, interval: number, timeoutMs?: number): Promise<IMXProvider | null>;
     getPKCEAuthorizationUrl(): string;

package/dist/index.js

@@ -3610,7 +3610,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.28.0' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.28.1-alpha' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -3670,7 +3670,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.28.0',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.28.1-alpha',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4081,7 +4081,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.28.0',
+    sdkVersion: 'ts-immutable-sdk-0.28.1-alpha',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -9728,7 +9728,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() {
@@ -10725,10 +10725,28 @@ 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
+     */
     async connectImxSilent() {
         return this.passportImxProviderFactory.getProviderSilent();
     }
-    async connectImx() {
+    async connectImx(options) {
+        const { useCachedSession = false } = options || {};
+        if (useCachedSession) {
+            return this.passportImxProviderFactory.getProviderSilent();
+        }
         return this.passportImxProviderFactory.getProvider();
     }
     async loginWithDeviceFlow() {
@@ -25923,15 +25941,6 @@ class ApproveError extends ExchangeError {
         super(message, ExchangeErrorCode.APPROVE_ERROR);
     }
 }
-class AlreadyApprovedError extends ExchangeError {
-    tokenAddress;
-    spenderAddress;
-    constructor(amountApproved, tokenAddress, spenderAddress) {
-        super(`already approved ${amountApproved} tokens`, ExchangeErrorCode.ALREADY_APPROVED_ERROR);
-        this.tokenAddress = tokenAddress;
-        this.spenderAddress = spenderAddress;
-    }
-}
 
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
@@ -28565,8 +28574,7 @@ const calculateGasFee = (gasPrice, gasEstimate) =>
 newAmount(gasEstimate.mul(gasPrice.value), gasPrice.token);
 
 /**
- * Get the amount of an ERC20 token that needs to be approved by
- * checking the existing allowance for the spender
+ * Check if the spender needs approval for the token
  *
  * @param provider - The provider to use for the call
  * @param ownerAddress - The address of the owner of the token
@@ -28574,11 +28582,11 @@ newAmount(gasEstimate.mul(gasPrice.value), gasPrice.token);
  * @param spenderAddress - The address of the spender
  * @returns - The amount of the token that needs to be approved
  */
-const getERC20AmountToApprove = async (provider, ownerAddress, tokenAmount, spenderAddress) => {
+const doesSpenderNeedApproval = async (provider, ownerAddress, tokenAmount, spenderAddress) => {
     // create an instance of the ERC20 token contract
     const erc20Contract = ERC20__factory.connect(tokenAmount.token.address, provider);
     // get the allowance for the token spender
-    // minimum is 0 - no allowance
+    // the minimum allowance is 0 - no allowance
     let allowance;
     try {
         allowance = await erc20Contract.allowance(ownerAddress, spenderAddress);
@@ -28587,12 +28595,12 @@ const getERC20AmountToApprove = async (provider, ownerAddress, tokenAmount, spen
         const message = e instanceof Error ? e.message : 'Unknown Error';
         throw new ApproveError(`failed to get allowance: ${message}`);
     }
-    // get the amount that needs to be approved
+    // check if approval is needed
     const requiredAmount = tokenAmount.value.sub(allowance);
     if (requiredAmount.isNegative() || requiredAmount.isZero()) {
-        throw new AlreadyApprovedError(tokenAmount.toString(), tokenAmount.token.address, spenderAddress);
+        return false;
     }
-    return newAmount(requiredAmount, tokenAmount.token);
+    return true;
 };
 /**
  * Get an unsigned ERC20 approve transaction
@@ -28634,18 +28642,9 @@ const prepareApproval = (tradeType, userSpecifiedAmount, quotedAmountWithSlippag
  * @returns The unsigned ERC20 approve transaction, or null if no approval is needed
  */
 const getApproveTransaction = async (provider, ownerAddress, tokenAmount, spenderAddress) => {
-    let amountToApprove;
-    try {
-        amountToApprove = await getERC20AmountToApprove(provider, ownerAddress, tokenAmount, spenderAddress);
-    }
-    catch (e) {
-        if (e instanceof AlreadyApprovedError) {
-            // already approved for the required amount, nothing to do
-            return null;
-        }
-        throw e;
-    }
-    return getUnsignedERC20ApproveTransaction(ownerAddress, amountToApprove, spenderAddress);
+    const needsApproval = await doesSpenderNeedApproval(provider, ownerAddress, tokenAmount, spenderAddress);
+    // @dev approvals are not additive, so we need to approve the full amount
+    return needsApproval ? getUnsignedERC20ApproveTransaction(ownerAddress, tokenAmount, spenderAddress) : null;
 };
 async function getApproveGasEstimate(provider, ownerAddress, spenderAddress, tokenAddress) {
     const erc20Contract = ERC20__factory.connect(tokenAddress, provider);
@@ -33537,7 +33536,7 @@ var $045213b18e9f1f94$export$75be0f6af9650f2c;
 })($045213b18e9f1f94$export$75be0f6af9650f2c || ($045213b18e9f1f94$export$75be0f6af9650f2c = {}));
 
 
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.28.0";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.28.1-alpha";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/passport.d.ts

@@ -10608,8 +10608,16 @@ declare class Passport {
     private readonly passportImxProviderFactory;
     private readonly passportEventEmitter;
     constructor(passportModuleConfiguration: PassportModuleConfiguration);
+    signIn(options?: {
+        useCachedSession: boolean;
+    }): Promise<UserProfile | null>;
+    /**
+     * @deprecated The method connectImx(useCachedSession) should be used instead
+     */
     connectImxSilent(): Promise<IMXProvider | null>;
-    connectImx(): Promise<IMXProvider>;
+    connectImx(options?: {
+        useCachedSession: boolean;
+    }): Promise<IMXProvider | null>;
     loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
     connectImxDeviceFlow(deviceCode: string, interval: number, timeoutMs?: number): Promise<IMXProvider | null>;
     getPKCEAuthorizationUrl(): string;

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.0' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.28.1-alpha' };
 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.0',
+    sdkVersion: 'ts-immutable-sdk-0.28.1-alpha',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -7758,7 +7758,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() {
@@ -8755,10 +8755,28 @@ 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
+     */
     async connectImxSilent() {
         return this.passportImxProviderFactory.getProviderSilent();
     }
-    async connectImx() {
+    async connectImx(options) {
+        const { useCachedSession = false } = options || {};
+        if (useCachedSession) {
+            return this.passportImxProviderFactory.getProviderSilent();
+        }
         return this.passportImxProviderFactory.getProvider();
     }
     async loginWithDeviceFlow() {

package/package.json

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