TL-B Schemes - swap.coffee

This page contains extensive information about custom entities used in communication with/in-between swap.coffee DEX contracts.

Types

AMM

constant_product$000 = AMM;

curve_fi_stable$001 = AMM;

Defines AMM strategy type of the pool.

AMM Settings

Some AMM strategies require additional settings whenever pool with such strategy is about to be created. Person who initiates this process must provide AMM settings cell within the transaction. Please, keep in mind that non-Constant Product pools may be created by the DEX administration only.

CurveFi Stable

amm_settings amplification:uint16 asset1_weight:Coins
             asset2_weight:Coins = AmmSettings;

Property Name	Meaning
amplification	Multiplier used in StableSwap formulas. The higher this value is, the closer exchange price stays to 1:1. The lower this value is, the more exchange price looks like from Constant Product formula
asset1_weight	Value by which first asset reserves and amounts multiplied in StableSwap formulas. Usually a power of 10
asset2_weight	Value by which second asset reserves and amounts multiplied in StableSwap formulas. Usually a power of 10

Asset

native$00 = Asset;

jetton$01 chain:uint8 hash:uint256 = Asset;

extra$10 id:uint32 = Asset;

Defines asset type (and metadata) to work with.

native

Used for TONcoin.

jetton

Used for any jettons.

extra

Used for extra currencies.

DepositLiquidityCondition

none$00 = DepositLiquidityCondition;

lp_quantity$01 min_lp_amount:Coins = DepositLiquidityCondition;

reserves_ratio$10 denominator:uint16 min_nominator:uint16
                  max_nominator:uint16 = DepositLiquidityCondition;

complex$11 min_lp_amount:Coins denominator:uint16 min_nominator:uint16
           max_nominator:uint16 = DepositLiquidityCondition;

Defines condition, which will be checked whenever contract receives liquidity deposition request. If it fails, transaction will be reverted.

none

Equivalent to no-condition.

lp_quantity

Allows to set minimum quantity of LP tokens you will get in return after liquidity deposition happens. If real quantity is lower than the given one, transaction will be reverted.

reserves_ratio

Allows to check pool reserves ratio before your liquidity deposition happens. In other words, all of the following formulas must be true:

reserves1 / reserves2 >= min_nominator / denominator
reserves1 / reserves2 <= max_nominator / denominator

complex

Just a combination of lp_quantity and reserves_ratio.

WithdrawLiquidityCondition

none$00 = WithdrawLiquidityCondition;

assets_quantity$01 min_first_amount:Coins min_second_amount = WithdrawLiquidityCondition;

reserves_ratio$10 denominator:uint16 min_nominator:uint16
                  max_nominator:uint16 = WithdrawLiquidityCondition;

complex$11 min_first_amount min_second_amount:Coins denominator:uint16
           min_nominator:uint16 max_nominator:uint16 = WithdrawLiquidityCondition;

Defines condition, which will be checked whenever user tries to withdraw already provided liquidity from the pool. If it fails, transaction will be reverted (and LP tokens will be minted back). Subtypes are very similar with DepositLiquidityCondition ones.

PoolParams

pool_params first:Asset second:Asset amm:AMM amm_settings:(Maybe ^Cell) = PoolParams;

Used to uniquely identify the pool. Only one pool can exist for given asset-pair, AMM type and AMM settings.

Property Name	Meaning
first	First asset of the pool (in any order)
second	Second asset of the pool (in any order)
amm	Market-making strategy of the pool
amm_settings	Cell of AMM settings. Must be set for those AMMs that require it

PublicPoolCreationParams

public_pool_creation_params recipient:MsgAddressInt
                            use_recipient_on_failure:int1
                            notification_data:(Maybe ^Cell)
= PublicPoolCreationParams;

Params that may be publicly used for new pools creation:

Property Name	Meaning
recipient	Address to which LP tokens must go after transaction succeed (or to which funds must return in failure scenario). Must be present
use_recipient_on_failure	Determines where to accrue funds in case of any failure. If set to 0, funds will be returned to transaction initiator; otherwise they will be returned to `recipient`
notification_data	Used for custom payloads. See: NotificationData

