PancakeSwap
Launch App
中文
中文
  • PancakeSwap 介绍
    • 入门指南 (BSC)
      • 创建钱包
      • 获取 BEP-20 代币
      • 在没有中心化交易所账户的情况下使用PancakeSwap
      • 连接钱包
    • 入门指南 (Aptos)
      • 创建钱包
      • 获取 Aptos 代币
      • Cake 跨链指南
      • 在 PancakeSwap 连接钱包
      • Aptos 常见问题解答
    • V3/V2 迁移
      • 如何进行迁移?
      • v3 的 APR 是怎么计算的?
      • 常见问题解答
      • V2 迁移
        • 迁移到 MasterChef v2
        • MasterChef v2
          • 农场列表
        • CAKE 糖浆池
    • 审计报告
    • veCAKE 退场计划
      • 质押 CAKE 赎回
    • 路线图
    • 需要帮助?点我
      • 故障排除指南
      • 常见问题解答
      • 什么是授权操作?
      • 如何修复 MetaMask 上卡住的交易
      • 来自币安学院的指南
  • 产品
    • 🔄交易
      • 代币兑换
      • 如何进行交易
      • 交易手续费和路由设置
      • 流动性资金池
      • 添加/移除流动性
      • 交易 FAQ
      • 做市商整合
      • 智能路由 (V2)
        • 如何通过智能路由进行交易?
      • Zap
        • Zap- 一键添加流动性 (V2)
      • 稳定币兑换
        • 如何使用稳定币兑换
      • 限价單交易 & 时间加权平均价格 (TWAP)
        • 如何使用限价单?
        • 如何使用时间加权平均价格(TWAP)?
        • 限价单 FAQ(旧)
    • 🚜农场
      • 如何使用农场
        • 如何使用农场 (旧版农场页面)
      • APR/ROI/IL 计算器
      • 农场 FAQ
      • 在 Aptos 链上参与农场
        • Aptos链 农场 FAQ
      • 跨链农场
        • 跨链农场 FAQ
      • bCAKE
        • 如何使用新的 bCAKE ?
        • 迁移指南
        • bCAKE FAQ
        • V2 (已弃用)
          • 如何使用 bCAKE?
    • 🔷veCAKE
      • 什么是 veCAKE?
      • 如何获得 veCAKE?
      • 从 CAKE 糖浆池迁移
      • 每周赚取 CAKE
        • 每周赚取 CAKE FAQ
      • Gauges Voting
        • Gauge Voting FAQ
      • 贿选 (投票激励)
      • veCAKE 管理协议
      • 为项目激励流动性
      • 将你的 veCAKE 跨链
      • veCAKE FAQ
    • 🍯糖浆池-质押 CAKE
      • 其他糖浆池
        • 糖浆池 FAQ 与排错指南
      • CAKE 糖浆池
        • 如何使用灵活质押糖浆池
        • 如何使用锁仓质押糖浆池
        • CAKE 糖浆池 FAQ
    • 🧑‍⚖️农场竞拍
    • 💹收入分成
      • 如何参与?
      • 收入分成 FAQ
    • 🛍️IFO (初次农场发行)
      • 如何参加 IFO
      • 如何参与跨链 IFO?
      • FAQ
      • iCAKE
      • 合约详情
    • 🌉跨链
      • EVM 链之间跨链
      • EVM 链与 Aptos 之间跨链
      • 跨链 FAQ
      • Wormhole Bridge Guide
      • 虫洞跨链桥 FAQ
    • 🤝简单赚币
      • 如何使用简单赚币
      • 简单赚币 FAQ
      • 条款和条件
    • 💧流动权益质押整合
      • 如何进行流动权益质押?
      • WBETH
        • WBETH FAQ
      • SnBNB
        • SnBNB FAQ
    • 🟪永续合约交易
      • 什么是永续合约交易
      • 永续合约交易 V2
        • 我应该如何使用它?
        • Dumb 模式
          • Dumb 模式指南
        • Degen Mode
          • Degen 模式动态费用
        • MADBTCUSD
          • MADBTCUSD FAQ
        • 永续合约 V2 术语表
        • 外汇交易
        • 永续合约交易 FAQ
          • Arbitrum
            • ALP 糖浆池 (Arbitrum)
              • ALP 购买&出售手续费
        • 交易奖励计划
          • Arbitrum
        • 支持的区块链、模式和交易对
      • 永续合约交易 V1
        • 永续合约 V1 术语表
        • 我应该如何使用它?
        • 永续合约 V1 FAQ
    • 🎮游戏平台
      • 📒品牌工具套件
      • 🎓Pancake Mayer
      • 🛡️Pancake Protectors 游戏
        • FAQ
    • 🎯PancakeSwap 任务平台
      • 准备工作
      • 如何参与并完成一个任务
      • 奖励
    • 🧈交易返利
      • 如何参与
        • 顶级交易者交易返利活动
        • CAKE 锁仓用户交易返利活动
      • 交易返利 FAQ
    • 🔮预测
      • 如何使用预测功能
      • AI 预测
      • 预测功能 FAQ
      • 预测功能故障排除
      • 预测 Telegram 小程序
    • 🎟️彩票 v2
      • 如何玩转彩票v2
      • 彩票 FAQ
    • 🍯糖浆彩票
      • 如何玩转糖浆彩票
      • 糖浆彩票抽奖延迟说明
      • 糖浆彩票 FAQ
    • 🖼️NFT市场
      • 🖼️NFT 个人资料系统
        • 如何设置 NFT 个人资料?
        • 战队
    • 💳购买加密货币
    • 🌐PancakeSwap 迷你小程序
      • 如何使用 PancakeSwap 迷你小程序
      • 迷你小程序常见问题解答
      • ⛓️PancakeSwap CEDEFI 整合
    • 📈信息站
    • 🖥️PancakeSwap 私人 RPC
    • 🔔通知服务
    • PancakeSwap v4
      • v4 FAQ
    • 💸期权
      • 期权入门
      • CLAMM 期权
      • 期权 FAQ
  • 治理&代币经济
    • CAKE 代币经济模型
      • CAKE 的总量上限
    • 🗳️投票(旧)
    • 治理(新)
      • 如何投票
        • 如何使用SafePal钱包进行投票
      • vCAKE
  • 生态系统&合作伙伴关系
    • 联盟计划
      • 联盟仪表板&返佣链接
      • 佣金结构及支付详情
      • 联盟计划规则和指南
      • 条款及细则
    • 大使计划
      • 👥社区管理
      • 🌎社区翻译者
      • ❓大使计划 FAQs
    • 品牌和标志
    • 联系我们
      • 客户服务
      • 社交媒体与社区
    • 💼商务合作
      • ⛽Vecake-Gauges
      • 🧑‍🌾初次农场发行- IFO
      • 🥞糖浆池和农场
      • 🖼️NFT 交易市场
      • ❓商务合作常见 FAQ
  • 给开发者们
    • 为项目做出贡献
      • 代码库概览
    • Bug 赏金
    • 智能合约 (EVM)
      • veCAKE & Gauge Voting
      • PancakeSwap 交易相关
        • v3 相关合约
          • PancakeV3Factory
          • 智能路由 V3
            • V3 兑换路由
            • V2 兑换路由
            • StableSwap 路由
          • 非同质化仓位
          • Pancake V3 池子
        • v2 相关合约
          • Factory v2
          • 路由 V2
        • Stable Swap
          • Stableswap 路由
          • StableSwap 池子
      • 主厨合约
        • 主厨合约 V3
      • 糖浆池
        • 可初始化的 SmartChef
        • 池子部署器
      • CAKE 糖浆池
      • IFO
      • 预测
      • 彩票
        • 彩票合约
      • 糖浆彩票
      • 农场助推器 (bCAKE)
      • IFO 投入上限(iCAKE)
      • 跨链农场
      • CAKE 跨链
      • Market Maker Pool
    • 智能合约 (Aptos)
      • PancakeSwap 交易相关
        • V2
          • 兑换核心 V2
          • V2 路由
      • 主厨合约
      • 糖浆池
      • IFO
      • Utils
    • API
      • Subgraph
    • 私人 RPC 节点
  • 团队
    • 厨房团队
    • 成为一名大厨
      • Solidity Engineer (Contract)
      • Frontend Engineer (Contract)
      • 产品设计师(UX/I)
      • 商务开发经理
      • 前端工程师
      • Solidity 工程师
      • 开发运维工程师
  • 联系我们
    • 客户服务
    • 社交媒体与社区
  • 代币分发 (🚧)
  • 参考资料
    • Old Tokenomics
      • CAKE Tokenomics v1
      • Controlling CAKE supply v1
    • 如何通过BscScan使用农场
