rainbow-swap-sdk - npm Package Compare versions

Comparing version 1.4.4 to 1.4.5

dist/index.d.ts

@@ -15,2 +15,3 @@ export { mapSwapRouteToRoute } from './dexes/shared/calculated-swap-route.utils';
 export { getAssetsRecord, getBestRoute, getAppStatus } from './utils/api.utils';
+export { toNano, fromNano } from './utils/big-int.utils';
 export { getQueryId } from './utils/transfer-params.utils';

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getQueryId = 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.getAssetsRecord = exports.SwapRouteType = exports.RouteDirectionEnum = exports.DexTypeEnum = exports.mapSwapRouteToRoute = void 0;
 var calculated_swap_route_utils_1 = require("./dexes/shared/calculated-swap-route.utils");
@@ -16,3 +16,6 @@ Object.defineProperty(exports, "mapSwapRouteToRoute", { enumerable: true, get: function () { return calculated_swap_route_utils_1.mapSwapRouteToRoute; } });
 Object.defineProperty(exports, "getAppStatus", { enumerable: true, get: function () { return api_utils_1.getAppStatus; } });
+var big_int_utils_1 = require("./utils/big-int.utils");
+Object.defineProperty(exports, "toNano", { enumerable: true, get: function () { return big_int_utils_1.toNano; } });
+Object.defineProperty(exports, "fromNano", { enumerable: true, get: function () { return big_int_utils_1.fromNano; } });
 var transfer_params_utils_1 = require("./utils/transfer-params.utils");
 Object.defineProperty(exports, "getQueryId", { enumerable: true, get: function () { return transfer_params_utils_1.getQueryId; } });

dist/types/best-route-params.type.d.ts

 export type BestRouteParams = {
+    /**
+     * The amount of the input asset that the user wants to send, specified in nano units.
+     * This should be a string representation of a bigint value.
+     *
+     * **Example:** `'1350000000'` (represents 1.35 TON in nano).
+     */
     inputAssetAmount: string;
+    /**
+     * The address or identifier of the asset that the user wants to send.
+     *
+     * **Example:**
+     * - `'ton'` for TON.
+     * - `'EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs'` for USDT.
+     */
     inputAssetAddress: string;
+    /**
+     * The address or identifier of the asset that the user wants to receive.
+     *
+     * **Example:**
+     * - `'ton'` for TON.
+     * - `'EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs'` for USDT.
+     */
     outputAssetAddress: string;
+    /**
+     * (Optional) The maximum length of the route.
+     * Should be a number between **1 and 3** (inclusive).
+     *
+     * **Default:** `2`
+     */
     maxDepth?: number;
+    /**
+     * (Optional) The wallet address of the user.
+     * If not provided, the `swapMessages` will return an empty array (`[]`).
+     */
     senderAddress?: string;
+    /**
+     * (Optional) The percentage setting for slippage tolerance.
+     * Should be a number between **0 and 100** (inclusive).
+     *
+     * **Example:** `1.5` for 1.5% slippage tolerance.
+     *
+     * **Default:** `5`
+     */
     maxSlippage?: number;
+    /**
+     * (Optional) The referral address of a user.
+     * Refer a new user and earn a share of their trading fees.
+     *
+     * For more details, visit the **Rewards Center** at [rainbow.ag](https://rainbow.ag).
+     */
+    referralAddress?: string;
+    /**
+     * (Optional) A unique identifier in our App Developer Partnership program.
+     * Integrate our SDK to enable in-app swaps, set custom fees, and enjoy a 50% revenue share.
+     *
+     * For more details, contact us at **Community Chat**: [https://t.me/rainbow_swap_chat](https://t.me/rainbow_swap_chat).
+     */
+    partnerId?: string;
 };

dist/types/best-route-response.type.d.ts

@@ -0,17 +1,22 @@
+import { BestRouteDisplayData } from './best-route-display-data.type';
 import { CalculatedSwapRoute } from './calculated-swap-route.type';
 import { Message } from '../interfaces/message.interface';
 export type BestRouteResponse = {
+    /**
+     * A user-friendly representation of the best route details.
+     */
+    displayData: BestRouteDisplayData;
+    /**
+     * An array of messages that should be signed and sent to the blockchain to execute the swap.
+     *
+     * - For TON dApps, it is recommended to use `@tonconnect/sdk`.
+     * - If the `senderAddress` parameter in the request was not set, an empty array (`[]`) will be returned.
+     * - An empty array in other cases indicates that no route was found between the input asset and the output asset.
+     */
+    swapMessages: Message[];
+    /**
+     * Detailed information about the most efficient routes for swapping the user's input asset,
+     * taking into account swap distribution and gas costs.
+     */
     bestRoute: CalculatedSwapRoute[];
-    displayData: {
-        inputAssetAmount: number;
-        inputAssetUsdAmount: number;
-        outputAssetAmount: number;
-        outputAssetUsdAmount: number;
-        minOutputAssetAmount: number;
-        exchangeRate: number;
-        maxSlippage: number;
-        routingFeePercent: number;
-        priceImprovementPercent: number;
-    };
-    swapMessages: Message[];
 };

package.json

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

