rainbow-swap-sdk
v1.4.14
Published
SDK for building applications on top of Rainbow.ag - Swap Aggregator on TON ๐.
Downloads
1,126
Maintainers
Keywords
Readme
Rainbow Swap ๐ SDK
This SDK is designed for building applications on top of Rainbow.ag - Swap Aggregator on TON blockchain ๐.
To receive your partnerId
, set custom fees, and enjoy a 50% revenue share, contact us in our Community Chat.
Installation
You can install the Rainbow Swap SDK using either npm or Yarn:
Using npm:
npm install rainbow-swap-sdk
Using Yarn:
yarn add rainbow-swap-sdk
Integrate Your dApp
Example: Swapping 1.35 TON to USDT
import {getAssetsList, getBestRoute, toNano} from 'rainbow-swap-sdk';
// 1. Load the list of available tokens
const assetsList = await getAssetsList({
userAssets: [] // Array of asset addresses the user holds; see AssetsListParams for more details.
});
// 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({
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
});
// 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 [tonConnectUI] = useTonConnectUI();
const result = await tonConnectUI.sendTransaction({
validUntil: Math.floor(Date.now() / 1000) + 60, // 60 seconds from now
messages: bestRouteResponse.swapMessages
});
Application Status Check
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.
import {getAppStatus} from 'rainbow-swap-sdk';
const {
isSwapsEnabled, // true if everything is working fine
message // Explanation of why swaps are disabled, if applicable
} = await getAppStatus();
Live Example
For a live example of using the SDK, visit the Rainbow Swap ๐ Repository.
Contact
For questions and suggestions, visit Community Chat.
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.