# @galacticcouncil/sdk 中文文档

规范地址：https://npmcn.com/package/%40galacticcouncil/sdk/

版本：10\.8\.0
npm 元数据更新时间：2026-03-10T18:23:13.584Z
中文译文更新时间：2026-11-15T21:27:56.935Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40galacticcouncil/sdk
原文对照：https://npmcn.com/package/%40galacticcouncil/sdk/?lang=original
项目主页：https://github.com/galacticcouncil/sdk#readme
源码仓库：https://github.com/galacticcouncil/sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：344 kB，98 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：11 个
- peer 依赖：@polkadot/api ~16\.4\.8，@polkadot/api-augment ~16\.4\.8，@polkadot/types ~16\.4\.8，@polkadot/util ~13\.5\.6，@polkadot/util-crypto ~13\.5\.6，viem ^2\.38\.3
- 首次发布：2022-09-02T12:30:07.800Z
- 最新版本发布：2026-03-10T18:23:13.440Z
- 近 30 天下载量：4726（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：224（近 12 个月 14 个）

## 中文简介

银河离链线路和优化各池订单,以最佳价格执行

## 安装

```sh
npm install @galacticcouncil/sdk
```

也可以使用：`pnpm add @galacticcouncil/sdk`、`yarn add @galacticcouncil/sdk`、`bun add @galacticcouncil/sdk`

## README

# 银河SDK

