reserve0 × reserve1 = k 定价。每笔兑换向流动性提供者支付 0.3% 的手续费。流动性以同质化的 LP 代币表示,LP 代币的 ID 就是池 ID。
指南:在 CPMM 上兑换
指南:提供 CPMM 流动性
查询池
getPoolId(tokenA, tokenB)
getPoolAddress(tokenA, tokenB)
返回代币对的合约地址(addressFromContractId(getPoolId(...)))。
poolExists(tokenA, tokenB)
getPoolState(tokenA, tokenB)
PoolNotFoundError。两个代币都必须在代币列表中。
getPoolProtocolFees(poolAddress)
报价(静态,离线)
所有报价函数都是静态纯函数。传入你已经获取的CpmmPoolContractState。
CpmmModule.computeSwapAmount(params)
amountOut >= reserveOut,抛出 InsufficientLiquidityError。
CpmmModule.getAmountOut(state, tokenInId, amountIn) / getAmountIn(state, tokenOutId, amountOut)
带 0.3% 手续费的原始 x·y=k 公式:
CpmmModule.calcPriceImpact(reserve0, reserve1, tokenInId, token0Id, amountIn, amountOut)
返回以百分比表示的价格影响。
CpmmModule.computeLiquidityAmounts(params)
- 已有池(设置了
poolState):给出一侧的数量(inputType: 'TokenA'使用amountA,'TokenB'使用amountB),函数会根据储备量推导另一侧的数量,以及你将获得的 LP 代币数量。 - 新池(
poolState未定义):amountA和amountB都必须提供。铸造的 LP =sqrt(amountA × amountB) − MINIMUM_LIQUIDITY(1000 个单位被永久锁定)。如果sqrt(amountA × amountB) <= 1000,抛出InsufficientLiquidityError。
{ tokenAId, tokenBId, amountA, amountB, shareAmount, sharePercentage, state? },其中 sharePercentage 是存入后你在池中的份额百分比。
CpmmModule.computeRemoveLiquidityAmounts(state, totalLiquidity, liquidityToRemove)
销毁 liquidityToRemove 个 LP 代币后返还的代币数量,以及你剩余的份额。totalLiquidity 是你的 LP 余额。如果 liquidityToRemove > totalLiquidity 则抛出错误。
CpmmModule.computeClaimableAmounts(state, liquidityBalance)
LP 余额对应的全部底层价值:{ token0, amount0, token1, amount1, ... }。
CpmmModule.minimalAmount(amount, slippage) / maximalAmount(amount, slippage)
滑点辅助函数。见数量与滑点。
兑换
swap(params, balances?)
SwapMinOut(精确输入)或 SwapMaxIn(精确输出)。需要签名器。
可选的集成方手续费,以输入代币计。
可选的预检查:如果提供了此参数且
balances.get(tokenIn) < 输入 + 手续费,会在签名前抛出 InsufficientBalanceError。对于 ALPH,请用 ALPH_TOKEN_ID 作为键。priceImpact >= 5,抛出 PriceImpactTooHighError。
simSwap(params)
swap 会使用的报价,不发送任何交易。如果 slippageBps 为空,默认 100n。
swapTo(params)
targetPrice 的精确输入交易并执行,方向自动推断。**跳过价格影响检查。**如果目标价格等于当前价格则抛出错误。适用于套利,以及把测试池的价格拉回锚定值。
流动性
addLiquidity(params, balances?)
sender 铸造 LP 代币。
removeLiquidity(params)
computeClaimableAmounts(tokenAId, tokenBId, liquidityBalance)
实例方法版本:获取池状态,然后返回 LP 余额对应的 { token0, amount0, token1, amount1 }。
创建池
createPool(params)
如果设置,会在一笔交易中创建代币对并存入初始流动性(
CreatePairAndAddLiquidity),两者的比例决定初始价格。如果省略,只创建代币对(CreatePair,会附加每种代币各 1 个最小单位)。配置
getConfig() 返回当前生效的 CpmmConfig(groupIndex、factoryId、routerId)。setConfig(config) 覆盖它。getCpmmConfig() 重新读取打包的部署文件。