Skip to content

Commit

Permalink
irrelevant subtitle removed
Browse files Browse the repository at this point in the history
  • Loading branch information
ignaciopenia committed Sep 4, 2024
1 parent 88ec3e4 commit f1bce7c
Showing 1 changed file with 2 additions and 21 deletions.
23 changes: 2 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,11 @@ You can install Alex-SDK using npm:
npm install alex-sdk
```

## Functions

The AlexSDK class includes the following functions:

```typescript
export declare class AlexSDK {
fetchSwappableCurrency(): Promise<TokenInfo[]>;
getAllPossibleRoutes(from: Currency, to: Currency): Promise<AMMRoute[]>;
getAmountTo(from: Currency, fromAmount: bigint, to: Currency): Promise<bigint>;
getBalances(stxAddress: string): Promise<Partial<{ [currency in Currency]: bigint }>>;
getFeeRate(from: Currency, to: Currency): Promise<bigint>;
getLatestPrices(): Promise<Partial<{ [currency in Currency]: number }>>;
getRoute(from: Currency, to: Currency): Promise<AMMRoute>;
getRouter(from: Currency, to: Currency): Promise<Currency[]>; // deprecated
getWayPoints(route: AMMRoute): Promise<TokenInfo[]>;
runSwap(stxAddress: string, currencyX: Currency,
currencyY: Currency, fromAmount: bigint,
minDy: bigint, customRoute: AMMRoute): Promise<TxToBroadCast>;
}
```
## Documentation

For detailed API documentation, including a full list of available methods and their usage, please refer to:

[SDK API Documentation](https://ignaciopenia.github.io/alex-sdk/).
[SDK API Documentation](/alex-sdk/).

## Usage

Expand Down

0 comments on commit f1bce7c

Please sign in to comment.