Add Tokemak #22

HanzCEO · 2025-06-24T13:58:25Z

Protocol Information

Protocol Name: Tokemak
Protocol Website: https://docs.tokemak.xyz
Indexing Smart Contract Addresses (e.g. factories):
- Ethereum
  - AutopoolETH Factory, https://etherscan.io/address/0x7fEd74094B7010c6FB3010ed5EfC00772fD2ED1f
- Base
  - AutopoolETH Factory, https://basescan.org/address/0x78A7c45E3cC7B9567b4803AEAF9b33bC8c898451
- Sonic
  - $wS Factory, https://sonicscan.org/address/0x98BbB7196dcf828289cE5Ca9e529a46c196b38e8
  - $USDC Factory, https://sonicscan.org/address/0x00D9caD65287d22C60D9C1957e844b06c4F489AF
- https://docs.tokemak.xyz/developer-docs/contracts-overview/contract-addresses

Summary of Integration

Provide a brief overview of your integration:

What does your protocol do?
- Tokemak's Autopilot was developed to address the many challenges liquidity providers (LPs) face when optimizing for best performance. No protocol currently offers fully autonomous, transparent and sophisticated rebalance solution focused solely on liquidity provision.
What type of liquidity does it provide (DEX, lending, yield farming, etc.)?
- Liquidity Provision Yield Vault
Any unique features that GlueX should consider?
- n/a

Implementation Details

Execution Functions Required

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.0;

interface AutopoolETH {
    function deposit(uint256 assets, address receiver) external returns (uint256 shares);
    function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);
}

Functions Implemented

get_amount_out()
get_amount_in()
get_apy()
get_tvl()

Dynamic States Required for AMM Calculations

oldestDebtReporting - Obtained from AutoPool.oldestDebtReporting()
totalSupply - AutoPool.totalSupply()
assetBreakdown - A dict, explained below. Obtained from AutoPool.getAssetBreakdown()
- totalIdle - The amount of baseAsset deposited into the contract pending deployment
- totalDebt - The current (though cached) value of assets we've deployed
- totalDebtMax - The current (though cached) value of assets we use for valuing during deposits
- totalDebtMin - The current (though cached) value of assets we use for valuing during withdrawals
previousAssetBreakdown - The same dict as assetBreakdown but N days ago
previousTotalSupply - The same as totalSupply but N days ago
days - N of days between previous* and current states
paused - AutoPool.paused()
shutdown - AutoPool.isShutdown()
profitUnlockSettings - A dict explained below. Obtained from AutoPool.getProfitUnlockSettings()
- fullProfitUnlockTime - Time at which all profit will have been unlocked
- profitUnlockRate - Per second rate at which profit shares unlocks. Rate when calculated is denominated in MAX_BPS_PROFIT
- lastProfitUnlockTime - Last time profits were unlocked
debtReportQueue - Array of Addresses of destination vaults (obtained from AutoPool.getDebtReportingQueue())
destinationInfo - Custom map of destVaultAddr => destInfo, with destInfo explained below:
- lastReport - Derived from the lastReport key of the value of AutoPool.getDestinationInfo()
- ownedShares - Derived from the ownedShares key of the value of AutoPool.getDestinationInfo()
- cachedMaxDebtValue - Derived from the cachedMaxDebtValue key of the value of AutoPool.getDestinationInfo()
- cachedMinDebtValue - Derived from the cachedMinDebtValue key of the value of AutoPool.getDestinationInfo()
- currentShares - destVaultAddr.balanceOf(currentPoolAddr) in uint256
- underlyerCeilingPrice - destVaultAddr.getUnderlyerCeilingPrice() in uint256
- underlyerFloorPrice - destVaultAddr.getUnderlyerFloorPrice() in uint256
- ONE - destVaultAddr.ONE() in uint256

Static States Required for AMM Calculations

vaultTokenAddress - Current in-operation ERC4626 vault address
asset - Current in-operation vault's underlying token address

Dependencies

N/A

Other Requirements

API Keys: n/a
Special Access Requirements: n/a

Test Results

Click to view test results

=========================================================================================================== test session starts ============================================================================================================
platform linux -- Python 3.13.2, pytest-8.3.5, pluggy-1.6.0 -- /home/hanz/Work/Bounty/liquidity-module-self-integration/venv/bin/python3
cachedir: .pytest_cache
rootdir: /home/hanz/Work/Bounty/liquidity-module-self-integration
plugins: cov-6.1.1
collected 16 items                                                                                                                                                                                                                         

