# Pool ### pool * [Description](#description) * [Data Storage](#data-storage) * [Interface](#interface) * [Messages](#messages) ## Interface ### getIsActive (int) getIsActive () Returns is pool is active #### Return Values | # | Type | Description | | - | ---- | ------------------------------------- | | 0 | int | int containing the pool::pool\_active | ### getPoolStateAndConfiguration (slice, slice, slice, slice, slice, slice, slice, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, slice, int, slice, slice, slice, int ) getPoolStateAndConfiguration () Returns pool state and configuration #### Return Values | # | Type | Description | | -- | ----- | ---------------------------------------------------------- | | 0 | slice | Router address | | 1 | slice | Admin address | | 2 | slice | Controller address | | 3 | slice | Jetton 0 Wallet address. The wallet is owned by the Router | | 4 | slice | Jetton 1 Wallet address. The wallet is owned by the Router | | 5 | slice | Jetton 0 Minter address. | | 6 | slice | Jetton 1 Minter address. | | 7 | int | Flag that denotes if the pool is active | | 8 | int | Pool tick spacing | | 9 | int | Fee that is used as a base. Stored in x 1/10000 | | 10 | int | Fee that protocol takes. Stored in x 1/10000 | | 11 | int | Fee that is currently active. Stored in x 1/10000 | | 12 | int | Current tick | | 13 | int | Current price | | 14 | int | Current liquidity | | 15 | int | pool::feeGrowthGlobal0X128 | | 16 | int | pool::feeGrowthGlobal1X128 | | 17 | int | Amount of jetton0 fee collected for protocol owners | | 18 | int | Amount of jetton1 fee collected for protocol owners | | 19 | int | Number of total minted NFT positions | | 20 | int | Reserves of the jetton0 | | 21 | int | Reserves of the jetton1 | | 22 | int | Number of active NFT positions | | 23 | int | Number of currently occupied ticks | | 24 | int | Number of operations with pool since the deploy | | 25 | slice | Arbiter address | ### getChildContracts (cell, cell, cell, cell) getChildContracts () #### Return Values | # | Type | Description | | - | ---- | --------------------------------- | | 1 | cell | code of the account contract | | 2 | cell | code of the nft position contract | | 3 | cell | metadata for NFT Collection | | 4 | cell | metadata for NFT Item | ### getAllTickInfos (cell) getAllTickInfos () returns the cell with all the ticks. #### Return Values | # | Type | Description | | - | ---- | ----------------------------------------------- | | 1 | cell | cell that contains the dict with all the ticks. | ### getTickInfosFrom (tuple) getTickInfosFrom (int key, int amount, int dir, int full) Returns ticks starting form key (non-inclusive) 0 forward 1 backward #### Parameters | # | Type | Name | Description | | - | ---- | ------ | ----------- | | 0 | int | key | | | 1 | int | amount | | | 2 | int | dir | | | 3 | int | full | | #### Return Values | # | Type | Description | | - | ----- | ----------------- | | 0 | tuple | a tuple with keys | ### getFeeGrowthInside (int, int) getFeeGrowthInside (int tickLower, int tickUpper, int posLiquidityDelta, int feeGrowthGlobal0X128, int feeGrowthGlobal1X128) Helper method to estimate fee growth inside a given position #### Parameters | # | Type | Name | Description | | - | ---- | -------------------- | ----------- | | 0 | int | tickLower | | | 1 | int | tickUpper | | | 2 | int | posLiquidityDelta | | | 3 | int | feeGrowthGlobal0X128 | | | 4 | int | feeGrowthGlobal1X128 | | #### Return Values | # | Type | Description | | - | ---- | ----------------------------------- | | 0 | int | amount of jetton0 that is collected | | 1 | int | amount of jetton1 that is collected | ### getCollectedFees (int, int) getCollectedFees (int tickLower, int tickUpper, int posLiquidityDelta, int posFeeGrowthInside0X128, int posFeeGrowthInside1X128) Predicts how much fees a position can collect #### Parameters | # | Type | Name | Description | | - | ---- | ----------------------- | ----------- | | 0 | int | tickLower | | | 1 | int | tickUpper | | | 2 | int | posLiquidityDelta | | | 3 | int | posFeeGrowthInside0X128 | | | 4 | int | posFeeGrowthInside1X128 | | #### Return Values | # | Type | Description | | - | ---- | ----------------------------------- | | 0 | int | amount of jetton0 that is collected | | 1 | int | amount of jetton1 that is collected | ### getUserAccountAddress (slice) getUserAccountAddress (slice user\_address) computes user account address for a given user @return0 account address ### getMintEstimate (int, int, int) getMintEstimate (int tickLower, int tickUpper, int liquidity) Computes estimates for the mint #### Parameters | # | Type | Name | Description | | - | ---- | --------- | ----------- | | 0 | int | tickLower | | | 1 | int | tickUpper | | | 2 | int | liquidity | | #### Return Values | # | Type | Description | | - | ---- | -------------------------------------------------------------------- | | 0 | int | amount of jetton0 needed to mint the position | | 1 | int | amount of jetton1 needed to mint the position | | 2 | int | error code that shows if the basic checks for the mint would succeed | ### getSwapEstimate (int, int) getSwapEstimate (int zeroForOne, int amount, int sqrtPriceLimitX96) **Deprecated** Computes estimates fot the swap #### Parameters | # | Type | Name | Description | | - | ---- | ----------------- | ----------- | | 0 | int | zeroForOne | | | 1 | int | amount | | | 2 | int | sqrtPriceLimitX96 | | #### Return Values | # | Type | Description | | - | ---- | -------------------------------------------------------- | | 0 | int | amount of jetton0 that would be put to/get from the pool | | 1 | int | amount of jetton1 that would be put to/get from the pool | ### getSwapEstimateGas (int, int) getSwapEstimateGas (int zeroForOne, int amount, int sqrtPriceLimitX96, int minOutAmount, int gasLimit) Computes estimates for the swap #### Parameters | # | Type | Name | Description | | --------- | --------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------- | | 0 | int | zeroForOne | | | 1 | int | amount | | | 2 | int | sqrtPriceLimitX96 | | | undefined | undefined | undefined | | | 4 | int | gasLimit | amount of gas (in gas units). If gasLimit is 0 - default value is used - that equals to contract gas limit from the config | #### Return Values | # | Type | Description | | - | ---- | -------------------------------------------------------- | | 0 | int | amount of jetton0 that would be put to/get from the pool | | 1 | int | amount of jetton1 that would be put to/get from the pool | ### get\_collection\_data (int, cell, slice) get\_collection\_data () In accordance with TEP-62 #### Return Values | # | Type | Description | | - | ----- | ----------- | | 0 | int | | | 1 | cell | | | 2 | slice | | ### get\_nft\_address\_by\_index (slice) get\_nft\_address\_by\_index (int index) In accordance with TEP-62 #### Return Values | # | Type | Description | | - | ----- | ----------- | | 0 | slice | | ### get\_nft\_content (cell) get\_nft\_content (int index, cell nftitem\_content) In accordance with TEP-62 we will form the output NFT onchain metadata If NFTItemContent "description" field that is passed to the pool by the pool administrator (pool::nftv3item\_content) begins with marker "%N%", data from the NFT is added to the beginning of the "description" field. If there is no data attached to the dictionary by the NFT, NFTItemContent description is unchanged #### Return Values | # | Type | Description | | - | ---- | ----------- | | 0 | cell | | ### get\_pending\_timelocks (int, int, cell, int, slice, int, slice, int, int ) get\_pending\_timelocks () Get timelocked changes pending to be applied ## Messages ### POOL\_INIT Opcode : **0x441c39ed** The first mandatory operation that fills crucial parameters of the pool\
PathMnemonicTypeDescription
opUint(32),op
query_idUint(64)queryid as of the TON documentation
from_adminUint(1),BoolFlag that shows if this message goes from router admin or pool factory
0Cell(0) roles_cellCell With Role
0has_adminUint(1),BoolFlag that shows if this message have a new admin address
0admin_addrAddress(267)New address of the admin. If has_admin is false could be 00b
0has_controllerUint(1),BoolFlag that shows if this message have a new controller address
0controller_addrAddress(267)Address that is allowed to change the fee. Can always be updated by admin.
0has_creatorUint(1),BoolFlag that shows if this message have a new creator address
0creator_addrAddress(267)Address that is allowed to change the fee. Can always be updated by admin. If has_controller is false could be 00b
00Cell(0) privilege_roles_cellCell With Privilege Roles
0->0has_arbiterUint(1),BoolFlag that shows if this message have a new Arbiter address
0->0arbiter_addrAddress(267)Address that is allowed to make privileged swaps
0->0has_almUint(1),BoolFlag that shows if this message have a new ALM address
0->0alm_addrAddress(267)Address that is used to identify ALM contract
01Cell(0) roles_addCell With Additional Roles
0->1has_oracleUint(1),BoolFlag that shows if this message have a new oracle address
0->1oracle_addrAddress(267)Address that is allowed to change the fee. Can always be updated by admin. Could be 00b
set_spacingUint(1),BoolFlag that shows if tick_spacing should be set to the pool or ignored
tick_spacingInt(24)Tick spacing to be used in the pool
set_priceUint(1),BoolFlag that shows if initial_priceX96 should be set to the pool or ignored
initial_priceX96Uint(160),PriceX96Initial price for the pool
set_activeUint(1),BoolFlag that shows if pool_active should be set to the pool or ignored
pool_activeUint(1),BoolFlag is we should start the pool as unlocked
protocol_feeUint(16),FeeLiquidity provider fee. base in FEE_DENOMINATOR parts. If value is more than 10000 value would be default
lp_fee_baseUint(16),FeeProtocol fee in FEE_DENOMINATOR. If value is more than 10000 value would be default
lp_fee_currentUint(16),FeeCurrent value of the pool fee, in case of dynamic adjustment. If value is more than 10000 value would be default
1Maybe Cell(1) сode_cellCell With Minters
1pool_codeCell(0),CodePool code
1account_codeCell(0),CodeAccount code
1position_codeCell(0),CodePosition code
2Maybe Cell(1) сontent_cellCell With Minters
2nft_contentCell(0),MetadataMetadata for the NFT Collection
2nft_item_contentCell(0),MetadataMetadata for the NFT Item
3Maybe Cell(1) minter_cellCell With Minters
3jetton0_minterAddress(267)Address of the jetton0 minter, used by indexer and frontend
3jetton1_minterAddress(267)Address of the jetton1 minter, used by indexer and frontend
TL-B Description (TBD) This is a preliminary tl-b - subject to change {% code title="Tlb for POOL\_INIT" overflow="wrap" lineNumbers="true" %} ```javascript POOL_INIT#441c39ed query_id:uint64 from_admin:uint1 roles_cell:^[ has_admin:uint1 admin_addr:MsgAddress has_controller:uint1 controller_addr:MsgAddress has_creator:uint1 creator_addr:MsgAddress privilege_roles_cell:^[ has_arbiter:uint1 arbiter_addr:MsgAddress has_alm:uint1 alm_addr:MsgAddress ] roles_add:^[ has_oracle:uint1 oracle_addr:MsgAddress ] ] set_spacing:uint1 tick_spacing:int24 set_price:uint1 initial_priceX96:uint160 set_active:uint1 pool_active:uint1 protocol_fee:uint16 lp_fee_base:uint16 lp_fee_current:uint16 сode_cell:(Maybe ^[ pool_code:Cell account_code:Cell position_code:Cell ] ) сontent_cell:(Maybe ^[ nft_content:Cell nft_item_content:Cell ] ) minter_cell:(Maybe ^[ jetton0_minter:MsgAddress jetton1_minter:MsgAddress ] ) = ContractMessages; ``` {% endcode %}
### POOL\_LOCK Opcode : **0x5e74697** This operation locks the pool. This is allowed to do by the operator and the admin\
PathMnemonicTypeDescription
opUint(32),op
query_idUint(64)queryid as of the TON documentation
TL-B Description (TBD) This is a preliminary tl-b - subject to change {% code title="Tlb for POOL\_LOCK" overflow="wrap" lineNumbers="true" %} ```javascript POOL_LOCK#5e74697 query_id:uint64 = ContractMessages; ``` {% endcode %}
### POOL\_UNLOCK Opcode : **0x3205adbd** This operation locks the pool. This is allowed to do by the operator and the admin\
PathMnemonicTypeDescription
opUint(32),op
query_idUint(64)queryid as of the TON documentation
TL-B Description (TBD) This is a preliminary tl-b - subject to change {% code title="Tlb for POOL\_UNLOCK" overflow="wrap" lineNumbers="true" %} ```javascript POOL_UNLOCK#3205adbd query_id:uint64 = ContractMessages; ``` {% endcode %}
### POOL\_SET\_FEE Opcode : **0x6bdcbeb8** This operation sets the fee values for the pool. This is allowed to do by the operator and the admin\
PathMnemonicTypeDescription
opUint(32),op
query_idUint(64)queryid as of the TON documentation
protocol_feeUint(16)Liquidity provider fee. base in FEE_DENOMINATOR parts
lp_fee_baseUint(16)Protocol fee in FEE_DENOMINATOR
lp_fee_currentUint(16)Current value of the pool fee, in case of dynamic adjustment
TL-B Description (TBD) This is a preliminary tl-b - subject to change {% code title="Tlb for POOL\_SET\_FEE" overflow="wrap" lineNumbers="true" %} ```javascript POOL_SET_FEE#6bdcbeb8 query_id:uint64 protocol_fee:uint16 lp_fee_base:uint16 lp_fee_current:uint16 = ContractMessages; ``` {% endcode %}
### POOL\_FUND\_ACCOUNT Opcode : **0x4468de77** Proxy proof of the jettons funding and mint request to the Account. For more information refer to [Account](https://docs.tonco.io/contracts-v1.6-forthcoming/account)\
PathMnemonicTypeDescription
opUint(32),op
query_idUint(64)queryid as of the TON documentation
owner_addrAddress(267)Address that would receive the minted NFT, excesses and refunds
initiator_addrAddress(267)Address that started funding sending
0Cell(0) funds_cellCell with parameters
0fundFirstUint(1),BooleanIf the amount the jetton0 in the pool
0amount0Coins(124)Amount of jetton that is funded for the mint
0amount1Coins(124)Amount of the other jetton that is funded for the mint (unused)
0inputWalletAddress(267)Address that would be user for sending refund in case of the bounce
1Maybe Cell(1) order_cellCell with order
1enough0Coins(124)When temporary storage (user account) satisfy both enough0/1 amounts - mint would trigger
1enough1Coins(124)When temporary storage (user account) satisfy both enough0/1 amounts - mint would trigger
1needPosUint(64)Amount of positions that are enough for the order to be executed
1passthroughUint(4)Amount of positions that will be untouched
1target_actionUint(32)target_action
10Maybe Cell(1) MintOrder0Cell with mint order
1->0op0Uint(32)
1->0liquidity0Uint(128)Amount of liquidity to mint
1->0tickLower0Int(24)lower bound of the range in which to mint
1->0tickUpper0Int(24)upper bound of the range in which to mint
1->0receiver0Address(267)Address of receiver of the NFT
11Maybe Cell(1) MintOrder1Cell with mint order
1->1op1Uint(32)
1->1liquidity1Uint(128)Amount of liquidity to mint
1->1tickLower1Int(24)lower bound of the range in which to mint
1->1tickUpper1Int(24)upper bound of the range in which to mint
1->1receiver1Address(267)Address of receiver of the NFT
12Maybe Cell(1) MintOrder2Cell with mint order
1->2op2Uint(32)
1->2liquidity2Uint(128)Amount of liquidity to mint
1->2tickLower2Int(24)lower bound of the range in which to mint
1->2tickUpper2Int(24)upper bound of the range in which to mint
1->2receiver2Address(267)Address of receiver of the NFT
13Maybe Cell(1) MintOrder3Cell with mint order
1->3op3Uint(32)
1->3liquidity3Uint(128)Amount of liquidity to mint
1->3tickLower3Int(24)lower bound of the range in which to mint
1->3tickUpper3Int(24)upper bound of the range in which to mint
1->3receiver3Address(267)Address of receiver of the NFT
TL-B Description (TBD) This is a preliminary tl-b - subject to change {% code title="Tlb for POOL\_FUND\_ACCOUNT" overflow="wrap" lineNumbers="true" %} ```javascript POOL_FUND_ACCOUNT#4468de77 query_id:uint64 owner_addr:MsgAddress initiator_addr:MsgAddress funds_cell:^[ fundFirst:uint1 amount0:(VarUInteger 16) amount1:(VarUInteger 16) inputWallet:MsgAddress ] order_cell:(Maybe ^[ enough0:(VarUInteger 16) enough1:(VarUInteger 16) needPos:uint64 passthrough:uint4 target_action:uint32 MintOrder0:(Maybe ^[ op0:uint32 liquidity0:uint128 tickLower0:int24 tickUpper0:int24 receiver0:MsgAddress ] ) MintOrder1:(Maybe ^[ op1:uint32 liquidity1:uint128 tickLower1:int24 tickUpper1:int24 receiver1:MsgAddress ] ) MintOrder2:(Maybe ^[ op2:uint32 liquidity2:uint128 tickLower2:int24 tickUpper2:int24 receiver2:MsgAddress ] ) MintOrder3:(Maybe ^[ op3:uint32 liquidity3:uint128 tickLower3:int24 tickUpper3:int24 receiver3:MsgAddress ] ) ] ) = ContractMessages; ``` {% endcode %}
### POOL\_START\_BURN Opcode : **0x530b5f2c** Burn whole or part of nft. Can be called by anyone, but if not called be the owner - would fail later. This operation would compute the amount of the fees that the position is eligible to get and then forwards a message to the [Position NFT](https://docs.tonco.io/contracts-v1.6-forthcoming/position_nft) contract\
PathMnemonicTypeDescription
opUint(32),op
query_idUint(64)queryid as of the TON documentation
burned_indexUint(64)Index if the NFT to burn
liquidity2BurnUint(128)Amount of the liquidity to burn, 0 is a valid amount, in this case only collected fees would be returned
tickLowerInt(24)Lower tick of the NFT. Should match the real one
tickUpperInt(24)Upper tick of the NFT. Should match the real one
TL-B Description (TBD) This is a preliminary tl-b - subject to change {% code title="Tlb for POOL\_START\_BURN" overflow="wrap" lineNumbers="true" %} ```javascript POOL_START_BURN#530b5f2c query_id:uint64 burned_index:uint64 liquidity2Burn:uint128 tickLower:int24 tickUpper:int24 = ContractMessages; ``` {% endcode %}
### POOL\_SWAP Opcode : **0xa7fb58f8** V1.5 Computes the swap math, and issues a command to the router to send funds. Only would be accepted from the router This operation we have several input parameters that would affect the result of the swap | Condition | Swap result | Returned Change | Error Code | | --------------------------------------------------------------------------------- | ---------------------------- | --------------- | -------------------------------- | | Swap finished sqrtPriceLimitX96 not reached. minOutAmount surpassed | total output number of coins | 0 | RESULT\_SWAP\_OK | | Swap finished minOutAmount not surpassed | 0 | amount | RESULT\_SWAP\_OUTPUT\_TOO\_SMALL | | Swap reached sqrtPriceLimitX96 after changing part1 coins. minOutAmount surpassed | output number of coins | amount - part1 | RESULT\_SWAP\_OK | \ Access Rights: This operation is allowed for pool::router\_address
PathMnemonicTypeDescription
opUint(32),op
query_idUint(64)queryid as of the TON documentation
source_typeUint(4)Type of source
from_userAddress(267)User that initiated the swap. This is used to control access
owner_addressAddress(267)Owner of the liquidity in swap
zeroForOneUint(1),Booleanused to identify swap direction
0Cell(0) params_cellCell with parameters
0amountCoins(124)Input amount of the jettons to be swapped
0sqrtPriceLimitX96Uint(160),PriceX96Limit marginal price. Swap won't go beyond it.
0minOutAmountCoins(124)Minimum amount of the output jettons to get back. If not reached, your input would be returned to you
1Cell(0) payloads_cellCell with payloads for swap result and change
1target_addressAddress(267)Target will receive the result of the swap. Could be addr_none() (*00b*) then owner_address is used
1ok_forward_amountCoins(124)Amount of TON to use for forward payload that would be sent with the result of the swap
1ok_forward_payloadCell(0),Maybe,PayloadPayload that would be sent with the jettons of the result of the swap
1ret_forward_amountCoins(124)Amount of TON to use for forward payload that would be sent with the change for the swap (if any)
1ret_forward_payloadCell(0),Maybe,PayloadPayload that would be sent with the jettons of the change of the swap (if any)
TL-B Description (TBD) This is a preliminary tl-b - subject to change {% code title="Tlb for POOL\_SWAP" overflow="wrap" lineNumbers="true" %} ```javascript POOL_SWAP#a7fb58f8 query_id:uint64 source_type:uint4 from_user:MsgAddress owner_address:MsgAddress zeroForOne:uint1 params_cell:^[ amount:(VarUInteger 16) sqrtPriceLimitX96:uint160 minOutAmount:(VarUInteger 16) ] payloads_cell:^[ target_address:MsgAddress ok_forward_amount:(VarUInteger 16) ok_forward_payload:(Maybe ^Cell) ret_forward_amount:(VarUInteger 16) ret_forward_payload:(Maybe ^Cell) ] = ContractMessages; ``` {% endcode %}