Herald Exchange Glide SDK Widget is a simple component for React applications.
npm install herald-exchange-glide-sdkHerald Exchange Glide SDK Widget is a simple component for React applications.
You can install Herald Exchange Glide SDK Widget via npm:
``bash`
npm install herald-exchange-glide-sdkor
yarn add herald-exchange-glide-sdk
To use widget in your React application, follow these steps:
`tsx`
import { GlideWidget } from "herald-exchange-glide-sdk";
Initialize the widget:
> To Generate API Key Please Visit : Herald Exchange.
> Supported Token Types : ["USDT", "USDC", "ETH", "BNB", "MATIC", "SOL", "TRX"]
`tsx`
apiKey={YOUR_API_KEY}
sellParameters={{
from_amount: "25",
from_currency: "TRX",
to_currency: "INR",
}}
mode="development"
/>
---
> Note:
> In development mode, the widget uses testnet to detect and simulate transactions.
> In production mode, it switches to mainnet for real transaction processing.
> â ď¸ Make sure to deploy your application in a production environment when going live to ensure accurate transaction tracking and wallet interactions.
- Type: string
- Description: A unique API key generated via the Herald Exchange App.
- This key is used to authenticate and authorize the widget.
- Example: 4bb06e2fdbfb8e392a0ab49e4d9819ae072dcef82d79af7893625a5ff1416f
---
- Type: string
- Allowed Values: "development" | "production"
- Default: "development"
- Description: Specifies the environment in which the widget runs.
- "development" is used for testing and debugging purposes.
- "production" should be used in live environments for optimized performance.
---
- Type: string
- Description: A unique identifier (UUID) generated via the Herald Exchange App, used to associate a transaction with a specific user or session.
- Helps track user activity and transaction flow.
- Example: 34edd6d6-eb12-422f-bd0e-63c5733527
---
- Type:
`ts``
{
from_amount: string;
from_currency: string;
to_currency: string;
}
- Description: Defines the default configuration for the sell flow.
- from_amount: A string representing the default amount to sell (e.g., "25").
- from_currency: The token the user wants to sell (e.g., "USDT").
- to_currency: The currency the user wants to receive (e.g., "USD").
â ď¸ If the selected currencies are not available or not active, the widget will default to the first available currency pair.
---
This project is licensed under the MIT License - see the LICENSE file for details.