V3Pool

해당 컨트랙트는 V3 풀입니다.

Code

Github Link: (Will be updated after official launch)

Events, Read-Only Functions, and State-Changing Functions

Events

Initialize

event Initialize(
    uint160 sqrtPriceX96,
    int24 tick
)

풀에서 #initialize가 처음 호출될 때 풀에서 정확히 한 번 방출됩니다.

Mint/Burn/Swap은 초기화 전에 풀에서 내보낼 수 없습니다.

Parameters:

Name

Type

Description

Mint

event Mint(
    address sender,
    address owner,
    int24 tickLower,
    int24 tickUpper,
    uint128 amount,
    uint256 amount0,
    uint256 amount1
)

주어진 포지션에 대해 유동성이 발행될 때 발생

Parameters:

Collect

event Collect(
    address owner,
    int24 tickLower,
    int24 tickUpper,
    uint128 amount0,
    uint128 amount1
)

포지션 소유자가 수수료를 수령할 때 발생

호출자가 수수료를 수집하지 않기로 선택하면 0 amount0 및 amount1로 수집 이벤트를 내보낼 수 있습니다.

Parameters:

Burn

event Burn(
    address owner,
    int24 tickLower,
    int24 tickUpper,
    uint128 amount,
    uint256 amount0,
    uint256 amount1
)

포지션의 유동성이 제거되었을 때 발생

#collect를 통해 인출해야 하는 유동성 포지션에서 얻은 수수료를 인출하지 않습니다.

Parameters:

Swap

event Swap(
    address sender,
    address recipient,
    int256 amount0,
    int256 amount1,
    uint160 sqrtPriceX96,
    uint128 liquidity,
    int24 tick
)

token0과 token1 사이의 모든 스왑에 대해 풀에서 내보냅니다.

Parameters:

IncreaseObservationCardinalityNext

event IncreaseObservationCardinalityNext(
    uint16 observationCardinalityNextOld,
    uint16 observationCardinalityNextNew
)

저장할 수 있는 관찰 수를 늘리기 위해 풀에서 내보냅니다.

observationCardinalityNext는 mint/swap/burn 직전에 인덱스에 관측치가 기록될 때까지 관측 카디널리티가 아닙니다.

Parameters:

Read-Only Functions

factory

function factory() external view returns (address)

IUniswapV3Factory 인터페이스를 준수해야 하는 풀을 배포한 계약

Return Values:

token0

function token0() external view returns (address)

주소별로 정렬된 풀의 두 토큰 중 첫 번째

Return Values:

token1

function token1() external view returns (address)

주소별로 정렬된 풀의 두 토큰 중 두 번째

Return Values:

fee

function fee() external view returns (uint24)

1/100 BIP 단위의 풀 수수료, 즉 1e-6

Return Values:

tickSpacing

function tickSpacing() external view returns (int24)

풀 틱 간격

