hermes-swap 0.0.15 → 0.0.16

package/README.md

@@ -1,26 +1,115 @@
-# hermes
+# Hermes Swap
 
-[![NPM version](https://img.shields.io/npm/v/hermes.svg?style=flat)](https://npmjs.com/package/hermes)
-[![NPM downloads](http://img.shields.io/npm/dm/hermes.svg?style=flat)](https://npmjs.com/package/hermes)
+[![NPM version](https://img.shields.io/npm/v/hermes-swap.svg?style=flat)](https://npmjs.com/package/hermes-swap)
+[![NPM downloads](http://img.shields.io/npm/dm/hermes-swap.svg?style=flat)](https://npmjs.com/package/hermes-swap)
 
-## Install
+一个用于去中心化交易所 (DEX) 兑换和跨链桥接的 TypeScript 工具库。
+
+## 特性
+
+- ✅ 完整的 TypeScript 支持
+- ✅ 支持多链 DEX 兑换
+- ✅ 支持多跳路由兑换
+- ✅ 提供兑换预期查询
+- 🚧 跨链桥接功能（开发中）
+- 🚧 兑换+桥接组合功能（开发中）
+
+## 安装
 
 ```bash
-$ yarn install
+npm install hermes-swap
+# 或
+yarn add hermes-swap
 ```
 
+## 快速开始
+
+```typescript
+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](./USAGE.md) 了解完整的使用指南和示例。
+
+## 导出内容
+
+### 主类
+- `Hermes` - 主类（默认导出和命名导出）
+
+### 类型定义
+- `IConfig`, `ISwapParams`, `IExpectParams`, `IBridgeParams`, `ISwapAndBridgeParams`
+- `IReceipt`, `IRouterPath`, `IExpectPayload`
+
+### 枚举
+- `ChainNameEnum` - 支持的区块链网络
+- `DexType` - DEX 类型
+
+### 常量
+- `AddressConst` - 常用代币地址
+
+## 开发
+
 ```bash
-$ npm run dev
-$ npm run build
+# 安装依赖
+yarn install
+
+# 开发模式
+npm run dev
+
+# 构建
+npm run build
+
+# 测试
+npm test
+
+# 测试覆盖率
+npm run test:coverage
 ```
 
-## Options
+## 测试
 
-TODO
+```bash
+npm test
+```
 
 ## LICENSE
 
 MIT
-# hermes
-
-测试: npm test

package/dist/cjs/index.d.ts

@@ -1,4 +1,5 @@
-import { IExpectParams, ISwapParams, IBridgeParams, ISwapAndBridgeParams, IReceipt, IConfig } from './types';
+import { IExpectParams, ISwapParams, IBridgeParams, ISwapAndBridgeParams, IReceipt, IConfig, ChainNameEnum, AddressConst, IExpectPayload, DexType, IRouterPath } from './types';
+export { IExpectParams, ISwapParams, IBridgeParams, ISwapAndBridgeParams, IReceipt, IConfig, ChainNameEnum, AddressConst, IExpectPayload, DexType, IRouterPath };
 declare class Hermes {
     private config;
     private providerMap;
@@ -16,3 +17,4 @@ declare class Hermes {
     private getAggregatorAddress;
 }
 export default Hermes;
+export { Hermes };

package/dist/cjs/index.js

@@ -29,9 +29,22 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  AddressConst: () => import_types.AddressConst,
+  ChainNameEnum: () => import_types.ChainNameEnum,
+  DexType: () => import_types.DexType,
+  Hermes: () => Hermes,
+  IBridgeParams: () => import_types.IBridgeParams,
+  IConfig: () => import_types.IConfig,
+  IExpectParams: () => import_types.IExpectParams,
+  IExpectPayload: () => import_types.IExpectPayload,
+  IReceipt: () => import_types.IReceipt,
+  IRouterPath: () => import_types.IRouterPath,
+  ISwapAndBridgeParams: () => import_types.ISwapAndBridgeParams,
+  ISwapParams: () => import_types.ISwapParams,
   default: () => src_default
 });
 module.exports = __toCommonJS(src_exports);
+var import_types = require("./types");
 var import_ethers = require("ethers");
 var import_ethers2 = require("ethers");
 var import_quoter = __toESM(require("./abis/quoter"));
@@ -182,3 +195,18 @@ var Hermes = class {
   }
 };
 var src_default = Hermes;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AddressConst,
+  ChainNameEnum,
+  DexType,
+  Hermes,
+  IBridgeParams,
+  IConfig,
+  IExpectParams,
+  IExpectPayload,
+  IReceipt,
+  IRouterPath,
+  ISwapAndBridgeParams,
+  ISwapParams
+});

package/dist/esm/index.d.ts

@@ -1,4 +1,5 @@
-import { IExpectParams, ISwapParams, IBridgeParams, ISwapAndBridgeParams, IReceipt, IConfig } from './types';
+import { IExpectParams, ISwapParams, IBridgeParams, ISwapAndBridgeParams, IReceipt, IConfig, ChainNameEnum, AddressConst, IExpectPayload, DexType, IRouterPath } from './types';
+export { IExpectParams, ISwapParams, IBridgeParams, ISwapAndBridgeParams, IReceipt, IConfig, ChainNameEnum, AddressConst, IExpectPayload, DexType, IRouterPath };
 declare class Hermes {
     private config;
     private providerMap;
@@ -16,3 +17,4 @@ declare class Hermes {
     private getAggregatorAddress;
 }
 export default Hermes;
+export { Hermes };

package/dist/esm/index.js

@@ -15,10 +15,14 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { IExpectParams, ISwapParams, IBridgeParams, ISwapAndBridgeParams, IReceipt, IConfig, ChainNameEnum, AddressConst, IExpectPayload, DexType, IRouterPath } from "./types";
 import { ethers } from 'ethers';
 import { Contract } from 'ethers';
 import QuoterAbi from "./abis/quoter";
 import AggregatorAbi from "./abis/aggregator";
+
+// 导出所有类型定义，方便用户使用
+export { IExpectParams, ISwapParams, IBridgeParams, ISwapAndBridgeParams, IReceipt, IConfig, ChainNameEnum, AddressConst, IExpectPayload, DexType, IRouterPath };
 var Hermes = /*#__PURE__*/function () {
   function Hermes(config) {
     _classCallCheck(this, Hermes);
@@ -338,5 +342,8 @@ var Hermes = /*#__PURE__*/function () {
     }
   }]);
   return Hermes;
-}();
-export default Hermes;
+}(); // 默认导出 Hermes 类
+export default Hermes;
+
+// 同时提供命名导出，方便不同使用场景
+export { Hermes };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "hermes-swap",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "A TypeScript utility library for swap and bridge",
-  "main": "dist/cjs/index.js",
-  "types": "dist/cjs/index.d.ts",
+  "main": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "scripts": {
     "dev": "father dev",
     "build": "father build",