> ## Documentation Index
> Fetch the complete documentation index at: https://docs.powfi.alephium.org/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK 与 API

> 基于 Powfi（Alephium 上的 DeFi 协议）进行开发：兑换、集中流动性与恒定乘积流动性，以及 xALPH 流动性质押。

Powfi 目前提供一个集成入口：**TypeScript SDK**（`@alephium/powfi-sdk`）。它封装了 Alephium 上的 Powfi 智能合约（CPMM 池、CLMM 池和 xALPH 质押），在本地计算报价，并通过任意 `@alephium/web3` 签名器构建和签署交易。

## 本章适合谁

* **钱包和前端开发者**：报价并执行兑换、展示池数据，或让用户提供流动性。
* **后端和机器人开发者**：针对 Powfi 池运行做市、套利或资金管理自动化。
* **聚合器和集成方**：通过 Powfi 路由交易，并可选择收取[集成方手续费](/zh/guides/integrator-fees)。

<Info>
  **想先跑点东西？** [快速开始](/zh/quickstart)用约 20 行代码读取测试网上的 CPMM 池并给出兑换报价，无需签名器。
</Info>

## 选择集成方式

| 你要构建的是 | 使用 | 原因 |
| - | - | - |
| 兑换界面或钱包 | `powfi.cpmm` / `powfi.clmm` + 静态报价函数 | 本地报价（每次按键无需 RPC），交易与签名器无关 |
| 交易机器人或后端 | `Powfi.load({ networkId, signer })` 搭配 `PrivateKeyWallet` | 完全控制滑点、截止时间和路由选择 |
| CLMM 流动性管理工具 | `powfi.clmm` + [`TickUtils`](/zh/utilities/tick-utils) + [`ClmmLiquidityUtils`](/zh/utilities/liquidity-utils) | 价格与 tick 的换算、头寸数学与链上取整一致 |
| 质押集成 | `powfi.staking` | 质押 ALPH 获得 xALPH，管理解除质押请求 |
| 模块未覆盖的功能 | 重新导出的[合约产物](/zh/reference/contracts) | 直接、带类型地访问每个 Powfi 合约和脚本 |

不确定的话，先从模块门面（`powfi.cpmm`、`powfi.clmm`、`powfi.staking`）开始。只有当你需要 SDK 未封装的方法时，才直接使用底层合约绑定。

## 协议组成

<CardGroup cols={2}>
  <Card title="CPMM" icon="scale-balanced" href="/zh/modules/cpmm">
    恒定乘积（x·y=k）池，兑换手续费 0.3%，LP 代币为同质化代币。
  </Card>

  <Card title="CLMM" icon="chart-area" href="/zh/modules/clmm">
    集中流动性（Uniswap V3 风格）池，支持费率档位、tick 区间和流动性挖矿奖励。
  </Card>

  <Card title="质押" icon="coins" href="/zh/modules/staking">
    质押 ALPH 获得流动性代币 xALPH，解除质押后随时间逐步解锁。
  </Card>

  <Card title="代币列表" icon="list" href="/zh/modules/token">
    来自 Alephium 代币列表的代币元数据（符号、精度、图标），带缓存。
  </Card>
</CardGroup>

## 下一步

<CardGroup cols={3}>
  <Card title="快速开始" icon="rocket" href="/zh/quickstart">
    安装、加载、报价、兑换。
  </Card>

  <Card title="TypeScript SDK" icon="code" href="/zh/typescript-sdk">
    初始化、模块门面、交易结果、常见陷阱。
  </Card>

  <Card title="指南" icon="book-open" href="/zh/guides/cpmm-swap">
    常见任务的端到端示例。
  </Card>
</CardGroup>

<Note>
  **版本说明。** 本章所有代码示例基于 `@alephium/powfi-sdk@1.0.2`（`@alephium/web3@3.0.3`）。SDK 变更后会重新验证页面并更新此说明。如果示例在新版本上运行失败，请先查看 [GitHub 上的更新日志](https://github.com/alephium/powfi-sdk)。
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.