@ bagsfm/ bags- sdk
一个用于与 Bags Public API 互动的TypeScript SDK - 索拉纳令牌发布和管理平台.
详细的API文件、指南和实例,访问 文件.bags.fm。 。 。 .
安装
npm install @bagsfm/bags-sdk
使用量
import { BagsSDK } from '@bagsfm/bags-sdk';
import { Connection, PublicKey } from '@solana/web3.js';
// Initialize the SDK
const connection = new Connection('https://mainnet.helius-rpc.com/?api-key=your-helius-api-key'); // Or any other RPC provider
const sdk = new BagsSDK('your-bags-api-key', connection, 'processed');
// Query token creators
const tokenMint = new PublicKey('your-token-mint-address');
const creators = await sdk.state.getTokenCreators(tokenMint);
console.log('Token creators:', creators);
// Get a swap quote
const quote = await sdk.trade.getQuote({
inputMint: 'So11111111111111111111111111111111111111112',
outputMint: 'your-token-mint-address',
amount: 1_000_000_000, // 1 SOL in lamports
slippageMode: 'dynamic',
});
console.log('Swap quote:', quote);
// Claim fees
const claimable = await sdk.fee.getAllClaimablePositions(walletPublicKey);
console.log('Claimable positions:', claimable);
API 参考
BagsSDK 软件
提供所有服务的SDK主课.
构造器
new BagsSDK(apiKey: string, connection: Connection, commitment?: Commitment)
参数:
apiKey: 您的 Bags API 密钥connection: 索拉纳网3.js 连接实例commitment: (可选)交易承诺级别(默认:'processed'(中文(简体) )
服务
| 服务 | 财产 | 说明 |
|---|---|---|
| API 客户端 | sdk.bagsApiClient | 用于直接 Bags API 呼叫的低级 HTTP 客户端 |
| 托肯启动 | sdk.tokenLaunch | 创建令牌启动并上传令牌元数据 |
| 状态 | sdk.state | 查询象征性创建者、终身费用、领导板、发射钱包和索赔数据 |
| 配置 | sdk.config | 创建和管理费用分摊配置和查询表 |
| 收费 | sdk.fee | 列出可索赔的手续费和建筑索赔交易 |
| 合伙人 | sdk.partner | 阅读/创建伙伴配置和索赔伙伴费用 |
| 贸易 | sdk.trade | 获取互换报价并构建互换交易 |
| 索拉纳 | sdk.solana | 提交 Jito 捆绑, 检查捆绑状态, 并查询 Jito 小费 |
| 收费共享管理员 | sdk.feeShareAdmin | 传输管理员角色、 列出管理员薄荷并更新共享配置 |
| 屏幕 | sdk.dexscreener | 检查订单可用性、创建订单并提交Dexscreener列表的付款 |
| 认证 | sdk.auth | 获取 API 密钥所有者的用户配置 |
| 罗宾 | sdk.robinhood | 列出Robinhood Chain可索赔的据点和未签字的索赔交易 |
出口公用事业
SDK 也导出您可以直接导入的辅助函数和类型 :
import {
sleep,
chunkArray,
signAndSendTransaction,
sendBundleAndConfirm,
createTipTransaction,
serializeVersionedTransaction,
prepareImageForFormData,
detectImageInputType,
sortKeys,
} from '@bagsfm/bags-sdk';
导出常数
常见的程序ID和地址为已命名的导出:
import {
BAGS_FEE_SHARE_V1_PROGRAM_ID,
BAGS_FEE_SHARE_V2_PROGRAM_ID,
METEORA_DBC_PROGRAM_ID,
METEORA_DAMM_V2_PROGRAM_ID,
BAGS_GLOBAL_LUT,
WRAPPED_SOL_MINT,
JITO_TIP_ACCOUNTS,
} from '@bagsfm/bags-sdk';
所需资源
- 节点.js 18.0.0
- 一个 Bags API 密钥( 在 https://dev.bags.fm (英语)(中文(简体) )
- Solana RPC 供应商(我们建议 赫利乌斯 - 他们提供免费等级)
发展
# Install dependencies
npm install
# Build the project
npm run build
# Watch mode for development
npm run dev
# Run tests
npm test
# Run tests in watch mode
npm run test:watch
# Lint source files
npm run lint
# Lint and auto-fix
npm run lint:fix
# Format source files
npm run format
# Check formatting
npm run format:check
# Clean build artifacts
npm run clean
许可证
麻省理工学院
支助
问题请访问 GitHub 问题。 。 。 .