HawkFi SDK 软件
用于与 Hawk 互动的全面类型SDK Fi的块链API和DeFi协议关于索拉纳. 这个SDK提供了一个统一的接口,用于管理流动性位置,执行交易,并与包括Meteora,Orca,Raydium,和Jupiter在内的多个DeFi协议相互作用.
* 特性
- 多议定书支持: 与Meteora DLMM, Orca Whirlpools, Raydium V2和木星完全融合
- 交易管理: 综合交易生成、签署和执行
- 职位管理: 创建、存款、取出和关闭流动资金头寸
- 自动化: 用于复合、再平衡和限制订单的自动化工作流程
- 账户管理: PDA 生成、令牌账户处理和缓存
- 卫生监测API 健康检查和系统状况监测
- 组合管理: 用户组合跟踪和位置分析
* 安装
npm install @hawksightco/hawk-sdk
或者说
yarn add @hawksightco/hawk-sdk
建筑
SDK是围绕一个模块化的架构而建造的,其关键组件如下:
核心类
HawkAPI - 主要入境点
提供所有SDK功能的中央管弦乐器:
import { HawkAPI } from '@hawksightco/hawk-sdk';
const hawkAPI = new HawkAPI('https://api2.hawksight.co');
TxGenerator - 交易管理
处理所有支持协议的区块链交易的创建和管理.
Client - HTTP 客户端
环绕Swagger客户端进行API通信,处理出错.
协议模块
- 梅特奥拉: DLMM 位置管理,自动化,快速生成
- 奥尔卡: Whirlpools 职位管理,奖励索赔
- Ium: V2 位置管理,NFT处理
- 木星:托肯互换,路由优化
QQ 快速启动
基本设置
import { HawkAPI } from '@hawksightco/hawk-sdk';
import { Connection, PublicKey } from '@solana/web3.js';
// Initialize connection and SDK
const connection = new Connection('https://api.mainnet-beta.solana.com');
const hawkAPI = new HawkAPI('https://api2.hawksight.co');
// Check API health
const health = await hawkAPI.health.check();
console.log('API Health:', health);
获取用户组合
const portfolio = await hawkAPI.general.getPortfolio({
wallet: 'user_wallet_address'
});
console.log('User Portfolio:', portfolio);
创建 Meteora 位置
import { BN } from 'bn.js';
const position = await hawkAPI.txGenerator.meteora.createPositionAndDeposit({
connection,
params: {
position: new PublicKey('position_address'),
pool: new PublicKey('pool_address'),
userWallet: new PublicKey('user_wallet'),
totalXAmount: new BN(1000000), // 1 token with 6 decimals
totalYAmount: new BN(1000000), // 1 token with 6 decimals
binRange: { lowerRange: 100, upperRange: 200 },
distribution: 'SPOT',
slippage: 0.01 // 1%
}
});
console.log('Position Created:', position);
执行批次交易
const result = await hawkAPI.batchExecute({
connection,
payer: new PublicKey('payer_address'),
instructions: [...], // Array of instructions
signers: [...], // Array of signers
lookupTableAddresses: [...] // Address lookup tables
});
console.log('Batch Execution Result:', result);
API 参考
HawkAPI 类
构造器
new HawkAPI(url?: string, options?: HawkApiOptions)
属性
health: 卫生检查设施general:一般API业务generalUtility: 一般工具端点util: 工具函数txGenerator: 交易生成txGeneratorAutomation:自动交易工作流程search: 托肯搜索功能ix: 简单指令生成器jupAlts: 木星替代品jupiterSwap: 木星互换功能pda: 简单的 PDA 生成器
方法
anchor(connection): 获取 Anchor 程序实例mintCache(connection): 获取薄荷缓存实例tokenCache(connection): 获取符号缓存实例combine(params): 合并多个交易batchExecute(params): 执行批次交易atomicity(params): 执行原子交易logging(flag): 启用/禁用日志raydiumSDK(connection): 获取Raydium SDK 实例
交易生成
网络操作
// Create position and deposit
await hawkAPI.txGenerator.meteora.createPositionAndDeposit(params);
// Deposit to existing position
await hawkAPI.txGenerator.meteora.deposit(params);
// Withdraw from position
await hawkAPI.txGenerator.meteora.withdraw(params);
// Close position
await hawkAPI.txGenerator.meteora.close(params);
// Claim rewards
await hawkAPI.txGenerator.meteora.claim(params);
// Compound rewards
await hawkAPI.txGenerator.meteora.compound(params);
// Rebalance position
await hawkAPI.txGenerator.meteora.rebalance(params);
已选中的多键复合
使用自动化发电机将一个游泳池收费符号组合起来,并保留另一个:
await hawkAPI.txGeneratorAutomation.meteoraCompoundFromLargePositionIxs(
connection,
payer,
{
userWallet,
position,
compoundTokenX: true,
compoundTokenY: false,
distribution: 'SPOT-IMBALANCED',
},
);
两种控件默认为 true,保留现有的复合行为并返回
格式。 设置为 false 生成只要求的交易。 键 X/Y
指泳池的薄荷定单. 用户PDA的ATA中仍然保留未选择的费用;
此方法不互换或转移给钱包。 奖励目的地
继续跟进 pdaTokenType。 。 。 .
选定的申请使用明确的净收费预算 在每个存款块, 包括最后一笔账户,永远不要扫清原有账户余额。 如果选中 符号不能存入当前激活的垃圾桶,其费用被索赔 保留。 执行前的活套移动仍可使押金无效; 呼叫者在重建失败运行之前必须核对已登陆的债权交易.
使用 meteoraCompoundFromLargePositionIxs 这些控件的所有位置宽度.
遗产 meteoraCompoundIxs 方法拒绝选中的按键请求。 执行
需要现有的 meteora_dlmm_add_liquidity_2_automation 指令; 已部署
兼容性和交易模拟必须先检查,然后允许混合
消费服务的自动化.
对于 AA: AC 混合 STA 累积,明确选择:
await hawkAPI.txGeneratorAutomation.meteoraCompoundFromLargePositionIxs(
connection,
payer,
{
userWallet,
position,
feeMode: 'hybrid',
compoundTokenX: true,
compoundTokenY: false,
distribution: 'CURVE-IMBALANCED',
},
);
在此模式下,选定费用复合 distribution,而未选择收费
直接向用户PDA STA索赔,扣除收割费。 缺少STA
在索赔前先初始化。 两者 false 在STA中累积两个符;
两者 true 混合使用限定净费数额。 没有费用交换或
产生整体平衡转移。 现有的技援/技援基金没有存入.
在需要押金时,设立押金还可确保两家汇兑的意向安排,包括:
零存款侧。 仅要求STA的积累不会产生这些额外的ATA.
报酬的处理仍受下列规定制约: pdaTokenType关闭 feeMode 保存
选择的 ATA 保留行为。 此选项适用于
复合发电机,而不是再平衡发电机;消费者必须明确电线
他们的混合再平衡处理,而不是假设它是由这个领域所允许的.
Orca 业务
// Open position
await hawkAPI.txGenerator.orca.openPosition(params);
// Close position
await hawkAPI.txGenerator.orca.closePosition(params);
// Deposit to position
await hawkAPI.txGenerator.orca.deposit(params);
// Withdraw from position
await hawkAPI.txGenerator.orca.withdraw(params);
// Claim rewards
await hawkAPI.txGenerator.orca.claimRewards(params);
Ium操作
// Open position
await hawkAPI.txGenerator.raydium.openPosition(params);
// Close position
await hawkAPI.txGenerator.raydium.closePosition(params);
// Increase liquidity
await hawkAPI.txGenerator.raydium.increaseLiquidity(params);
// Decrease liquidity
await hawkAPI.txGenerator.raydium.decreaseLiquidity(params);
工具函数
PDA 生成
import { generateUserPda, generateAta, generateLimitToken } from '@hawksightco/hawk-sdk';
const userPda = generateUserPda(userWallet);
const ata = generateAta(owner, mint);
const limitToken = generateLimitToken(userPda, mint);
交易公用事业
import { createTxMetadata, resultOrError } from '@hawksightco/hawk-sdk';
const metadata = await createTxMetadata(generalUtility, connection, payer, data);
测试
运行测试套件 :
yarn test
测试套房包括:
- 所有主要构成部分的单位测试
- 协议互动的综合测试
- 交易生成测试
- 处理测试出错
建筑
将类型脚本源构建为 JavaScript :
yarn build
这创造了 dist/ 包含编译的 JavaScript 文件的目录 .
依赖关系
核心依赖关系
@solana/web3.js- 索拉纳区块链互动@coral-xyz/anchor- 索拉纳方案互动@meteora-ag/dlmm- Meteora协议SDK@orca-so/whirlpools-sdk- Orca协议SDK@raydium-io/raydium-sdk-v2- Raydium协议SDK@hawksightco/swagger-client- 自动生成的API客户端
发展依赖
typescript- 类型脚本汇编jest- 测试框架@types/*- 类型脚本类型定义
协议支持
| 议定书 | 特征 | 状态 |
|---|---|---|
| 梅特奥拉 | DLMM 位置、自动化、快速生成 | ++ 充分支持 |
| 奥尔卡 | 胡尔池、职位管理、奖励 | ++ 充分支持 |
| Ium | V2职位、NFT处理、自动化 | ++ 充分支持 |
| 木星 | 交换、路由、替代办法 | ++ 充分支持 |
版本管理
- 当前版本数字 :
1.3.9 - 依赖关系: 使用有适当范围的语义版本
~仅用于补丁更新(例如,~1.0.51(中文(简体) )^用于小更新(例如:,^0.29.0(中文(简体) )
发展
添加新协议
- 在
src/ixGenerator/ - 在其中添加 PDA 生成器
src/pdaGenerator/ - 将IDL定义纳入
src/idl/ - 添加类型
src/types.ts - 与
TxGenerator类 - 添加综合测试
处理错误
- 使用
AppError用于一致错误处理的分类 - 包含正确的错误消息和代码
- 处理网络故障
- 提供有意义的错误反应
* 额外资源
捐款
当为 SDK 贡献时 :
- 遵循类型脚本最佳做法
- 添加新特性的综合测试
- 更新 API 更改的文档
- 提交前确保所有测试通过
- 使用语义输入消息
许可证
麻省理工学院许可证 - 详情见LICENSE文件.