틱은 이 값의 배수에서만 사용할 수 있으며 최소값은 1이고 항상 양수입니다. 예: tickSpacing이 3이면 틱이 3번째 틱마다 초기화될 수 있음을 의미합니다(예: ..., -6, -3, 0, 3, 6, ... 이 값은 항상 양수인데도 캐스팅을 피하기 위해 int24입니다.

Return Values:

maxLiquidityPerTick

function maxLiquidityPerTick() external view returns (uint128)The maximum amount of position liquidity that can use any tick in the range

이 매개변수는 유동성이 uint128을 초과하는 것을 방지하기 위해 틱당 적용되며 풀에 범위 내 유동성을 추가하는 것을 방지하기 위해 범위를 벗어난 유동성이 사용되는 것을 방지합니다.

Return Values:

snapshotCumulativesInside

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

틱 누적, 유동성당 초 및 틱 범위 내 초의 스냅샷을 반환합니다.

스냅샷은 위치가 존재하는 기간 동안 찍은 다른 스냅샷과만 비교해야 합니다. 즉, 첫 번째 스냅샷이 생성된 시점과 두 번째 스냅샷이 생성된 시점 사이의 전체 기간 동안 포지션이 유지되지 않으면 스냅샷을 비교할 수 없습니다.

Parameters:

Return Values:

observe

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

현재 블록 타임스탬프에서 각 타임스탬프 secondsAgo 시점의 누적 틱 및 유동성을 반환합니다.

시간 가중 평균 틱 또는 범위 내 유동성을 얻으려면 두 개의 값으로 호출해야 합니다. 하나는 기간의 시작을 나타내고 다른 하나는 기간의 끝을 나타냅니다. 예를 들어 지난 시간 가중 평균 틱을 얻으려면 secondsAgos = [3600, 0]으로 호출해야 합니다. 시간 가중 평균 틱은 토큰1 / 토큰0의 로그 기준 sqrt(1.0001)에서 풀의 기하학적 시간 가중 평균 가격을 나타냅니다. TickMath 라이브러리를 사용하여 눈금 값에서 비율로 이동할 수 있습니다.

Parameters:

Return Values:

slot0

function slot0() external view returns (
    uint160 sqrtPriceX96, 
    int24 tick, 
    uint16 observationIndex, 
    uint16 observationCardinality, 
    uint16 observationCardinalityNext, 
    uint8 feeProtocol, 
    bool unlocked
)

풀의 0번째 스토리지 슬롯은 많은 값을 저장하며 외부에서 액세스할 때 가스를 절약하기 위한 단일 방법으로 노출됩니다.

Return Values:

feeGrowthGlobal0X128

function feeGrowthGlobal0X128() external view returns (uint256)

풀의 전체 수명 동안 유동성 단위당 수집된 token0의 Q128.128 수수료로 수수료 증가

이 값은 uint256을 오버플로할 수 있습니다.

feeGrowthGlobal1X128

function feeGrowthGlobal1X128() external view returns (uint256)

풀의 전체 수명 동안 유동성 단위당 수집된 token1의 Q128.128 수수료로 수수료 증가

이 값은 uint256을 오버플로할 수 있습니다.

liquidity

function liquidity() external view returns (uint128)

현재 풀에서 사용할 수 있는 유동성 범위

이 값은 모든 틱의 총 유동성과 관련이 없습니다.

ticks

function ticks(
    int24 tick
) external view returns (
    uint128 liquidityGross, 
    int128 liquidityNet, 
    uint256 feeGrowthOutside0X128, 
    uint256 feeGrowthOutside1X128, 
    int56 tickCumulativeOutside, 
    uint160 secondsPerLiquidityOutsideX128, 
    uint32 secondsOutside, 
    bool initialized,
    uint256 rewardGrowthOutsideX128
)

풀에서 특정 틱에 대한 정보 조회

Parameters:

Return Values:

positions

function positions(
    bytes32 key
) external view returns (
    uint128 liquidity, 
    uint256 feeGrowthInside0LastX128, 
    uint256 feeGrowthInside1LastX128, 
    uint128 tokensOwed0, 
    uint128 tokensOwed1,
    uint256 rewardGrowthInsideLastX128,
    uint128 rewardOwed
)

포지션 키로 포지션에 대한 정보를 반환합니다.

Parameters:

Return Values:

observe

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

현재 블록 타임스탬프에서 각 타임스탬프 secondsAgo시점의 누적 틱 및 유동성을 반환합니다.

Parameters:

Return Values:

observations

function observations(
    uint256 index
) external view returns (
    uint32 blockTimestamp, 
    int56 tickCumulative, 
    uint160 secondsPerLiquidityCumulativeX128, 
    bool initialized
)

특정 관찰 색인에 대한 데이터를 반환합니다.

배열의 특정 인덱스가 아닌 일정 시간 전의 관찰을 얻기 위해 이 메서드 대신 #observe()를 사용하고 싶을 가능성이 큽니다.

Parameters:

Return Values:

State-Changing Functions

increaseObservationCardinalityNext

function increaseObservationCardinalityNext(
    uint16 observationCardinalityNext
) external;

이 풀이 저장할 가격 및 유동성 관찰의 최대 수를 늘립니다.

이 방법은 풀에 이미 입력 observeCardinalityNext보다 크거나 같은 observeCardinalityNext가 있는 경우 작동하지 않습니다.

Parameters:

initialize

function initialize(
    uint160 sqrtPriceX96
) external;

풀의 초기 가격을 설정합니다. 잠금 해제된 상태로 초기화되기 때문에 잠기지 않음

Parameters:

mint

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

주어진 수신자/tickLower/tickUpper 위치에 유동성 추가

Parameters:

Return Values:

collect

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

포지션에 빚진 토큰을 수집합니다.

획득한 수수료를 재계산하지 않으며, 이는 발행 또는 유동성 소각을 통해 수행되어야 합니다. 콜렉트는 포지션 소유자가 호출해야 합니다. token0 또는 token1만 인출하려면 amount0Requested 또는 amount1Requested를 0으로 설정하면 됩니다. 빚진 모든 토큰을 인출하기 위해 호출자는 빚진 실제 토큰보다 큰 값을 전달할 수 있습니다. 유형(uint128).max. 빚진 토큰은 누적된 스왑 수수료 또는 소진된 유동성에서 나올 수 있습니다.

Parameters:

Return Values:

burn

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

발신자로부터 유동성을 소각하고 유동성에 대해 포지션에 빚진 계정 토큰

Parameters:

Return Values:

swap

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

token0을 token1로 바꾸거나 token1을 token0으로 바꿉니다.

이 메서드의 호출자는 IUniswapV3SwapCallback#uniswapV3SwapCallback 형식의 콜백을 받습니다.

Parameters:

Return Values:

snapshotCumulativesInside

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

틱 누적, 유동성당 초 및 틱 범위 내 초의 스냅샷을 반환합니다.

Parameters:

Return Values:

PreviousV3Factory NextNonfungiblePositionManager

Last updated 1 year ago

Code

Events, Read-Only Functions, and State-Changing Functions

Events

Initialize​

Mint​

Collect​

Burn​

Swap​

Read-Only Functions

factory​

token0​

token1​

fee​

tickSpacing​

maxLiquidityPerTick​

snapshotCumulativesInside​

observe​

slot0​

feeGrowthGlobal0X128​

feeGrowthGlobal1X128​

liquidity​

ticks​

positions​

observe​

observations​

State-Changing Functions

increaseObservationCardinalityNext​

initialize​

mint​

collect​

burn​

swap​

snapshotCumulativesInside​

Code

Events, Read-Only Functions, and State-Changing Functions

Events

Initialize​

Mint​

Collect​

Burn​

Swap​

Read-Only Functions

factory​

token0​

token1​

fee​

tickSpacing​

maxLiquidityPerTick​

snapshotCumulativesInside​

observe​

slot0​

feeGrowthGlobal0X128​

feeGrowthGlobal1X128​

liquidity​

ticks​

positions​

observe​

observations​

State-Changing Functions

increaseObservationCardinalityNext​

initialize​

mint​

collect​

burn​

swap​

snapshotCumulativesInside​

Initialize

Mint

Collect

Burn

Swap

factory

token0

token1

fee

tickSpacing

maxLiquidityPerTick

snapshotCumulativesInside

observe

slot0

feeGrowthGlobal0X128

feeGrowthGlobal1X128

liquidity

ticks

positions

observe

observations

increaseObservationCardinalityNext

initialize

mint

collect

burn

swap

snapshotCumulativesInside

Initialize

Mint

Collect

Burn

Swap

factory

token0

token1

fee

tickSpacing

maxLiquidityPerTick

snapshotCumulativesInside

observe

slot0

feeGrowthGlobal0X128

feeGrowthGlobal1X128

liquidity

ticks

positions

observe

observations

increaseObservationCardinalityNext

initialize

mint

collect

burn

swap

snapshotCumulativesInside