Powered by GitBook
On this page
  • Solidity API
  • PancakeV3Pool

Was this helpful?

  1. 给开发者们
  2. 智能合约 (EVM)
  3. PancakeSwap 交易相关
  4. v3 相关合约

Pancake V3 池子

Pancake V3 池子(PancakeV3Pool)。

Solidity API

PancakeV3Pool

factory

address factory

The contract that deployed the pool, which must adhere to the IPancakeV3Factory interface

Return Values

token0

address token0

The first of the two tokens of the pool, sorted by address

Return Values

token1

address token1

The second of the two tokens of the pool, sorted by address

Return Values

fee

uint24 fee

The pool's fee in hundredths of a bip, i.e. 1e-6

Return Values

tickSpacing

int24 tickSpacing

The pool tick spacing

Ticks can only be used at multiples of this value, minimum of 1 and always positive e.g.: a tickSpacing of 3 means ticks can be initialized every 3rd tick, i.e., ..., -6, -3, 0, 3, 6, ... This value is an int24 to avoid casting even though it is always positive.

Return Values

maxLiquidityPerTick

uint128 maxLiquidityPerTick

The maximum amount of position liquidity that can use any tick in the range

This parameter is enforced per tick to prevent liquidity from overflowing a uint128 at any point, and also prevents out-of-range liquidity from being used to prevent adding in-range liquidity to a pool

