LogoLogo
ston-fi/docs
ston-fi/docs
  • User section
    • About
    • STON.fi Protocol
    • Fees
    • Glossary
    • Procedure for Adding Tokens to the Default List
    • Whitepaper
  • Developer section
    • Architecture
    • SDK
      • DEX v1 guide
        • reference
        • swap
        • provide liquidity
        • refund liquidity
        • burn liquidity tokens
      • DEX v2 guide
        • swap
        • provide liquidity
        • refund liquidity
        • burn liquidity tokens
        • withdraw fee from vault
      • Farm guide
        • stake in farm
        • claim farm rewards
        • unstake from farm
        • destroy farm NFT
      • Transaction sending guide
        • via ton
        • via tonweb
        • via tonconnect
      • v0.5 > v1.0.0 migration guide
      • v0.5 (deprecated)
        • DEX guide
          • swap
          • provide liquidity
          • refund liquidity
          • burn liquidity tokens
        • Farm guide
          • stake in farm
          • claim farm rewards
          • unstake from farm
          • destroy farm NFT
        • Transaction sending guide
          • via ton
          • via tonweb
          • via tonconnect
      • v0.4 > v0.5 migration guide
      • v0.4 (deprecated)
        • perform a swap operation
        • provide liquidity
        • refund liquidity
        • burn liquidity tokens
        • using get methods
        • create a custom router revision
    • API reference v1
      • Router
      • Pool
      • LpAccount
      • LpWallet
    • API reference v2
      • Router
      • Pool
      • LpAccount
      • LpWallet
      • Vault
      • Swap examples
      • LpProvide examples
      • Vault examples
      • Op Codes
    • DEX API
    • OMNISTON
      • Resolvers (How to become a resolver)
      • Swap overview
      • Swap extra
      • Swap grpc
      • React
      • Nodejs
      • Referral fees
    • Quickstart Guides
      • Swap Guide
      • Omniston Guide
  • Help
    • Contact Us
Powered by GitBook
On this page
  • Off-chain get methods
  • get_vault_data
  • Owner operation handlers
  • withdraw_fee (0x354bcdf4)
  • Internal message handlers
  • deposit_ref_fee (0x0490f09b)
Export as PDF
  1. Developer section
  2. API reference v2

Vault

This section contains api reference of the vault contract

PreviousLpWalletNextSwap examples

Last updated 2 months ago

Check for in-depth message flow.

Off-chain get methods

get_vault_data

Returns Vault data

(slice, slice, slice, int) get_vault_data() method_id;

Arguments

None

Result

Returns VaultData structure containing current state of the Vault.

VaultData 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 (0x354bcdf4)

Burn an amount of liquidity tokens.

TL-B

withdraw_fee#354bcdf4 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 (0x0490f09b)

Increase ref fee tracker for the user.

TL-B

deposit_ref_fee#490f09b 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.

examples