LpAccount
This section contains api reference of the lp account contract
Off-chain get methods
get_lp_account_data
get_lp_account_data
Returns current state of the LpAccount
.
Arguments
None
Result
Returns LpAccountData
structure containing current state of the lp account.
LpAccountData
structure
On-chain queries
On-chain counterparts of getter methods.
Operations table
getter_lp_account_data
(0x24cfc100)
getter_lp_account_data
(0x24cfc100)Sends a message with current state of the lp account. On-chain equivalent of get_lp_account_data
.
TL-B
Message body
None
Outgoing messages
Sends a message with current state of the lp account to sender_address
Response message body
Pool message handlers
Handles incoming messages from a pool
Operations table
add_liquidity
(0x50c6a654)
add_liquidity
(0x50c6a654)Stores the sent amount of tokens by the user to be added as new liquidity. Upon receiving an appropriate amount of both tokens sends a message with those amounts to a pool to be added as new liquidity. The automatic liquidity addition happens only if the amount of both tokens if greater than 1000 and non-zero min_lp_out
was specified, otherwise the user can keep increasing the amount of stored tokens.
TL-B
Message body
additional_fields
Notes:
addition of liquidity will fail if a user should receive less than
min_lp_out
of lp tokens as a result
Outgoing messages
Sends a message to the pool with cb_add_liquidity
op
Response message body
additional_data
Notes:
addition of liquidity will fail if a user should receive less than
min_lp_out
of lp tokens as a resultLpAccount
is deleted upon sending this message (Pool
always sends msgs withstate_init
)
User message handlers
Handles incoming messages from a user
Operations table
refund_me
(0x132b9a2c)
refund_me
(0x132b9a2c)Initiates a refund of stored tokens by add_liquidity
if the user decides to cancel the addition of new liquidity. The amount of stored tokens will be sent to the pool which will initiate a transfer back to the user.
TL-B
Message body
None
Outgoing messages
Sends a message with cb_refund_me
op code and amount of stored tokens to a pool. The pool will send a message to refund those tokens back to the user.
Response message body
direct_add_liquidity
(0x0ff8bfc6)
direct_add_liquidity
(0x0ff8bfc6)Initiates an addition of new liquidity to a pool with a specified amount of both tokens and a minimum amount of received liquidity. The operation is successful only if there's an equal or greater amount of both tokens stored in the account (the amount of both tokens must be greater than 1000). This method is useful if an automatic liquidity addition has not been triggered upon deposition of tokens.
TL-B
Message body
additional_data
Notes:
addition of liquidity will fail if a user should receive less than
min_lp_out
of lp tokens as a resultmin_lp_out
value must be greater than zero for this operation to proceed
Outgoing messages
Sends a message with cb_add_liquidity
op code and amount of both tokens to be added as new liquidity.
reset_gas
(0x29d22935)
reset_gas
(0x29d22935)Updates the amount of TON (in nanoTons) on the lp account to storage_fee::lp_account
(10000000) of the account. The remaining TON will be sent back to the user_address
TL-B
Message body
None
Outgoing messages
Sends an empty message back to the user with the remaining TON
Constants
Last updated