Return Values

PROTOCOL_FEE_SP

uint32 PROTOCOL_FEE_SP

PROTOCOL_FEE_DENOMINATOR

uint256 PROTOCOL_FEE_DENOMINATOR

Slot0

struct Slot0 {
  uint160 sqrtPriceX96;
  int24 tick;
  uint16 observationIndex;
  uint16 observationCardinality;
  uint16 observationCardinalityNext;
  uint32 feeProtocol;
  bool unlocked;
}

slot0

struct PancakeV3Pool.Slot0 slot0

The 0th storage slot in the pool stores many values, and is exposed as a single method to save gas when accessed externally.

Return Values

feeGrowthGlobal0X128

uint256 feeGrowthGlobal0X128

The fee growth as a Q128.128 fees of token0 collected per unit of liquidity for the entire life of the pool

This value can overflow the uint256

feeGrowthGlobal1X128

uint256 feeGrowthGlobal1X128

The fee growth as a Q128.128 fees of token1 collected per unit of liquidity for the entire life of the pool

This value can overflow the uint256

ProtocolFees

struct ProtocolFees {
  uint128 token0;
  uint128 token1;
}

protocolFees

struct PancakeV3Pool.ProtocolFees protocolFees

The amounts of token0 and token1 that are owed to the protocol

Protocol fees will never exceed uint128 max in either token

liquidity

uint128 liquidity

The currently in range liquidity available to the pool

This value has no relationship to the total liquidity across all ticks

ticks

mapping(int24 => struct Tick.Info) ticks

Look up information about a specific tick in the pool

Parameters

Return Values

tickBitmap

mapping(int16 => uint256) tickBitmap

Returns 256 packed tick initialized boolean values. See TickBitmap for more information

positions

mapping(bytes32 => struct Position.Info) positions

Returns the information about a position by the position's key

Parameters

Return Values

observations

struct Oracle.Observation[65535] observations

Returns data about a specific observation index

You most likely want to use #observe() instead of this method to get an observation as of some amount of time ago, rather than at a specific index in the array.

Parameters

Return Values

lmPool

contract IPancakeV3LmPool lmPool

SetLmPoolEvent

event SetLmPoolEvent(address addr)

lock

modifier lock()

Mutually exclusive reentrancy protection into the pool to/from a method. This method also prevents entrance to a function before the pool is initialized. The reentrancy guard is required throughout the contract because we use balance checks to determine the payment status of interactions such as mint, swap and flash.

onlyFactoryOwner

modifier onlyFactoryOwner()

Prevents calling a function from anyone except the address returned by IPancakeV3Factory#owner()

constructor

constructor() public

_blockTimestamp

function _blockTimestamp() internal view virtual returns (uint32)

Returns the block timestamp truncated to 32 bits, i.e. mod 2**32. This method is overridden in tests.

snapshotCumulativesInside

function snapshotCumulativesInside(int24 tickLower, int24 tickUpper) external view returns (int56 tickCumulativeInside, uint160 secondsPerLiquidityInsideX128, uint32 secondsInside)

