Charm Finance
  • Charm Overview
    • The mission
  • Products Overview
    • Alpha Vaults
      • Whitepaper
      • FAQ
    • Charm Simulator
  • Provide Liquidity
    • Overview
    • The Benefits
    • Risks and Mitigants
    • Charm Vaults
    • Community Vaults
    • Conclusion
    • Fees
    • FAQ
    • User Guides
      • Home Page
      • Depositing and Withdrawing
      • Vault Information Page
      • Performance Page
      • Portfolio Page
  • Manage Liquidity
    • Overview
    • The Benefits
    • Challenges and Solution
    • Uses Cases
    • How it works
    • Risks and mitigants
    • Conclusion
    • Fees
    • FAQ
    • User Guides
      • Create Vault
        • Default Values
        • Next Steps
      • Vault Parameters
      • Rebalancing
      • Verifying Vaults
      • Capital Efficiency
      • Other Features
      • Best Practices
      • Walkthroughs
        • Create Vault
        • Edit Vault
        • Automating Rebalance
        • Verify Manager
  • Technical References
    • Overview
    • Core
      • AlphaProVault
      • AlphaProVaultFactory
      • CloneFactory
      • Interfaces
    • Periphery
    • Error Codes
    • Contract Addresses
    • Subgraph
  • Links
    • Alpha Vaults v2
    • Contracts
    • Blog
  • Appendix
    • Glossary
    • Audit Reports
    • Team
    • Charm's Investors
    • 中文版
  • Research
    • Medallion
      • Whitepaper
      • FAQ
      • Decentralised competition
  • Previous Products
    • Alpha Vaults v1
    • Charm Options
      • Key Features
        • Capital Efficiency
      • Use Cases
      • How trading works
      • How liquidity provision works
      • Trading Tutorials
        • Open a position
          • Notes
        • Close a position
        • Settlement
      • Liquidity Provision Tutorials
        • Provide liquidity
        • Withdraw Liquidity
    • Cube Tokens
      • How it works
Powered by GitBook
On this page
  • Essential Interfaces
  • Pool Interfaces
  • Vault Interfaces
  • Protocol Interfaces
  • Strategy Interfaces
  • Security Interfaces
  • Gas Optimization Interfaces
  • Vault Manager Interfaces
  1. Technical References
  2. Core

Interfaces

Summarising the vault's functions that can be called by anyone

PreviousCloneFactoryNextPeriphery

Last updated 8 months ago

Essential Interfaces

These interfaces allow an external contract or address to trigger the vault to perform essential functions, or to provide important information to the caller.

Interface
Implementation
Summary

deposit();

Depositing into the vault

withdraw();

Withdrawing from the vault

rebalance();

Rebalance the vault

checkCanRebalance();

Check if vault can rebalance

getTotalAmounts();

Get the total amount of tokens held by the vault

getBalance0();

Amount of token0 not used

getBalance1();

Amount of token1 not used

totalsupply();

IERC20Upgradeable.sol

Get the total number of vault shares that's been minted

name();

IERC20Upgradeable.sol

Name of the vault share

symbol();

IERC20Upgradeable.sol

Symbol of the vault share

Pool Interfaces

The following interfaces are implemented by each of the getter functions for the :

Interface

pool();

token0();

token1();

tickSpacing();

Vault Interfaces

Interface

name();

symbol();

maxTotalSupply();

Protocol Interfaces

Interface

factory();

protocolFee();

accruedProtocolFees0();

accruedProtocolFees1();

Strategy Interfaces

Interface

fullRangeWeight();

baseThreshold();

limitThreshold();

period();

lastTimestamp();

lastTick();

fullLower();

fullUpper();

baseLower();

baseUpper();

limitLower();

limitUpper();

Security Interfaces

Interface

maxTwapDeviation();

twapDuration();

Gas Optimization Interfaces

Interface

minTickMove();

Vault Manager Interfaces

Interface

manager();

pendingManager();

rebalanceDelegate();

period();

managerFee();

pendingManagerFee();

accruedManagerFees0();

accruedManagerFees1();

baseUpper();

The following interfaces are implemented by each of the getter functions for the :

The following interfaces are implemented by each of the getter functions for :

The following interfaces are implemented by each of the getter functions for :

The following interfaces are implemented by each of the getter functions for the :

The following interfaces are implemented by each of the getter functions for :

he following interfaces are implemented by each of the getter functions for the :

Pool Variables
Vault Variables
Protocol Variables
Strategy Variables
Security Variables
Gas Optimization Variables
Vault Manager Variables
deposit()
withdraw()
rebalance()
checkCanRebalance()
getTotalAmounts()
getBalance0()
getBalance1()