Hermes Swap

一个用于去中心化交易所 (DEX) 兑换和跨链桥接的 TypeScript 工具库。

特性

• ✅ 完整的 TypeScript 支持
• ✅ 支持多链 DEX 兑换
• ✅ 支持多跳路由兑换
• ✅ 提供兑换预期查询
• 🚧 跨链桥接功能（开发中）
• 🚧 兑换+桥接组合功能（开发中）

安装

npm install hermes-swap
# 或
yarn add hermes-swap

快速开始

import Hermes, { IConfig, ChainNameEnum } from 'hermes-swap';

// 配置
const config: IConfig = {
  rpc: {
    [ChainNameEnum.ETH]: {
      url: 'https://eth-mainnet.g.alchemy.com/v2/YOUR_KEY',
    }
  },
  quoterAddress: {
    [ChainNameEnum.ETH]: '0xQuoterAddress...'
  },
  aggregatorAddress: {
    [ChainNameEnum.ETH]: '0xAggregatorAddress...'
  },
  executorMap: {
    [ChainNameEnum.ETH]: 'executor-private-key'
  }
};

// 初始化
const hermes = new Hermes(config);

// 查询预期输出
const expectedAmount = await hermes.expect({
  chain: ChainNameEnum.ETH,
  amountInWei: BigInt('1000000000000000000'),
  path: [/* 路由路径 */]
});

// 执行兑换
const receipt = await hermes.swap({
  user: '0xUserAddress...',
  chain: ChainNameEnum.ETH,
  amountInWei: BigInt('1000000000000000000'),
  path: [/* 路由路径 */],
  minAmountOutList: [/* 最小输出量 */]
});

详细文档

查看 USAGE.md 了解完整的使用指南和示例。

导出内容

主类

• Hermes - 主类（默认导出和命名导出）

类型定义

• IConfig, ISwapParams, IExpectParams, IBridgeParams, ISwapAndBridgeParams
• IReceipt, IRouterPath, IExpectPayload

枚举

• ChainNameEnum - 支持的区块链网络
• DexType - DEX 类型

常量

• AddressConst - 常用代币地址

开发

# 安装依赖
yarn install

# 开发模式
npm run dev

# 构建
npm run build

# 测试
npm test

# 测试覆盖率
npm run test:coverage

测试

npm test

LICENSE

MIT