https://github.com/raydium-io/raydium-sdk-V2
Open-source Typescript SDK for Raydium
https://github.com/raydium-io/raydium-sdk-V2
Last synced: 2 months ago
JSON representation
Open-source Typescript SDK for Raydium
- Host: GitHub
- URL: https://github.com/raydium-io/raydium-sdk-V2
- Owner: raydium-io
- License: gpl-3.0
- Created: 2022-11-21T08:35:14.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T08:06:57.000Z (3 months ago)
- Last Synced: 2025-03-10T14:05:08.133Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 4.45 MB
- Stars: 206
- Watchers: 5
- Forks: 97
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - raydium-io/raydium-sdk-V2 - Open-source Typescript SDK for Raydium (TypeScript)
README
# Raydium SDK
[npm-image]: https://img.shields.io/npm/v/@raydium-io/raydium-sdk-v2.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@raydium-io/raydium-sdk-v2
[![npm][npm-image]][npm-url]
An SDK for building applications on top of Raydium.
## Usage Guide
### Installation
```
$ yarn add @raydium-io/raydium-sdk-v2
```
## SDK method Demo
[SDK V2 Demo Repo](https://github.com/raydium-io/raydium-sdk-V2-demo)
## SDK local test
```
$ yarn dev {directory}
e.g. yarn dev test/init.ts
```
## Features
### Initialization
```javascript
import { Raydium } from "@raydium-io/raydium-sdk";
const raydium = await Raydium.load({
connection,
owner, // key pair or publicKey, if you run a node process, provide keyPair
signAllTransactions, // optional - provide sign functions provided by @solana/wallet-adapter-react
tokenAccounts, // optional, if dapp handle it by self can provide to sdk
tokenAccountRowInfos, // optional, if dapp handle it by self can provide to sdk
disableLoadToken: false, // default is false, if you don't need token info, set to true
});
```
#### how to transform token account data
```javascript
import { parseTokenAccountResp } from "@raydium-io/raydium-sdk";
const solAccountResp = await connection.getAccountInfo(owner.publicKey);
const tokenAccountResp = await connection.getTokenAccountsByOwner(owner.publicKey, { programId: TOKEN_PROGRAM_ID });
const token2022Req = await connection.getTokenAccountsByOwner(owner.publicKey, { programId: TOKEN_2022_PROGRAM_ID });
const tokenAccountData = parseTokenAccountResp({
owner: owner.publicKey,
solAccountResp,
tokenAccountResp: {
context: tokenAccountResp.context,
value: [...tokenAccountResp.value, ...token2022Req.value],
},
});
```
#### data after initialization
```
# token
raydium.token.tokenList
raydium.token.tokenMap
raydium.token.mintGroup
# token account
raydium.account.tokenAccounts
raydium.account.tokenAccountRawInfos
```
#### Api methods (https://github.com/raydium-io/raydium-sdk-V2/blob/master/src/api/api.ts)
- fetch raydium default mint list (mainnet only)
```javascript
const data = await raydium.api.getTokenList();
```
- fetch mints recognizable by raydium
```javascript
const data = await raydium.api.getTokenInfo([
"So11111111111111111111111111111111111111112",
"4k3Dyjzvzp8eMZWUXbBCjEvwSkkk59S5iCNLY3QrkX6R",
]);
```
- fetch pool list (mainnet only)
available fetch params defined here: https://github.com/raydium-io/raydium-sdk-V2/blob/master/src/api/type.ts#L249
```javascript
const data = await raydium.api.getPoolList({});
```
- fetch poolInfo by id (mainnet only)
```javascript
// ids: join pool ids by comma(,)
const data = await raydium.api.fetchPoolById({
ids: "AVs9TA4nWDzfPJE9gGVNJMVhcQy3V9PGazuz33BfG2RA,8sLbNZoA1cfnvMJLPfp98ZLAnFSYCFApfJKMbiXNLwxj",
});
```
- fetch pool list by mints (mainnet only)
```javascript
const data = await raydium.api.fetchPoolByMints({
mint1: "So11111111111111111111111111111111111111112",
mint2: "4k3Dyjzvzp8eMZWUXbBCjEvwSkkk59S5iCNLY3QrkX6R", // optional,
// extra params: https://github.com/raydium-io/raydium-sdk-V2/blob/master/src/api/type.ts#L249
});
```
- fetch farmInfo by id (mainnet only)
```javascript
// ids: join farm ids by comma(,)
const data = await raydium.api.fetchFarmInfoById({
ids: "4EwbZo8BZXP5313z5A2H11MRBP15M5n6YxfmkjXESKAW,HUDr9BDaAGqi37xbQHzxCyXvfMCKPTPNF8g9c9bPu1Fu",
});
```