rainbow-swap-sdk 1.2.1 → 1.2.2

package/README.md

@@ -53,6 +53,19 @@ const swapMessages = await getSwapMessages(
 );
 ```
 
+### Application status check
+
+Additionally, you might want to check if everything is functioning correctly. For instance, you could temporarily disable swaps if block production on TON is disrupted due to the DOGS listing.
+
+```typescript
+import { getAppStatus } from 'rainbow-swap-sdk';
+
+const {
+    isSwapsEnabled, // true - if everything works fine
+    message // explanations why swaps are disabled
+} = await getAppStatus();
+```
+
 ### Live example
 
 For a live example of using the SDK, visit [Rainbow Swap 🌈 repository](https://github.com/0xblackbot/rainbow-swap).

package/dist/index.d.ts

@@ -4,10 +4,11 @@ export { RouteDirectionEnum } from './enums/route-direction.enum';
 export { SwapRouteType } from './enums/swap-route-type.enum';
 export type { RouteStep } from './interfaces/route-step.interface';
 export type { RouteStepWithCalculation } from './interfaces/route-step-with-calculation.interface';
+export type { AppStatus } from './types/app-status.type';
 export type { Asset } from './types/asset.type';
 export type { AssetsRecord } from './types/assets-record.type';
 export type { BestRouteResponse } from './types/best-route-response.type';
 export type { CalculatedSwapRoute } from './types/calculated-swap-route.type';
-export { getAssetsRecord, getBestRoute } from './utils/api.utils';
+export { getAssetsRecord, getBestRoute, getAppStatus } from './utils/api.utils';
 export { getSwapMessages, getRainbowWalletActivationMessages } from './utils/message.utils';
 export { getIsRainbowWalletActive, getIsActivationRequired } from './utils/rainbow-wallet.utils';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIsActivationRequired = exports.getIsRainbowWalletActive = exports.getRainbowWalletActivationMessages = exports.getSwapMessages = exports.getBestRoute = exports.getAssetsRecord = exports.SwapRouteType = exports.RouteDirectionEnum = exports.DexTypeEnum = exports.mapSwapRouteToRoute = void 0;
+exports.getIsActivationRequired = exports.getIsRainbowWalletActive = exports.getRainbowWalletActivationMessages = exports.getSwapMessages = exports.getAppStatus = exports.getBestRoute = exports.getAssetsRecord = exports.SwapRouteType = exports.RouteDirectionEnum = exports.DexTypeEnum = exports.mapSwapRouteToRoute = void 0;
 var calculated_swap_route_utils_1 = require("./dexes/shared/calculated-swap-route.utils");
 Object.defineProperty(exports, "mapSwapRouteToRoute", { enumerable: true, get: function () { return calculated_swap_route_utils_1.mapSwapRouteToRoute; } });
 var dex_type_enum_1 = require("./enums/dex-type.enum");
@@ -12,6 +12,7 @@ Object.defineProperty(exports, "SwapRouteType", { enumerable: true, get: functio
 var api_utils_1 = require("./utils/api.utils");
 Object.defineProperty(exports, "getAssetsRecord", { enumerable: true, get: function () { return api_utils_1.getAssetsRecord; } });
 Object.defineProperty(exports, "getBestRoute", { enumerable: true, get: function () { return api_utils_1.getBestRoute; } });
+Object.defineProperty(exports, "getAppStatus", { enumerable: true, get: function () { return api_utils_1.getAppStatus; } });
 var message_utils_1 = require("./utils/message.utils");
 Object.defineProperty(exports, "getSwapMessages", { enumerable: true, get: function () { return message_utils_1.getSwapMessages; } });
 Object.defineProperty(exports, "getRainbowWalletActivationMessages", { enumerable: true, get: function () { return message_utils_1.getRainbowWalletActivationMessages; } });

package/dist/types/app-status.type.d.ts

@@ -0,0 +1,4 @@
+export type AppStatus = {
+    isSwapsEnabled: boolean;
+    message: string;
+};

package/dist/types/app-status.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/api.utils.d.ts

@@ -1,3 +1,4 @@
+import { AppStatus } from '../types/app-status.type';
 import { AssetsRecord } from '../types/assets-record.type';
 import { BestRouteResponse } from '../types/best-route-response.type';
 export declare const getAssetsRecord: () => Promise<AssetsRecord>;
@@ -6,3 +7,4 @@ export declare const getBestRoute: (params: {
     inputAssetAddress: string;
     outputAssetAddress: string;
 }) => Promise<BestRouteResponse>;
+export declare const getAppStatus: () => Promise<AppStatus>;

package/dist/utils/api.utils.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBestRoute = exports.getAssetsRecord = void 0;
+exports.getAppStatus = exports.getBestRoute = exports.getAssetsRecord = void 0;
 const globals_1 = require("../globals");
 const getAssetsRecord = () => globals_1.API.get('/assets-record').then(response => response.data);
 exports.getAssetsRecord = getAssetsRecord;
 const getBestRoute = (params) => globals_1.API.get('/best-route', { params }).then(response => response.data);
 exports.getBestRoute = getBestRoute;
+const getAppStatus = () => globals_1.API.get('/app-status').then(response => response.data);
+exports.getAppStatus = getAppStatus;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rainbow-swap-sdk",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "SDK for building applications on top of Rainbow Swap 🌈 - The Next Gen DEX Aggregator on TON 💎.",
   "repository": "https://github.com/0xblackbot/rainbow-swap-sdk.git",
   "license": "Apache-2.0",