mirror of
https://github.com/alexgo-io/alex-sdk.git
synced 2026-01-12 14:25:02 +08:00
4c7e1bd016
- Add missing AMMRoute import - Move stxAddress declaration before its usage - Add missing 'amount' variable declaration - Fix 'sdk' -> 'alex' variable name consistency - Fix undefined x1, x2 variables in route example - Use allRoutes[0] as example route instead
87 lines
2.8 KiB
Markdown
87 lines
2.8 KiB
Markdown
# Alex-SDK
|
|
|
|
Alex-SDK is an easy-to-use library that exposes the swap functionality from [alexlab.co](https://app.alexlab.co/swap) to be integrated into any app or wallet. It enables users to perform swaps with a wide variety of supported currencies.
|
|
|
|
## Installation
|
|
|
|
You can install Alex-SDK using npm:
|
|
|
|
```bash
|
|
npm install alex-sdk
|
|
```
|
|
|
|
## Documentation
|
|
|
|
For detailed API documentation, including a full list of available methods and their usage, please refer to:
|
|
|
|
[SDK API Documentation](https://alexgo-io.github.io/alex-sdk/).
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
import { AlexSDK, Currency, AMMRoute } from 'alex-sdk';
|
|
|
|
const alex = new AlexSDK();
|
|
|
|
(async () => {
|
|
// Define your STX address
|
|
const stxAddress = 'SM2MARAVW6BEJCD13YV2RHGYHQWT7TDDNMNRB1MVT';
|
|
|
|
// Get swap fee between STX and ALEX
|
|
const feeRate = await alex.getFeeRate(Currency.STX, Currency.ALEX);
|
|
console.log('Swap fee:', feeRate);
|
|
|
|
// Get the router path for swapping STX to ALEX
|
|
const router = await alex.getRoute(Currency.STX, Currency.ALEX);
|
|
console.log('Router path:', router);
|
|
|
|
// Get the amount of USDA that will be received when swapping 100 ALEX
|
|
const amountTo = await alex.getAmountTo(
|
|
Currency.STX,
|
|
BigInt(100 * 1e8), // all decimals are multiplied by 1e8
|
|
Currency.ALEX
|
|
);
|
|
console.log('Amount to receive:', Number(amountTo) / 1e8);
|
|
|
|
// To get the transaction to broadcast
|
|
const amount = 100; // Amount to swap
|
|
const tx = await alex.runSwap(
|
|
stxAddress,
|
|
Currency.STX,
|
|
Currency.ALEX,
|
|
BigInt(Number(amount) * 1e8),
|
|
BigInt(0)
|
|
);
|
|
|
|
// Then broadcast the transaction yourself
|
|
await openContractCall(tx);
|
|
|
|
// Get the latest prices for all supported currencies
|
|
const latestPrices = await alex.getLatestPrices();
|
|
console.log('Latest prices:', latestPrices);
|
|
|
|
// Get balances for the STX address
|
|
const balances = await alex.getBalances(stxAddress);
|
|
console.log('Balances:', balances);
|
|
|
|
// Fetch information about all swappable currencies
|
|
const swappableCurrencies = await alex.fetchSwappableCurrency();
|
|
console.log('Swappable currencies:', swappableCurrencies);
|
|
|
|
// Get all possible routes for swapping currencies
|
|
const allRoutes = await alex.getAllPossibleRoutes(Currency.STX, Currency.ALEX);
|
|
console.log('All possible routes:', allRoutes);
|
|
|
|
// Get way points for a route
|
|
const someRoute: AMMRoute = allRoutes[0]; // Use the first available route
|
|
const wayPoints = await alex.getWayPoints(someRoute);
|
|
console.log('Way points for the route:', wayPoints);
|
|
})();
|
|
```
|
|
|
|
There is a fully working example in the [alex-sdk-example](https://github.com/alexgo-io/alex-sdk-example).
|
|
|
|
## Contributing
|
|
|
|
Contributions to the project are welcome. Please fork the repository, make your changes, and submit a pull request. Ensure your changes follow the code style and conventions used.
|