TypeScript SDK

​

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 phát hiện tính năng khởi động của SDK
  blockhashCommitment: "confirmed",
});

​

Các module facade

raydium.cpmm       // CPMM pools: createPool, addLiquidity, withdrawLiquidity, swap, ...
raydium.clmm       // CLMM pools: createPool, openPositionFromBase, increasePositionFromBase,
                   //             decreaseLiquidity, harvestAllRewards, swap, limit orders, ...
raydium.liquidity  // AMM v4 pools: computeAmountOut, swap, addLiquidity, removeLiquidity, ...
raydium.farm       // Farm v3/v5/v6: deposit, withdraw, harvestAllRewards, create,
                   //                restartReward(s), addNewRewardToken(s)
raydium.launchpad  // LaunchLab: createLaunchpad, buyToken, buyTokenExactOut, sellToken,
                   //            claimCreatorFee, curve-rule and platform-config builders, ...
raydium.tradeV2    // Multi-pool routing: route discovery, compute, route-execution
raydium.marketV2   // OpenBook market creation (legacy)
raydium.utils1216  // One-off historical-claim helpers
raydium.token      // Token list + metadata: load(), getTokenInfo()
raydium.account    // Wallet token accounts, ATA lookup and creation
raydium.api        // The REST client (fetchPoolById, getCpmmConfigs, fetchLaunchConfigs, ...)

​

Các builder giao dịch

import { Percent } from "@raydium-io/raydium-sdk-v2";

const { execute, builder, transaction, instructionTypes, signers, extInfo } =
  await raydium.cpmm.addLiquidity({
    poolInfo,
    inputAmount,              // BN — one side, not a pair
    baseIn: true,
    slippage: new Percent(1, 100),   // a Percent, not a number
    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 hướng dẫn và người ký được tích lũy. builder.build() trả về một TxBuildData mà transaction của nó là một Transaction legacy duy nhất; builder.buildV0() trả về một TxV0BuildData với một VersionedTransaction duy nhất. Chỉ buildMultiTx / buildMultiTxV0 mới tạo ra một mảng.
• transaction — Transaction / VersionedTransaction đã được xây dựng.
• instructionTypes / signers — các nhãn hướng dẫn và tập người ký được tích lũy.
• extInfo — các tính năng bổ sung cụ thể cho sản phẩm. Ví dụ: cpmm.createPool trả về extInfo.address.{poolId, lpMint, vaultA, vaultB}; launchpad.createLaunchpad trả về extInfo.address (một LaunchpadPoolInfo cùng với poolId).

​

Tại sao các builder async?

​

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

• raydium.clmm.createCustomizablePool — siêu tập hợp của createPool chấp nhận collectFeeOn và dynamicFeeConfig (PublicKey của tài khoản cấu hình). Việc cung cấp dynamicFeeConfig chính là điều bật phí động; không có cờ enableDynamicFee riêng và cũng không có dynamicFeeConfigId. 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 lệnh giới hạn tick đơn. Lấy poolInfo, baseIn (hướng), orderTick, amount, và tùy chọn tickArrayBitmap, noneIndex, ownerInfo. Dùng trợ giúp được xuất ra getOrderTick({ baseIn, mintADecimal, mintBDecimal, tickSpacing, price }) để lượng tử hóa tick.
• raydium.clmm.increaseLimitOrder / decreaseLimitOrder — điều chỉnh phần chưa điền của một lệnh hiện có. Cả hai lấy { poolInfo, limitOrder, amount }; decreaseLimitOrder thêm một slippage tùy chọn. Giảm sẽ hoàn nguyên trên một lệnh đã điền đầy với InvalidOrderPhase.
• raydium.clmm.settleLimitOrder / settleAllLimitOrder — quét đầu ra đã điền vào ATA của chủ sở hữu. settleLimitOrder chỉ lấy { limitOrder } — không có poolInfo. Hoặc chủ sở hữu lệnh hoặc keeper limit_order_admin của chương trình đều có thể gọi nó.
• raydium.clmm.closeLimitOrder / closeAllLimitOrder — đóng các lệnh đã giải quyết hoàn toàn để khôi phục tiền thuê.
• raydium.api.getClmmDynamicConfigs() — trợ giúp REST nhấn điểm cuối mới /main/clmm-dynamic-config. (Không có trợ giúp hay điểm cuối cấu hình lệnh giới hạn: các lệnh giới hạn được khóa theo tick, không theo một tài khoản cấu hình cho mỗi pool.)

​

Những cạm bẫy phổ biến

​

1. Cluster không khớp

​

2. Quên tạo trước ATA

​

3. poolInfo cũ

​

4. Phí ưu tiên

const { execute } = await raydium.cpmm.swap({
  poolInfo,
  baseIn,                    // required: which side inputAmount is denominated in
  inputAmount: new BN(...),
  swapResult: ...,           // required: from CurveCalculator.swapBaseInput/Output
  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 so với number

​

Chính sách phiên bản

• @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 mục tiêu nó.
• Một gói 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 nào kể từ năm 2024. Coi v1 là hết hạn: không sử dụng nó cho mã mới, và di chuyển bất kỳ tích hợp v1 còn lại sang v2.
• SDK v2 là pre-1.0. Các thay đổi ngắt giữa các bản phát hành phụ 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. Kiểm tra lại kiểu trả về của mọi lệnh gọi thay đổi — các thay đổi hình dạng (ví dụ: extInfo) xảy ra thường xuyên.
2. Tạo lại chữ ký tìm nạp poolInfo — một trường có thể đã được đổi tên.
3. Xác minh lại xử lý slippage của bạn; SDK đã chuyển giữa các hành vi ràng buộc tự động và ràng buộc opt-in trên các bản phát hành.
4. Nếu bạn sử dụng raydium.tradeV2 (định tuyến), xác minh lại hình dạng tuyến đường — đó là phần không ổn định nhất của bề mặt. Lưu ý facade đã được đổi tên từ trade thành tradeV2; tên cũ không còn tồn tại.

​

Nhận trợ giúp

• GitHub issues — tệp tại github.com/raydium-io/raydium-sdk-V2/issues cho lỗi và yêu cầu tính năng. Nhóm Raydium theo dõi một cách tích cực.
• Discord — kênh #dev-support tại discord.gg/raydium để nhận trợ giúp đồng bộ.
• Telegram — trò chuyện nhà phát triển được liên kết từ raydium.io (tránh các nhóm Telegram không được xác minh).

​

Con trỏ

• sdk-api/rest-api — phần bổ sung HTTP cho SDK.
• sdk-api/trade-api — các giao dịch swap được xây dựng trên máy chủ.
• sdk-api/anchor-idl — tạo lại các client trực tiếp từ IDL chương trình.
• sdk-api/python-integration — tương đương Python 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.