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 |
reserves1 / reserves2 >= min_nominator / denominator
reserves1 / reserves2 <= max_nominator / denominator
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 |
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 |
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 |
receiver
is none, it’s considered being equal to transaction recipient.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Property Name | Meaning |
---|---|
params | Parameters used to uniquely identify the pool. See: PoolParams |
creation_params | Parameters used for pool creation. See: PoolCreationParams |
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 |
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 |
Property Name | Meaning |
---|---|
params | Parameters used for liquidity provisioning. See: DepositLiquidityParams |
Property Name | Meaning |
---|---|
query_id | Non-unique identifier which you may specify to track this transaction |
params | Parameters used for liquidity provisioning. See: DepositLiquidityParams |
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 |
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 |
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 |
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
.
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 |
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 |
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 |
Property Name | Meaning |
---|---|
code | Code of the contract |
data | Data of the contract |
action | Optional code cell that must be invoked after contract initialization |
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 |
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 |
contract_address
must be none in case of administrator wanting to upgrade the Factory itself.