[![npm version](https://img.shields.io/npm/v/@galacticcouncil/sdk.svg)](https://www.npmjs.com/package/@galacticcouncil/sdk)

水分 SDK 顶部 [@polkadot{.js} (中文(简体) )](https://polkadot.js.org/)。 。 。 .

目录 :

-   [安装](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-installation)
-   [解决问题](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-troubleshooting)
-   [使用量](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-usage)
-   [构成部分](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-components)
    -   [api 密码](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-api)
    -   [客户端](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-client)
    -   [页:1](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-ctx)
    -   [tx 类型](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-tx)
-   [API 参考](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-api-reference)
    -   [预告片](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-aaveutils)
    -   [贸易路透社](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-traderouter)
    -   [交易计时器](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-tradescheduler)
    -   [余额](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-balanceclient)
    -   [资产客户端](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-assetclient)
-   [实例](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-examples)

## 安装

安装方式 [无](https://www.npmjs.com/)数字 :

`npm install @galacticcouncil/sdk`

## 解决问题

### 第8.x版 (中文(简体) )

⚠️ **重要内容:** 在8X版里 我们升级了 `@polkadot/api` 改为版本 **16.x (韩语)**。 。 。 .

见 [更改日志](https://github.com/galacticcouncil/sdk/blob/master/packages/sdk/CHANGELOG.md#800) 详细情况.

### 2.x版 (中文(简体) )

截止 **v2.x (英语)** .wasm 文件不再嵌入捆绑 但推迟是为了改善负载性能和减少 模块大小(仅包含).

详细访问情况 [难题. md](https://npmcn.com/package/%40galacticcouncil/sdk/TROUBLESHOOTING.md)

## 使用量

使用 `createSdkContext` 快速设置 SDK 的所有组件——池上下文,交易逻辑,客户访问,和交易建设——在一个单调中.

```ts
import { createSdkContext } from '@galacticcouncil/sdk';
import { ApiPromise, WsProvider } from '@polkadot/api';

const ws = 'wss://hydration-rpc.n.dwellir.com';
const wsProvider = new WsProvider(ws, 2_500, {}, 60_000, 102400, 10 * 60_000);

const api = await ApiPromise.create({
  provider: wsProvider,
});

const sdk = await createSdkContext(api);

// Don't forget to cleanup resources when DONE
sdk.destroy();
api.disconnect();
```

它处理所有必要的设置 在引擎盖下。 只要插上你的ApiPromise, 你准备与注册,账户,池,路由器等互动.

⚠️ **说明:** 确保每个会话只保留一个实例.

## 构成部分

### `api`

-   `aave: AaveUtils` ——涉事公用事业.
-   `router: TradeRouter` ——跨池交易链外优化,实现价格执行最佳.
-   `scheduler: TradeScheduler` ——交易订单调度.

### `client`

-   `asset: AssetClient` 书记官处元数据和查询.
-   `balance: BalanceClient` ——账户余额跟踪.
-   `evm: EvmClient` ——与EVM互动.

### `ctx`

-   `pool: PoolService` ——内国情池上下文. 已启动,支助:
    -   爱
    -   缩写
    -   平面图
    -   XYK 池数
    -   LBP 池库

### `tx`

-   `TxBuilderFactory` 使用流利的API生成可提交交易的工厂.

### `destroy()`

慷慨地清理了SDK的资源. 离开前总是打电话,以避免内存出漏或呆滞订阅.

## API 参考

### 预告片

| 方法 | 说明 |
| :-- | :-- |
| `getSummary(user: string): AaveSummary` | 返回市场摘要. |
| `getHealthFactor(user: string): number` | 计算高频. |
| `getHealthFactorAfterWithdraw(user: string, reserve:string, withdrawAmount: string): number` | 退出后计算高频. |
| `getHealthFactorAfterSupply(user: string, reserve:string, supplyAmount: string): number` | 供应后计算高频. |
| `getMaxWithdraw(user: string, reserve:string): Amount` | 尽量安全撤退. |

\* 用于类型定义访问 [类型.ts](https://npmcn.com/package/%40galacticcouncil/sdk/src/aave/types.ts)  

### 贸易路透社

| 方法 | 说明 |
| :-- | :-- |
| `getPools(): PoolBase[]` | 返回当前可用集合列表. |
| `getAllPaths(tokenIn: string, tokenOut: string): Hop[][]` | 计算两个资产之间的可能路径. |
| `getAllAssets(): PoolBase[]` | 列出可通过路由器进行交易的所有资产. |
| `getAssetPairs(token: string): Asset[]` | 列出所有给定令牌的资产可以交易 . |
| `getBestSell(tokenIn: string, tokenOut: string, amountIn: bigint | string): Trade` | 找到特定投入量的最佳销售交易. |
| `getBestBuy(tokenIn: string, tokenOut: string, amountOut: bigint | string): Trade` | 找到特定产出量的最佳购买交易 . |
| `getBuy(tokenIn: string, tokenOut: string, amountOut: bigint | string, route?: Hop[]): Trade` | 使用特定路由(可选)计算购买. |
| `getSell(tokenIn: string, tokenOut: string, amountIn: bigint | string, route?: Hop[]): Trade` | 使用特定路径( 可选) 计算销售 . |
| `getBestSpotPrice(tokenIn: string, tokenOut: string): Amount` | 获得两个符号之间的当前现货价格. |
| `getMostLiquidRoute(tokenIn: string, tokenOut: string): Hop[]` | 在两个符号之间找到流动性最高的路线. |

\* 用于类型定义访问 [类型.ts](https://npmcn.com/package/%40galacticcouncil/sdk/src/sor/types.ts)  

### 交易计时器

| 方法 | 说明 |
| :-- | :-- |
| `getDcaOrder(assetIn: string, assetOut: string, amountInTotal: string, duration: number): TradeDcaOrder` | 计算 DCA 顺序 . |
| `getTwapBuyOrder(assetIn: string, assetOut: string, amountInTotal: string): TradeOrder` | 计算 TWAP 购买订单 . |
| `getTwapSellOrder(assetIn: string, assetOut: string, amountInTotal: string): TradeOrder` | 计算TWAP销售订单. |

\* 用于类型定义访问 [类型.ts](https://npmcn.com/package/%40galacticcouncil/sdk/src/sor/types.ts)  

### 资产客户端

| 方法 | 说明 |
| :-- | :-- |
| `getOnChainAssets(includeInvalid?: boolean, external?: ExternalAsset[]): Promise<Asset[]>` | 从登记册中以元数据返回资产. |

\* 用于类型定义访问 [类型.ts](https://npmcn.com/package/%40galacticcouncil/sdk/src/types.ts)  

## 实例

所有例子都假设SDK已经初始化, [见](https://npmcn.com/package/%40galacticcouncil/sdk/#readme-usage)

### 贸易路透社

计算 HDX 和 built tx 的 1 DOT 的销售量, 并有 5% 的 滑行率( 如果未指定默认为 1%)

```typescript
const { api, tx } = sdk;

const trade = await api.router.getBestSell("5", "10", "10");
const tradeTx = await tx.trade(trade)
  .withBeneficiary(BENEFICIARY)
  .withSlippage(5)
  .build();
console.log(trade.toHuman());
console.log('Transaction hash:', tradeTx.hex);
```

### 资产客户端

获取链上默认数据 .

```typescript
const { client } = sdk;

const assets = await client.asset.getOnChainAssets();
console.log(assets);
```

展示更多关于真正链条的工作实例,见 [脚本](https://npmcn.com/package/%40galacticcouncil/sdk/test/script/examples) 节.

运行 : `$ npx tsx ./test/script/examples/<examplePackage>/<exampleName>.ts` 有有效示例包名称( n) .

## 常见问题

### @galacticcouncil/sdk 是什么？

银河离链线路和优化各池订单,以最佳价格执行

### 如何安装 @galacticcouncil/sdk？

在项目目录运行 npm install @galacticcouncil/sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@polkadot/api（~16\.4\.8）、@polkadot/api-augment（~16\.4\.8）、@polkadot/types（~16\.4\.8）、@polkadot/util（~13\.5\.6）、@polkadot/util-crypto（~13\.5\.6）、viem（^2\.38\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @galacticcouncil/sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @galacticcouncil/sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @galacticcouncil/sdk 可以商用吗？

@galacticcouncil/sdk 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @galacticcouncil/sdk 的下载量有多少？

根据 npm 官方下载统计，@galacticcouncil/sdk 在 2026/10/16 – 2026/11/14 这 30 天内被下载 4,726 次，日均约 158 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @galacticcouncil/sdk 还在维护吗？

最新版本 10\.8\.0 发布于 2026/03/11（8 个月前）；至今共发布 224 个版本，其中过去 12 个月发布了 14 个；首次发布于 2022/09/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。