> For the complete documentation index, see [llms.txt](https://docs-v4.venus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-v4.venus.io/technical-reference.md).

# Technical reference

- [Contracts Overview](https://docs-v4.venus.io/technical-reference/contracts-overview.md)
- [Technical articles](https://docs-v4.venus.io/technical-reference/reference-technical-articles.md)
- [Automatic income allocation](https://docs-v4.venus.io/technical-reference/reference-technical-articles/automatic-income-allocation.md)
- [Capped Oracles](https://docs-v4.venus.io/technical-reference/reference-technical-articles/capped-oracles.md)
- [Contributing](https://docs-v4.venus.io/technical-reference/reference-technical-articles/contributing.md)
- [Diamond Comptroller in the Core pool](https://docs-v4.venus.io/technical-reference/reference-technical-articles/diamond-comptroller.md)
- [E-Mode](https://docs-v4.venus.io/technical-reference/reference-technical-articles/emode.md)
- [Trade](https://docs-v4.venus.io/technical-reference/reference-technical-articles/trade.md)
- [Fixed Term Vaults](https://docs-v4.venus.io/technical-reference/reference-technical-articles/fixed-rate-vaults.md)
- [Native Token Gateway](https://docs-v4.venus.io/technical-reference/reference-technical-articles/native-token-gateway.md)
- [Omnichain Governance](https://docs-v4.venus.io/technical-reference/reference-technical-articles/omnichain-governance.md)
- [Prime tokens](https://docs-v4.venus.io/technical-reference/reference-technical-articles/prime.md)
- [DeviationBoundedOracle](https://docs-v4.venus.io/technical-reference/reference-technical-articles/deviation-bounded-oracle.md)
- [FlashLoan](https://docs-v4.venus.io/technical-reference/reference-technical-articles/flashloan-core-pool.md)
- [Risk Stewards](https://docs-v4.venus.io/technical-reference/reference-technical-articles/risk-stewards.md)
- [Shortfall and auctions (historical; BNB mainnet paused)](https://docs-v4.venus.io/technical-reference/reference-technical-articles/shortfall-and-auctions.md)
- [TokenBuyback Contract](https://docs-v4.venus.io/technical-reference/reference-technical-articles/token-converters.md)
- [Two Kinks Interest Rate Curve](https://docs-v4.venus.io/technical-reference/reference-technical-articles/two-kinks-interest-rate-curve.md)
- [VenusERC4626 Vaults](https://docs-v4.venus.io/technical-reference/reference-technical-articles/venus-erc-4626.md)
- [XVS Bridge](https://docs-v4.venus.io/technical-reference/reference-technical-articles/xvs-bridge.md)
- [Core Pool](https://docs-v4.venus.io/technical-reference/reference-core-pool.md)
- [Comptroller](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller.md)
- [ComptrollerLens](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/comptroller-lens.md)
- [Diamond](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond.md)
- [Diamond](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond/diamond.md)
- [DiamondConsolidated](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond/diamond-consolidated.md)
- [Facets](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond/facets.md)
- [FacetBase (inherited API)](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond/facets/facet-base.md)
- [MarketFacet](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond/facets/market-facet.md)
- [PolicyFacet](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond/facets/policy-facet.md)
- [RewardFacet](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond/facets/reward-facet.md)
- [SetterFacet](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond/facets/setter-facet.md)
- [FlashLoanFacet](https://docs-v4.venus.io/technical-reference/reference-core-pool/comptroller/diamond/facets/flashloan-facet.md)
- [VToken](https://docs-v4.venus.io/technical-reference/reference-core-pool/vtoken.md)
- [Prime](https://docs-v4.venus.io/technical-reference/reference-core-pool/prime.md)
- [Prime token](https://docs-v4.venus.io/technical-reference/reference-core-pool/prime/prime.md)
- [Prime leaderboard](https://docs-v4.venus.io/technical-reference/reference-core-pool/prime/prime-leaderboard.md)
- [Prime leaderboard storage](https://docs-v4.venus.io/technical-reference/reference-core-pool/prime/prime-leaderboard-storage.md)
- [Prime lens](https://docs-v4.venus.io/technical-reference/reference-core-pool/prime/prime-lens.md)
- [Prime liquidity provider](https://docs-v4.venus.io/technical-reference/reference-core-pool/prime/prime-liquidity-provider.md)
- [Prime storage](https://docs-v4.venus.io/technical-reference/reference-core-pool/prime/prime-storage.md)
- [Vaults](https://docs-v4.venus.io/technical-reference/reference-core-pool/vaults.md)
- [XVS](https://docs-v4.venus.io/technical-reference/reference-core-pool/vaults/xvs.md)
- [XVSVault](https://docs-v4.venus.io/technical-reference/reference-core-pool/vaults/xvs/xvs-vault.md)
- [XVSVaultProxy](https://docs-v4.venus.io/technical-reference/reference-core-pool/vaults/xvs/xvs-vault-proxy.md)
- [XVSStore](https://docs-v4.venus.io/technical-reference/reference-core-pool/vaults/xvs/xvs-store.md)
- [XVSVaultTreasury](https://docs-v4.venus.io/technical-reference/reference-core-pool/vaults/xvs/xvs-vault-treasury.md)
- [VAI](https://docs-v4.venus.io/technical-reference/reference-core-pool/vaults/vai.md)
- [VAIVault](https://docs-v4.venus.io/technical-reference/reference-core-pool/vaults/vai/vai-vault.md)
- [VAIVaultProxy](https://docs-v4.venus.io/technical-reference/reference-core-pool/vaults/vai/vai-vault-proxy.md)
- [InterestRateModels](https://docs-v4.venus.io/technical-reference/reference-core-pool/interestratemodels.md)
- [JumpModel](https://docs-v4.venus.io/technical-reference/reference-core-pool/interestratemodels/jumpmodel.md)
- [TwoKinksInterestRateModel](https://docs-v4.venus.io/technical-reference/reference-core-pool/interestratemodels/twokinksinterestratemodel.md)
- [WhitePaperModel](https://docs-v4.venus.io/technical-reference/reference-core-pool/interestratemodels/whitepapermodel.md)
- [InterestRateModelLens](https://docs-v4.venus.io/technical-reference/reference-core-pool/interestratemodels/interestratemodellens.md)
- [Liquidator](https://docs-v4.venus.io/technical-reference/reference-core-pool/liquidator.md)
- [VTreasury](https://docs-v4.venus.io/technical-reference/reference-core-pool/vtreasury.md)
- [VenusLens](https://docs-v4.venus.io/technical-reference/reference-core-pool/venus-lens.md)
- [PSM](https://docs-v4.venus.io/technical-reference/reference-core-pool/peg-stability.md)
- [VBNBAdmin](https://docs-v4.venus.io/technical-reference/reference-core-pool/vbnbadmin.md)
- [Isolated Pools](https://docs-v4.venus.io/technical-reference/reference-isolated-pools.md)
- [Comptroller](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/comptroller.md)
- [Comptroller](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/comptroller/comptroller.md)
- [ComptrollerStorage](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/comptroller/comptroller-storage.md)
- [VenusERC4626](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/venus-erc4626.md)
- [VenusERC4626Factory](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/venus-erc4626/venus-erc4626-factory.md)
- [VToken](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/vtoken.md)
- [VToken](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/vtoken/vtoken.md)
- [VTokenInterfaces](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/vtoken/vtoken-interfaces.md)
- [NativeTokenGateway](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/native-token-gateway.md)
- [Pool Registry](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/pool-registry.md)
- [PoolRegistry](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/pool-registry/pool-registry.md)
- [PoolRegistryInterface](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/pool-registry/pool-registry-interface.md)
- [RewardsDistributor](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/rewards-distributor.md)
- [PoolLens](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/pool-lens.md)
- [Interest Rate Models](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/interest-rate-models.md)
- [InterestRateModel](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/interest-rate-models/interest-rate-model.md)
- [BaseJumpRateModelV2](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/interest-rate-models/base-jump-rate-model-v2.md)
- [JumpRateModelV2](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/interest-rate-models/jump-rate-model-v2.md)
- [TwoKinksInterestRateModel](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/interest-rate-models/two-kinks-interest-rate-model.md)
- [WhitePaperInterestRateModel](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/interest-rate-models/white-paper-interest-rate-model.md)
- [Protocol reserves and legacy Shortfall](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/risk-fund-and-shortfall.md)
- [Shortfall (legacy/recovery; BNB mainnet paused)](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/risk-fund-and-shortfall/shortfall.md)
- [ProtocolShareReserve (current)](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/risk-fund-and-shortfall/protocol-share-reserve.md)
- [RiskFundV2 (current BNB mainnet custody)](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/risk-fund-and-shortfall/risk-fund-v2.md)
- [RiskFundV2 storage (compatibility)](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/risk-fund-and-shortfall/risk-fund-storage.md)
- [Utility](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/utility.md)
- [MaxLoopsLimitHelper](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/utility/max-loops-limit-helper.md)
- [ErrorReporter](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/utility/error-reporter.md)
- [ExponentialNoError](https://docs-v4.venus.io/technical-reference/reference-isolated-pools/utility/exponential-no-error.md)
- [Fixed Term Vaults](https://docs-v4.venus.io/technical-reference/reference-fixed-rate-vaults.md)
- [InstitutionalVaultController](https://docs-v4.venus.io/technical-reference/reference-fixed-rate-vaults/institutional-vault-controller.md)
- [InstitutionalLoanVault](https://docs-v4.venus.io/technical-reference/reference-fixed-rate-vaults/institutional-loan-vault.md)
- [LiquidationAdapter](https://docs-v4.venus.io/technical-reference/reference-fixed-rate-vaults/liquidation-adapter.md)
- [InstitutionPositionToken](https://docs-v4.venus.io/technical-reference/reference-fixed-rate-vaults/institution-position-token.md)
- [BaseVault](https://docs-v4.venus.io/technical-reference/reference-fixed-rate-vaults/base-vault.md)
- [Oracle](https://docs-v4.venus.io/technical-reference/reference-oracle.md)
- [ResilientOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/resilient-oracle.md)
- [DeviationBoundedOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/deviation-bounded-oracle.md)
- [BoundValidator](https://docs-v4.venus.io/technical-reference/reference-oracle/bound-validator.md)
- [Sources](https://docs-v4.venus.io/technical-reference/reference-oracle/oracles.md)
- [ChainlinkOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/oracles/chainlink-oracle.md)
- [SequencerChainlinkOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/oracles/sequencer-chainlink-oracle.md)
- [BinanceOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/oracles/binance-oracle.md)
- [Correlated token oracles](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles.md)
- [AnkrBNBOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/ankr-bnb-oracle.md)
- [AsBNBOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/as-bnb-oracle.md)
- [CorrelatedTokenOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/correlated-token-oracle.md)
- [BNBxOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/bnbx-oracle.md)
- [OneJumpOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/one-jump-oracle.md)
- [PendleOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/pendle-oracle.md)
- [SFraxOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/sfrax-oracle.md)
- [SFrxETHOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/sfrx-ethoracle.md)
- [SlisBNBOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/slis-bnb-oracle.md)
- [StkBNBOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/stk-bnb-oracle.md)
- [WBETHOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/wbeth-oracle.md)
- [WeETHAccountantOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/we-eth-accountant-oracle.md)
- [WeETHOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/we-eth-oracle.md)
- [WstETHOracle](https://docs-v4.venus.io/technical-reference/reference-oracle/correlated-token-oracles/wst-eth-oracle.md)
- [Governance](https://docs-v4.venus.io/technical-reference/reference-governance.md)
- [AccessControlManager](https://docs-v4.venus.io/technical-reference/reference-governance/access-control-manager.md)
- [GovernorBravoDelegate](https://docs-v4.venus.io/technical-reference/reference-governance/governor-bravo-delegate.md)
- [AccessControlledV5](https://docs-v4.venus.io/technical-reference/reference-governance/access-controlled-v5.md)
- [GovernorBravoDelegator](https://docs-v4.venus.io/technical-reference/reference-governance/governor-bravo-delegator.md)
- [Timelock](https://docs-v4.venus.io/technical-reference/reference-governance/timelock.md)
- [GovernorBravoInterfaces](https://docs-v4.venus.io/technical-reference/reference-governance/governor-bravo-interfaces.md)
- [AccessControlledV8](https://docs-v4.venus.io/technical-reference/reference-governance/access-controlled-v8.md)
- [BaseOmnichainControllerSrc](https://docs-v4.venus.io/technical-reference/reference-governance/base-omnichain-controller-src.md)
- [BaseOmnichainControllerDest](https://docs-v4.venus.io/technical-reference/reference-governance/base-omnichain-controller-dest.md)
- [OmnichainProposalSender](https://docs-v4.venus.io/technical-reference/reference-governance/omnichain-proposal-sender.md)
- [OmnichainGovernanceExecutor](https://docs-v4.venus.io/technical-reference/reference-governance/omnichain-governance-executor.md)
- [OmnichainExecutorOwner](https://docs-v4.venus.io/technical-reference/reference-governance/omnichain-executor-owner.md)
- [RiskOracle](https://docs-v4.venus.io/technical-reference/reference-governance/risk-oracle.md)
- [RiskStewardReceiver](https://docs-v4.venus.io/technical-reference/reference-governance/risk-steward-receiver.md)
- [DestinationStewardReceiver](https://docs-v4.venus.io/technical-reference/reference-governance/destination-steward-receiver.md)
- [BaseRiskSteward](https://docs-v4.venus.io/technical-reference/reference-governance/base-risk-steward.md)
- [MarketCapsRiskSteward](https://docs-v4.venus.io/technical-reference/reference-governance/market-caps-risk-steward.md)
- [CollateralFactorsRiskSteward](https://docs-v4.venus.io/technical-reference/reference-governance/collateral-factors-risk-steward.md)
- [IRMRiskSteward](https://docs-v4.venus.io/technical-reference/reference-governance/irm-risk-steward.md)
- [XVS Bridge](https://docs-v4.venus.io/technical-reference/reference-xvs-bridge.md)
- [BaseXVSProxyOFT](https://docs-v4.venus.io/technical-reference/reference-xvs-bridge/basexvsproxyoft.md)
- [XVSProxyOFTSrc](https://docs-v4.venus.io/technical-reference/reference-xvs-bridge/xvsproxyoftsrc.md)
- [XVSProxyOFTDest](https://docs-v4.venus.io/technical-reference/reference-xvs-bridge/xvsproxyoftdest.md)
- [XVSBridgeAdmin](https://docs-v4.venus.io/technical-reference/reference-xvs-bridge/xvsbridgeadmin.md)
- [XVS](https://docs-v4.venus.io/technical-reference/reference-xvs-bridge/xvs.md)
- [TokenController](https://docs-v4.venus.io/technical-reference/reference-xvs-bridge/tokencontroller.md)
- [Periphery](https://docs-v4.venus.io/technical-reference/reference-periphery.md)
- [RelativePositionManager](https://docs-v4.venus.io/technical-reference/reference-periphery/relative-position-manager.md)
- [LeverageStrategiesManager](https://docs-v4.venus.io/technical-reference/reference-periphery/leverage-strategies-manager.md)
- [SwapHelper](https://docs-v4.venus.io/technical-reference/reference-periphery/swap-helper.md)
- [SwapRouter](https://docs-v4.venus.io/technical-reference/reference-periphery/swap-router.md)
- [DeviationSentinel](https://docs-v4.venus.io/technical-reference/reference-periphery/deviation-sentinel.md)
- [EBrake](https://docs-v4.venus.io/technical-reference/reference-periphery/ebrake.md)
- [Liquidity Hub](https://docs-v4.venus.io/technical-reference/reference-liquidity-hub.md)
- [Hub](https://docs-v4.venus.io/technical-reference/reference-liquidity-hub/hub.md)
- [vhToken](https://docs-v4.venus.io/technical-reference/reference-liquidity-hub/vhtoken.md)
- [Yield Groups](https://docs-v4.venus.io/technical-reference/reference-liquidity-hub/yield-groups.md)
- [Adapters](https://docs-v4.venus.io/technical-reference/reference-liquidity-hub/adapters.md)
- [Interfaces](https://docs-v4.venus.io/technical-reference/reference-liquidity-hub/interfaces.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs-v4.venus.io/technical-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.