Vault

This section contains api reference of the router contract

Check examples for in-depth message flow.

Off-chain get methods

get_vault_data

Returns Vault data

(slice, slice, slice, int) get_router_data() method_id;

Arguments

None

Result

Returns VaultData structure containing current state of the Vault.

RouterData structure

Key	Type	Index	Description
owner_address	Address	0	Owner of this Vault
token_address	Address	1	Address of Router's jetton wallet for s token'
router_address	Address	2	Router's address
deposited_amount	bigint	3	Amount of tokens collected

Owner operation handlers

Handles calls from the Vault owner

withdraw_fee (0x45ed2dc7)

Burn an amount of liquidity tokens.

TL-B

withdraw_fee#45ed2dc7 query_id:uint64 = InternalMsgBody;

Message body

Name	Type	Description
op	uint32	Operation code
query_id	uint64	Query id

Outgoing messages

Sends a message with vault_pay_to op code to the router contract with the amount of token to be payed.

Internal message handlers

Handles calls from the Router owner

deposit_ref_fee (0x537c5a70)

Increase ref fee tracker for the user.

TL-B

deposit_ref_fee#537c5a70 query_id:uint64 jetton_amount:Coins excesses_address:MsgAddress = InternalMsgBody;

Message body

Name	Type	Description
op	uint32	Operation code
query_id	uint64	Query id
jetton_amount	bigint	Amount of the tokens
excesses_address	Address	Address to receive TON excesses

Outgoing messages

Sends excesses to excesses_address.