# @ekubo/sdk 中文文档

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

版本：0\.0\.10
npm 元数据更新时间：2026-08-20T05:12:57.046Z
中文译文更新时间：2026-11-13T10:17:42.061Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：130 kB，25 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-02-12T19:48:29.253Z
- 最新版本发布：2026-08-04T13:57:56.920Z
- 近 30 天下载量：21991（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 5 个）

## 中文简介

Ekubo 共享数学和协议编码工具

## 安装

```sh
npm install @ekubo/sdk
```

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

## README

# @ekubo/ sdk

共享类型脚本数学和协议编码工具 [Ekubo 协议](https://ekubo.org/)支持EVM和史塔克网.

## 安装

```sh
npm install @ekubo/sdk
# or
bun add @ekubo/sdk
```

## 使用量

所有功能都是纯洁和无依赖的. 精确协议整数使用本地 `bigint` 数值.

```ts
import {
  toSqrtRatio,
  computeStep,
  maxLiquidityForTokenAmounts,
} from "@ekubo/sdk";

// Convert a tick to a sqrt ratio for Starknet
const sqrtRatio = toSqrtRatio(0, "starknet");

// Compute a single swap step
const result = computeStep({
  sqrtRatio,
  liquidity: 1000000n,
  sqrtRatioLimit: toSqrtRatio(100, "starknet"),
  amount: 500n,
  isToken1: false,
  fee: 0n,
});
// result: { consumedAmount, calculatedAmount, sqrtRatioNext, feeAmount }

// Compute the maximum liquidity for a position given token amounts
const liquidity = maxLiquidityForTokenAmounts({
  sqrtPrice: sqrtRatio,
  sqrtPriceLower: toSqrtRatio(-100, "starknet"),
  sqrtPriceUpper: toSqrtRatio(100, "starknet"),
  amountBase: 1000n,
  amountQuote: 1000n,
});
```

## API 参考

### 类型

#### `Chain`

```ts
type Chain = "evm" | "starknet";
```

选择特定链式勾选和 sqrt 比率边界 .

* * *

### 常数

| 名称 | 说明 |
| --- | --- |
| `MAX_U128` | 128 位无符号整数的最大值 |
| `MAX_U256` | 256位无符号整数的最大值 |
| `EVM_MIN_TICK` | EVM 最小勾选 |
| `EVM_MAX_TICK` | EVM 最大勾选 |
| `EVM_MIN_SQRT_RATIO` | EVM的最低比例 |
| `EVM_MAX_SQRT_RATIO` | EVM 最大 squrt 比率 |
| `EVM_MAX_TICK_SPACING` | EVM 最大勾选间隔 |
| `STARKNET_MIN_TICK` | Starknet 最小勾选 |
| `STARKNET_MAX_TICK` | Starknet 的最大勾选 |
| `STARKNET_MIN_SQRT_RATIO` | Starknet 的最低比例 |
| `STARKNET_MAX_SQRT_RATIO` | Starknet 的最大 squrt 比率 |
| `STARKNET_MAX_TICK_SPACING` | Starknet 的最大勾选间隔 |

* * *

### 勾选 / Sqrt 比率

#### `toSqrtRatio(tick: number, chain: Chain): bigint`

将勾选索引转换为给定链的固定点 sqrt 比率.

```ts
const sqrtRatio = toSqrtRatio(1000, "evm");
```

#### `floatSqrtRatioToFixed(sqrtRatioFloat: bigint): bigint`

将紧凑的96位浮点比例(存储于Starknet主网的链上)转换为数学函数中使用的固定点表示.

#### `fixedSqrtRatioToFloat(sqrtRatio: bigint): bigint`

将定点 sqrt 比率转换为 Starknet 主网所期望的紧凑浮点格式 .

* * *

### 笔数三角洲

#### `amount0Delta(sqrtRatioA, sqrtRatioB, liquidity, roundUp): bigint`

计算给定流动性在两个 sqrt 比率之间的值(基准值).

#### `amount1Delta(sqrtRatioA, sqrtRatioB, liquidity, roundUp): bigint`

计算给定流动性的两个 sqrt 比率之间的令牌1 (引用令牌)的金额.

* * *

### 价格 / Sqrt 比率

#### `nextSqrtRatioFromAmount0(sqrtRatio, liquidity, amount0): bigint | null`

计算交易给定的 order0 后下一个 sqrt 比率。 回返 `null` 如果结果超出范围.

#### `nextSqrtRatioFromAmount1(sqrtRatio, liquidity, amount1): bigint | null`

计算交易给定的值 1 后的下个 sqrt 比率 。 回返 `null` 如果结果超出范围.

* * *

### 交换

#### `computeStep({ sqrtRatio, liquidity, sqrtRatioLimit, amount, isToken1, fee }): SwapResult`

计算在勾选范围内的一阶互换.

-   `sqrtRatio` - 现行比例
-   `liquidity` - 流动资金
-   `sqrtRatioLimit` - 互换停止的积分比(价格限制)
-   `amount` - 签名值为互换;负值表示准确输出
-   `isToken1` – 说吧 – `true` 如果指定的金额是符号 1
-   `fee` - 收费占 `2^128`

回返情况:

```ts
{
  consumedAmount: bigint; // amount of the specified token consumed
  calculatedAmount: bigint; // amount of the other token
  sqrtRatioNext: bigint; // sqrt ratio after the step
  feeAmount: bigint; // fee collected
}
```

* * *

### 流动性

#### `maxLiquidityForBaseToken({ sqrtPriceLower, sqrtPriceUpper, amount }): bigint`

返回在价格范围内从一定数量的基准令牌(token0)中可实现的最大流动性.

#### `maxLiquidityForQuoteToken({ sqrtPriceLower, sqrtPriceUpper, amount }): bigint`

返回在价格范围内从一定数量的引号(token1)中可实现的最大流动性.

#### `maxLiquidityForTokenAmounts({ sqrtPrice, sqrtPriceLower, sqrtPriceUpper, amountBase, amountQuote }): bigint`

返回可实现的最大流动性,既考虑到象征性数额,又考虑到当前价格.

#### `maxLiquidityForSpecifiedAmount({ sqrtPrice, sqrtPriceLower, sqrtPriceUpper, amount }): bigint`

返回指定基数或引数的最大流动性.

```ts
// Specify base amount
const liq = maxLiquidityForSpecifiedAmount({
  sqrtPrice,
  sqrtPriceLower,
  sqrtPriceUpper,
  amount: { base: 1000n },
});

// Specify quote amount
const liq2 = maxLiquidityForSpecifiedAmount({
  sqrtPrice,
  sqrtPriceLower,
  sqrtPriceUpper,
  amount: { quote: 1000n },
});
```

#### `amountsFromSpecifiedAmount({ sqrtPrice, sqrtPriceLower, sqrtPriceUpper, amount }): { base, quote, maxLiquidity }`

鉴于一个基数或引号金额,返回该位置的标值和最大流动性.

#### `liquidityToAmountBase({ sqrtPriceLower, sqrtPriceUpper, liquidity }): bigint`

将流动性值转换为价格范围所需的基值值.

#### `liquidityToAmountQuote({ sqrtPriceLower, sqrtPriceUpper, liquidity }): bigint`

将流动性值转换为价格范围所需报价值.

* * *

### 图瓦卢

#### `calculateNextSqrtRatio(sqrtRatio, liquidity, token0SaleRate, token1SaleRate, timeElapsed, fee): bigint`

计算特定时间过后TWAMM(时间加权平均市场制造者)的下个 squrt比率.

* * *

### 公用事业

#### `msb(x: bigint): number`

返回最显著位的位置 `x`。 。 。 .

* * *

### EVM v3 池键

`encodeEvmConcentratedPoolConfig` 财务报告和审定财务报表 `encodeEvmStableswapPoolConfig` 收拾东西 Core使用的32字节v3配置. `decodeEvmPoolConfig` 返回扩展名, 准确 `bigint` Q64 收费,池式歧视,以及类型特定参数.

`encodeEvmPoolKey` 返回由 Core 编码的 96 字节ABI 编码. `deriveEvmPoolId` 接受消费者提供的Keccak-256功能,该功能 保持无 SDK 依赖性 :

```ts
import { deriveEvmPoolId, encodeEvmConcentratedPoolConfig } from "@ekubo/sdk";
import { keccak256 } from "viem";

const config = encodeEvmConcentratedPoolConfig({
  fee: 2n ** 64n / 10_000n,
  tickSpacing: 200,
  extension: "0x0000000000000000000000000000000000000000",
});
const poolId = deriveEvmPoolId({ token0, token1, config }, keccak256);
```

遗产位置 阅读器可以使用 `encodeEvmV2ConcentratedPoolConfig` 财务报告和审定财务报表 `encodeEvmV2StableswapPoolConfig`; v2 配置故意省略 v3 池 类型歧视者.

### EVM 协议密钥和带盐的ID

SDK还拥有应用程序共享的确切协议编码和 交易编制者 :

-   `encodeEvmAuctionConfig` 编号 : `decodeEvmAuctionConfig`
-   `encodeEvmTwammOrderConfig` 编号 : `decodeEvmTwammOrderConfig`
-   `calculateEvmTwammMaxSaleRate`
-   `deriveEvmAuctionTokenId`, (中文(简体) ), `deriveEvmTwammOrderTokenId`,以及 `deriveEvmVeTokenId`
-   `deriveEvmIndexedSalt`

运行功能接受呼叫器提供的 Keccak-256 执行 sDK的依赖性是无的,同时在各地使用相同的ABI预想.

* * *

## 发展

这个项目使用 [阿宝](https://bun.sh/)。 。 。 .

```sh
# Install dependencies
bun install

# Run tests
bun test

# Build
bun run build
```

## 许可证

[麻省理工学院](https://npmcn.com/package/%40ekubo/sdk/LICENSE)

## 常见问题

### @ekubo/sdk 是什么？

Ekubo 共享数学和协议编码工具

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

在项目目录运行 npm install @ekubo/sdk，或使用 pnpm add / yarn add / bun add。

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

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

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

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

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

@ekubo/sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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