TypeScript SDK

Documentation Index

Fetch the complete documentation index at: https://docs.raydium.io/llms.txt

Use this file to discover all available pages before exploring further.

​

Cài đặt

npm install @raydium-io/raydium-sdk-v2 @solana/web3.js @solana/spl-token
# hoặc
pnpm add @raydium-io/raydium-sdk-v2 @solana/web3.js @solana/spl-token

​

Khởi tạo

import { Raydium } from "@raydium-io/raydium-sdk-v2";
import { Connection, Keypair, clusterApiUrl } from "@solana/web3.js";

const connection = new Connection(process.env.RPC_URL ?? clusterApiUrl("mainnet-beta"));
const owner      = Keypair.fromSecretKey(/* ... */);

const raydium = await Raydium.load({
  owner,
  connection,
  cluster: "mainnet",           // "mainnet" | "devnet"
  disableFeatureCheck: true,    // bỏ qua lệnh gọi API kiểm tra tính năng khởi động của SDK
  blockhashCommitment: "confirmed",
});

​

Bốn module facade

raydium.cpmm       // CPMM pools: createPool, addLiquidity, withdrawLiquidity, swap, ...
raydium.clmm       // CLMM pools: createPool, openPositionFromBase, increasePositionFromBase,
                   //             decreaseLiquidity, harvestAllRewards, swap, ...
raydium.liquidity  // AMM v4 pools: computeAmountOut, swap, addLiquidity, removeLiquidity, ...
raydium.farm       // Farm v3/v5/v6: deposit, withdraw, harvestAllRewards, create, setRewards
raydium.launchpad  // LaunchLab: createLaunchpad, buyExactIn, sellExactIn, graduate, ...
raydium.trade      // Multi-pool routing: quotes, route-execution (beta in 0.2.41)
raydium.token      // Helpers: get token list, metadata, ATA creation

​

Xây dựng transaction

const { execute, builder, transaction, innerTransactions, extInfo } =
  await raydium.cpmm.addLiquidity({
    poolInfo,
    amountInA,
    amountInB,
    slippage: 0.005,
    txVersion: TxVersion.V0,
  });

• execute — một hàm tiện lợi ký + gửi. Tương đương với builder.execute.
• builder — instance TxBuilder với tất cả các instruction và signer được tích lũy. Gọi .build() để lấy VersionedTransaction[]; hữu ích khi bạn cần inject các instruction của riêng mình hoặc ký bằng signer bên ngoài.
• transaction / innerTransactions — các mảng instruction thô. Sử dụng khi xây dựng transaction đa chương trình được kết hợp.
• extInfo — những thứ bổ sung dành riêng cho sản phẩm. Ví dụ: createPool trả về extInfo.poolId; createLaunchpad trả về PDA trạng thái launch mới.

​

Tại sao builder async?

​

Bổ sung module CLMM (bản phát hành mới nhất)

• raydium.clmm.createCustomizablePool — tập hợp super của createPool chấp nhận collectFeeOn, enableDynamicFee, và dynamicFeeConfigId. Sử dụng điều này cho bất kỳ pool mới nào cần các knob mới; createPool cổ điển tiếp tục hoạt động cho các pool phí mặc định.
• raydium.clmm.openLimitOrder — mở một limit order single-tick trên pool hỗ trợ chúng. Lấy poolInfo, poolKeys, limitOrderConfig (từ /main/clmm-limit-order-config), inputMint, inputAmount, và target tick.
• raydium.clmm.increaseLimitOrder / decreaseLimitOrder — điều chỉnh phần chưa được điền của đơn hàng hiện có. Giảm revert trên một đơn hàng đã điền hoàn toàn với InvalidOrderPhase.
• raydium.clmm.settleLimitOrder / settleAllLimitOrder — quét output đã điền vào ATA của owner. Là owner của đơn hàng hay keeper limit_order_admin của pool đều có thể gọi chúng.
• raydium.clmm.closeLimitOrder / closeAllLimitOrder — đóng các đơn hàng đã settle hoàn toàn để khôi phục rent.
• raydium.api.getClmmDynamicConfigs() / getClmmLimitOrderConfigs() — trình helper REST truy cập các endpoint /main/clmm-dynamic-config và /main/clmm-limit-order-config mới.

​

Những lỗi bẫy phổ biến

​

1. Cluster không khớp

​

2. Quên pre-create ATA

​

3. poolInfo cũ

​

4. Priority fees

const { execute } = await raydium.cpmm.swap({
  poolInfo,
  inputAmount: new BN(...),
  swapResult: ...,
  slippage: 0.005,
  txVersion: TxVersion.V0,
  computeBudgetConfig: {
    units: 250_000,          // CU limit
    microLamports: 50_000,   // priority fee per CU
  },
});

​

5. Dung sai slippage phải khớp với loại pool

​

6. BN vs number

​

Chính sách versioning

• @raydium-io/raydium-sdk-v2 là SDK duy nhất mà Raydium duy trì. Tất cả tài liệu, demo và hướng dẫn tích hợp nhắm tới nó.
• Một package v1 cũ hơn (@raydium-io/raydium-sdk) tồn tại trên npm vì lý do lịch sử. Bảo trì kết thúc sau khi CPMM và LaunchLab được gửi (v1 không bao giờ được hỗ trợ cho cả hai), và không có bản phát hành v1 kể từ 2024. Coi v1 là end-of-life: không sử dụng nó cho code mới, và di chuyển bất kỳ tích hợp v1 còn lại sang v2.
• SDK v2 ở giai đoạn pre-1.0. Những thay đổi quan trọng giữa các bản phát hành minor 0.x là có thể; ghim phiên bản bạn đã xác minh và kiểm tra ghi chú phát hành GitHub khi nâng cấp.

​

Nâng cấp

1. Re-check kiểu trả về của mỗi lệnh gọi thay đổi — những thay đổi hình dạng (ví dụ: extInfo) hạ cánh thường xuyên.
2. Tái tạo ra poolInfo fetch signatures — một trường có thể đã được đổi tên.
3. Re-verify xử lý slippage của bạn; SDK đã dịch chuyển giữa auto-bound và opt-in bound behaviors qua các bản phát hành.
4. Nếu bạn sử dụng raydium.trade (routing), re-verify hình dạng route — đó là phần không ổn định nhất của bề mặt.

​

Nhận trợ giúp

• GitHub issues — file tại github.com/raydium-io/raydium-sdk-V2/issues để báo cáo lỗi và yêu cầu tính năng. Đội Raydium giám sát một cách tích cực.
• Discord — channel #dev-support tại discord.gg/raydium để nhận trợ giúp đồng bộ.
• Telegram — developer chat được liên kết từ raydium.io (tránh các nhóm Telegram chưa được xác minh).

​

Con trỏ

• sdk-api/rest-api — phần bổ sung HTTP cho SDK.
• sdk-api/trade-api — swap transactions được xây dựng trên server.
• sdk-api/anchor-idl — tạo lại client trực tiếp từ program IDL.
• sdk-api/python-integration — tương đương Python thông qua solana-py.
• integration-guides/priority-fee-tuning — kích thước computeBudgetConfig.

• Raydium SDK v2 source
• Ghi chú phát hành Raydium SDK.