rainbow-swap-sdk 1.4.5 → 1.4.6

package/README.md

@@ -30,13 +30,16 @@ yarn add rainbow-swap-sdk
 ### Example: Swapping 1.35 TON to USDT
 
 ```typescript
-import {getAssetsRecord, getBestRoute, toNano} from 'rainbow-swap-sdk';
+import {getAssetsList, getBestRoute, toNano} from 'rainbow-swap-sdk';
 
 // 1. Load the list of available tokens
-const assetsRecord = await getAssetsRecord();
+const assetsList = await getAssetsList({
+    userAssets: [] // Array of asset addresses the user holds; see AssetsListParams for more details.
+});
 
-const inputAsset = assetsRecord['ton']; // TON asset
-const outputAsset = assetsRecord['EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs']; // USDT asset
+// Retrieve specific assets by their address
+const inputAsset = assetsList.find(asset => asset.address === 'ton');
+const outputAsset = assetsList.find(asset => asset.address === 'EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs');
 
 // 2. Load the best swap route and swap messages
 const bestRouteResponse = await getBestRoute({

package/dist/index.d.ts

@@ -7,10 +7,11 @@ 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 { AssetsListParams } from './types/assets-list-patams.type';
 export type { AssetsRecord } from './types/assets-record.type';
 export type { BestRouteParams } from './types/best-route-params.type';
 export type { BestRouteResponse } from './types/best-route-response.type';
 export type { CalculatedSwapRoute } from './types/calculated-swap-route.type';
-export { getAssetsRecord, getBestRoute, getAppStatus } from './utils/api.utils';
+export { getAssetsRecord, getAssetsList, getBestRoute, getAppStatus } from './utils/api.utils';
 export { toNano, fromNano } from './utils/big-int.utils';
 export { getQueryId } from './utils/transfer-params.utils';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getQueryId = exports.fromNano = exports.toNano = exports.getAppStatus = exports.getBestRoute = exports.getAssetsRecord = exports.SwapRouteType = exports.RouteDirectionEnum = exports.DexTypeEnum = exports.mapSwapRouteToRoute = void 0;
+exports.getQueryId = exports.fromNano = exports.toNano = exports.getAppStatus = exports.getBestRoute = exports.getAssetsList = 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");
@@ -11,6 +11,7 @@ var swap_route_type_enum_1 = require("./enums/swap-route-type.enum");
 Object.defineProperty(exports, "SwapRouteType", { enumerable: true, get: function () { return swap_route_type_enum_1.SwapRouteType; } });
 var api_utils_1 = require("./utils/api.utils");
 Object.defineProperty(exports, "getAssetsRecord", { enumerable: true, get: function () { return api_utils_1.getAssetsRecord; } });
+Object.defineProperty(exports, "getAssetsList", { enumerable: true, get: function () { return api_utils_1.getAssetsList; } });
 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 big_int_utils_1 = require("./utils/big-int.utils");

package/dist/types/assets-list-patams.type.d.ts

@@ -0,0 +1,25 @@
+export type AssetsListParams = {
+    /**
+     * A list of asset addresses that the user holds balances in.
+     *
+     * **Example values:**
+     * - `'ton'` for TON.
+     * - `'EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs'` for USDT.
+     *
+     * **Default:** An empty array (`[]`), indicating no specified user assets.
+     */
+    userAssets?: string[];
+    /**
+     * A text string used to filter assets by symbol, name, or address.
+     *
+     * **Default:** An empty string (`''`), indicating no specific filter applied.
+     */
+    searchValue?: string;
+    /**
+     * The maximum number of assets (excluding user-owned) to return in the response.
+     * Acceptable values range from 10 to 200.
+     *
+     * **Default:** `100`
+     */
+    limit?: number;
+};

package/dist/types/assets-list-patams.type.js

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

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

@@ -1,7 +1,10 @@
 import { AppStatus } from '../types/app-status.type';
+import { Asset } from '../types/asset.type';
+import { AssetsListParams } from '../types/assets-list-patams.type';
 import { AssetsRecord } from '../types/assets-record.type';
 import { BestRouteParams } from '../types/best-route-params.type';
 import { BestRouteResponse } from '../types/best-route-response.type';
 export declare const getAssetsRecord: () => Promise<AssetsRecord>;
+export declare const getAssetsList: (params: AssetsListParams) => Promise<Asset[]>;
 export declare const getBestRoute: (params: BestRouteParams) => Promise<BestRouteResponse>;
 export declare const getAppStatus: () => Promise<AppStatus>;

package/dist/utils/api.utils.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAppStatus = exports.getBestRoute = exports.getAssetsRecord = void 0;
+exports.getAppStatus = exports.getBestRoute = exports.getAssetsList = 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 getAssetsList = (params) => globals_1.API.post('/assets-list', params).then(response => response.data);
+exports.getAssetsList = getAssetsList;
 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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rainbow-swap-sdk",
-  "version": "1.4.5",
+  "version": "1.4.6",
   "description": "SDK for building applications on top of Rainbow.ag - Swap Aggregator on TON 💎.",
   "repository": "https://github.com/0xblackbot/rainbow-swap-sdk.git",
   "license": "Apache-2.0",