Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raydium-io/raydium-sdk-V2-demo
https://github.com/raydium-io/raydium-sdk-V2-demo
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/raydium-io/raydium-sdk-V2-demo
- Owner: raydium-io
- Created: 2024-05-07T02:47:26.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-05-29T02:51:27.000Z (7 months ago)
- Last Synced: 2024-05-29T06:51:25.930Z (7 months ago)
- Language: TypeScript
- Size: 471 KB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - raydium-io/raydium-sdk-V2-demo - Open-source Typescript SDK demos (TypeScript)
README
# RAYDIUM SDK V2 demo
## About the project
This project is for [RAYDIUM SDK V2](https://github.com/raydium-io/raydium-sdk-V2) demonstration
## Getting Started
### Installation
`yarn install`
this will install the dependencies for running the demo script
### Prerequisites
Modify `config.ts.template` to fit your configuration, and rename it to `config.ts`
- ``: replace to your own one
- ``: replace to your prefer one
- ``: by default it's no needed to provide raydium api host, only provide it when test on devent.
### Usage
- `yarn dev src//` run the specific demo script, e.g. yarn dev src/cpmm/deposit.ts. **Note: if you want to execute tx, remember to uncomment code in last line**
### Sdk Methods
#### Transaction methods return data
all transaction related build function (e.g. await raydium.clmm.openPositionFromBase/ await raydium.cpmm.createPool ..etc) will return all transactions and instructions
```
const { execute, transaction, builder, extInfo } = await raydium.clmm.openPositionFromBase({ xxx })
```
- `transaction or transactions`: all built transactions
- `builder`: all instructions in transaction. e.g. builder.allInstructions, builder.AllTxData
- `extInfo`: transaction related publicKeys. (e.g: extInfo from raydium.cpmm.createPool includes poolId, programId...etc)
#### Fetch pool list by mints
```
import { PoolFetchType } from '@raydium-io/raydium-sdk-v2'
const list = await raydium.api.fetchPoolByMints({
mint1: '4k3Dyjzvzp8eMZWUXbBCjEvwSkkk59S5iCNLY3QrkX6R', // required
mint2: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v', // optional
type: PoolFetchType.All, // optional
sort: 'liquidity', // optional
order: 'desc', // optional
page: 1, // optional
})
```
### Fetch Mint info from Api or Rpc
```
await raydium.token.getTokenInfo('')
```
### Fetch token account
```
await raydium.account.fetchWalletTokenAccounts() // if need to force fetching token account, pass param { forceUpdate: true }
```
### More api methods [check here](https://github.com/raydium-io/raydium-sdk-V2?tab=readme-ov-file#api-methods-httpsgithubcomraydium-ioraydium-sdk-v2blobmastersrcapiapits)
### FAQ
#### Error: block height exceeded
- transactions were expired, set higher priority fees (computeBudgetConfig) to make it go through smoothly
- if you are testing in devnet, remember to replace programId to devnet one.
#### raydium.api.fetchPoolById/raydium.api.fetchFarmInfoById return null
- currently api doesn't support devnet pool/farm data, please test on mainnet.
- only raydium.xxxx.getRpcPoolInfos support get devnet `rpc` pool info.
- new created pool needs couple minutes to sync data to api, if you want to get info immediately, use raydium.xxxx.getRpcPoolInfos instead.
#### create amm pool error
- `0x10001a9`: you might use https://openbook-tools.dexlab.space/market/create?network=devnet to create devnet market, and they used wrong devent program id, so please use createMarket.ts in demo to create market
- `lp amount is too less`: please provide more base/quote amount when create pool, if there's SOL/WSOL in your market, it's better provide more than 4 sol(4\*10\*\*9) in initial amount.