PrivatePoolCreationParams

private_pool_creation_params is_active:uint1 extra_settings:(Maybe ^Cell)
= PrivatePoolCreationParams;

Params that may be used for new pools creation by DEX administration only:

Property Name	Meaning
is_active	Is pool active (functional) at the time it’s being created. Must be set to 1 when invoked from non-admin users
extra_settings	Reserved for future features, not currently in use

PoolCreationParams

pool_creation_params public:PublicPoolCreationParams private:PrivatePoolCreationParams
= PoolCreationParams;

Params for new pools creation.

NotificationDataSingle

notification_data_single receiver:MsgAddressInt fwd_gas:Coins
                         payload:^Cell = NotificationDataSingle;

Defines where to send (and with how much gas) custom payload for various actions within DEX. If receiver is none, it’s considered being equal to transaction recipient.

NotificationData

notification_data on_success:(Maybe ^NotificationDataSingle)
                  on_failure:(Maybe ^NotificationDataSingle) = NotificationData;

Defines how to handle notifications (custom payloads) in none of, one of or both scenarios of successful/failed execution.

PoolUpdateParams

pool_update_params flags:(## 2)
                   protocol_fee:flags.0?uint16 lp_fee:flags.0?uint16
                   is_active:flags.1?uint1 = PoolUpdateParams;

Defines pool’s parameters that may be updated by DEX administrator.

SwapParams

swap_params deadline:uint32 recipient:MsgAddressInt referral:MsgAddressInt
            notification_data:(Maybe ^NotificationData) = SwapParams;

Defines parameters that are essential for all (multi-hop) steps of single swap transaction:

Property Name	Meaning
deadline	Unix timestamp. If contract receives swap message after that time, transaction will be failed at that step
recipient	Address to which funds must go after swap transaction is over (both in success/failure scenarios). Must be present
referral	Address to which referral fees will be accrued. If none, referral fees go to the protocol
notification_data	Used for custom payloads. See: NotificationData

SwapStepParams

swap_step_params pool_address_hash:uint256 min_output_amount:Coins
                 next:(Maybe ^SwapStepParams) = SwapStepParams;

Defines parameters that are unique for every (multi-hop) step of swap transaction:

Property Name	Meaning
pool_address_hash	Hash part of the pool’s address
min_output_amount	Minimum quantity of output asset to receive. If you get less, transaction will fail
next	Next swap-step if any

SwapStepInternalParams

swap_step_internal_params previous_amount:Coins previous_asset_hint:(Maybe Asset)
                          min_output_amount:Coins
                          next:(Maybe ^SwapStepParams) = SwapStepInternalParams;

Same as SwapStepParams, but is being used in inter-contract communication.

Property Name	Meaning
previous_amount	Amount of asset you received on the previous swap-step
previous_asset_hint	Asset you received on the previous swap-step. It’s present only in cases when user tries to perform sequential swaps on pools of the same asset-pairs (but probably different AMM types)
min_output_amount	Minimum quantity of output asset to receive. If you get less, transaction will fail
next	Next swap-step if any

PoolReserves

pool_reserves input_reserve:Coins output_reserve:Coins = PoolReserves;

Defines reserves of the pool.

DepositLiquidityParamsTrimmed

deposit_liquidity_params_trimmed recipient:MsgAddressInt use_recipient_on_failure:int1
                                 referral:MsgAddressInt
                                 deadline:uint32 condition:DepositLiquidityCondition
                                 extra_settings:(Maybe ^Cell)
                                 notification_data:(Maybe ^NotificationData)
= DepositLiquidityParamsTrimmed;

Defines parameters required for liquidity provisioning. This exact entity is being used in inter-contract communication and lacks some of extra information (see below).

Property Name	Meaning
recipient	Address to which LP tokens must go after transaction succeed (or to which funds must return in failure scenario). Must be present
use_recipient_on_failure	Determines where to accrue funds in case of any failure. If set to 0, funds will be returned to transaction initiator; otherwise they will be returned to `recipient`
referral	Referral address used exclusively for analytical purposes. No fees or any kind or rewards will be given
deadline	Unix timestamp. If contract receives liquidity provisioning message after that time, transaction will be failed at that step
condition	Used to protect the liquidity provider from unfavorable pool conditions. See: DepositLiquidityCondition
extra_settings	Reserved for future features, not currently in use
notification_data	Used for custom payloads. See: NotificationData

DepositLiquidityParams

deposit_liquidity_params params:^DepositLiquidityParamsTrimmed
                         pool_params:^PoolParams = DepositLiquidityParams;

Extended version of the previous one. Pool parameters are used to identify the pool.

WithdrawLiquidityParams

withdraw_liquidity_params use_recipient_on_failure:int1 deadline:uint32
                          condition:WithdrawLiquidityCondition
                          extra_settings:(Maybe ^Cell)
                          on_success:(Maybe ^NotificationDataSingle)
= WithdrawLiquidityParams;

Defines parameters that may be specified by user when withdrawing already provided liquidity (by burning his LP tokens). This exact entity is being used as a custom_payload within burn message.

Property Name	Meaning
use_recipient_on_failure	Determines where to accrue funds in case of any failure. If set to 0, funds will be returned to transaction initiator; otherwise they will be returned to `recipient`
deadline	Unix timestamp. If contract receives liquidity withdrawal message after that time, transaction will be failed at that step
condition	Used to protect the liquidity withdrawer from unfavorable pool conditions. See: WithdrawLiquidityCondition
extra_settings	Reserved for future features, not currently in use
on_success	Used for custom payloads on successful liquidity withdrawals. See: NotificationData

ContractUpdate

contract_update code:(Maybe ^Cell) data:(Maybe ^Cell) = ContractUpdate;

Entity used in administrative action of contract updates.

Messages

SwapNative

swap_native#c0ffee00 query_id:uint64 amount:Coins _:SwapStepParams
                     params:^SwapParams = SwapNative;

Must be sent by user to the Native Vault to initiate swap transaction.

Property Name	Meaning
query_id	Non-unique identifier which you may specify to track this transaction
amount	Amount of TONs to swap. Must be lower than the message value of TONs (because extra TONs will be used to pay for gas, and will be returned at the end of the transaction)
_	Parameters for the first swap-step of the transaction. See: SwapStepParams
params	Parameters that are essential for all steps of the swap transaction. See: SwapParams

SwapJetton

swap_jetton#c0ffee10 _:SwapStepParams params:^SwapParams = SwapJetton;

Must be sent by user to the corresponding Jetton Vault as a forward payload of a jetton-transfer message to initiate swap transaction. Query ID, jetton and it’s amount are being determined internally from jetton transfer notification and therefore mustn’t be present here.

Property Name	Meaning
_	Parameters for the first swap-step of the transaction. See: SwapStepParams
params	Parameters that are essential for all steps of the swap transaction. See: SwapParams

SwapExtra

swap_extra#c0ffee01 query_id:uint64 _:SwapStepParams
                    params:^SwapParams = SwapExtra;

Must be sent by user to the corresponding Extra-Currency Vault to initiate swap transaction. Extra-currency and it’s amount are being determined internally from the vault type and extra-currencies dictionary within the message.

Property Name	Meaning
query_id	Non-unique identifier which you may specify to track this transaction
_	Parameters for the first swap-step of the transaction. See: SwapStepParams
params	Parameters that are essential for all steps of the swap transaction. See: SwapParams

SwapSuccessfulEvent

swap_successful_event#c0ffee30 query_id:uint64 input:Asset input_amount:Coins
                               output_amount:Coins
                               reserves:^PoolReserves = SwapSuccessfulEvent;

Is being sent by the pool as an external outgoing message whenever swap step completes successfully. This message occurs after payout is guaranteed to happen, but before it actually happens.

Property Name	Meaning
query_id	Propagated identifier
input	Input (given) asset of the swap operation. There is no output asset property, but it may be determined from the pool address and data
input_amount	Amount of input (given) asset of the swap operation
output_amount	Amount of output (received) asset of the swap operation
reserves	Pool’s reserves at the moment swap happened

SwapFailedEvent

swap_failed_event#c0ffee31 query_id:uint64 input:Asset input_amount:Coins
                           reserves:(Maybe ^PoolReserves) = SwapFailedEvent;

Is being sent by the pool as an external outgoing message whenever swap step completes badly (i.e. it was slippage tolerated or deadline exceeded). This message occurs after payout (of the input asset) is guaranteed to happen, but before it actually happens. Despite the fact that message itself does not contain failure reason, it may be determined as an exit code of the TVM.

Property Name	Meaning
query_id	Propagated identifier
input	Input (given) asset of the swap operation. There is no output asset property, but it may be determined from the pool address and data
input_amount	Amount of input (given) asset of the swap operation
reserves	Information about pool’s reserves at a time it tries to execute this transaction. Guaranteed to be present to slippage-tolerated failures only

CreatePoolNative

create_pool_native#c0ffee02 query_id:uint64 amount:Coins params:PoolParams
                            creation_params:PoolCreationParams = CreatePoolNative;

Must be sent by user to the Native Vault as a part of pool creation (and it’s initial liquidity provisioning).

Property Name	Meaning
query_id	Non-unique identifier which you may specify to track this transaction
amount	Amount of TONs to deposit into liquidity. Must be lower than the message value of TONs (because extra TONs will be used to pay for gas, and will be returned at the end of the transaction)
params	Parameters used to uniquely identify the pool. See: PoolParams
creation_params	Parameters used for pool creation. See: PoolCreationParams

CreatePoolJetton

create_pool_jetton#c0ffee11 params:PoolParams
                            creation_params:PoolCreationParams = CreatePoolJetton;

Must be sent by user to the corresponding Jetton Vault as a part of pool creation (and it’s initial liquidity provisioning). This message must be included as a forward payload to the jetton-transfer message. Query ID, jetton and it’s amount are being determined internally from jetton transfer notification and therefore mustn’t be present here.

Property Name	Meaning
params	Parameters used to uniquely identify the pool. See: PoolParams
creation_params	Parameters used for pool creation. See: PoolCreationParams

CreatePoolExtra

create_pool_extra#c0ffee03 query_id:uint64 params:PoolParams
                           creation_params:PoolCreationParams = CreatePoolExtra;

Must be sent by user to the corresponding Extra-Currency Vault as a part of pool creation (and it’s initial liquidity provisioning). Extra-currency and it’s amount are being determined internally from the vault type and extra-currencies dictionary within the message.

Property Name	Meaning
query_id	Non-unique identifier which you may specify to track this transaction
params	Parameters used to uniquely identify the pool. See: PoolParams
creation_params	Parameters used for pool creation. See: PoolCreationParams

DepositLiquidityNative

deposit_liquidity_native#c0ffee04 query_id:uint64 amount:Coins
                                  params:DepositLiquidityParams
= DepositLiquidityNative;

Must be sent by user to the Native Vault as a part of liquidity provisioning process.

Property Name	Meaning
query_id	Non-unique identifier which you may specify to track this transaction
amount	Amount of TONs to deposit into liquidity. Must be lower than the message value of TONs (because extra TONs will be used to pay for gas, and will be returned at the end of the transaction)
params	Parameters used for liquidity provisioning. See: DepositLiquidityParams

DepositLiquidityJetton

deposit_liquidity_jetton#c0ffee12 params:DepositLiquidityParams
= DepositLiquidityJetton;

Must be sent by user to the corresponding Jetton Vault as a part of liquidity provisioning process. This message must be included as a forward payload to the jetton-transfer message. Query ID, jetton and it’s amount are being determined internally from jetton transfer notification and therefore mustn’t be present here.

Property Name	Meaning
params	Parameters used for liquidity provisioning. See: DepositLiquidityParams

DepositLiquidityExtra

deposit_liquidity_extra#c0ffee05 query_id:uint64 params:DepositLiquidityParams
= DepositLiquidityExtra;

Must be sent by user to the corresponding Extra-Currency Vault as a part of liquidity provisioning process. Extra-currency and it’s amount are being determined internally from the vault type and extra-currencies dictionary within the message.

Property Name	Meaning
query_id	Non-unique identifier which you may specify to track this transaction
params	Parameters used for liquidity provisioning. See: DepositLiquidityParams

DepositLiquiditySuccessfulEvent

deposit_liquidity_successful_event#c0ffee33 query_id:uint64 amount1:Coins
                                            amount2:Coins lp_amount:Coins
                                            total_supply:PoolReserves
                                            reserves:PoolReserves
= DepositLiquiditySuccessfulEvent;

Is being sent by the pool as an external outgoing message whenever liquidity provisioning step completes successfully. This message occurs after LP tokens payout is guaranteed to happen, but before it actually happens.

Property Name	Meaning
query_id	Propagated identifier
amount1	Amount of pool’s first asset that were used for the liquidity provisioning
amount2	Amount of pool’s second asset that were used for the liquidity provisioning
lp_amount	Amount of LP tokens user received as a result of this liquidity provisioning
total_supply	Information about how pool’s LP tokens total supply changed with this operation
reserves	Pool’s reserves at the moment this operation happened

DepositLiquidityFailedEvent

deposit_liquidity_failed_event#c0ffee34 query_id:uint64 amount1:Coins
                                        amount2:Coins min_lp_amount:Coins
                                        total_supply:Coins reserves:PoolReserves
= DepositLiquidityFailedEvent;

Is being sent by the pool as an external outgoing message whenever liquidity provisioning step completes badly (i.e. it’s condition check failed or deadline exceeded). This message occurs after payout (of provided assets) is guaranteed to happen, but before it actually happens. Despite the fact that message itself does not contain failure reason, it may be determined as an exit code of the TVM.

Property Name	Meaning
query_id	Propagated identifier
amount1	Amount of pool’s first asset that were about to be used for the liquidity provisioning
amount2	Amount of pool’s second asset that were about to be used for the liquidity provisioning
min_lp_amount	Minimum amount of LP tokens user was asking for
total_supply	Total supply of LP tokens at the moment this liquidity provisioning was about to happen
reserves	Pool’s reserves at the moment this liquidity provisioning was about to happen

LiquidityWithdrawalEvent

liquidity_withdrawal_event#c0ffee35 query_id:uint64 amount1:Coins amount2:Coins
                                    lp_amount:Coins total_supply:PoolReserves
                                    reserves:PoolReserves
= LiquidityWithdrawalEvent;

Is being sent by the pool as an external outgoing message whenever somebody withdraws previously provided liquidity. This message occurs after payout is guaranteed to happen, but before it actually happens.

Property Name	Meaning
query_id	Propagated identifier
amount1	Amount of pool’s first asset that will be sent to the user
amount2	Amount of pool’s second asset that will be sent to the user
lp_amount	Amount of LP tokens being burnt
total_supply	Information about how pool’s LP tokens total supply changed with this operation
reserves	Pool’s reserves at the moment this operation happened

WithdrawDeposit

withdraw_deposit#c0ffee07 query_id:uint64 = WithdrawDeposit;

Must be sent by the user to the PoolCreator or LiquidityDepository if only one of 2 liquidity provisioning transactions succeeded and user decides to cancel previously initiated process. As a result of this message execution, all half-way deposited funds will be returned back to the user.

Burn (liquidity withdrawal)

To withdraw liquidity, user simply needs to burn his LP tokens by sending the following message to his LP jetton wallet, according to jetton standard:

burn#595f07bc query_id:uint64 amount:(VarUInteger 16)
              response_destination:MsgAddress custom_payload:(Maybe ^Cell)
              = InternalMsgBody;

Although this scheme includes a custom_payload, regular jetton wallets do not support it, and therefore there is no way for user to provide any extra data related to token burning. That’s why we slightly modified code of our LP jetton wallets, and they support custom_payload. If needed, user may use it, passing WithdrawLiquidityParams as a custom_payload.

Miscellaneous

Payout

payout#c0ffee32 query_id:uint64 = Payout;

Is being sent by the Native Vault and Extra-Currency Vaults in some cases. More specifically, it occurs if:

Operation was initiated without notifications (custom payloads)
Operation was initiated with notification, but it’s recipient differs from the wallet that receives funds

It means that in a situation when operation was initiated with notification, but it’s recipient is the same as the one who receives funds, this message won’t be created.

CreateVault

create_vault#c0ffee06 query_id:uint64 asset:Asset = CreateVault;

Must be sent by a user to the Factory in order to create new vault.

Property Name	Meaning
query_id	Non-unique identifier which you may specify to track this transaction
asset	Asset for which new vault must be created

Notification

notification#c0ffee36 query_id:uint64 body:^Cell = Notification;

Serves as a wrapper for any outgoing messages proposed by transaction initiator as a marker of operation completion status. Therefore, is being sent by Vaults or Pools after operation completes.

Inter-contract communication

SwapInternal

swap_internal#c0ffee20 query_id:uint64 _:SwapStepInternalParams params:^SwapParams
                       proof:^Cell = SwapInternal;

For any first step of swap transaction, this message will be sent from Vaults to the Pool. For any intermediate steps of swap transaction, it will be sent from one Pool to another.

Property Name	Meaning
query_id	Propagated identifier
_	Parameters of the current swap step
params	Parameters which are essential for all steps of this swap transaction
proof	Special cell constructed for securing inter-contract communication

PayoutInternal

payout_internal#c0ffee21 query_id:uint64 recipient:MsgAddressInt amount:Coins
                         notification_data:(Maybe ^NotificationDataSingle)
                         proof:(Maybe ^Cell) = PayoutInternal;

Is being sent by Pools to the Vaults every time Pool decides that a payment must happen. Keep in mind that there’s no asset defined in the message, because it can be determined by the Vault data.

Property Name	Meaning
query_id	Propagated identifier
recipient	Address of the one who will receive funds
amount	Amount of asset to be sent to the recipient
notification_data	Used for custom payloads. See: NotificationData
proof	Special cell constructed for securing inter-contract communication

Deploy

deploy#c0ffee22 code:^Cell data:^Cell action:(Maybe ^Cell) = Deploy;

Is being sent by Factory every time it decides to deploy a new contract.

Property Name	Meaning
code	Code of the contract
data	Data of the contract
action	Optional code cell that must be invoked after contract initialization

CreatePoolCreatorRequest

create_pool_creator_request#c0ffee23 query_id:uint64 amount:Coins params:PoolParams
                                     creation_params:^PoolCreationParams
                                     sender:MsgAddressInt proof:^Cell
= CreatePoolCreatorRequest;

Is being sent by Vaults to the Factory at the moment somebody tries to create new pool. Keep in mind that there’s no asset defined in the message, because it can be determined by the Vault data.

Property Name	Meaning
query_id	Propagated identifier
amount	Amount of this vault’s asset user provided as an initial liquidity for the pool
params	Parameters for pool creation
creation_params	Parameters used for pool creation. See: PoolCreationParams
sender	Address of the one who initialized pool creation
proof	Special cell constructed for securing inter-contract communication

CreatePoolCreatorInternal

create_pool_creator_internal#c0ffee24 query_id:uint64 asset:Asset amount:Coins
                                      creation_params:^PoolCreationParams
= CreatePoolCreatorInternal;

Is being sent by the Factory whenever it’s about to deploy new PoolCreator. Properties are pretty much the same with CreatePoolCreatorRequest.

CreatePoolRequest

create_pool_request#c0ffee25 query_id:uint64 amount1:Coins
                             amount2:Coins tx_initiator:MsgAddressInt
                             creation_params:^PoolCreationParams proof:^Cell
= CreatePoolRequest;

Is being sent by the PoolCreator to the Factory when it’s time the uninitialize PoolCreator and deploy a Pool. Properties are pretty much the same with CreatePoolCreatorRequest.

CreatePoolInternal

create_pool_internal#c0ffee26 query_id:uint64 amount1:Coins
                              amount2:Coins tx_initiator:MsgAddressInt
                              recipient:MsgAddressInt
                              use_recipient_on_failure:int1
                              extra_settings:(Maybe ^Cell)
                              notification_data:(Maybe ^NotificationData)
= CreatePoolInternal;

Is being sent by the Factory whenever it’s about to deploy new Pool. Properties are pretty much the same with CreatePoolCreatorRequest.

CreateLiquidityDepositoryRequest

create_liquidity_depository_request#c0ffee27 query_id:uint64 amount:Coins
                                             params:DepositLiquidityParams
                                             sender:MsgAddressInt
                                             proof:^Cell
= CreateLiquidityDepositoryRequest;

Is being sent by Vaults to the Factory at the moment somebody tries to deposit liquidity to some pool. Keep in mind that there’s no asset defined in the message, because it can be determined by the Vault data.

Property Name	Meaning
query_id	Propagated identifier
amount	Amount of this vault’s asset user provided as a liquidity for the pool
params	Parameters for liquidity provisioning. See DepositLiquidityParams
sender	Address of the user who initiated transaction
proof	Special cell constructed for securing inter-contract communication

CreateLiquidityDepositoryInternal

create_liquidity_depository_internal#c0ffee28 query_id:uint64 asset:Asset
                                              amount:Coins
                                              params:^DepositLiquidityParamsTrimmed
= CreateLiquidityDepositoryInternal;

Is being sent by the Factory whenever it’s about to deploy new LiquidityDepository. Properties are pretty much the same with CreateLiquidityDepositoryRequest.

DepositLiquidityInternal

deposit_liquidity_internal#c0ffee29 query_id:uint64 amount1:Coins
                                    amount2:Coins tx_initiator:MsgAddressInt
                                    params:^DepositLiquidityParamsTrimmed
                                    proof:^Cell = DepositLiquidityInternal;

Is being sent by the LiquidityDepository to the Pool when it’s time to uninitialize LiquidityDepository and execute liquidity provisioning on the Pool side. Properties are pretty much the same with CreateLiquidityDepositoryRequest.

CreateVaultInternal

create_vault_internal#c0ffee2a query_id:uint64 = CreateVaultInternal;

Is being sent by the Factory whenever it’s about to deploy new Vault.

UpdatePoolInternal

update_pool_internal#c0ffee2b query_id:uint64 excesses_receiver:MsgAddressInt
                              params:^PoolUpdateParams = UpdatePoolInternal;

Is being sent by the Factory to the Pool whenever it receives administrative request to do so.

ActivateVaultInternal

activate_vault_internal#c0ffee2c query_id:uint64
                                 wallet:MsgAddressInt = ActivateVaultInternal;

Is being sent by the Factory to the Vault whenever it receives administrative request to do so. When Factory creates new Jetton Vault, it internally initiates process of determining it’s own jetton wallet’s address. It is required to ensure security later on, but unfortunately in order to obtain that address Jetton Vault needs to ask Jetton Master for it. Not all Jetton Masters support such thing on-chain, therefore for some older jettons administrative affection is required.

WithdrawInternal

withdraw_internal#c0ffee2d query_id:uint64 asset:Asset amount:Coins
                           receiver:MsgAddressInt = WithdrawInternal;

Is being sent by the Factory to the Pool whenever it receives administrative request to do so. Upon receiving such a message, Pool checks whether administrator is trying to withdraw not more than stored amount of collected protocol fees. If so, it sends payout command to the Vault to fulfill initial request.

UpdateContractInternal

update_contract_internal#c0ffee2e query_id:uint64 excesses_receiver:MsgAddressInt
                                  _:ContractUpdate = UpdateContractInternal;

Is being sent by the Factory to any DEX contract whenever it receives administrative request to do so.

Administrative

UpdateAdmin

update_admin#c0ffee40 query_id:uint64 address:MsgAddressInt = UpdateAdmin;

Must be sent from the administrative wallet to the Factory in order to update administrative wallet’s address.

UpdatePool

update_pool#c0ffee41 query_id:uint64 pool_params:PoolParams
                     params:^PoolUpdateParams = UpdatePool;

Must be sent from the administrative wallet to the Factory in order to update parameters of the pool.

ActivateVault

activate_vault#c0ffee42 query_id:uint64 asset:Asset
                        wallet:MsgAddressInt = ActivateVault;

Must be sent from the administrative wallet to the Factory in order to activate some Jetton Vault.

Withdraw

withdraw#c0ffee43 query_id:uint64 pool_address:MsgAddressInt asset:Asset
                  amount:Coins receiver:MsgAddressInt = Withdraw;

Must be sent from the withdrawer wallet to the Factory in order to withdraw some assets. Used to withdraw collected protocol fees: they are calculated (collected) on-chain, but must be distributed off-chain in order to significantly lower gas consumption for end-users.

UpdateCodeCell

update_code_cell#c0ffee44 query_id:uint64 code_cell:^Cell = UpdateCodeCell;

Must be sent from the administrative wallet to the Factory in order to update code cells of all the contracts that will be deployed by the Factory in the future.

UpdateContract

update_contract#c0ffee45 query_id:uint64 contract_address:MsgAddressInt
                         _:ContractUpdate = UpdateContract;

Must be sent from the administrative wallet to the Factory in order to update already existing contract. contract_address must be none in case of administrator wanting to upgrade the Factory itself.

UpdateWithdrawer

update_withdrawer#c0ffee46 query_id:uint64 address:MsgAddressInt = UpdateWithdrawer;

Must be sent from the administrative wallet to the Factory in order to update withdrawer wallet’s address.

Technical Guides

Documentation Index

​Types

​AMM

​AMM Settings

​CurveFi Stable

​Asset

​native

​jetton

​extra

​DepositLiquidityCondition

​none

​lp_quantity

​reserves_ratio

​complex

​WithdrawLiquidityCondition

​PoolParams

​PublicPoolCreationParams

​PrivatePoolCreationParams

​PoolCreationParams

​NotificationDataSingle

​NotificationData

​PoolUpdateParams

​SwapParams

​SwapStepParams

​SwapStepInternalParams

​PoolReserves

​DepositLiquidityParamsTrimmed

​DepositLiquidityParams

​WithdrawLiquidityParams

​ContractUpdate

​Messages

​Related to swaps

​SwapNative

​SwapJetton

​SwapExtra

​SwapSuccessfulEvent

​SwapFailedEvent

​Related to pools creation and liquidity provisioning

​CreatePoolNative

​CreatePoolJetton

​CreatePoolExtra

​DepositLiquidityNative

​DepositLiquidityJetton

​DepositLiquidityExtra

​DepositLiquiditySuccessfulEvent

​DepositLiquidityFailedEvent

​LiquidityWithdrawalEvent

​WithdrawDeposit

​Burn (liquidity withdrawal)

​Miscellaneous

​Payout

​CreateVault

​Notification

​Inter-contract communication

​SwapInternal

​PayoutInternal

​Deploy

​CreatePoolCreatorRequest

​CreatePoolCreatorInternal

​CreatePoolRequest

​CreatePoolInternal

​CreateLiquidityDepositoryRequest

​CreateLiquidityDepositoryInternal

​DepositLiquidityInternal

​CreateVaultInternal

​UpdatePoolInternal

​ActivateVaultInternal

​WithdrawInternal

​UpdateContractInternal

​Administrative

​UpdateAdmin

​UpdatePool

​ActivateVault

​Withdraw

​UpdateCodeCell

​UpdateContract

​UpdateWithdrawer