tests/testtokemak_liquidity_module.py::test_get_amount_out_general PASSED                                                                                                                                                            [  6%]
tests/testtokemak_liquidity_module.py::test_get_amount_out_deposit_exact PASSED                                                                                                                                                      [ 12%]
tests/testtokemak_liquidity_module.py::test_get_amount_out_redeem_exact PASSED                                                                                                                                                       [ 18%]
tests/testtokemak_liquidity_module.py::test_get_amount_out_stale PASSED                                                                                                                                                              [ 25%]
tests/testtokemak_liquidity_module.py::test_get_amount_out_vault_to_asset PASSED                                                                                                                                                     [ 31%]
tests/testtokemak_liquidity_module.py::test_get_amount_in_general PASSED                                                                                                                                                             [ 37%]
tests/testtokemak_liquidity_module.py::test_get_amount_in_exact PASSED                                                                                                                                                               [ 43%]
tests/testtokemak_liquidity_module.py::test_get_amount_in_deposit_exact PASSED                                                                                                                                                       [ 50%]
tests/testtokemak_liquidity_module.py::test_get_amount_in_redeem_exact PASSED                                                                                                                                                        [ 56%]
tests/testtokemak_liquidity_module.py::test_get_amount_in_stale PASSED                                                                                                                                                               [ 62%]
tests/testtokemak_liquidity_module.py::test_get_apy_zero_days PASSED                                                                                                                                                                 [ 68%]
tests/testtokemak_liquidity_module.py::test_get_apy_exact PASSED                                                                                                                                                                     [ 75%]
tests/testtokemak_liquidity_module.py::test_get_apy_stale PASSED                                                                                                                                                                     [ 81%]
tests/testtokemak_liquidity_module.py::test_get_tvl_general PASSED                                                                                                                                                                   [ 87%]
tests/testtokemak_liquidity_module.py::test_get_tvl_exact PASSED                                                                                                                                                                     [ 93%]
tests/testtokemak_liquidity_module.py::test_get_tvl_no_token PASSED                                                                                                                                                                  [100%]

============================================================================================================== tests coverage ==============================================================================================================
_____________________________________________________________________________________________ coverage: platform linux, python 3.13.2-final-0 ______________________________________________________________________________________________

Name                                    Stmts   Miss  Cover
-----------------------------------------------------------
modules/helpers/autopool4626.py            56     11    80%
modules/helpers/autopooldebt.py            37     19    49%
modules/helpers/autopoolfees.py            14      2    86%
modules/helpers/block.py                    2      0   100%
modules/tokemak_liquidity_module.py        69      2    97%
templates/liquidity_module.py              22      4    82%
tests/testtokemak_liquidity_module.py     128      8    94%
-----------------------------------------------------------
TOTAL                                     328     46    86%
============================================================================================================ 16 passed in 0.12s ============================================================================================================

fix: Fixed idle asset not being included

…_total_assets

…smart contract

Ishita-GlueX · 2025-08-21T04:31:35Z

modules/helpers/autopoolfees.py

+    full_time = profit_unlock_settings.get('fullProfitUnlockTime', 0)
+    profit_unlock_rate =  profit_unlock_settings.get('profitUnlockRate', 0)
+    last_profit_unlock_time =  profit_unlock_settings.get('lastProfitUnlockTime', 0)
+    self_balance = pool_state.get('selfBalance', 0) # this.balanceOf(address(this))


Since this refers to the AutopoolFees contract itself, we’ll need the on-chain address of the AutopoolFees contract to correctly fetch this balance. Could you clarify where we should be sourcing that address from.

AutopoolFees are a library which is used on the Autopool contract.

Thus, any state that is in autopoolfees.py is in Autopuul contract.

self_balance is IERC20(address(this)).balanceOf(address(this))

Ishita-GlueX · 2025-08-21T06:30:08Z

modules/helpers/autopooldebt.py

+            break
+
+        # currentShares is destVault.balanceOf(address(this)) where `this` is the autopool contract
+        current_shares = destination_info[dest_vault].get('currentShares', 0)


Since this refers to the AutopoolDebtcontract itself, we’ll need the on-chain address of the AutopoolDebt contract to correctly fetch this balance. Could you clarify where we should be sourcing that address from.

AutopoolDebt is a library which is used on the Autopool contract.

Thus, any state that is in autopooldebt.py is in Autopool contract.

Regarding the destination_info Dict, it is a mapping of address => DestVaultInfo. The address keys can be obtained from calling Autopool.getDestinations() which returns an array of addresses. The struct of a DestVaultInfo has been described here:

Ishita-GlueX · 2025-08-21T07:36:27Z

modules/scripts/fetch_all.py

+
+		destination_info[destl]["currentShares"] = currentShares
+		destination_info[destl]["underlyerCeilingPrice"] = underlyerCeilingPrice
+		destination_info[destl]["underlyerFloorPrice"] = underlyerFloorPrice


For fetching each state we have a max computation units set to 1000000. While fetching underlyerCeilingPrice its taking more than the max computation units.
Here is the tenderly simulation you can have a look.