README.md

 # Rainbow Swap 🌈 SDK
 
-This SDK is designed for building applications on top of [Rainbow Swap 🌈](https://github.com/0xblackbot/rainbow-swap) - The Next Gen DEX Aggregator on the TON blockchain 💎.
+This SDK is designed for building applications on top of [Rainbow.ag](https://github.com/0xblackbot/rainbow-swap) - Swap Aggregator on TON blockchain 💎.
 
---- 
+---
 
-**We have plans to integrate commissions and share them with those who have integrated this SDK into their DApps.**
+**To receive your `partnerId`, set custom fees, and enjoy a 50% revenue share, contact us in our [Community Chat](https://t.me/rainbow_swap_chat).**
 
@@ -14,5 +14,7 @@ ---
 
-### Installation
+## Installation
 
-To install the rainbow-swap-sdk, use the following npm command:
+You can install the Rainbow Swap SDK using either npm or Yarn:
+
+**Using npm:**
 ```shell
@@ -22,9 +24,13 @@ npm install rainbow-swap-sdk
 
-### Integrate your dApp
+**Using Yarn:**
+```shell
+yarn add rainbow-swap-sdk
+```
 
+## Integrate Your dApp
+
+### Example: Swapping 1.35 TON to USDT
+
 ```typescript
-import {
-    getAssetsRecord,
-    getBestRoute
-} from 'rainbow-swap-sdk';
+import {getAssetsRecord, getBestRoute, toNano} from 'rainbow-swap-sdk';
 
@@ -34,43 +40,49 @@ // 1. Load the list of available tokens
 
-...
+const inputAsset = assetsRecord['ton']; // TON asset
+const outputAsset = assetsRecord['EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs']; // USDT asset
 
-// 2. Load the best swap route & swap messages
-const params = {
-  inputAssetAmount: '1000000000', // 1 TON in nano
-  inputAssetAddress: 'ton', // TON
-  outputAssetAddress: 'EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs', // USDT jetton master address
-  maxDepth: 2, // optional number of maximum route length (should be in range from 1 to 3)
-  userAddress: 'UQDGGjjuwhikx8ZPJsrLbKXGq7mx26D8pK_l8GqBejzB52Pa', // optional user wallet address, if set - swapMessages will return
-  slippageTolerance: 5 // optional max slippage value (should be in range )
-};
+// 2. Load the best swap route and swap messages
+const bestRouteResponse = await getBestRoute({
+    inputAssetAmount: toNano('1.35', inputAsset.decimals).toString(), // Convert 1.35 TON to nano format
+    inputAssetAddress: inputAsset.address,
+    outputAssetAddress: outputAsset.address,
+    senderAddress: 'UQDGGjjuwhikx8ZPJsrLbKXGq7mx26D8pK_l8GqBejzB52Pa', // Optional user wallet address; if set, swap messages will be returned
+    partnerId: 'demo-partner' // Optional unique identifier in our App Developer Partnership program
+});
 
-const bestRouteResponse = await getBestRoute(params);
+// 3. Sign and send messages to the blockchain to execute the swap.
+// This example uses the React UI client. For other frameworks, refer to https://docs.ton.org/develop/dapps/ton-connect/overview
+import {useTonConnectUI} from '@tonconnect/ui-react';
 
-const bestRoute = bestRouteResponse.bestRoute; // Route of the best possible swap route
-const swapMessages = bestRouteResponse.swapMessages; // Array of messages that should be sent to @tonconnect
+const [tonConnectUI] = useTonConnectUI();
+
+const result = await tonConnectUI.sendTransaction({
+    validUntil: Math.floor(Date.now() / 1000) + 60, // 60 seconds from now
+    messages: bestRouteResponse.swapMessages
+});
 ```
 
-### Application status check
+## 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.
+You may want to check the status of your application to ensure everything is functioning correctly. For example, temporarily disable swaps if block production on TON is disrupted due to an external event like the DOGS listing.
 
 ```typescript
-import { getAppStatus } from 'rainbow-swap-sdk';
+import {getAppStatus} from 'rainbow-swap-sdk';
 
 const {
-    isSwapsEnabled, // true - if everything works fine
-    message // explanations why swaps are disabled
+    isSwapsEnabled, // true if everything is working fine
+    message // Explanation of why swaps are disabled, if applicable
 } = await getAppStatus();
 ```
 
-### Live example
+## Live Example
 
-For a live example of using the SDK, visit [Rainbow Swap 🌈 repository](https://github.com/0xblackbot/rainbow-swap).
+For a live example of using the SDK, visit the [Rainbow Swap 🌈 Repository](https://github.com/0xblackbot/rainbow-swap).
 
-### Contact
+## Contact
 
-For questions and suggestions, contact us at [Blackbot](https://blackbot.technology/).
+For questions and suggestions, visit [Community Chat](https://t.me/rainbow_swap_chat).
 
-### License
+## License
 
 This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

No alert changes

Improved metrics

Total package byte prevSize

37251

increased by14.76%

Number of package files

71

increased by5.97%

Lines of code

456

increased by35.71%

Number of lines in readme file

86

increased by16.22%

No dependency changes