@lifi/sdk 1.1.5 → 1.2.1

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.2.1](https://github.com/lifinance/sdk/compare/v1.2.0...v1.2.1) (2022-08-22)
+
+## [1.2.0](https://github.com/lifinance/sdk/compare/v1.1.6...v1.2.0) (2022-08-22)
+
+
+### Features
+
+* add version check ([#102](https://github.com/lifinance/sdk/issues/102)) ([dbc0fc5](https://github.com/lifinance/sdk/commit/dbc0fc5805a2d6c9b3da8547d44c3e93f1a3b8ed))
+
+### [1.1.6](https://github.com/lifinance/sdk/compare/v1.1.5...v1.1.6) (2022-08-19)
+
 ### [1.1.5](https://github.com/lifinance/sdk/compare/v1.1.4...v1.1.5) (2022-08-19)
 
 ### [1.1.4](https://github.com/lifinance/sdk/compare/v1.1.3...v1.1.4) (2022-08-19)

package/dist/Lifi.js

@@ -12,6 +12,7 @@ import balances from './balances';
 import { getRpcProvider } from './connectors';
 import { StatusManager } from './execution/StatusManager';
 import { StepExecutor } from './execution/StepExecutor';
+import { checkPackageUpdates } from './helpers';
 import ApiService from './services/ApiService';
 import ChainsService from './services/ChainsService';
 import ConfigService from './services/ConfigService';
@@ -19,6 +20,7 @@ import { isToken } from './typeguards';
 import { ValidationError } from './utils/errors';
 import { handlePreRestart } from './utils/preRestart';
 import { deepClone } from './utils/utils';
+import { name, version } from './version';
 export default class LIFI {
     constructor(configUpdate) {
         this.activeRouteDictionary = {};
@@ -366,5 +368,6 @@ export default class LIFI {
         this.chainsService.getChains().then((chains) => {
             this.configService.updateChains(chains);
         });
+        checkPackageUpdates(name, version, configUpdate === null || configUpdate === void 0 ? void 0 : configUpdate.disableVersionCheck);
     }
 }

package/dist/cjs/Lifi.js

@@ -17,6 +17,7 @@ const balances_1 = __importDefault(require("./balances"));
 const connectors_1 = require("./connectors");
 const StatusManager_1 = require("./execution/StatusManager");
 const StepExecutor_1 = require("./execution/StepExecutor");
+const helpers_1 = require("./helpers");
 const ApiService_1 = __importDefault(require("./services/ApiService"));
 const ChainsService_1 = __importDefault(require("./services/ChainsService"));
 const ConfigService_1 = __importDefault(require("./services/ConfigService"));
@@ -24,6 +25,7 @@ const typeguards_1 = require("./typeguards");
 const errors_1 = require("./utils/errors");
 const preRestart_1 = require("./utils/preRestart");
 const utils_1 = require("./utils/utils");
+const version_1 = require("./version");
 class LIFI {
     constructor(configUpdate) {
         this.activeRouteDictionary = {};
@@ -371,6 +373,7 @@ class LIFI {
         this.chainsService.getChains().then((chains) => {
             this.configService.updateChains(chains);
         });
+        (0, helpers_1.checkPackageUpdates)(version_1.name, version_1.version, configUpdate === null || configUpdate === void 0 ? void 0 : configUpdate.disableVersionCheck);
     }
 }
 exports.default = LIFI;

package/dist/cjs/helpers.d.ts

@@ -16,3 +16,4 @@ export declare const getEthereumPublicKeyHook: (walletAddress: string) => () =>
  */
 export declare const getRandomNumber: (min: number, max: number) => number;
 export declare const isSameToken: (tokenA: Token, tokenB: Token) => boolean;
+export declare const checkPackageUpdates: (packageName?: string, packageVersion?: string, disableCheck?: boolean) => Promise<void>;

package/dist/cjs/helpers.js

@@ -9,7 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSameToken = exports.getRandomNumber = exports.getEthereumPublicKeyHook = exports.getEthereumDecryptionHook = void 0;
+exports.checkPackageUpdates = exports.isSameToken = exports.getRandomNumber = exports.getEthereumPublicKeyHook = exports.getEthereumDecryptionHook = void 0;
+const version_1 = require("./version");
 const ethereumRequest = (method, params) => __awaiter(void 0, void 0, void 0, function* () {
     // If ethereum.request() exists, the provider is probably EIP-1193 compliant.
     if (!ethereum || !ethereum.request) {
@@ -52,3 +53,36 @@ exports.getRandomNumber = getRandomNumber;
 const isSameToken = (tokenA, tokenB) => tokenA.chainId === tokenB.chainId &&
     tokenA.address.toLowerCase() === tokenB.address.toLowerCase();
 exports.isSameToken = isSameToken;
+function semverCompare(a, b) {
+    if (a.startsWith(b + '-')) {
+        return -1;
+    }
+    if (b.startsWith(a + '-')) {
+        return 1;
+    }
+    return a.localeCompare(b, undefined, {
+        numeric: true,
+        sensitivity: 'case',
+        caseFirst: 'upper',
+    });
+}
+const checkPackageUpdates = (packageName, packageVersion, disableCheck) => __awaiter(void 0, void 0, void 0, function* () {
+    if (disableCheck || process.env.NODE_ENV !== 'development') {
+        return;
+    }
+    try {
+        const pkgName = packageName !== null && packageName !== void 0 ? packageName : version_1.name;
+        const response = yield (yield fetch(`https://registry.npmjs.org/${pkgName}/latest`)).json();
+        const latestVersion = response.version;
+        const currentVersion = packageVersion !== null && packageVersion !== void 0 ? packageVersion : version_1.version;
+        if (semverCompare(latestVersion, currentVersion)) {
+            console.warn(
+            // eslint-disable-next-line max-len
+            `${pkgName}: new package version is available. Please update as soon as possible to enjoy the newest features. Current version: ${currentVersion}. Latest version: ${latestVersion}.`);
+        }
+    }
+    catch (error) {
+        // Cannot verify version, might be network error etc. We don't bother showing anything in that case
+    }
+});
+exports.checkPackageUpdates = checkPackageUpdates;

package/dist/cjs/types/internal.types.d.ts

@@ -35,6 +35,7 @@ export declare type Config = {
     multicallAddresses: Record<ChainId, string | undefined>;
     defaultExecutionSettings: InternalExecutionSettings;
     defaultRouteOptions: RouteOptions;
+    disableVersionCheck?: boolean;
 };
 export declare type ConfigUpdate = {
     apiUrl?: string;
@@ -42,6 +43,7 @@ export declare type ConfigUpdate = {
     multicallAddresses?: Record<number, string | undefined>;
     defaultExecutionSettings?: ExecutionSettings;
     defaultRouteOptions?: RouteOptions;
+    disableVersionCheck?: boolean;
 };
 export declare type SwitchChainHook = (requiredChainId: number) => Promise<Signer | undefined>;
 export interface AcceptSlippageUpdateHookParams {

package/dist/cjs/version.d.ts

@@ -0,0 +1,2 @@
+export declare const name = "@lifi/sdk";
+export declare const version = "1.2.1";

package/dist/cjs/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.version = exports.name = void 0;
+exports.name = '@lifi/sdk';
+exports.version = '1.2.1';

package/dist/helpers.d.ts

@@ -16,3 +16,4 @@ export declare const getEthereumPublicKeyHook: (walletAddress: string) => () =>
  */
 export declare const getRandomNumber: (min: number, max: number) => number;
 export declare const isSameToken: (tokenA: Token, tokenB: Token) => boolean;
+export declare const checkPackageUpdates: (packageName?: string, packageVersion?: string, disableCheck?: boolean) => Promise<void>;

package/dist/helpers.js

@@ -7,6 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { name, version } from './version';
 const ethereumRequest = (method, params) => __awaiter(void 0, void 0, void 0, function* () {
     // If ethereum.request() exists, the provider is probably EIP-1193 compliant.
     if (!ethereum || !ethereum.request) {
@@ -45,3 +46,35 @@ export const getRandomNumber = (min, max) => {
 };
 export const isSameToken = (tokenA, tokenB) => tokenA.chainId === tokenB.chainId &&
     tokenA.address.toLowerCase() === tokenB.address.toLowerCase();
+function semverCompare(a, b) {
+    if (a.startsWith(b + '-')) {
+        return -1;
+    }
+    if (b.startsWith(a + '-')) {
+        return 1;
+    }
+    return a.localeCompare(b, undefined, {
+        numeric: true,
+        sensitivity: 'case',
+        caseFirst: 'upper',
+    });
+}
+export const checkPackageUpdates = (packageName, packageVersion, disableCheck) => __awaiter(void 0, void 0, void 0, function* () {
+    if (disableCheck || process.env.NODE_ENV !== 'development') {
+        return;
+    }
+    try {
+        const pkgName = packageName !== null && packageName !== void 0 ? packageName : name;
+        const response = yield (yield fetch(`https://registry.npmjs.org/${pkgName}/latest`)).json();
+        const latestVersion = response.version;
+        const currentVersion = packageVersion !== null && packageVersion !== void 0 ? packageVersion : version;
+        if (semverCompare(latestVersion, currentVersion)) {
+            console.warn(
+            // eslint-disable-next-line max-len
+            `${pkgName}: new package version is available. Please update as soon as possible to enjoy the newest features. Current version: ${currentVersion}. Latest version: ${latestVersion}.`);
+        }
+    }
+    catch (error) {
+        // Cannot verify version, might be network error etc. We don't bother showing anything in that case
+    }
+});

package/dist/types/internal.types.d.ts

@@ -35,6 +35,7 @@ export declare type Config = {
     multicallAddresses: Record<ChainId, string | undefined>;
     defaultExecutionSettings: InternalExecutionSettings;
     defaultRouteOptions: RouteOptions;
+    disableVersionCheck?: boolean;
 };
 export declare type ConfigUpdate = {
     apiUrl?: string;
@@ -42,6 +43,7 @@ export declare type ConfigUpdate = {
     multicallAddresses?: Record<number, string | undefined>;
     defaultExecutionSettings?: ExecutionSettings;
     defaultRouteOptions?: RouteOptions;
+    disableVersionCheck?: boolean;
 };
 export declare type SwitchChainHook = (requiredChainId: number) => Promise<Signer | undefined>;
 export interface AcceptSlippageUpdateHookParams {

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const name = "@lifi/sdk";
+export declare const version = "1.2.1";

package/dist/version.js

@@ -0,0 +1,2 @@
+export const name = '@lifi/sdk';
+export const version = '1.2.1';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/sdk",
-  "version": "1.1.5",
+  "version": "1.2.1",
   "description": "LI.FI Any-to-Any Cross-Chain-Swap SDK",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
@@ -30,7 +30,12 @@
     "prepublishOnly": "run-s build use:npmReadme && pinst --enable",
     "postpublish": "npm run use:gitReadme && pinst --enable",
     "prepare": "husky install",
-    "release": "standard-version"
+    "release": "standard-version -a"
+  },
+  "standard-version": {
+    "scripts": {
+      "postbump": "node scripts/version.js && git add ."
+    }
   },
   "lint-staged": {
     "src/**/*.{ts,tsx}": [
@@ -75,7 +80,7 @@
   "dependencies": {
     "@ethersproject/abi": "^5.6.4",
     "@ethersproject/contracts": "^5.6.2",
-    "@lifi/types": "^1.5.0",
+    "@lifi/types": "^1.5.1",
     "axios": "^0.27.2",
     "bignumber.js": "^9.1.0",
     "eth-rpc-errors": "^4.0.3",