Returns a snapshot of the tick cumulative, seconds per liquidity and seconds inside a tick range

Snapshots must only be compared to other snapshots, taken over a period for which a position existed. I.e., snapshots cannot be compared if a position is not held for the entire period between when the first snapshot is taken and the second snapshot is taken.

Parameters

Name
Type
Description

tickLower

int24

The lower tick of the range

tickUpper

int24

The upper tick of the range

Return Values

Name
Type
Description

tickCumulativeInside

int56

The snapshot of the tick accumulator for the range

secondsPerLiquidityInsideX128

uint160

The snapshot of seconds per liquidity for the range

secondsInside

uint32

The snapshot of seconds per liquidity for the range

observe

function observe(uint32[] secondsAgos) external view returns (int56[] tickCumulatives, uint160[] secondsPerLiquidityCumulativeX128s)

Returns the cumulative tick and liquidity as of each timestamp secondsAgo from the current block timestamp

To get a time weighted average tick or liquidity-in-range, you must call this with two values, one representing the beginning of the period and another for the end of the period. E.g., to get the last hour time-weighted average tick, you must call it with secondsAgos = [3600, 0]. The time weighted average tick represents the geometric time weighted average price of the pool, in log base sqrt(1.0001) of token1 / token0. The TickMath library can be used to go from a tick value to a ratio.

Parameters

Name
Type
Description

secondsAgos

uint32[]

From how long ago each cumulative tick and liquidity value should be returned

Return Values

Name
Type
Description

tickCumulatives

int56[]

Cumulative tick values as of each secondsAgos from the current block timestamp

secondsPerLiquidityCumulativeX128s

uint160[]

Cumulative seconds per liquidity-in-range value as of each secondsAgos from the current block timestamp

increaseObservationCardinalityNext

function increaseObservationCardinalityNext(uint16 observationCardinalityNext) external

Increase the maximum number of price and liquidity observations that this pool will store

This method is no-op if the pool already has an observationCardinalityNext greater than or equal to the input observationCardinalityNext.

Parameters

Name
Type
Description

observationCardinalityNext

uint16

The desired minimum number of observations for the pool to store

initialize

function initialize(uint160 sqrtPriceX96) external

Sets the initial price for the pool

not locked because it initializes unlocked

Parameters

Name
Type
Description

sqrtPriceX96

uint160

the initial sqrt price of the pool as a Q64.96

ModifyPositionParams

struct ModifyPositionParams {
  address owner;
  int24 tickLower;
  int24 tickUpper;
  int128 liquidityDelta;
}

mint

function mint(address recipient, int24 tickLower, int24 tickUpper, uint128 amount, bytes data) external returns (uint256 amount0, uint256 amount1)

Adds liquidity for the given recipient/tickLower/tickUpper position

_noDelegateCall is applied indirectly via modifyPosition

Parameters

Name
Type
Description

recipient

address

The address for which the liquidity will be created

tickLower

int24

The lower tick of the position in which to add liquidity

tickUpper

int24

The upper tick of the position in which to add liquidity

amount

uint128

The amount of liquidity to mint

data

bytes

Any data that should be passed through to the callback

Return Values

Name
Type
Description

amount0

uint256

The amount of token0 that was paid to mint the given amount of liquidity. Matches the value in the callback

amount1

uint256

The amount of token1 that was paid to mint the given amount of liquidity. Matches the value in the callback

collect

function collect(address recipient, int24 tickLower, int24 tickUpper, uint128 amount0Requested, uint128 amount1Requested) external returns (uint128 amount0, uint128 amount1)

Collects tokens owed to a position

Does not recompute fees earned, which must be done either via mint or burn of any amount of liquidity. Collect must be called by the position owner. To withdraw only token0 or only token1, amount0Requested or amount1Requested may be set to zero. To withdraw all tokens owed, caller may pass any value greater than the actual tokens owed, e.g. type(uint128).max. Tokens owed may be from accumulated swap fees or burned liquidity.

Parameters

Name
Type
Description

recipient

address

The address which should receive the fees collected

tickLower

int24

The lower tick of the position for which to collect fees

tickUpper

int24

The upper tick of the position for which to collect fees

amount0Requested

uint128

How much token0 should be withdrawn from the fees owed

amount1Requested

uint128

How much token1 should be withdrawn from the fees owed