https://www.tdly.co/shared/simulation/73ccb525-6a4f-43cf-9f0a-ce0ec44dac98

Because of this limitation, we won’t be able to integrate this.

I will devise a solution that fits this constraint

@Ishita-GlueX is it possible that the computation unit be increased by 100k? That specific pool is directed towards institutional usage and is a new addition to the Tokemak catalogue.

You can see here after the 100k CU limit addition, the function call actually requires less than 1M CU:
https://www.tdly.co/shared/simulation/01424017-c55a-45df-8ccb-1c5078d60f17

0x4b1ea6f0e97cb0e859b1521a4548fbd0a94e6a63 is a destination vault address, not a pool address.
Fetching getUnderlyerCeilingPrice() from this is consuming too much gas (over 100k).

I understand, fetching each state such as DestinationVault.underlyerCeilingPrice() has a limit of 1M CU. However, DestinationVault.underlyerCeilingPrice() actually did not use more than that (1M CU). Instead, tenderly fails for some reason with gaslimit=1M. So, I increased the limit by 100k, essentially using gaslimit=1.1M. This, works and the result shows that underlyerCeillingPrice actually did not use more than 1M CU, but somehow blocked by a factor unknown.

The behavior is not always consistent — sometimes the call goes through under 1M, and other times it fails unless given some extra buffer. So it’s not a fixed threshold.

@Ishita-GlueX This Silo institutional pool was new and is not under my watch when I implement this integration. The only pools that does this is Silo Institutional's, there are 2 of them. Other pools only need about 200k CU to fetch DestinationVault.underlyerCeilingPrice().

HanzCEO added 13 commits June 24, 2025 20:58

feat: Added initial files

7b1c056

feat: Added standard functions

402e933

feat: Added get_amount_in and get_amount_out

7aec2ea

feat: Added get_tvl

384e9a8

feat: Added get_apy

903d380

test: Added test file

61001b2

fix: Fixed idle asset not being included

docs: Added TODO Note

9e166dc

feat: Organized helpers

21b14f5

feat: Added _max_deposit

6e48391

fix: Fixed fee and input_amount retval

92e29b8

fix: Changed destination_info as a pool_state

f5f8766

feat: Added script to fetch all params

ee3a9cf

fix: Fixed total_assets_time_checked's initial value for recalculated…

c085367

…_total_assets

HanzCEO marked this pull request as ready for review June 28, 2025 14:16

HanzCEO added 4 commits July 6, 2025 20:52

fix: Fixed convert_to_shares and convert_to_assets to match with the …

ba17416

…smart contract

chore: removed TODO tag

3605924

chore: changed some code comments

ac17b08

fix: Fixed overloaded ERC4626 functions with correct implementation

10dbe8c

HanzCEO marked this pull request as draft July 7, 2025 00:56

HanzCEO added 4 commits July 8, 2025 06:31

chore: stage failing tests

6095773

feat: Explicitly define 4 paths of trade

04e626d

fix: Fixed get_amount_in

6100477

fix: Fixed get_amount_in (missed staging)

b39e7b8

HanzCEO marked this pull request as ready for review July 23, 2025 16:26

Ishita-GlueX reviewed Aug 21, 2025

View reviewed changes

HanzCEO requested a review from Ishita-GlueX September 9, 2025 06:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Tokemak #22

Add Tokemak #22

Uh oh!

HanzCEO commented Jun 24, 2025 •

edited

Loading

Uh oh!

Ishita-GlueX Aug 21, 2025

Uh oh!

HanzCEO Aug 21, 2025

Uh oh!

Ishita-GlueX Aug 21, 2025

Uh oh!

HanzCEO Aug 21, 2025

Uh oh!

Ishita-GlueX Aug 21, 2025 •

edited

Loading

Uh oh!

HanzCEO Aug 21, 2025

Uh oh!

HanzCEO Aug 23, 2025

Uh oh!

Ishita-GlueX Aug 25, 2025 •

edited

Loading

Uh oh!

HanzCEO Aug 27, 2025

Uh oh!

Ishita-GlueX Aug 27, 2025

Uh oh!

HanzCEO Aug 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add Tokemak #22

Are you sure you want to change the base?

Add Tokemak #22

Uh oh!

Conversation

HanzCEO commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Protocol Information

Summary of Integration

Implementation Details

Execution Functions Required

Functions Implemented

Dynamic States Required for AMM Calculations

Static States Required for AMM Calculations

Dependencies

Other Requirements

Test Results

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ishita-GlueX Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ishita-GlueX Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

HanzCEO commented Jun 24, 2025 •

edited

Loading

Ishita-GlueX Aug 21, 2025 •

edited

Loading

Ishita-GlueX Aug 25, 2025 •

edited

Loading