Return Values

Name
Type
Description

amount0

uint128

The amount of fees collected in token0

amount1

uint128

The amount of fees collected in token1

burn

function burn(int24 tickLower, int24 tickUpper, uint128 amount) external returns (uint256 amount0, uint256 amount1)

Burn liquidity from the sender and account tokens owed for the liquidity to the position

_noDelegateCall is applied indirectly via modifyPosition

Parameters

Name
Type
Description

tickLower

int24

The lower tick of the position for which to burn liquidity

tickUpper

int24

The upper tick of the position for which to burn liquidity

amount

uint128

How much liquidity to burn

Return Values

Name
Type
Description

amount0

uint256

The amount of token0 sent to the recipient

amount1

uint256

The amount of token1 sent to the recipient

SwapCache

struct SwapCache {
  uint32 feeProtocol;
  uint128 liquidityStart;
  uint32 blockTimestamp;
  int56 tickCumulative;
  uint160 secondsPerLiquidityCumulativeX128;
  bool computedLatestObservation;
}

SwapState

struct SwapState {
  int256 amountSpecifiedRemaining;
  int256 amountCalculated;
  uint160 sqrtPriceX96;
  int24 tick;
  uint256 feeGrowthGlobalX128;
  uint128 protocolFee;
  uint128 liquidity;
}

StepComputations

struct StepComputations {
  uint160 sqrtPriceStartX96;
  int24 tickNext;
  bool initialized;
  uint160 sqrtPriceNextX96;
  uint256 amountIn;
  uint256 amountOut;
  uint256 feeAmount;
}

swap

function swap(address recipient, bool zeroForOne, int256 amountSpecified, uint160 sqrtPriceLimitX96, bytes data) external returns (int256 amount0, int256 amount1)

Swap token0 for token1, or token1 for token0

The caller of this method receives a callback in the form of IPancakeV3SwapCallback#pancakeV3SwapCallback

Parameters

Name
Type
Description

recipient

address

The address to receive the output of the swap

zeroForOne

bool

The direction of the swap, true for token0 to token1, false for token1 to token0

amountSpecified

int256

The amount of the swap, which implicitly configures the swap as exact input (positive), or exact output (negative)

sqrtPriceLimitX96

uint160

The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this value after the swap. If one for zero, the price cannot be greater than this value after the swap

data

bytes

Any data to be passed through to the callback

Return Values

Name
Type
Description

amount0

int256

The delta of the balance of token0 of the pool, exact when negative, minimum when positive

amount1

int256

The delta of the balance of token1 of the pool, exact when negative, minimum when positive

flash

function flash(address recipient, uint256 amount0, uint256 amount1, bytes data) external

Receive token0 and/or token1 and pay it back, plus a fee, in the callback

The caller of this method receives a callback in the form of IPancakeV3FlashCallback#pancakeV3FlashCallback Can be used to donate underlying tokens pro-rata to currently in-range liquidity providers by calling with 0 amount{0,1} and sending the donation amount(s) from the callback

Parameters

Name
Type
Description

recipient

address

The address which will receive the token0 and token1 amounts

amount0

uint256

The amount of token0 to send

amount1

uint256

The amount of token1 to send

data

bytes

Any data to be passed through to the callback

setFeeProtocol

function setFeeProtocol(uint32 feeProtocol0, uint32 feeProtocol1) external

Set the denominator of the protocol's % share of the fees

Parameters

Name
Type
Description

feeProtocol0

uint32

new protocol fee for token0 of the pool

feeProtocol1

uint32

new protocol fee for token1 of the pool

collectProtocol

function collectProtocol(address recipient, uint128 amount0Requested, uint128 amount1Requested) external returns (uint128 amount0, uint128 amount1)

Collect the protocol fee accrued to the pool

Parameters

Name
Type
Description

recipient

address

The address to which collected protocol fees should be sent

amount0Requested

uint128

The maximum amount of token0 to send, can be 0 to collect fees in only token1

amount1Requested

uint128

The maximum amount of token1 to send, can be 0 to collect fees in only token0

Return Values

Name
Type
Description

amount0

uint128

The protocol fee collected in token0

amount1

uint128

The protocol fee collected in token1

setLmPool

function setLmPool(contract IPancakeV3LmPool _lmPool) external
Previous非同质化仓位Nextv2 相关合约

Last updated 1 year ago

Was this helpful?